/** * Forgejo API * This documentation describes the Forgejo API. * * The version of the OpenAPI document: 12.0.1-69-f75e427e+gitea-1.22.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from './configuration.js'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import globalAxios from 'axios'; import type { RequestArgs } from './base.js'; import { BaseAPI } from './base.js'; /** * APIError is an api error with a message * @export * @interface APIError */ export interface APIError { /** * * @type {string} * @memberof APIError */ message?: string; /** * * @type {string} * @memberof APIError */ url?: string; } /** * * @export * @interface APIForbiddenError */ export interface APIForbiddenError { /** * * @type {string} * @memberof APIForbiddenError */ message?: string; /** * * @type {string} * @memberof APIForbiddenError */ url?: string; } /** * * @export * @interface APIInternalServerError */ export interface APIInternalServerError { /** * * @type {string} * @memberof APIInternalServerError */ message?: string; /** * * @type {string} * @memberof APIInternalServerError */ url?: string; } /** * * @export * @interface APIInvalidTopicsError */ export interface APIInvalidTopicsError { /** * * @type {Array} * @memberof APIInvalidTopicsError */ invalidTopics?: Array; /** * * @type {string} * @memberof APIInvalidTopicsError */ message?: string; } /** * * @export * @interface APINotFound */ export interface APINotFound { /** * * @type {Array} * @memberof APINotFound */ errors?: Array; /** * * @type {string} * @memberof APINotFound */ message?: string; /** * * @type {string} * @memberof APINotFound */ url?: string; } /** * * @export * @interface APIRepoArchivedError */ export interface APIRepoArchivedError { /** * * @type {string} * @memberof APIRepoArchivedError */ message?: string; /** * * @type {string} * @memberof APIRepoArchivedError */ url?: string; } /** * * @export * @interface APIUnauthorizedError */ export interface APIUnauthorizedError { /** * * @type {string} * @memberof APIUnauthorizedError */ message?: string; /** * * @type {string} * @memberof APIUnauthorizedError */ url?: string; } /** * * @export * @interface APIValidationError */ export interface APIValidationError { /** * * @type {string} * @memberof APIValidationError */ message?: string; /** * * @type {string} * @memberof APIValidationError */ url?: string; } /** * * @export * @interface AccessToken */ export interface AccessToken { /** * * @type {number} * @memberof AccessToken */ id?: number; /** * * @type {string} * @memberof AccessToken */ name?: string; /** * * @type {Array} * @memberof AccessToken */ scopes?: Array; /** * * @type {string} * @memberof AccessToken */ sha1?: string; /** * * @type {string} * @memberof AccessToken */ token_last_eight?: string; } /** * ActionRun represents an action run * @export * @interface ActionRun */ export interface ActionRun { /** * the cron id for the schedule trigger * @type {number} * @memberof ActionRun */ ScheduleID?: number; /** * who approved this action run * @type {number} * @memberof ActionRun */ approved_by?: number; /** * the commit sha the action run ran on * @type {string} * @memberof ActionRun */ commit_sha?: string; /** * when the action run was created * @type {string} * @memberof ActionRun */ created?: string; /** * A Duration represents the elapsed time between two instants as an int64 nanosecond count. The representation limits the largest representable duration to approximately 290 years. * @type {number} * @memberof ActionRun */ duration?: number; /** * the webhook event that causes the workflow to run * @type {string} * @memberof ActionRun */ event?: string; /** * the payload of the webhook event that causes the workflow to run * @type {string} * @memberof ActionRun */ event_payload?: string; /** * the url of this action run * @type {string} * @memberof ActionRun */ html_url?: string; /** * the action run id * @type {number} * @memberof ActionRun */ id?: number; /** * a unique number for each run of a repository * @type {number} * @memberof ActionRun */ index_in_repo?: number; /** * If this is triggered by a PR from a forked repository or an untrusted user, we need to check if it is approved and limit permissions when running the workflow. * @type {boolean} * @memberof ActionRun */ is_fork_pull_request?: boolean; /** * has the commit/tag/… the action run ran on been deleted * @type {boolean} * @memberof ActionRun */ is_ref_deleted?: boolean; /** * may need approval if it\'s a fork pull request * @type {boolean} * @memberof ActionRun */ need_approval?: boolean; /** * the commit/tag/… the action run ran on * @type {string} * @memberof ActionRun */ prettyref?: string; /** * * @type {Repository} * @memberof ActionRun */ repository?: Repository; /** * when the action run was started * @type {string} * @memberof ActionRun */ started?: string; /** * the current status of this run * @type {string} * @memberof ActionRun */ status?: string; /** * when the action run was stopped * @type {string} * @memberof ActionRun */ stopped?: string; /** * the action run\'s title * @type {string} * @memberof ActionRun */ title?: string; /** * the trigger event defined in the `on` configuration of the triggered workflow * @type {string} * @memberof ActionRun */ trigger_event?: string; /** * * @type {User} * @memberof ActionRun */ trigger_user?: User; /** * when the action run was last updated * @type {string} * @memberof ActionRun */ updated?: string; /** * the name of workflow file * @type {string} * @memberof ActionRun */ workflow_id?: string; } /** * ActionRunJob represents a job of a run * @export * @interface ActionRunJob */ export interface ActionRunJob { /** * the action run job id * @type {number} * @memberof ActionRunJob */ id?: number; /** * the action run job name * @type {string} * @memberof ActionRunJob */ name?: string; /** * the action run job needed ids * @type {Array} * @memberof ActionRunJob */ needs?: Array; /** * the owner id * @type {number} * @memberof ActionRunJob */ owner_id?: number; /** * the repository id * @type {number} * @memberof ActionRunJob */ repo_id?: number; /** * the action run job labels to run on * @type {Array} * @memberof ActionRunJob */ runs_on?: Array; /** * the action run job status * @type {string} * @memberof ActionRunJob */ status?: string; /** * the action run job latest task id * @type {number} * @memberof ActionRunJob */ task_id?: number; } /** * ActionTask represents a ActionTask * @export * @interface ActionTask */ export interface ActionTask { /** * * @type {string} * @memberof ActionTask */ created_at?: string; /** * * @type {string} * @memberof ActionTask */ display_title?: string; /** * * @type {string} * @memberof ActionTask */ event?: string; /** * * @type {string} * @memberof ActionTask */ head_branch?: string; /** * * @type {string} * @memberof ActionTask */ head_sha?: string; /** * * @type {number} * @memberof ActionTask */ id?: number; /** * * @type {string} * @memberof ActionTask */ name?: string; /** * * @type {number} * @memberof ActionTask */ run_number?: number; /** * * @type {string} * @memberof ActionTask */ run_started_at?: string; /** * * @type {string} * @memberof ActionTask */ status?: string; /** * * @type {string} * @memberof ActionTask */ updated_at?: string; /** * * @type {string} * @memberof ActionTask */ url?: string; /** * * @type {string} * @memberof ActionTask */ workflow_id?: string; } /** * ActionTaskResponse returns a ActionTask * @export * @interface ActionTaskResponse */ export interface ActionTaskResponse { /** * * @type {number} * @memberof ActionTaskResponse */ total_count?: number; /** * * @type {Array} * @memberof ActionTaskResponse */ workflow_runs?: Array; } /** * ActionVariable return value of the query API * @export * @interface ActionVariable */ export interface ActionVariable { /** * the value of the variable * @type {string} * @memberof ActionVariable */ data?: string; /** * the name of the variable * @type {string} * @memberof ActionVariable */ name?: string; /** * the owner to which the variable belongs * @type {number} * @memberof ActionVariable */ owner_id?: number; /** * the repository to which the variable belongs * @type {number} * @memberof ActionVariable */ repo_id?: number; } /** * * @export * @interface Activity */ export interface Activity { /** * * @type {User} * @memberof Activity */ act_user?: User; /** * * @type {number} * @memberof Activity */ act_user_id?: number; /** * * @type {Comment} * @memberof Activity */ comment?: Comment; /** * * @type {number} * @memberof Activity */ comment_id?: number; /** * * @type {string} * @memberof Activity */ content?: string; /** * * @type {string} * @memberof Activity */ created?: string; /** * * @type {number} * @memberof Activity */ id?: number; /** * * @type {boolean} * @memberof Activity */ is_private?: boolean; /** * the type of action * @type {string} * @memberof Activity */ op_type?: ActivityOpTypeEnum; /** * * @type {string} * @memberof Activity */ ref_name?: string; /** * * @type {Repository} * @memberof Activity */ repo?: Repository; /** * * @type {number} * @memberof Activity */ repo_id?: number; /** * * @type {number} * @memberof Activity */ user_id?: number; } export declare const ActivityOpTypeEnum: { readonly CreateRepo: "create_repo"; readonly RenameRepo: "rename_repo"; readonly StarRepo: "star_repo"; readonly WatchRepo: "watch_repo"; readonly CommitRepo: "commit_repo"; readonly CreateIssue: "create_issue"; readonly CreatePullRequest: "create_pull_request"; readonly TransferRepo: "transfer_repo"; readonly PushTag: "push_tag"; readonly CommentIssue: "comment_issue"; readonly MergePullRequest: "merge_pull_request"; readonly CloseIssue: "close_issue"; readonly ReopenIssue: "reopen_issue"; readonly ClosePullRequest: "close_pull_request"; readonly ReopenPullRequest: "reopen_pull_request"; readonly DeleteTag: "delete_tag"; readonly DeleteBranch: "delete_branch"; readonly MirrorSyncPush: "mirror_sync_push"; readonly MirrorSyncCreate: "mirror_sync_create"; readonly MirrorSyncDelete: "mirror_sync_delete"; readonly ApprovePullRequest: "approve_pull_request"; readonly RejectPullRequest: "reject_pull_request"; readonly CommentPull: "comment_pull"; readonly PublishRelease: "publish_release"; readonly PullReviewDismissed: "pull_review_dismissed"; readonly PullRequestReadyForReview: "pull_request_ready_for_review"; readonly AutoMergePullRequest: "auto_merge_pull_request"; }; export type ActivityOpTypeEnum = (typeof ActivityOpTypeEnum)[keyof typeof ActivityOpTypeEnum]; /** * ActivityPub type * @export * @interface ActivityPub */ export interface ActivityPub { /** * * @type {string} * @memberof ActivityPub */ '@context'?: string; } /** * AddCollaboratorOption options when adding a user as a collaborator of a repository * @export * @interface AddCollaboratorOption */ export interface AddCollaboratorOption { /** * * @type {string} * @memberof AddCollaboratorOption */ permission?: AddCollaboratorOptionPermissionEnum; } export declare const AddCollaboratorOptionPermissionEnum: { readonly Read: "read"; readonly Write: "write"; readonly Admin: "admin"; }; export type AddCollaboratorOptionPermissionEnum = (typeof AddCollaboratorOptionPermissionEnum)[keyof typeof AddCollaboratorOptionPermissionEnum]; /** * AddTimeOption options for adding time to an issue * @export * @interface AddTimeOption */ export interface AddTimeOption { /** * * @type {string} * @memberof AddTimeOption */ created?: string; /** * time in seconds * @type {number} * @memberof AddTimeOption */ time: number; /** * User who spent the time (optional) * @type {string} * @memberof AddTimeOption */ user_name?: string; } /** * AnnotatedTag represents an annotated tag * @export * @interface AnnotatedTag */ export interface AnnotatedTag { /** * * @type {TagArchiveDownloadCount} * @memberof AnnotatedTag */ archive_download_count?: TagArchiveDownloadCount; /** * * @type {string} * @memberof AnnotatedTag */ message?: string; /** * * @type {AnnotatedTagObject} * @memberof AnnotatedTag */ object?: AnnotatedTagObject; /** * * @type {string} * @memberof AnnotatedTag */ sha?: string; /** * * @type {string} * @memberof AnnotatedTag */ tag?: string; /** * * @type {CommitUser} * @memberof AnnotatedTag */ tagger?: CommitUser; /** * * @type {string} * @memberof AnnotatedTag */ url?: string; /** * * @type {PayloadCommitVerification} * @memberof AnnotatedTag */ verification?: PayloadCommitVerification; } /** * AnnotatedTagObject contains meta information of the tag object * @export * @interface AnnotatedTagObject */ export interface AnnotatedTagObject { /** * * @type {string} * @memberof AnnotatedTagObject */ sha?: string; /** * * @type {string} * @memberof AnnotatedTagObject */ type?: string; /** * * @type {string} * @memberof AnnotatedTagObject */ url?: string; } /** * Attachment a generic attachment * @export * @interface Attachment */ export interface Attachment { /** * * @type {string} * @memberof Attachment */ browser_download_url?: string; /** * * @type {string} * @memberof Attachment */ created_at?: string; /** * * @type {number} * @memberof Attachment */ download_count?: number; /** * * @type {number} * @memberof Attachment */ id?: number; /** * * @type {string} * @memberof Attachment */ name?: string; /** * * @type {number} * @memberof Attachment */ size?: number; /** * * @type {string} * @memberof Attachment */ type?: AttachmentTypeEnum; /** * * @type {string} * @memberof Attachment */ uuid?: string; } export declare const AttachmentTypeEnum: { readonly Attachment: "attachment"; readonly External: "external"; }; export type AttachmentTypeEnum = (typeof AttachmentTypeEnum)[keyof typeof AttachmentTypeEnum]; /** * * @export * @interface BlockedUser */ export interface BlockedUser { /** * * @type {number} * @memberof BlockedUser */ block_id?: number; /** * * @type {string} * @memberof BlockedUser */ created_at?: string; } /** * Branch represents a repository branch * @export * @interface Branch */ export interface Branch { /** * * @type {PayloadCommit} * @memberof Branch */ commit?: PayloadCommit; /** * * @type {string} * @memberof Branch */ effective_branch_protection_name?: string; /** * * @type {boolean} * @memberof Branch */ enable_status_check?: boolean; /** * * @type {string} * @memberof Branch */ name?: string; /** * * @type {boolean} * @memberof Branch */ protected?: boolean; /** * * @type {number} * @memberof Branch */ required_approvals?: number; /** * * @type {Array} * @memberof Branch */ status_check_contexts?: Array; /** * * @type {boolean} * @memberof Branch */ user_can_merge?: boolean; /** * * @type {boolean} * @memberof Branch */ user_can_push?: boolean; } /** * BranchProtection represents a branch protection for a repository * @export * @interface BranchProtection */ export interface BranchProtection { /** * * @type {boolean} * @memberof BranchProtection */ apply_to_admins?: boolean; /** * * @type {Array} * @memberof BranchProtection */ approvals_whitelist_teams?: Array; /** * * @type {Array} * @memberof BranchProtection */ approvals_whitelist_username?: Array; /** * * @type {boolean} * @memberof BranchProtection */ block_on_official_review_requests?: boolean; /** * * @type {boolean} * @memberof BranchProtection */ block_on_outdated_branch?: boolean; /** * * @type {boolean} * @memberof BranchProtection */ block_on_rejected_reviews?: boolean; /** * Deprecated: true * @type {string} * @memberof BranchProtection */ branch_name?: string; /** * * @type {string} * @memberof BranchProtection */ created_at?: string; /** * * @type {boolean} * @memberof BranchProtection */ dismiss_stale_approvals?: boolean; /** * * @type {boolean} * @memberof BranchProtection */ enable_approvals_whitelist?: boolean; /** * * @type {boolean} * @memberof BranchProtection */ enable_merge_whitelist?: boolean; /** * * @type {boolean} * @memberof BranchProtection */ enable_push?: boolean; /** * * @type {boolean} * @memberof BranchProtection */ enable_push_whitelist?: boolean; /** * * @type {boolean} * @memberof BranchProtection */ enable_status_check?: boolean; /** * * @type {boolean} * @memberof BranchProtection */ ignore_stale_approvals?: boolean; /** * * @type {Array} * @memberof BranchProtection */ merge_whitelist_teams?: Array; /** * * @type {Array} * @memberof BranchProtection */ merge_whitelist_usernames?: Array; /** * * @type {string} * @memberof BranchProtection */ protected_file_patterns?: string; /** * * @type {boolean} * @memberof BranchProtection */ push_whitelist_deploy_keys?: boolean; /** * * @type {Array} * @memberof BranchProtection */ push_whitelist_teams?: Array; /** * * @type {Array} * @memberof BranchProtection */ push_whitelist_usernames?: Array; /** * * @type {boolean} * @memberof BranchProtection */ require_signed_commits?: boolean; /** * * @type {number} * @memberof BranchProtection */ required_approvals?: number; /** * * @type {string} * @memberof BranchProtection */ rule_name?: string; /** * * @type {Array} * @memberof BranchProtection */ status_check_contexts?: Array; /** * * @type {string} * @memberof BranchProtection */ unprotected_file_patterns?: string; /** * * @type {string} * @memberof BranchProtection */ updated_at?: string; } /** * ChangeFileOperation for creating, updating or deleting a file * @export * @interface ChangeFileOperation */ export interface ChangeFileOperation { /** * new or updated file content, must be base64 encoded * @type {string} * @memberof ChangeFileOperation */ content?: string; /** * old path of the file to move * @type {string} * @memberof ChangeFileOperation */ from_path?: string; /** * indicates what to do with the file * @type {string} * @memberof ChangeFileOperation */ operation: ChangeFileOperationOperationEnum; /** * path to the existing or new file * @type {string} * @memberof ChangeFileOperation */ path: string; /** * sha is the SHA for the file that already exists, required for update or delete * @type {string} * @memberof ChangeFileOperation */ sha?: string; } export declare const ChangeFileOperationOperationEnum: { readonly Create: "create"; readonly Update: "update"; readonly Delete: "delete"; }; export type ChangeFileOperationOperationEnum = (typeof ChangeFileOperationOperationEnum)[keyof typeof ChangeFileOperationOperationEnum]; /** * 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) * @export * @interface ChangeFilesOptions */ export interface ChangeFilesOptions { /** * * @type {Identity} * @memberof ChangeFilesOptions */ author?: Identity; /** * branch (optional) to base this file from. if not given, the default branch is used * @type {string} * @memberof ChangeFilesOptions */ branch?: string; /** * * @type {Identity} * @memberof ChangeFilesOptions */ committer?: Identity; /** * * @type {CommitDateOptions} * @memberof ChangeFilesOptions */ dates?: CommitDateOptions; /** * list of file operations * @type {Array} * @memberof ChangeFilesOptions */ files: Array; /** * message (optional) for the commit of this file. if not supplied, a default message will be used * @type {string} * @memberof ChangeFilesOptions */ message?: string; /** * new_branch (optional) will make a new branch from `branch` before creating the file * @type {string} * @memberof ChangeFilesOptions */ new_branch?: string; /** * Add a Signed-off-by trailer by the committer at the end of the commit log message. * @type {boolean} * @memberof ChangeFilesOptions */ signoff?: boolean; } /** * ChangedFile store information about files affected by the pull request * @export * @interface ChangedFile */ export interface ChangedFile { /** * * @type {number} * @memberof ChangedFile */ additions?: number; /** * * @type {number} * @memberof ChangedFile */ changes?: number; /** * * @type {string} * @memberof ChangedFile */ contents_url?: string; /** * * @type {number} * @memberof ChangedFile */ deletions?: number; /** * * @type {string} * @memberof ChangedFile */ filename?: string; /** * * @type {string} * @memberof ChangedFile */ html_url?: string; /** * * @type {string} * @memberof ChangedFile */ previous_filename?: string; /** * * @type {string} * @memberof ChangedFile */ raw_url?: string; /** * * @type {string} * @memberof ChangedFile */ status?: string; } /** * CombinedStatus holds the combined state of several statuses for a single commit * @export * @interface CombinedStatus */ export interface CombinedStatus { /** * * @type {string} * @memberof CombinedStatus */ commit_url?: string; /** * * @type {Repository} * @memberof CombinedStatus */ repository?: Repository; /** * * @type {string} * @memberof CombinedStatus */ sha?: string; /** * CommitStatusState holds the state of a CommitStatus It can be \"pending\", \"success\", \"error\" and \"failure\" * @type {string} * @memberof CombinedStatus */ state?: string; /** * * @type {Array} * @memberof CombinedStatus */ statuses?: Array; /** * * @type {number} * @memberof CombinedStatus */ total_count?: number; /** * * @type {string} * @memberof CombinedStatus */ url?: string; } /** * Comment represents a comment on a commit or issue * @export * @interface Comment */ export interface Comment { /** * * @type {Array} * @memberof Comment */ assets?: Array; /** * * @type {string} * @memberof Comment */ body?: string; /** * * @type {string} * @memberof Comment */ created_at?: string; /** * * @type {string} * @memberof Comment */ html_url?: string; /** * * @type {number} * @memberof Comment */ id?: number; /** * * @type {string} * @memberof Comment */ issue_url?: string; /** * * @type {string} * @memberof Comment */ original_author?: string; /** * * @type {number} * @memberof Comment */ original_author_id?: number; /** * * @type {string} * @memberof Comment */ pull_request_url?: string; /** * * @type {string} * @memberof Comment */ updated_at?: string; /** * * @type {User} * @memberof Comment */ user?: User; } /** * * @export * @interface Commit */ export interface Commit { /** * * @type {User} * @memberof Commit */ author?: User; /** * * @type {RepoCommit} * @memberof Commit */ commit?: RepoCommit; /** * * @type {User} * @memberof Commit */ committer?: User; /** * * @type {string} * @memberof Commit */ created?: string; /** * * @type {Array} * @memberof Commit */ files?: Array; /** * * @type {string} * @memberof Commit */ html_url?: string; /** * * @type {Array} * @memberof Commit */ parents?: Array; /** * * @type {string} * @memberof Commit */ sha?: string; /** * * @type {CommitStats} * @memberof Commit */ stats?: CommitStats; /** * * @type {string} * @memberof Commit */ url?: string; } /** * CommitAffectedFiles store information about files affected by the commit * @export * @interface CommitAffectedFiles */ export interface CommitAffectedFiles { /** * * @type {string} * @memberof CommitAffectedFiles */ filename?: string; /** * * @type {string} * @memberof CommitAffectedFiles */ status?: string; } /** * CommitDateOptions store dates for GIT_AUTHOR_DATE and GIT_COMMITTER_DATE * @export * @interface CommitDateOptions */ export interface CommitDateOptions { /** * * @type {string} * @memberof CommitDateOptions */ author?: string; /** * * @type {string} * @memberof CommitDateOptions */ committer?: string; } /** * * @export * @interface CommitMeta */ export interface CommitMeta { /** * * @type {string} * @memberof CommitMeta */ created?: string; /** * * @type {string} * @memberof CommitMeta */ sha?: string; /** * * @type {string} * @memberof CommitMeta */ url?: string; } /** * CommitStats is statistics for a RepoCommit * @export * @interface CommitStats */ export interface CommitStats { /** * * @type {number} * @memberof CommitStats */ additions?: number; /** * * @type {number} * @memberof CommitStats */ deletions?: number; /** * * @type {number} * @memberof CommitStats */ total?: number; } /** * CommitStatus holds a single status of a single Commit * @export * @interface CommitStatus */ export interface CommitStatus { /** * * @type {string} * @memberof CommitStatus */ context?: string; /** * * @type {string} * @memberof CommitStatus */ created_at?: string; /** * * @type {User} * @memberof CommitStatus */ creator?: User; /** * * @type {string} * @memberof CommitStatus */ description?: string; /** * * @type {number} * @memberof CommitStatus */ id?: number; /** * CommitStatusState holds the state of a CommitStatus It can be \"pending\", \"success\", \"error\" and \"failure\" * @type {string} * @memberof CommitStatus */ status?: string; /** * * @type {string} * @memberof CommitStatus */ target_url?: string; /** * * @type {string} * @memberof CommitStatus */ updated_at?: string; /** * * @type {string} * @memberof CommitStatus */ url?: string; } /** * * @export * @interface CommitUser */ export interface CommitUser { /** * * @type {string} * @memberof CommitUser */ date?: string; /** * * @type {string} * @memberof CommitUser */ email?: string; /** * * @type {string} * @memberof CommitUser */ name?: string; } /** * * @export * @interface Compare */ export interface Compare { /** * * @type {Array} * @memberof Compare */ commits?: Array; /** * * @type {Array} * @memberof Compare */ files?: Array; /** * * @type {number} * @memberof Compare */ total_commits?: number; } /** * ContentsResponse contains information about a repo\'s entry\'s (dir, file, symlink, submodule) metadata and content * @export * @interface ContentsResponse */ export interface ContentsResponse { /** * * @type {FileLinksResponse} * @memberof ContentsResponse */ _links?: FileLinksResponse; /** * `content` is populated when `type` is `file`, otherwise null * @type {string} * @memberof ContentsResponse */ content?: string; /** * * @type {string} * @memberof ContentsResponse */ download_url?: string; /** * `encoding` is populated when `type` is `file`, otherwise null * @type {string} * @memberof ContentsResponse */ encoding?: string; /** * * @type {string} * @memberof ContentsResponse */ git_url?: string; /** * * @type {string} * @memberof ContentsResponse */ html_url?: string; /** * * @type {string} * @memberof ContentsResponse */ last_commit_sha?: string; /** * * @type {string} * @memberof ContentsResponse */ last_commit_when?: string; /** * * @type {string} * @memberof ContentsResponse */ name?: string; /** * * @type {string} * @memberof ContentsResponse */ path?: string; /** * * @type {string} * @memberof ContentsResponse */ sha?: string; /** * * @type {number} * @memberof ContentsResponse */ size?: number; /** * `submodule_git_url` is populated when `type` is `submodule`, otherwise null * @type {string} * @memberof ContentsResponse */ submodule_git_url?: string; /** * `target` is populated when `type` is `symlink`, otherwise null * @type {string} * @memberof ContentsResponse */ target?: string; /** * `type` will be `file`, `dir`, `symlink`, or `submodule` * @type {string} * @memberof ContentsResponse */ type?: string; /** * * @type {string} * @memberof ContentsResponse */ url?: string; } /** * CreateAccessTokenOption options when create access token * @export * @interface CreateAccessTokenOption */ export interface CreateAccessTokenOption { /** * * @type {string} * @memberof CreateAccessTokenOption */ name: string; /** * * @type {Array} * @memberof CreateAccessTokenOption */ scopes?: Array; } /** * CreateBranchProtectionOption options for creating a branch protection * @export * @interface CreateBranchProtectionOption */ export interface CreateBranchProtectionOption { /** * * @type {boolean} * @memberof CreateBranchProtectionOption */ apply_to_admins?: boolean; /** * * @type {Array} * @memberof CreateBranchProtectionOption */ approvals_whitelist_teams?: Array; /** * * @type {Array} * @memberof CreateBranchProtectionOption */ approvals_whitelist_username?: Array; /** * * @type {boolean} * @memberof CreateBranchProtectionOption */ block_on_official_review_requests?: boolean; /** * * @type {boolean} * @memberof CreateBranchProtectionOption */ block_on_outdated_branch?: boolean; /** * * @type {boolean} * @memberof CreateBranchProtectionOption */ block_on_rejected_reviews?: boolean; /** * Deprecated: true * @type {string} * @memberof CreateBranchProtectionOption */ branch_name?: string; /** * * @type {boolean} * @memberof CreateBranchProtectionOption */ dismiss_stale_approvals?: boolean; /** * * @type {boolean} * @memberof CreateBranchProtectionOption */ enable_approvals_whitelist?: boolean; /** * * @type {boolean} * @memberof CreateBranchProtectionOption */ enable_merge_whitelist?: boolean; /** * * @type {boolean} * @memberof CreateBranchProtectionOption */ enable_push?: boolean; /** * * @type {boolean} * @memberof CreateBranchProtectionOption */ enable_push_whitelist?: boolean; /** * * @type {boolean} * @memberof CreateBranchProtectionOption */ enable_status_check?: boolean; /** * * @type {boolean} * @memberof CreateBranchProtectionOption */ ignore_stale_approvals?: boolean; /** * * @type {Array} * @memberof CreateBranchProtectionOption */ merge_whitelist_teams?: Array; /** * * @type {Array} * @memberof CreateBranchProtectionOption */ merge_whitelist_usernames?: Array; /** * * @type {string} * @memberof CreateBranchProtectionOption */ protected_file_patterns?: string; /** * * @type {boolean} * @memberof CreateBranchProtectionOption */ push_whitelist_deploy_keys?: boolean; /** * * @type {Array} * @memberof CreateBranchProtectionOption */ push_whitelist_teams?: Array; /** * * @type {Array} * @memberof CreateBranchProtectionOption */ push_whitelist_usernames?: Array; /** * * @type {boolean} * @memberof CreateBranchProtectionOption */ require_signed_commits?: boolean; /** * * @type {number} * @memberof CreateBranchProtectionOption */ required_approvals?: number; /** * * @type {string} * @memberof CreateBranchProtectionOption */ rule_name?: string; /** * * @type {Array} * @memberof CreateBranchProtectionOption */ status_check_contexts?: Array; /** * * @type {string} * @memberof CreateBranchProtectionOption */ unprotected_file_patterns?: string; } /** * CreateBranchRepoOption options when creating a branch in a repository * @export * @interface CreateBranchRepoOption */ export interface CreateBranchRepoOption { /** * Name of the branch to create * @type {string} * @memberof CreateBranchRepoOption */ new_branch_name: string; /** * Deprecated: true Name of the old branch to create from * @type {string} * @memberof CreateBranchRepoOption */ old_branch_name?: string; /** * Name of the old branch/tag/commit to create from * @type {string} * @memberof CreateBranchRepoOption */ old_ref_name?: string; } /** * CreateEmailOption options when creating email addresses * @export * @interface CreateEmailOption */ export interface CreateEmailOption { /** * email addresses to add * @type {Array} * @memberof CreateEmailOption */ emails?: Array; } /** * 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) * @export * @interface CreateFileOptions */ export interface CreateFileOptions { /** * * @type {Identity} * @memberof CreateFileOptions */ author?: Identity; /** * branch (optional) to base this file from. if not given, the default branch is used * @type {string} * @memberof CreateFileOptions */ branch?: string; /** * * @type {Identity} * @memberof CreateFileOptions */ committer?: Identity; /** * content must be base64 encoded * @type {string} * @memberof CreateFileOptions */ content: string; /** * * @type {CommitDateOptions} * @memberof CreateFileOptions */ dates?: CommitDateOptions; /** * message (optional) for the commit of this file. if not supplied, a default message will be used * @type {string} * @memberof CreateFileOptions */ message?: string; /** * new_branch (optional) will make a new branch from `branch` before creating the file * @type {string} * @memberof CreateFileOptions */ new_branch?: string; /** * Add a Signed-off-by trailer by the committer at the end of the commit log message. * @type {boolean} * @memberof CreateFileOptions */ signoff?: boolean; } /** * CreateForkOption options for creating a fork * @export * @interface CreateForkOption */ export interface CreateForkOption { /** * name of the forked repository * @type {string} * @memberof CreateForkOption */ name?: string; /** * organization name, if forking into an organization * @type {string} * @memberof CreateForkOption */ organization?: string; } /** * CreateGPGKeyOption options create user GPG key * @export * @interface CreateGPGKeyOption */ export interface CreateGPGKeyOption { /** * An armored GPG key to add * @type {string} * @memberof CreateGPGKeyOption */ armored_public_key: string; /** * * @type {string} * @memberof CreateGPGKeyOption */ armored_signature?: string; } /** * CreateHookOption options when create a hook * @export * @interface CreateHookOption */ export interface CreateHookOption { /** * * @type {boolean} * @memberof CreateHookOption */ active?: boolean; /** * * @type {string} * @memberof CreateHookOption */ authorization_header?: string; /** * * @type {string} * @memberof CreateHookOption */ branch_filter?: string; /** * CreateHookOptionConfig has all config options in it required are \"content_type\" and \"url\" Required * @type {{ [key: string]: string; }} * @memberof CreateHookOption */ config: { [key: string]: string; }; /** * * @type {Array} * @memberof CreateHookOption */ events?: Array; /** * * @type {string} * @memberof CreateHookOption */ type: CreateHookOptionTypeEnum; } export declare const CreateHookOptionTypeEnum: { readonly Forgejo: "forgejo"; readonly Dingtalk: "dingtalk"; readonly Discord: "discord"; readonly Gitea: "gitea"; readonly Gogs: "gogs"; readonly Msteams: "msteams"; readonly Slack: "slack"; readonly Telegram: "telegram"; readonly Feishu: "feishu"; readonly Wechatwork: "wechatwork"; readonly Packagist: "packagist"; }; export type CreateHookOptionTypeEnum = (typeof CreateHookOptionTypeEnum)[keyof typeof CreateHookOptionTypeEnum]; /** * CreateIssueCommentOption options for creating a comment on an issue * @export * @interface CreateIssueCommentOption */ export interface CreateIssueCommentOption { /** * * @type {string} * @memberof CreateIssueCommentOption */ body: string; /** * * @type {string} * @memberof CreateIssueCommentOption */ updated_at?: string; } /** * CreateIssueOption options to create one issue * @export * @interface CreateIssueOption */ export interface CreateIssueOption { /** * deprecated * @type {string} * @memberof CreateIssueOption */ assignee?: string; /** * * @type {Array} * @memberof CreateIssueOption */ assignees?: Array; /** * * @type {string} * @memberof CreateIssueOption */ body?: string; /** * * @type {boolean} * @memberof CreateIssueOption */ closed?: boolean; /** * * @type {string} * @memberof CreateIssueOption */ due_date?: string; /** * list of label ids * @type {Array} * @memberof CreateIssueOption */ labels?: Array; /** * milestone id * @type {number} * @memberof CreateIssueOption */ milestone?: number; /** * * @type {string} * @memberof CreateIssueOption */ ref?: string; /** * * @type {string} * @memberof CreateIssueOption */ title: string; } /** * CreateKeyOption options when creating a key * @export * @interface CreateKeyOption */ export interface CreateKeyOption { /** * An armored SSH key to add * @type {string} * @memberof CreateKeyOption */ key: string; /** * Describe if the key has only read access or read/write * @type {boolean} * @memberof CreateKeyOption */ read_only?: boolean; /** * Title of the key to add * @type {string} * @memberof CreateKeyOption */ title: string; } /** * CreateLabelOption options for creating a label * @export * @interface CreateLabelOption */ export interface CreateLabelOption { /** * * @type {string} * @memberof CreateLabelOption */ color: string; /** * * @type {string} * @memberof CreateLabelOption */ description?: string; /** * * @type {boolean} * @memberof CreateLabelOption */ exclusive?: boolean; /** * * @type {boolean} * @memberof CreateLabelOption */ is_archived?: boolean; /** * * @type {string} * @memberof CreateLabelOption */ name: string; } /** * CreateMilestoneOption options for creating a milestone * @export * @interface CreateMilestoneOption */ export interface CreateMilestoneOption { /** * * @type {string} * @memberof CreateMilestoneOption */ description?: string; /** * * @type {string} * @memberof CreateMilestoneOption */ due_on?: string; /** * * @type {string} * @memberof CreateMilestoneOption */ state?: CreateMilestoneOptionStateEnum; /** * * @type {string} * @memberof CreateMilestoneOption */ title?: string; } export declare const CreateMilestoneOptionStateEnum: { readonly Open: "open"; readonly Closed: "closed"; }; export type CreateMilestoneOptionStateEnum = (typeof CreateMilestoneOptionStateEnum)[keyof typeof CreateMilestoneOptionStateEnum]; /** * CreateOAuth2ApplicationOptions holds options to create an oauth2 application * @export * @interface CreateOAuth2ApplicationOptions */ export interface CreateOAuth2ApplicationOptions { /** * * @type {boolean} * @memberof CreateOAuth2ApplicationOptions */ confidential_client?: boolean; /** * * @type {string} * @memberof CreateOAuth2ApplicationOptions */ name?: string; /** * * @type {Array} * @memberof CreateOAuth2ApplicationOptions */ redirect_uris?: Array; } /** * CreateOrUpdateSecretOption options when creating or updating secret * @export * @interface CreateOrUpdateSecretOption */ export interface CreateOrUpdateSecretOption { /** * Data of the secret to update * @type {string} * @memberof CreateOrUpdateSecretOption */ data: string; } /** * CreateOrgOption options for creating an organization * @export * @interface CreateOrgOption */ export interface CreateOrgOption { /** * * @type {string} * @memberof CreateOrgOption */ description?: string; /** * * @type {string} * @memberof CreateOrgOption */ email?: string; /** * * @type {string} * @memberof CreateOrgOption */ full_name?: string; /** * * @type {string} * @memberof CreateOrgOption */ location?: string; /** * * @type {boolean} * @memberof CreateOrgOption */ repo_admin_change_team_access?: boolean; /** * * @type {string} * @memberof CreateOrgOption */ username: string; /** * possible values are `public` (default), `limited` or `private` * @type {string} * @memberof CreateOrgOption */ visibility?: CreateOrgOptionVisibilityEnum; /** * * @type {string} * @memberof CreateOrgOption */ website?: string; } export declare const CreateOrgOptionVisibilityEnum: { readonly Public: "public"; readonly Limited: "limited"; readonly Private: "private"; }; export type CreateOrgOptionVisibilityEnum = (typeof CreateOrgOptionVisibilityEnum)[keyof typeof CreateOrgOptionVisibilityEnum]; /** * CreatePullRequestOption options when creating a pull request * @export * @interface CreatePullRequestOption */ export interface CreatePullRequestOption { /** * * @type {string} * @memberof CreatePullRequestOption */ assignee?: string; /** * * @type {Array} * @memberof CreatePullRequestOption */ assignees?: Array; /** * * @type {string} * @memberof CreatePullRequestOption */ base?: string; /** * * @type {string} * @memberof CreatePullRequestOption */ body?: string; /** * * @type {string} * @memberof CreatePullRequestOption */ due_date?: string; /** * * @type {string} * @memberof CreatePullRequestOption */ head?: string; /** * * @type {Array} * @memberof CreatePullRequestOption */ labels?: Array; /** * * @type {number} * @memberof CreatePullRequestOption */ milestone?: number; /** * * @type {string} * @memberof CreatePullRequestOption */ title?: string; } /** * CreatePullReviewComment represent a review comment for creation api * @export * @interface CreatePullReviewComment */ export interface CreatePullReviewComment { /** * * @type {string} * @memberof CreatePullReviewComment */ body?: string; /** * if comment to new file line or 0 * @type {number} * @memberof CreatePullReviewComment */ new_position?: number; /** * if comment to old file line or 0 * @type {number} * @memberof CreatePullReviewComment */ old_position?: number; /** * the tree path * @type {string} * @memberof CreatePullReviewComment */ path?: string; } /** * CreatePullReviewOptions are options to create a pull review * @export * @interface CreatePullReviewOptions */ export interface CreatePullReviewOptions { /** * * @type {string} * @memberof CreatePullReviewOptions */ body?: string; /** * * @type {Array} * @memberof CreatePullReviewOptions */ comments?: Array; /** * * @type {string} * @memberof CreatePullReviewOptions */ commit_id?: string; /** * ReviewStateType review state type * @type {string} * @memberof CreatePullReviewOptions */ event?: string; } /** * * @export * @interface CreatePushMirrorOption */ export interface CreatePushMirrorOption { /** * * @type {string} * @memberof CreatePushMirrorOption */ interval?: string; /** * * @type {string} * @memberof CreatePushMirrorOption */ remote_address?: string; /** * * @type {string} * @memberof CreatePushMirrorOption */ remote_password?: string; /** * * @type {string} * @memberof CreatePushMirrorOption */ remote_username?: string; /** * * @type {boolean} * @memberof CreatePushMirrorOption */ sync_on_commit?: boolean; /** * * @type {boolean} * @memberof CreatePushMirrorOption */ use_ssh?: boolean; } /** * CreateQutaGroupOptions represents the options for creating a quota group * @export * @interface CreateQuotaGroupOptions */ export interface CreateQuotaGroupOptions { /** * Name of the quota group to create * @type {string} * @memberof CreateQuotaGroupOptions */ name?: string; /** * Rules to add to the newly created group. If a rule does not exist, it will be created. * @type {Array} * @memberof CreateQuotaGroupOptions */ rules?: Array; } /** * CreateQuotaRuleOptions represents the options for creating a quota rule * @export * @interface CreateQuotaRuleOptions */ export interface CreateQuotaRuleOptions { /** * The limit set by the rule * @type {number} * @memberof CreateQuotaRuleOptions */ limit?: number; /** * Name of the rule to create * @type {string} * @memberof CreateQuotaRuleOptions */ name?: string; /** * The subjects affected by the rule * @type {Array} * @memberof CreateQuotaRuleOptions */ subjects?: Array; } /** * CreateReleaseOption options when creating a release * @export * @interface CreateReleaseOption */ export interface CreateReleaseOption { /** * * @type {string} * @memberof CreateReleaseOption */ body?: string; /** * * @type {boolean} * @memberof CreateReleaseOption */ draft?: boolean; /** * * @type {boolean} * @memberof CreateReleaseOption */ hide_archive_links?: boolean; /** * * @type {string} * @memberof CreateReleaseOption */ name?: string; /** * * @type {boolean} * @memberof CreateReleaseOption */ prerelease?: boolean; /** * * @type {string} * @memberof CreateReleaseOption */ tag_name: string; /** * * @type {string} * @memberof CreateReleaseOption */ target_commitish?: string; } /** * CreateRepoOption options when creating repository * @export * @interface CreateRepoOption */ export interface CreateRepoOption { /** * Whether the repository should be auto-initialized? * @type {boolean} * @memberof CreateRepoOption */ auto_init?: boolean; /** * DefaultBranch of the repository (used when initializes and in template) * @type {string} * @memberof CreateRepoOption */ default_branch?: string; /** * Description of the repository to create * @type {string} * @memberof CreateRepoOption */ description?: string; /** * Gitignores to use * @type {string} * @memberof CreateRepoOption */ gitignores?: string; /** * Label-Set to use * @type {string} * @memberof CreateRepoOption */ issue_labels?: string; /** * License to use * @type {string} * @memberof CreateRepoOption */ license?: string; /** * Name of the repository to create * @type {string} * @memberof CreateRepoOption */ name: string; /** * ObjectFormatName of the underlying git repository * @type {string} * @memberof CreateRepoOption */ object_format_name?: CreateRepoOptionObjectFormatNameEnum; /** * Whether the repository is private * @type {boolean} * @memberof CreateRepoOption */ private?: boolean; /** * Readme of the repository to create * @type {string} * @memberof CreateRepoOption */ readme?: string; /** * Whether the repository is template * @type {boolean} * @memberof CreateRepoOption */ template?: boolean; /** * TrustModel of the repository * @type {string} * @memberof CreateRepoOption */ trust_model?: CreateRepoOptionTrustModelEnum; } export declare const CreateRepoOptionObjectFormatNameEnum: { readonly Sha1: "sha1"; readonly Sha256: "sha256"; }; export type CreateRepoOptionObjectFormatNameEnum = (typeof CreateRepoOptionObjectFormatNameEnum)[keyof typeof CreateRepoOptionObjectFormatNameEnum]; export declare const CreateRepoOptionTrustModelEnum: { readonly Default: "default"; readonly Collaborator: "collaborator"; readonly Committer: "committer"; readonly Collaboratorcommitter: "collaboratorcommitter"; }; export type CreateRepoOptionTrustModelEnum = (typeof CreateRepoOptionTrustModelEnum)[keyof typeof CreateRepoOptionTrustModelEnum]; /** * CreateStatusOption holds the information needed to create a new CommitStatus for a Commit * @export * @interface CreateStatusOption */ export interface CreateStatusOption { /** * * @type {string} * @memberof CreateStatusOption */ context?: string; /** * * @type {string} * @memberof CreateStatusOption */ description?: string; /** * CommitStatusState holds the state of a CommitStatus It can be \"pending\", \"success\", \"error\" and \"failure\" * @type {string} * @memberof CreateStatusOption */ state?: string; /** * * @type {string} * @memberof CreateStatusOption */ target_url?: string; } /** * CreateTagOption options when creating a tag * @export * @interface CreateTagOption */ export interface CreateTagOption { /** * * @type {string} * @memberof CreateTagOption */ message?: string; /** * * @type {string} * @memberof CreateTagOption */ tag_name: string; /** * * @type {string} * @memberof CreateTagOption */ target?: string; } /** * CreateTagProtectionOption options for creating a tag protection * @export * @interface CreateTagProtectionOption */ export interface CreateTagProtectionOption { /** * * @type {string} * @memberof CreateTagProtectionOption */ name_pattern?: string; /** * * @type {Array} * @memberof CreateTagProtectionOption */ whitelist_teams?: Array; /** * * @type {Array} * @memberof CreateTagProtectionOption */ whitelist_usernames?: Array; } /** * CreateTeamOption options for creating a team * @export * @interface CreateTeamOption */ export interface CreateTeamOption { /** * * @type {boolean} * @memberof CreateTeamOption */ can_create_org_repo?: boolean; /** * * @type {string} * @memberof CreateTeamOption */ description?: string; /** * * @type {boolean} * @memberof CreateTeamOption */ includes_all_repositories?: boolean; /** * * @type {string} * @memberof CreateTeamOption */ name: string; /** * * @type {string} * @memberof CreateTeamOption */ permission?: CreateTeamOptionPermissionEnum; /** * * @type {Array} * @memberof CreateTeamOption */ units?: Array; /** * * @type {{ [key: string]: string; }} * @memberof CreateTeamOption */ units_map?: { [key: string]: string; }; } export declare const CreateTeamOptionPermissionEnum: { readonly Read: "read"; readonly Write: "write"; readonly Admin: "admin"; }; export type CreateTeamOptionPermissionEnum = (typeof CreateTeamOptionPermissionEnum)[keyof typeof CreateTeamOptionPermissionEnum]; /** * CreateUserOption create user options * @export * @interface CreateUserOption */ export 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\". * @type {string} * @memberof CreateUserOption */ created_at?: string; /** * * @type {string} * @memberof CreateUserOption */ email: string; /** * * @type {string} * @memberof CreateUserOption */ full_name?: string; /** * * @type {string} * @memberof CreateUserOption */ login_name?: string; /** * * @type {boolean} * @memberof CreateUserOption */ must_change_password?: boolean; /** * * @type {string} * @memberof CreateUserOption */ password?: string; /** * * @type {boolean} * @memberof CreateUserOption */ restricted?: boolean; /** * * @type {boolean} * @memberof CreateUserOption */ send_notify?: boolean; /** * * @type {number} * @memberof CreateUserOption */ source_id?: number; /** * * @type {string} * @memberof CreateUserOption */ username: string; /** * * @type {string} * @memberof CreateUserOption */ visibility?: string; } /** * CreateVariableOption the option when creating variable * @export * @interface CreateVariableOption */ export interface CreateVariableOption { /** * Value of the variable to create * @type {string} * @memberof CreateVariableOption */ value: string; } /** * CreateWikiPageOptions form for creating wiki * @export * @interface CreateWikiPageOptions */ export interface CreateWikiPageOptions { /** * content must be base64 encoded * @type {string} * @memberof CreateWikiPageOptions */ content_base64?: string; /** * optional commit message summarizing the change * @type {string} * @memberof CreateWikiPageOptions */ message?: string; /** * page title. leave empty to keep unchanged * @type {string} * @memberof CreateWikiPageOptions */ title?: string; } /** * Cron represents a Cron task * @export * @interface Cron */ export interface Cron { /** * * @type {number} * @memberof Cron */ exec_times?: number; /** * * @type {string} * @memberof Cron */ name?: string; /** * * @type {string} * @memberof Cron */ next?: string; /** * * @type {string} * @memberof Cron */ prev?: string; /** * * @type {string} * @memberof Cron */ schedule?: string; } /** * DeleteEmailOption options when deleting email addresses * @export * @interface DeleteEmailOption */ export interface DeleteEmailOption { /** * email addresses to delete * @type {Array} * @memberof DeleteEmailOption */ emails?: Array; } /** * 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) * @export * @interface DeleteFileOptions */ export interface DeleteFileOptions { /** * * @type {Identity} * @memberof DeleteFileOptions */ author?: Identity; /** * branch (optional) to base this file from. if not given, the default branch is used * @type {string} * @memberof DeleteFileOptions */ branch?: string; /** * * @type {Identity} * @memberof DeleteFileOptions */ committer?: Identity; /** * * @type {CommitDateOptions} * @memberof DeleteFileOptions */ dates?: CommitDateOptions; /** * message (optional) for the commit of this file. if not supplied, a default message will be used * @type {string} * @memberof DeleteFileOptions */ message?: string; /** * new_branch (optional) will make a new branch from `branch` before creating the file * @type {string} * @memberof DeleteFileOptions */ new_branch?: string; /** * sha is the SHA for the file that already exists * @type {string} * @memberof DeleteFileOptions */ sha: string; /** * Add a Signed-off-by trailer by the committer at the end of the commit log message. * @type {boolean} * @memberof DeleteFileOptions */ signoff?: boolean; } /** * DeleteLabelOption options for deleting a label * @export * @interface DeleteLabelsOption */ export interface DeleteLabelsOption { /** * * @type {string} * @memberof DeleteLabelsOption */ updated_at?: string; } /** * DeployKey a deploy key * @export * @interface DeployKey */ export interface DeployKey { /** * * @type {string} * @memberof DeployKey */ created_at?: string; /** * * @type {string} * @memberof DeployKey */ fingerprint?: string; /** * * @type {number} * @memberof DeployKey */ id?: number; /** * * @type {string} * @memberof DeployKey */ key?: string; /** * * @type {number} * @memberof DeployKey */ key_id?: number; /** * * @type {boolean} * @memberof DeployKey */ read_only?: boolean; /** * * @type {Repository} * @memberof DeployKey */ repository?: Repository; /** * * @type {string} * @memberof DeployKey */ title?: string; /** * * @type {string} * @memberof DeployKey */ url?: string; } /** * DismissPullReviewOptions are options to dismiss a pull review * @export * @interface DismissPullReviewOptions */ export interface DismissPullReviewOptions { /** * * @type {string} * @memberof DismissPullReviewOptions */ message?: string; /** * * @type {boolean} * @memberof DismissPullReviewOptions */ priors?: boolean; } /** * DispatchWorkflowOption options when dispatching a workflow * @export * @interface DispatchWorkflowOption */ export interface DispatchWorkflowOption { /** * Input keys and values configured in the workflow file. * @type {{ [key: string]: string; }} * @memberof DispatchWorkflowOption */ inputs?: { [key: string]: string; }; /** * Git reference for the workflow * @type {string} * @memberof DispatchWorkflowOption */ ref: string; /** * Flag to return the run info * @type {boolean} * @memberof DispatchWorkflowOption */ return_run_info?: boolean; } /** * DispatchWorkflowRun represents a workflow run * @export * @interface DispatchWorkflowRun */ export interface DispatchWorkflowRun { /** * the workflow run id * @type {number} * @memberof DispatchWorkflowRun */ id?: number; /** * the jobs name * @type {Array} * @memberof DispatchWorkflowRun */ jobs?: Array; /** * a unique number for each run of a repository * @type {number} * @memberof DispatchWorkflowRun */ run_number?: number; } /** * EditAttachmentOptions options for editing attachments * @export * @interface EditAttachmentOptions */ export interface EditAttachmentOptions { /** * (Can only be set if existing attachment is of external type) * @type {string} * @memberof EditAttachmentOptions */ browser_download_url?: string; /** * * @type {string} * @memberof EditAttachmentOptions */ name?: string; } /** * EditBranchProtectionOption options for editing a branch protection * @export * @interface EditBranchProtectionOption */ export interface EditBranchProtectionOption { /** * * @type {boolean} * @memberof EditBranchProtectionOption */ apply_to_admins?: boolean; /** * * @type {Array} * @memberof EditBranchProtectionOption */ approvals_whitelist_teams?: Array; /** * * @type {Array} * @memberof EditBranchProtectionOption */ approvals_whitelist_username?: Array; /** * * @type {boolean} * @memberof EditBranchProtectionOption */ block_on_official_review_requests?: boolean; /** * * @type {boolean} * @memberof EditBranchProtectionOption */ block_on_outdated_branch?: boolean; /** * * @type {boolean} * @memberof EditBranchProtectionOption */ block_on_rejected_reviews?: boolean; /** * * @type {boolean} * @memberof EditBranchProtectionOption */ dismiss_stale_approvals?: boolean; /** * * @type {boolean} * @memberof EditBranchProtectionOption */ enable_approvals_whitelist?: boolean; /** * * @type {boolean} * @memberof EditBranchProtectionOption */ enable_merge_whitelist?: boolean; /** * * @type {boolean} * @memberof EditBranchProtectionOption */ enable_push?: boolean; /** * * @type {boolean} * @memberof EditBranchProtectionOption */ enable_push_whitelist?: boolean; /** * * @type {boolean} * @memberof EditBranchProtectionOption */ enable_status_check?: boolean; /** * * @type {boolean} * @memberof EditBranchProtectionOption */ ignore_stale_approvals?: boolean; /** * * @type {Array} * @memberof EditBranchProtectionOption */ merge_whitelist_teams?: Array; /** * * @type {Array} * @memberof EditBranchProtectionOption */ merge_whitelist_usernames?: Array; /** * * @type {string} * @memberof EditBranchProtectionOption */ protected_file_patterns?: string; /** * * @type {boolean} * @memberof EditBranchProtectionOption */ push_whitelist_deploy_keys?: boolean; /** * * @type {Array} * @memberof EditBranchProtectionOption */ push_whitelist_teams?: Array; /** * * @type {Array} * @memberof EditBranchProtectionOption */ push_whitelist_usernames?: Array; /** * * @type {boolean} * @memberof EditBranchProtectionOption */ require_signed_commits?: boolean; /** * * @type {number} * @memberof EditBranchProtectionOption */ required_approvals?: number; /** * * @type {Array} * @memberof EditBranchProtectionOption */ status_check_contexts?: Array; /** * * @type {string} * @memberof EditBranchProtectionOption */ unprotected_file_patterns?: string; } /** * EditDeadlineOption options for creating a deadline * @export * @interface EditDeadlineOption */ export interface EditDeadlineOption { /** * * @type {string} * @memberof EditDeadlineOption */ due_date: string; } /** * EditGitHookOption options when modifying one Git hook * @export * @interface EditGitHookOption */ export interface EditGitHookOption { /** * * @type {string} * @memberof EditGitHookOption */ content?: string; } /** * EditHookOption options when modify one hook * @export * @interface EditHookOption */ export interface EditHookOption { /** * * @type {boolean} * @memberof EditHookOption */ active?: boolean; /** * * @type {string} * @memberof EditHookOption */ authorization_header?: string; /** * * @type {string} * @memberof EditHookOption */ branch_filter?: string; /** * * @type {{ [key: string]: string; }} * @memberof EditHookOption */ config?: { [key: string]: string; }; /** * * @type {Array} * @memberof EditHookOption */ events?: Array; } /** * EditIssueCommentOption options for editing a comment * @export * @interface EditIssueCommentOption */ export interface EditIssueCommentOption { /** * * @type {string} * @memberof EditIssueCommentOption */ body: string; /** * * @type {string} * @memberof EditIssueCommentOption */ updated_at?: string; } /** * EditIssueOption options for editing an issue * @export * @interface EditIssueOption */ export interface EditIssueOption { /** * deprecated * @type {string} * @memberof EditIssueOption */ assignee?: string; /** * * @type {Array} * @memberof EditIssueOption */ assignees?: Array; /** * * @type {string} * @memberof EditIssueOption */ body?: string; /** * * @type {string} * @memberof EditIssueOption */ due_date?: string; /** * * @type {number} * @memberof EditIssueOption */ milestone?: number; /** * * @type {string} * @memberof EditIssueOption */ ref?: string; /** * * @type {string} * @memberof EditIssueOption */ state?: string; /** * * @type {string} * @memberof EditIssueOption */ title?: string; /** * * @type {boolean} * @memberof EditIssueOption */ unset_due_date?: boolean; /** * * @type {string} * @memberof EditIssueOption */ updated_at?: string; } /** * EditLabelOption options for editing a label * @export * @interface EditLabelOption */ export interface EditLabelOption { /** * * @type {string} * @memberof EditLabelOption */ color?: string; /** * * @type {string} * @memberof EditLabelOption */ description?: string; /** * * @type {boolean} * @memberof EditLabelOption */ exclusive?: boolean; /** * * @type {boolean} * @memberof EditLabelOption */ is_archived?: boolean; /** * * @type {string} * @memberof EditLabelOption */ name?: string; } /** * EditMilestoneOption options for editing a milestone * @export * @interface EditMilestoneOption */ export interface EditMilestoneOption { /** * * @type {string} * @memberof EditMilestoneOption */ description?: string; /** * * @type {string} * @memberof EditMilestoneOption */ due_on?: string; /** * * @type {string} * @memberof EditMilestoneOption */ state?: string; /** * * @type {string} * @memberof EditMilestoneOption */ title?: string; } /** * EditOrgOption options for editing an organization * @export * @interface EditOrgOption */ export interface EditOrgOption { /** * * @type {string} * @memberof EditOrgOption */ description?: string; /** * * @type {string} * @memberof EditOrgOption */ email?: string; /** * * @type {string} * @memberof EditOrgOption */ full_name?: string; /** * * @type {string} * @memberof EditOrgOption */ location?: string; /** * * @type {boolean} * @memberof EditOrgOption */ repo_admin_change_team_access?: boolean; /** * possible values are `public`, `limited` or `private` * @type {string} * @memberof EditOrgOption */ visibility?: EditOrgOptionVisibilityEnum; /** * * @type {string} * @memberof EditOrgOption */ website?: string; } export declare const EditOrgOptionVisibilityEnum: { readonly Public: "public"; readonly Limited: "limited"; readonly Private: "private"; }; export type EditOrgOptionVisibilityEnum = (typeof EditOrgOptionVisibilityEnum)[keyof typeof EditOrgOptionVisibilityEnum]; /** * EditPullRequestOption options when modify pull request * @export * @interface EditPullRequestOption */ export interface EditPullRequestOption { /** * * @type {boolean} * @memberof EditPullRequestOption */ allow_maintainer_edit?: boolean; /** * * @type {string} * @memberof EditPullRequestOption */ assignee?: string; /** * * @type {Array} * @memberof EditPullRequestOption */ assignees?: Array; /** * * @type {string} * @memberof EditPullRequestOption */ base?: string; /** * * @type {string} * @memberof EditPullRequestOption */ body?: string; /** * * @type {string} * @memberof EditPullRequestOption */ due_date?: string; /** * * @type {Array} * @memberof EditPullRequestOption */ labels?: Array; /** * * @type {number} * @memberof EditPullRequestOption */ milestone?: number; /** * * @type {string} * @memberof EditPullRequestOption */ state?: string; /** * * @type {string} * @memberof EditPullRequestOption */ title?: string; /** * * @type {boolean} * @memberof EditPullRequestOption */ unset_due_date?: boolean; } /** * EditQuotaRuleOptions represents the options for editing a quota rule * @export * @interface EditQuotaRuleOptions */ export interface EditQuotaRuleOptions { /** * The limit set by the rule * @type {number} * @memberof EditQuotaRuleOptions */ limit?: number; /** * The subjects affected by the rule * @type {Array} * @memberof EditQuotaRuleOptions */ subjects?: Array; } /** * EditReactionOption contain the reaction type * @export * @interface EditReactionOption */ export interface EditReactionOption { /** * * @type {string} * @memberof EditReactionOption */ content?: string; } /** * EditReleaseOption options when editing a release * @export * @interface EditReleaseOption */ export interface EditReleaseOption { /** * * @type {string} * @memberof EditReleaseOption */ body?: string; /** * * @type {boolean} * @memberof EditReleaseOption */ draft?: boolean; /** * * @type {boolean} * @memberof EditReleaseOption */ hide_archive_links?: boolean; /** * * @type {string} * @memberof EditReleaseOption */ name?: string; /** * * @type {boolean} * @memberof EditReleaseOption */ prerelease?: boolean; /** * * @type {string} * @memberof EditReleaseOption */ tag_name?: string; /** * * @type {string} * @memberof EditReleaseOption */ target_commitish?: string; } /** * EditRepoOption options when editing a repository\'s properties * @export * @interface EditRepoOption */ export interface EditRepoOption { /** * either `true` to allow fast-forward-only merging pull requests, or `false` to prevent fast-forward-only merging. * @type {boolean} * @memberof EditRepoOption */ allow_fast_forward_only_merge?: boolean; /** * either `true` to allow mark pr as merged manually, or `false` to prevent it. * @type {boolean} * @memberof EditRepoOption */ 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. * @type {boolean} * @memberof EditRepoOption */ allow_merge_commits?: boolean; /** * either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. * @type {boolean} * @memberof EditRepoOption */ allow_rebase?: boolean; /** * either `true` to allow rebase with explicit merge commits (--no-ff), or `false` to prevent rebase with explicit merge commits. * @type {boolean} * @memberof EditRepoOption */ allow_rebase_explicit?: boolean; /** * either `true` to allow updating pull request branch by rebase, or `false` to prevent it. * @type {boolean} * @memberof EditRepoOption */ allow_rebase_update?: boolean; /** * either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. * @type {boolean} * @memberof EditRepoOption */ allow_squash_merge?: boolean; /** * set to `true` to archive this repository. * @type {boolean} * @memberof EditRepoOption */ archived?: boolean; /** * either `true` to enable AutodetectManualMerge, or `false` to prevent it. Note: In some special cases, misjudgments can occur. * @type {boolean} * @memberof EditRepoOption */ autodetect_manual_merge?: boolean; /** * set to `true` to allow edits from maintainers by default * @type {boolean} * @memberof EditRepoOption */ default_allow_maintainer_edit?: boolean; /** * sets the default branch for this repository. * @type {string} * @memberof EditRepoOption */ default_branch?: string; /** * set to `true` to delete pr branch after merge by default * @type {boolean} * @memberof EditRepoOption */ default_delete_branch_after_merge?: boolean; /** * set to a merge style to be used by this repository: \"merge\", \"rebase\", \"rebase-merge\", \"squash\", \"fast-forward-only\", \"manually-merged\", or \"rebase-update-only\". * @type {string} * @memberof EditRepoOption */ default_merge_style?: string; /** * set to a update style to be used by this repository: \"rebase\" or \"merge\" * @type {string} * @memberof EditRepoOption */ default_update_style?: string; /** * a short description of the repository. * @type {string} * @memberof EditRepoOption */ description?: string; /** * enable prune - remove obsolete remote-tracking references when mirroring * @type {boolean} * @memberof EditRepoOption */ enable_prune?: boolean; /** * * @type {ExternalTracker} * @memberof EditRepoOption */ external_tracker?: ExternalTracker; /** * * @type {ExternalWiki} * @memberof EditRepoOption */ external_wiki?: ExternalWiki; /** * set the globally editable state of the wiki * @type {boolean} * @memberof EditRepoOption */ globally_editable_wiki?: boolean; /** * either `true` to enable actions unit, or `false` to disable them. * @type {boolean} * @memberof EditRepoOption */ has_actions?: boolean; /** * either `true` to enable issues for this repository or `false` to disable them. * @type {boolean} * @memberof EditRepoOption */ has_issues?: boolean; /** * either `true` to enable packages unit, or `false` to disable them. * @type {boolean} * @memberof EditRepoOption */ has_packages?: boolean; /** * either `true` to enable project unit, or `false` to disable them. * @type {boolean} * @memberof EditRepoOption */ has_projects?: boolean; /** * either `true` to allow pull requests, or `false` to prevent pull request. * @type {boolean} * @memberof EditRepoOption */ has_pull_requests?: boolean; /** * either `true` to enable releases unit, or `false` to disable them. * @type {boolean} * @memberof EditRepoOption */ has_releases?: boolean; /** * either `true` to enable the wiki for this repository or `false` to disable it. * @type {boolean} * @memberof EditRepoOption */ has_wiki?: boolean; /** * either `true` to ignore whitespace for conflicts, or `false` to not ignore whitespace. * @type {boolean} * @memberof EditRepoOption */ ignore_whitespace_conflicts?: boolean; /** * * @type {InternalTracker} * @memberof EditRepoOption */ internal_tracker?: InternalTracker; /** * set to a string like `8h30m0s` to set the mirror interval time * @type {string} * @memberof EditRepoOption */ mirror_interval?: string; /** * name of the repository * @type {string} * @memberof EditRepoOption */ 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. * @type {boolean} * @memberof EditRepoOption */ private?: boolean; /** * either `true` to make this repository a template or `false` to make it a normal repository * @type {boolean} * @memberof EditRepoOption */ template?: boolean; /** * a URL with more information about the repository. * @type {string} * @memberof EditRepoOption */ website?: string; /** * sets the branch used for this repository\'s wiki. * @type {string} * @memberof EditRepoOption */ wiki_branch?: string; } /** * EditTagProtectionOption options for editing a tag protection * @export * @interface EditTagProtectionOption */ export interface EditTagProtectionOption { /** * * @type {string} * @memberof EditTagProtectionOption */ name_pattern?: string; /** * * @type {Array} * @memberof EditTagProtectionOption */ whitelist_teams?: Array; /** * * @type {Array} * @memberof EditTagProtectionOption */ whitelist_usernames?: Array; } /** * EditTeamOption options for editing a team * @export * @interface EditTeamOption */ export interface EditTeamOption { /** * * @type {boolean} * @memberof EditTeamOption */ can_create_org_repo?: boolean; /** * * @type {string} * @memberof EditTeamOption */ description?: string; /** * * @type {boolean} * @memberof EditTeamOption */ includes_all_repositories?: boolean; /** * * @type {string} * @memberof EditTeamOption */ name: string; /** * * @type {string} * @memberof EditTeamOption */ permission?: EditTeamOptionPermissionEnum; /** * * @type {Array} * @memberof EditTeamOption */ units?: Array; /** * * @type {{ [key: string]: string; }} * @memberof EditTeamOption */ units_map?: { [key: string]: string; }; } export declare const EditTeamOptionPermissionEnum: { readonly Read: "read"; readonly Write: "write"; readonly Admin: "admin"; }; export type EditTeamOptionPermissionEnum = (typeof EditTeamOptionPermissionEnum)[keyof typeof EditTeamOptionPermissionEnum]; /** * EditUserOption edit user options * @export * @interface EditUserOption */ export interface EditUserOption { /** * * @type {boolean} * @memberof EditUserOption */ active?: boolean; /** * * @type {boolean} * @memberof EditUserOption */ admin?: boolean; /** * * @type {boolean} * @memberof EditUserOption */ allow_create_organization?: boolean; /** * * @type {boolean} * @memberof EditUserOption */ allow_git_hook?: boolean; /** * * @type {boolean} * @memberof EditUserOption */ allow_import_local?: boolean; /** * * @type {string} * @memberof EditUserOption */ description?: string; /** * * @type {string} * @memberof EditUserOption */ email?: string; /** * * @type {string} * @memberof EditUserOption */ full_name?: string; /** * * @type {string} * @memberof EditUserOption */ location?: string; /** * * @type {string} * @memberof EditUserOption */ login_name?: string; /** * * @type {number} * @memberof EditUserOption */ max_repo_creation?: number; /** * * @type {boolean} * @memberof EditUserOption */ must_change_password?: boolean; /** * * @type {string} * @memberof EditUserOption */ password?: string; /** * * @type {boolean} * @memberof EditUserOption */ prohibit_login?: boolean; /** * * @type {string} * @memberof EditUserOption */ pronouns?: string; /** * * @type {boolean} * @memberof EditUserOption */ restricted?: boolean; /** * * @type {number} * @memberof EditUserOption */ source_id?: number; /** * * @type {string} * @memberof EditUserOption */ visibility?: string; /** * * @type {string} * @memberof EditUserOption */ website?: string; } /** * Email an email address belonging to a user * @export * @interface Email */ export interface Email { /** * * @type {string} * @memberof Email */ email?: string; /** * * @type {boolean} * @memberof Email */ primary?: boolean; /** * * @type {number} * @memberof Email */ user_id?: number; /** * * @type {string} * @memberof Email */ username?: string; /** * * @type {boolean} * @memberof Email */ verified?: boolean; } /** * ExternalTracker represents settings for external tracker * @export * @interface ExternalTracker */ export interface ExternalTracker { /** * External Issue Tracker URL Format. Use the placeholders {user}, {repo} and {index} for the username, repository name and issue index. * @type {string} * @memberof ExternalTracker */ external_tracker_format?: string; /** * External Issue Tracker issue regular expression * @type {string} * @memberof ExternalTracker */ external_tracker_regexp_pattern?: string; /** * External Issue Tracker Number Format, either `numeric`, `alphanumeric`, or `regexp` * @type {string} * @memberof ExternalTracker */ external_tracker_style?: string; /** * URL of external issue tracker. * @type {string} * @memberof ExternalTracker */ external_tracker_url?: string; } /** * ExternalWiki represents setting for external wiki * @export * @interface ExternalWiki */ export interface ExternalWiki { /** * URL of external wiki. * @type {string} * @memberof ExternalWiki */ external_wiki_url?: string; } /** * * @export * @interface FileCommitResponse */ export interface FileCommitResponse { /** * * @type {CommitUser} * @memberof FileCommitResponse */ author?: CommitUser; /** * * @type {CommitUser} * @memberof FileCommitResponse */ committer?: CommitUser; /** * * @type {string} * @memberof FileCommitResponse */ created?: string; /** * * @type {string} * @memberof FileCommitResponse */ html_url?: string; /** * * @type {string} * @memberof FileCommitResponse */ message?: string; /** * * @type {Array} * @memberof FileCommitResponse */ parents?: Array; /** * * @type {string} * @memberof FileCommitResponse */ sha?: string; /** * * @type {CommitMeta} * @memberof FileCommitResponse */ tree?: CommitMeta; /** * * @type {string} * @memberof FileCommitResponse */ url?: string; } /** * FileDeleteResponse contains information about a repo\'s file that was deleted * @export * @interface FileDeleteResponse */ export interface FileDeleteResponse { /** * * @type {FileCommitResponse} * @memberof FileDeleteResponse */ commit?: FileCommitResponse; /** * * @type {object} * @memberof FileDeleteResponse */ content?: object; /** * * @type {PayloadCommitVerification} * @memberof FileDeleteResponse */ verification?: PayloadCommitVerification; } /** * FileLinksResponse contains the links for a repo\'s file * @export * @interface FileLinksResponse */ export interface FileLinksResponse { /** * * @type {string} * @memberof FileLinksResponse */ git?: string; /** * * @type {string} * @memberof FileLinksResponse */ html?: string; /** * * @type {string} * @memberof FileLinksResponse */ self?: string; } /** * FileResponse contains information about a repo\'s file * @export * @interface FileResponse */ export interface FileResponse { /** * * @type {FileCommitResponse} * @memberof FileResponse */ commit?: FileCommitResponse; /** * * @type {ContentsResponse} * @memberof FileResponse */ content?: ContentsResponse; /** * * @type {PayloadCommitVerification} * @memberof FileResponse */ verification?: PayloadCommitVerification; } /** * FilesResponse contains information about multiple files from a repo * @export * @interface FilesResponse */ export interface FilesResponse { /** * * @type {FileCommitResponse} * @memberof FilesResponse */ commit?: FileCommitResponse; /** * * @type {Array} * @memberof FilesResponse */ files?: Array; /** * * @type {PayloadCommitVerification} * @memberof FilesResponse */ verification?: PayloadCommitVerification; } /** * GPGKey a user GPG key to sign commit and tag in repository * @export * @interface GPGKey */ export interface GPGKey { /** * * @type {boolean} * @memberof GPGKey */ can_certify?: boolean; /** * * @type {boolean} * @memberof GPGKey */ can_encrypt_comms?: boolean; /** * * @type {boolean} * @memberof GPGKey */ can_encrypt_storage?: boolean; /** * * @type {boolean} * @memberof GPGKey */ can_sign?: boolean; /** * * @type {string} * @memberof GPGKey */ created_at?: string; /** * * @type {Array} * @memberof GPGKey */ emails?: Array; /** * * @type {string} * @memberof GPGKey */ expires_at?: string; /** * * @type {number} * @memberof GPGKey */ id?: number; /** * * @type {string} * @memberof GPGKey */ key_id?: string; /** * * @type {string} * @memberof GPGKey */ primary_key_id?: string; /** * * @type {string} * @memberof GPGKey */ public_key?: string; /** * * @type {Array} * @memberof GPGKey */ subkeys?: Array; /** * * @type {boolean} * @memberof GPGKey */ verified?: boolean; } /** * GPGKeyEmail an email attached to a GPGKey * @export * @interface GPGKeyEmail */ export interface GPGKeyEmail { /** * * @type {string} * @memberof GPGKeyEmail */ email?: string; /** * * @type {boolean} * @memberof GPGKeyEmail */ verified?: boolean; } /** * GeneralAPISettings contains global api settings exposed by it * @export * @interface GeneralAPISettings */ export interface GeneralAPISettings { /** * * @type {number} * @memberof GeneralAPISettings */ default_git_trees_per_page?: number; /** * * @type {number} * @memberof GeneralAPISettings */ default_max_blob_size?: number; /** * * @type {number} * @memberof GeneralAPISettings */ default_paging_num?: number; /** * * @type {number} * @memberof GeneralAPISettings */ max_response_items?: number; } /** * GeneralAttachmentSettings contains global Attachment settings exposed by API * @export * @interface GeneralAttachmentSettings */ export interface GeneralAttachmentSettings { /** * * @type {string} * @memberof GeneralAttachmentSettings */ allowed_types?: string; /** * * @type {boolean} * @memberof GeneralAttachmentSettings */ enabled?: boolean; /** * * @type {number} * @memberof GeneralAttachmentSettings */ max_files?: number; /** * * @type {number} * @memberof GeneralAttachmentSettings */ max_size?: number; } /** * GeneralRepoSettings contains global repository settings exposed by API * @export * @interface GeneralRepoSettings */ export interface GeneralRepoSettings { /** * * @type {boolean} * @memberof GeneralRepoSettings */ forks_disabled?: boolean; /** * * @type {boolean} * @memberof GeneralRepoSettings */ http_git_disabled?: boolean; /** * * @type {boolean} * @memberof GeneralRepoSettings */ lfs_disabled?: boolean; /** * * @type {boolean} * @memberof GeneralRepoSettings */ migrations_disabled?: boolean; /** * * @type {boolean} * @memberof GeneralRepoSettings */ mirrors_disabled?: boolean; /** * * @type {boolean} * @memberof GeneralRepoSettings */ stars_disabled?: boolean; /** * * @type {boolean} * @memberof GeneralRepoSettings */ time_tracking_disabled?: boolean; } /** * GeneralUISettings contains global ui settings exposed by API * @export * @interface GeneralUISettings */ export interface GeneralUISettings { /** * * @type {Array} * @memberof GeneralUISettings */ allowed_reactions?: Array; /** * * @type {Array} * @memberof GeneralUISettings */ custom_emojis?: Array; /** * * @type {string} * @memberof GeneralUISettings */ default_theme?: string; } /** * GenerateRepoOption options when creating repository using a template * @export * @interface GenerateRepoOption */ export interface GenerateRepoOption { /** * include avatar of the template repo * @type {boolean} * @memberof GenerateRepoOption */ avatar?: boolean; /** * Default branch of the new repository * @type {string} * @memberof GenerateRepoOption */ default_branch?: string; /** * Description of the repository to create * @type {string} * @memberof GenerateRepoOption */ description?: string; /** * include git content of default branch in template repo * @type {boolean} * @memberof GenerateRepoOption */ git_content?: boolean; /** * include git hooks in template repo * @type {boolean} * @memberof GenerateRepoOption */ git_hooks?: boolean; /** * include labels in template repo * @type {boolean} * @memberof GenerateRepoOption */ labels?: boolean; /** * Name of the repository to create * @type {string} * @memberof GenerateRepoOption */ name: string; /** * The organization or person who will own the new repository * @type {string} * @memberof GenerateRepoOption */ owner: string; /** * Whether the repository is private * @type {boolean} * @memberof GenerateRepoOption */ private?: boolean; /** * include protected branches in template repo * @type {boolean} * @memberof GenerateRepoOption */ protected_branch?: boolean; /** * include topics in template repo * @type {boolean} * @memberof GenerateRepoOption */ topics?: boolean; /** * include webhooks in template repo * @type {boolean} * @memberof GenerateRepoOption */ webhooks?: boolean; } /** * GitBlob represents a git blob * @export * @interface GitBlob */ export interface GitBlob { /** * * @type {string} * @memberof GitBlob */ content?: string; /** * * @type {string} * @memberof GitBlob */ encoding?: string; /** * * @type {string} * @memberof GitBlob */ sha?: string; /** * * @type {number} * @memberof GitBlob */ size?: number; /** * * @type {string} * @memberof GitBlob */ url?: string; } /** * GitEntry represents a git tree * @export * @interface GitEntry */ export interface GitEntry { /** * * @type {string} * @memberof GitEntry */ mode?: string; /** * * @type {string} * @memberof GitEntry */ path?: string; /** * * @type {string} * @memberof GitEntry */ sha?: string; /** * * @type {number} * @memberof GitEntry */ size?: number; /** * * @type {string} * @memberof GitEntry */ type?: string; /** * * @type {string} * @memberof GitEntry */ url?: string; } /** * GitHook represents a Git repository hook * @export * @interface GitHook */ export interface GitHook { /** * * @type {string} * @memberof GitHook */ content?: string; /** * * @type {boolean} * @memberof GitHook */ is_active?: boolean; /** * * @type {string} * @memberof GitHook */ name?: string; } /** * * @export * @interface GitObject */ export interface GitObject { /** * * @type {string} * @memberof GitObject */ sha?: string; /** * * @type {string} * @memberof GitObject */ type?: string; /** * * @type {string} * @memberof GitObject */ url?: string; } /** * GitTreeResponse returns a git tree * @export * @interface GitTreeResponse */ export interface GitTreeResponse { /** * * @type {number} * @memberof GitTreeResponse */ page?: number; /** * * @type {string} * @memberof GitTreeResponse */ sha?: string; /** * * @type {number} * @memberof GitTreeResponse */ total_count?: number; /** * * @type {Array} * @memberof GitTreeResponse */ tree?: Array; /** * * @type {boolean} * @memberof GitTreeResponse */ truncated?: boolean; /** * * @type {string} * @memberof GitTreeResponse */ url?: string; } /** * GitignoreTemplateInfo name and text of a gitignore template * @export * @interface GitignoreTemplateInfo */ export interface GitignoreTemplateInfo { /** * * @type {string} * @memberof GitignoreTemplateInfo */ name?: string; /** * * @type {string} * @memberof GitignoreTemplateInfo */ source?: string; } /** * Hook a hook is a web hook when one repository changed * @export * @interface Hook */ export interface Hook { /** * * @type {boolean} * @memberof Hook */ active?: boolean; /** * * @type {string} * @memberof Hook */ authorization_header?: string; /** * * @type {string} * @memberof Hook */ branch_filter?: string; /** * Deprecated: use Metadata instead * @type {{ [key: string]: string; }} * @memberof Hook */ config?: { [key: string]: string; }; /** * * @type {string} * @memberof Hook */ content_type?: string; /** * * @type {string} * @memberof Hook */ created_at?: string; /** * * @type {Array} * @memberof Hook */ events?: Array; /** * * @type {number} * @memberof Hook */ id?: number; /** * * @type {object} * @memberof Hook */ metadata?: object; /** * * @type {string} * @memberof Hook */ type?: string; /** * * @type {string} * @memberof Hook */ updated_at?: string; /** * * @type {string} * @memberof Hook */ url?: string; } /** * Identity for a person\'s identity like an author or committer * @export * @interface Identity */ export interface Identity { /** * * @type {string} * @memberof Identity */ email?: string; /** * * @type {string} * @memberof Identity */ name?: string; } /** * InternalTracker represents settings for internal tracker * @export * @interface InternalTracker */ export interface InternalTracker { /** * Let only contributors track time (Built-in issue tracker) * @type {boolean} * @memberof InternalTracker */ allow_only_contributors_to_track_time?: boolean; /** * Enable dependencies for issues and pull requests (Built-in issue tracker) * @type {boolean} * @memberof InternalTracker */ enable_issue_dependencies?: boolean; /** * Enable time tracking (Built-in issue tracker) * @type {boolean} * @memberof InternalTracker */ enable_time_tracker?: boolean; } /** * Issue represents an issue in a repository * @export * @interface Issue */ export interface Issue { /** * * @type {Array} * @memberof Issue */ assets?: Array; /** * * @type {User} * @memberof Issue */ assignee?: User; /** * * @type {Array} * @memberof Issue */ assignees?: Array; /** * * @type {string} * @memberof Issue */ body?: string; /** * * @type {string} * @memberof Issue */ closed_at?: string; /** * * @type {number} * @memberof Issue */ comments?: number; /** * * @type {string} * @memberof Issue */ created_at?: string; /** * * @type {string} * @memberof Issue */ due_date?: string; /** * * @type {string} * @memberof Issue */ html_url?: string; /** * * @type {number} * @memberof Issue */ id?: number; /** * * @type {boolean} * @memberof Issue */ is_locked?: boolean; /** * * @type {Array