@candriajs/git-neko-kit 0.8.4 → 0.8.6

package/dist/index.d.ts

@@ -1,10 +1,38 @@
 import { RawAxiosResponseHeaders, AxiosResponseHeaders } from 'axios';
 import { ExecException, exec } from 'child_process';
 
+/**
+ * 获取本地仓库的默认分支
+ * @param local_path - 本地仓库路径
+ * @returns 默认分支名称
+ * @example
+ * ```ts
+ * console.log(await get_local_repo_default_branch('/path/to/repo'))
+ * -> 'main'
+ * ```
+ */
+declare function get_local_repo_default_branch(local_path: string): Promise<string>;
+/**
+ * 获取远程仓库的默认分支
+ * @param remote_url - 远程仓库URL
+ * @returns 默认分支名称
+ * @example
+ * ```ts
+ * console.log(await get_remote_repo_default_branch('https://github.com/CandriaJS/git-neko-kit'))
+ * -> 'main'
+ * ```
+ */
+declare function get_remote_repo_default_branch(remote_url: string): Promise<string>;
+
 /** 代理地址类型 */
 type ProxyUrlType = string;
-/** 代理类型 */
-type ProxyType = 'reverse' | 'common';
+/**
+ * 代理类型：
+ * - reverse: 反向代理
+ * - original: 原始代理
+ * - common: 通用代理
+ */
+type ProxyType = 'reverse' | 'original' | 'common';
 /** Git类型 */
 type GitType = 'github' | 'gitee' | 'gitcode';
 /**
@@ -250,20 +278,9 @@ interface ClientType {
 }
 
 /** 用户信息参数类型 */
-interface UserInfoParamType extends UserNameParamType {
-    /** 授权token */
-    access_token?: AccessTokenType['access_token'];
-}
-/** 授权用户信息参数对象类型 */
-interface UserInfoByAuthParamType {
-    /** 授权token */
-    access_token?: AccessTokenType['access_token'];
-}
+type UserInfoParamType = UserNameParamType;
 /** 通过用户ID 获取用户信息参数类型 */
-interface UserInfoByIdParamType extends UserIdParamType {
-    /** 授权token */
-    access_token?: AccessTokenType['access_token'];
-}
+type UserInfoByIdParamType = UserIdParamType;
 /** 用户信息响应类型 */
 interface UserInfoResponseType {
     /** 账号ID */
@@ -296,6 +313,228 @@ interface UserInfoResponseType {
     following: number;
 }
 
+/** 仓库所有者参数类型 */
+type RepoUser = Omit<UserInfoResponseType, 'followers' | 'following' | 'blog' | 'bio' | 'public_repos'>;
+/** 仓库列表参数类型 */
+interface RepoListBaseParamType {
+    /** 排序方式，可选created， updated， pushed， full_name， 默认为 full_name */
+    sort?: 'created' | 'updated' | 'pushed' | 'full_name';
+    /** 排序方式，可选asc， desc， 默认为 desc */
+    direction?: 'asc' | 'desc';
+    /** 每页数量 */
+    per_page?: number;
+    /** 页码 */
+    page?: number;
+}
+interface UserByTokenRepoListParamType extends RepoListBaseParamType {
+    /** 仓库的可见性，可选all， public， private， 默认为 all */
+    visibility?: 'all' | 'public' | 'private';
+    /** 仓库的状态，可选all， public， private， 默认为 all */
+    affiliation?: 'owner' | 'collaborator' | 'organization_member';
+    /** 类型，可选all， owner， member， 默认为 all */
+    type?: 'all' | 'owner' | 'member';
+}
+/** 仓库信息请求参数 */
+type RepoInfoParamType = RepoBaseParamType;
+/** * 仓库信息 */
+interface RepoInfoResponseType {
+    /** * 仓库的唯一 ID */
+    id: number;
+    /** * 仓库的名称 */
+    name: string;
+    /** * 仓库的完整名称，包含用户名或组织名 */
+    full_name: string;
+    /** * 仓库拥有者的信息 */
+    owner: RepoUser;
+    /** 仓库是否公开 */
+    public: boolean;
+    /** * 仓库是否私有 */
+    private: boolean;
+    /** * 仓库的可见性 */
+    visibility: 'public' | 'private';
+    /** * 仓库是否是 fork 仓库 */
+    fork: boolean;
+    /** * 仓库是否已归档 */
+    archived: boolean;
+    /** * 仓库是否被禁用 */
+    disabled: boolean;
+    /** * 仓库的 HTML 页面 URL */
+    html_url: string;
+    /** * 仓库的描述信息 */
+    description: string | null;
+    /** * 仓库的 Stargazer 数量 */
+    stargazers_count: number;
+    /** * 仓库的 Watcher 数量 */
+    watchers_count: number;
+    /** * 仓库的主编程语言 */
+    language: string | null;
+    /** * 仓库的 fork 数量 */
+    forks_count: number;
+    /** * 开放的 issue 数量 */
+    open_issues_count: number;
+    /** * 仓库的默认分支 */
+    default_branch: string;
+    /** * 仓库的创建时间 */
+    created_at: string;
+    /** * 仓库的更新时间 */
+    updated_at: string;
+    /** * 仓库的推送时间 */
+    pushed_at: string;
+}
+/** 组织仓库列表参数类型 */
+interface OrgRepoListParmType extends RepoListBaseParamType {
+    /** 组织名称 */
+    org: string;
+    /** 类型，可选all， public， private 默认为 all */
+    type?: 'all' | 'public' | 'private';
+}
+/**
+ * 组织仓库列表响应类型
+ * 该类型包含了多个仓库的信息，每个仓库都有自己的详细信息。
+ */
+type OrgRepoListResponseType = RepoInfoResponseType[];
+/** 创建组织仓库请求参数 */
+interface OrgRepoCreateParamType extends OrgNameParamType {
+    /** 仓库名称 */
+    name: string;
+    /** 仓库描述 */
+    description?: string;
+    /** 仓库主页 */
+    homepage?: string;
+    /** 仓库可见性 */
+    visibility?: 'public' | 'private';
+    /** 是否开启议题issue */
+    has_issues?: boolean;
+    /** 是否开启wiki */
+    has_wiki?: boolean;
+    /** 仓库自动初始化 */
+    auto_init?: boolean;
+}
+/** 创建组织仓库响应类型 */
+type OrgRepoCreateResponseType = RepoInfoResponseType;
+/** 创建用户仓库参数类型 */
+type UserRepoCreateParamType = Omit<OrgRepoCreateParamType, 'org'> & RepoOwnerParamType;
+/** 创建用户仓库响应类型 */
+type UserRepoCreateResponseType = RepoInfoResponseType;
+/** 用户仓库列表参数类型 */
+interface UserRepoListParamType extends RepoListBaseParamType {
+    /** 用户名 */
+    username: string;
+    /** 类型，可选all， owner， member， 默认为 all */
+    type?: 'all' | 'owner' | 'member';
+}
+/** 用户仓库列表类型 */
+type UserRepoListType = Array<RepoInfoResponseType & {
+    /** * 仓库的角色名称 */
+    role_name?: string;
+}>;
+/** 仓库语言信息类型 */
+interface LanguageInfo {
+    /** 编程语言名称 */
+    language: string;
+    /** 语言对应的颜色 */
+    color: string;
+    /** 在仓库中的占比（百分比） */
+    percent: number;
+    /** 该语言的代码字节数 */
+    bytes: number;
+}
+/** 仓库语言列表参数类型 */
+type RepoLanguagesListParamType = RepoBaseParamType;
+/** 仓库语言列表类型 */
+interface RepoLanguagesListResponseType {
+    /** 仓库的语言统计信息列表 */
+    languages: LanguageInfo[];
+}
+/** 获取仓库可见性参数类型 */
+type GetRepoVisibilityParamType = RepoBaseParamType;
+/** 获取仓库可见性响应类型 */
+type GetRepoVisibilityResponseType = RepoInfoResponseType['visibility'];
+/** 获取仓库默认分支参数类型 */
+type GetRepoDefaultBranchParamType = RepoBaseParamType;
+/** 获取仓库默认分支响应类型 */
+type GetRepoDefaultBranchResponseType = RepoInfoResponseType['default_branch'];
+/** 获取仓库主要语言参数类型 */
+type GetRepoMainLanguageParamType = RepoBaseParamType;
+/** 仓库主要语言响应类型 */
+type GetRepoMainLanguageResponseType = RepoInfoResponseType['language'];
+/**
+ * 协作者权限 ,可选 pull，triage, push, maintain, admin，默认pull
+ * pull - 只读访问，协作者可以查看仓库内容。
+ * push - 允许推送代码到仓库分支，同时拥有 pull 权限。
+ * admin - 拥有仓库的完全控制权，包括更改设置和删除仓库。
+ */
+type CollaboratorPermissionType = 'pull' | 'push' | 'admin';
+/** 协作者参数类型 */
+type CollaboratorParamType = RepoInfoParamType & UserNameParamType & {
+    /** 邀请的权限 */
+    permission?: CollaboratorPermissionType;
+};
+/** 邀请协作者响应类型 */
+interface AddCollaboratorResponseType {
+    /** 被邀请者ID */
+    id: number;
+    /** 被邀请者用户名 */
+    login: string;
+    /** 被邀请者的别名 */
+    name: string | null;
+    /** 仓库的地址 */
+    html_url: string;
+    /** 被邀请者的权限 */
+    permissions: string;
+}
+/** 协作者列表参数类型 */
+type GetCollaboratorListParamType = RepoInfoParamType & {
+    /**
+     * 筛选按隶属关系返回的协作者
+     * outside - 列出所有外部协作者，包括仓库成员和外部 collaborator。
+     * direct - 列出仓库成员。
+     * all - 列出仓库成员和外部 collaborator。
+    */
+    affiliation?: 'outside' | 'direct' | 'all';
+    /** 权限 */
+    permission?: CollaboratorPermissionType;
+    /** 每页数量 */
+    per_page?: number;
+    /** 页码 */
+    page?: number;
+};
+/** 协作者信息类型 */
+interface CollaboratorInfoResponseType {
+    /** 协作者id */
+    id: number;
+    /** 协作者登录名 */
+    login: string;
+    /** 头像URL */
+    avatar_url: string;
+    /** 协作者邮箱 */
+    email: string | null;
+    /** 协作者姓名 */
+    name: string | null;
+    /** 权限设置 */
+    permissions: {
+        /** 拉取权限 */
+        pull: boolean;
+        /** 分类权限 */
+        triage: boolean;
+        /** 推送权限 */
+        push: boolean;
+        /** 维护权限 */
+        maintain: boolean;
+        /** 管理权限 */
+        admin: boolean;
+    };
+}
+/** 协作者列表响应类型 */
+type GetCollaboratorListResponseType = CollaboratorInfoResponseType[];
+/** 移除协作者参数类型 */
+type RemoveCollaboratorParamType = RepoBaseParamType & UserNameParamType;
+/** 移除协作者响应类型 */
+interface RemoveCollaboratorResponseType {
+    /** 状态信息 */
+    info: string;
+}
+
 type AppUser = Omit<UserInfoResponseType, 'bio' | 'blog' | 'followers' | 'following' | 'public_repos'>;
 /**
  * 定义 Base 应用所需的权限
@@ -318,8 +557,6 @@ interface AppInfoParamType {
      * 是https://github.com/settings/apps/:app_slug的
      * */
     app_slug: string;
-    /** 访问令牌 */
-    access_token?: AccessTokenType['access_token'];
 }
 /**
  * 应用的详细信息
@@ -381,6 +618,148 @@ interface AppRepoInfoResponseType {
     /** 更新时间 */
     updated_at: string;
 }
+/** 通过仓库信息获取应用信息参数类型 */
+type GetAppInfoByRepoParamType = RepoInfoParamType;
+/** 通过仓库信息获取应用信息响应类型 */
+type GetAppInfoByRepoResponseType = AppRepoInfoResponseType;
+/** 通过用户信息获取应用信息参数 */
+type GetAppInfoByUserParamType = UserNameParamType;
+/** 通过用户信息获取应用信息响应类型 */
+type GetAppInfoByUserResponseType = AppRepoInfoResponseType;
+/** 通过用户信息获取应用信息参数 */
+type GetAppInfoByOrgParamType = OrgNameParamType;
+/** 通过用户信息获取应用信息响应类型 */
+type GetAppInfoByOrgResponseType = AppRepoInfoResponseType;
+/** 访问令牌权限 */
+interface AccessTokenPermissionsType {
+    /** GitHub Actions 工作流、工作流运行和工件的权限 */
+    actions: 'read' | 'write';
+    /** 存储库创建、删除、设置、团队和协作者创建的权限 */
+    administration: 'read' | 'write';
+    /** 代码检查的权限 */
+    checks: 'read' | 'write';
+    /** 创建、编辑、删除和列出 GitHub Codespaces 的权限 */
+    codespaces: 'read' | 'write';
+    /** 存储库内容、提交、分支、下载、发布和合并的权限 */
+    contents: 'read' | 'write';
+    /** 管理 Dependabot 密钥的权限 */
+    dependabot_secrets: 'read' | 'write';
+    /** 部署和部署状态的权限 */
+    deployments: 'read' | 'write';
+    /** 管理存储库环境的权限 */
+    environments: 'read' | 'write';
+    /** 问题和相关评论、指派、标签和里程碑的权限 */
+    issues: 'read' | 'write';
+    /** 搜索存储库、列出协作者和访问存储库元数据的权限 */
+    metadata: 'read' | 'write';
+    /** 管理 GitHub Packages 发布的包的权限 */
+    packages: 'read' | 'write';
+    /** 获取 Pages 状态、配置和构建的权限，并创建新的构建 */
+    pages: 'read' | 'write';
+    /** 管理拉取请求及相关评论、指派、标签、里程碑和合并的权限 */
+    pull_requests: 'read' | 'write';
+    /** 查看和编辑存储库自定义属性的权限 */
+    repository_custom_properties: 'read' | 'write';
+    /** 管理存储库的 post-receive 钩子的权限 */
+    repository_hooks: 'read' | 'write';
+    /** 管理存储库项目、列和卡片的权限 */
+    repository_projects: 'read' | 'write' | 'admin';
+    /** 查看和管理秘密扫描警报的权限 */
+    secret_scanning_alerts: 'read' | 'write';
+    /** 管理存储库秘密的权限 */
+    secrets: 'read' | 'write';
+    /** 查看和管理安全事件的权限，比如代码扫描警报 */
+    security_events: 'read' | 'write';
+    /** 只管理单个文件的权限 */
+    single_file: 'read' | 'write';
+    /** 管理提交状态的权限 */
+    statuses: 'read' | 'write';
+    /** 管理 Dependabot 警报的权限 */
+    vulnerability_alerts: 'read' | 'write';
+    /** 更新 GitHub Actions 工作流文件的权限 */
+    workflows: 'write';
+    /** 管理组织团队和成员的权限 */
+    members: 'read' | 'write';
+    /** 管理组织访问权限的权限 */
+    organization_administration: 'read' | 'write';
+    /** 管理自定义存储库角色的权限 */
+    organization_custom_roles: 'read' | 'write';
+    /** 管理自定义组织角色的权限 */
+    organization_custom_org_roles: 'read' | 'write';
+    /** 管理自定义属性的权限 */
+    organization_custom_properties: 'read' | 'write' | 'admin';
+    /** 管理 GitHub Copilot 组织成员访问权限的权限 */
+    organization_copilot_seat_management: 'write';
+    /** 查看和管理组织公告横幅的权限 */
+    organization_announcement_banners: 'read' | 'write';
+    /** 查看组织活动的权限 */
+    organization_events: 'read';
+    /** 管理组织的 post-receive 钩子的权限 */
+    organization_hooks: 'read' | 'write';
+    /** 查看和管理组织的个人访问令牌请求的权限 */
+    organization_personal_access_tokens: 'read' | 'write';
+    /** 查看和管理组织批准的个人访问令牌的权限 */
+    organization_personal_access_token_requests: 'read' | 'write';
+    /** 查看组织计划的权限 */
+    organization_plan: 'read';
+    /** 管理组织项目的权限 */
+    organization_projects: 'read' | 'write' | 'admin';
+    /** 管理组织 GitHub Packages 包的权限 */
+    organization_packages: 'read' | 'write';
+    /** 管理组织秘密的权限 */
+    organization_secrets: 'read' | 'write';
+    /** 查看和管理组织 GitHub Actions 自托管运行器的权限 */
+    organization_self_hosted_runners: 'read' | 'write';
+    /** 查看和管理被组织屏蔽的用户的权限 */
+    organization_user_blocking: 'read' | 'write';
+    /** 管理团队讨论和相关评论的权限 */
+    team_discussions: 'read' | 'write';
+    /** 管理用户的电子邮件地址的权限 */
+    email_addresses: 'read' | 'write';
+    /** 管理用户的关注者的权限 */
+    followers: 'read' | 'write';
+    /** 管理 Git SSH 密钥的权限 */
+    git_ssh_keys: 'read' | 'write';
+    /** 查看和管理 GPG 密钥的权限 */
+    gpg_keys: 'read' | 'write';
+    /** 查看和管理存储库的互动限制的权限 */
+    interaction_limits: 'read' | 'write';
+    /** 管理用户的个人资料设置的权限 */
+    profile: 'write';
+    /** 列出和管理用户标星的存储库的权限 */
+    starring: 'read' | 'write';
+}
+/** 为应用创建访问令牌参数类型 */
+interface CreateAccessTokenForAppParamType {
+    /** 应用安装id */
+    installation_id: number;
+    /** 存储库名称列表 */
+    repositories: Array<string>;
+    /** 存储库id列表 */
+    repository_ids: Array<number>;
+    /** 访问令牌权限 */
+    permissions: AccessTokenPermissionsType;
+}
+/** 为应用创建访问令牌响应类型 */
+interface CreateAccessTokenForAppResponseType {
+    /** 访问令牌 */
+    token: string;
+    /** 访问令牌过期时间 */
+    expires_at: string;
+    /** 访问令牌权限 */
+    permissions: Record<string, string>;
+    /** 访问令牌仓库选择范围 */
+    repository_selection: 'all' | 'selected';
+    /** 访问令牌仓库列表 */
+    repositories: Array<RepoInfoResponseType>;
+}
+/** 撤销应用程序访问令牌响应类型 */
+interface RevokeAccessTokenResponseType {
+    /** 是否撤销成功 */
+    success: boolean;
+    /** 撤销结果信息 */
+    info: string;
+}
 
 /** Github 授权令牌接口返回类型 */
 interface TokenResponseType {
@@ -861,300 +1240,79 @@ interface CreteIssueCommentParamType extends RepoBaseParamType {
 }
 /** 创建议题评论响应类型 */
 type CreteIssueCommentResponseType = IssueCommentInfoResponseType;
-/** 更新议题评论参数类型 */
-interface UpdateIssueCommentParamType extends IssueCommentInfoParamType {
-    /** 评论内容 */
-    body: string;
-}
-/** 更新议题评论响应类型 */
-type UpdateIssueCommentResponseType = IssueCommentInfoResponseType;
-/** 删除议题评论参数类型 */
-interface RemoveIssueCommentParamType extends RepoBaseParamType {
-    /** 评论ID */
-    comment_id: string | number;
-}
-/** 删除议题评论响应类型 */
-interface RemoveIssueCommentResponseType {
-    /** 删除状态信息 */
-    info: string;
-}
-/** 获取子议题列表参数类型 */
-interface SubIssueListParamType extends RepoBaseParamType {
-    /** 议题ID */
-    issue_number: IssueNumberParamType['issue_number'];
-    /**
-     * 每页结果数量
-     * @default 30
-     */
-    per_page?: number;
-    /**
-     * 页码
-     * @default 1
-     */
-    page?: number;
-}
-/** 获取子议题列表响应类型 */
-type SubIssueListResponseType = IssueInfoResponseType[];
-/** 添加子议题参数类型 */
-interface AddSubIssueParamType extends RepoBaseParamType {
-    /** 议题ID */
-    issue_number: IssueNumberParamType['issue_number'];
-    /** * 子议题ID */
-    sub_issue_id: IssueNumberParamType['issue_number'];
-    /** * 是否替换父议题 */
-    replace_parent: boolean;
-}
-/** 添加子议题响应类型 */
-type AddSubIssueResponseType = IssueInfoResponseType;
-/** 删除子议题参数类型 */
-interface RemoveSubIssueParamType extends RepoBaseParamType {
-    /** 议题ID */
-    issue_number: IssueNumberParamType['issue_number'];
-    /** 子议题ID */
-    sub_issue_id: IssueNumberParamType['issue_number'];
-}
-/** 删除子议题响应类型 */
-type RemoveSubIssueResponseType = IssueInfoResponseType;
-/** 重新确定子议题优先级参数类型 */
-interface ReprioritizeSubIssueParamType extends RepoBaseParamType {
-    /** 议题ID */
-    issue_number: IssueNumberParamType['issue_number'];
-    /** 子议题ID */
-    sub_issue_id: IssueNumberParamType['issue_number'];
-    /**
-     * 要优先排序的子问题的 ID（与 before_id 互斥，只能指定其中一个）
-     * 在此 ID 之后放置子问题
-     */
-    after_id?: IssueNumberParamType['issue_number'];
-    /**
-     * 要优先排序的子问题的 ID（与 after_id 互斥，只能指定其中一个）
-     * 在此 ID 之前放置子问题
-     */
-    before_id?: IssueNumberParamType['issue_number'];
-}
-/** 重新确定子议题优先级响应类型 */
-type ReprioritizeSubIssueResponseType = IssueInfoResponseType;
-
-/** 仓库所有者参数类型 */
-type RepoUser = Omit<UserInfoResponseType, 'followers' | 'following' | 'blog' | 'bio' | 'public_repos'>;
-/** 仓库列表参数类型 */
-interface RepoListBaseParamType {
-    /** 排序方式，可选created， updated， pushed， full_name， 默认为 full_name */
-    sort?: 'created' | 'updated' | 'pushed' | 'full_name';
-    /** 排序方式，可选asc， desc， 默认为 desc */
-    direction?: 'asc' | 'desc';
-    /** 每页数量 */
-    per_page?: number;
-    /** 页码 */
-    page?: number;
-}
-interface UserByTokenRepoListParamType extends RepoListBaseParamType {
-    /** 仓库的可见性，可选all， public， private， 默认为 all */
-    visibility?: 'all' | 'public' | 'private';
-    /** 仓库的状态，可选all， public， private， 默认为 all */
-    affiliation?: 'owner' | 'collaborator' | 'organization_member';
-    /** 类型，可选all， owner， member， 默认为 all */
-    type?: 'all' | 'owner' | 'member';
-}
-/** 仓库信息请求参数 */
-type RepoInfoParamType = RepoBaseParamType;
-/** * 仓库信息 */
-interface RepoInfoResponseType {
-    /** * 仓库的唯一 ID */
-    id: number;
-    /** * 仓库的名称 */
-    name: string;
-    /** * 仓库的完整名称，包含用户名或组织名 */
-    full_name: string;
-    /** * 仓库拥有者的信息 */
-    owner: RepoUser;
-    /** 仓库是否公开 */
-    public: boolean;
-    /** * 仓库是否私有 */
-    private: boolean;
-    /** * 仓库的可见性 */
-    visibility: 'public' | 'private';
-    /** * 仓库是否是 fork 仓库 */
-    fork: boolean;
-    /** * 仓库是否已归档 */
-    archived: boolean;
-    /** * 仓库是否被禁用 */
-    disabled: boolean;
-    /** * 仓库的 HTML 页面 URL */
-    html_url: string;
-    /** * 仓库的描述信息 */
-    description: string | null;
-    /** * 仓库的 Stargazer 数量 */
-    stargazers_count: number;
-    /** * 仓库的 Watcher 数量 */
-    watchers_count: number;
-    /** * 仓库的主编程语言 */
-    language: string | null;
-    /** * 仓库的 fork 数量 */
-    forks_count: number;
-    /** * 开放的 issue 数量 */
-    open_issues_count: number;
-    /** * 仓库的默认分支 */
-    default_branch: string;
-    /** * 仓库的创建时间 */
-    created_at: string;
-    /** * 仓库的更新时间 */
-    updated_at: string;
-    /** * 仓库的推送时间 */
-    pushed_at: string;
-}
-/** 组织仓库列表参数类型 */
-interface OrgRepoListParmType extends RepoListBaseParamType {
-    /** 组织名称 */
-    org: string;
-    /** 类型，可选all， public， private 默认为 all */
-    type?: 'all' | 'public' | 'private';
-}
-/**
- * 组织仓库列表响应类型
- * 该类型包含了多个仓库的信息，每个仓库都有自己的详细信息。
- */
-type OrgRepoListResponseType = RepoInfoResponseType[];
-/** 创建组织仓库请求参数 */
-interface OrgRepoCreateParamType extends OrgNameParamType {
-    /** 仓库名称 */
-    name: string;
-    /** 仓库描述 */
-    description?: string;
-    /** 仓库主页 */
-    homepage?: string;
-    /** 仓库可见性 */
-    visibility?: 'public' | 'private';
-    /** 是否开启议题issue */
-    has_issues?: boolean;
-    /** 是否开启wiki */
-    has_wiki?: boolean;
-    /** 仓库自动初始化 */
-    auto_init?: boolean;
-}
-/** 创建组织仓库响应类型 */
-type OrgRepoCreateResponseType = RepoInfoResponseType;
-/** 创建用户仓库参数类型 */
-type UserRepoCreateParamType = Omit<OrgRepoCreateParamType, 'org'> & RepoOwnerParamType;
-/** 创建用户仓库响应类型 */
-type UserRepoCreateResponseType = RepoInfoResponseType;
-/** 用户仓库列表参数类型 */
-interface UserRepoListParamType extends RepoListBaseParamType {
-    /** 用户名 */
-    username: string;
-    /** 类型，可选all， owner， member， 默认为 all */
-    type?: 'all' | 'owner' | 'member';
-}
-/** 用户仓库列表类型 */
-type UserRepoListType = Array<RepoInfoResponseType & {
-    /** * 仓库的角色名称 */
-    role_name?: string;
-}>;
-/** 仓库语言信息类型 */
-interface LanguageInfo {
-    /** 编程语言名称 */
-    language: string;
-    /** 语言对应的颜色 */
-    color: string;
-    /** 在仓库中的占比（百分比） */
-    percent: number;
-    /** 该语言的代码字节数 */
-    bytes: number;
-}
-/** 仓库语言列表参数类型 */
-type RepoLanguagesListParamType = RepoBaseParamType;
-/** 仓库语言列表类型 */
-interface RepoLanguagesListResponseType {
-    /** 仓库的语言统计信息列表 */
-    languages: LanguageInfo[];
+/** 更新议题评论参数类型 */
+interface UpdateIssueCommentParamType extends IssueCommentInfoParamType {
+    /** 评论内容 */
+    body: string;
 }
-/** 获取仓库可见性参数类型 */
-type GetRepoVisibilityParamType = RepoBaseParamType;
-/** 获取仓库可见性响应类型 */
-type GetRepoVisibilityResponseType = RepoInfoResponseType['visibility'];
-/** 获取仓库默认分支参数类型 */
-type GetRepoDefaultBranchParamType = RepoBaseParamType;
-/** 获取仓库默认分支响应类型 */
-type GetRepoDefaultBranchResponseType = RepoInfoResponseType['default_branch'];
-/** 获取仓库主要语言参数类型 */
-type GetRepoMainLanguageParamType = RepoBaseParamType;
-/** 仓库主要语言响应类型 */
-type GetRepoMainLanguageResponseType = RepoInfoResponseType['language'];
-/**
- * 协作者权限 ,可选 pull，triage, push, maintain, admin，默认pull
- * pull - 只读访问，协作者可以查看仓库内容。
- * push - 允许推送代码到仓库分支，同时拥有 pull 权限。
- * admin - 拥有仓库的完全控制权，包括更改设置和删除仓库。
- */
-type CollaboratorPermissionType = 'pull' | 'push' | 'admin';
-/** 协作者参数类型 */
-type CollaboratorParamType = RepoInfoParamType & UserNameParamType & {
-    permission?: CollaboratorPermissionType;
-};
-/** 邀请协作者响应类型 */
-interface AddCollaboratorResponseType {
-    /** 被邀请者ID */
-    id: number;
-    /** 被邀请者用户名 */
-    login: string;
-    /** 被邀请者的别名 */
-    name: string | null;
-    /** 仓库的地址 */
-    html_url: string;
-    /** 被邀请者的权限 */
-    permissions: string;
+/** 更新议题评论响应类型 */
+type UpdateIssueCommentResponseType = IssueCommentInfoResponseType;
+/** 删除议题评论参数类型 */
+interface RemoveIssueCommentParamType extends RepoBaseParamType {
+    /** 评论ID */
+    comment_id: string | number;
 }
-/** 协作者列表参数类型 */
-type GetCollaboratorListParamType = RepoInfoParamType & {
+/** 删除议题评论响应类型 */
+interface RemoveIssueCommentResponseType {
+    /** 删除状态信息 */
+    info: string;
+}
+/** 获取子议题列表参数类型 */
+interface SubIssueListParamType extends RepoBaseParamType {
+    /** 议题ID */
+    issue_number: IssueNumberParamType['issue_number'];
     /**
-     * 筛选按隶属关系返回的协作者
-     * outside - 列出所有外部协作者，包括仓库成员和外部 collaborator。
-     * direct - 列出仓库成员。
-     * all - 列出仓库成员和外部 collaborator。
-    */
-    affiliation?: 'outside' | 'direct' | 'all';
-    /** 权限 */
-    permission?: CollaboratorPermissionType;
-    /** 每页数量 */
+     * 每页结果数量
+     * @default 30
+     */
     per_page?: number;
-    /** 页码 */
+    /**
+     * 页码
+     * @default 1
+     */
     page?: number;
-};
-/** 协作者信息类型 */
-interface CollaboratorInfoResponseType {
-    /** 协作者id */
-    id: number;
-    /** 协作者登录名 */
-    login: string;
-    /** 头像URL */
-    avatar_url: string;
-    /** 协作者邮箱 */
-    email: string | null;
-    /** 协作者姓名 */
-    name: string | null;
-    /** 权限设置 */
-    permissions: {
-        /** 拉取权限 */
-        pull: boolean;
-        /** 分类权限 */
-        triage: boolean;
-        /** 推送权限 */
-        push: boolean;
-        /** 维护权限 */
-        maintain: boolean;
-        /** 管理权限 */
-        admin: boolean;
-    };
 }
-/** 协作者列表响应类型 */
-type GetCollaboratorListResponseType = CollaboratorInfoResponseType[];
-/** 移除协作者参数类型 */
-type RemoveCollaboratorParamType = RepoBaseParamType & UserNameParamType;
-/** 移除协作者响应类型 */
-interface RemoveCollaboratorResponseType {
-    /** 状态信息 */
-    info: string;
+/** 获取子议题列表响应类型 */
+type SubIssueListResponseType = IssueInfoResponseType[];
+/** 添加子议题参数类型 */
+interface CreateSubIssueParamType extends RepoBaseParamType {
+    /** 议题ID */
+    issue_number: IssueNumberParamType['issue_number'];
+    /** * 子议题ID */
+    sub_issue_id: IssueNumberParamType['issue_number'];
+    /** * 是否替换父议题 */
+    replace_parent: boolean;
+}
+/** 添加子议题响应类型 */
+type CreateSubIssueResponseType = IssueInfoResponseType;
+/** 删除子议题参数类型 */
+interface RemoveSubIssueParamType extends RepoBaseParamType {
+    /** 议题ID */
+    issue_number: IssueNumberParamType['issue_number'];
+    /** 子议题ID */
+    sub_issue_id: IssueNumberParamType['issue_number'];
+}
+/** 删除子议题响应类型 */
+type RemoveSubIssueResponseType = IssueInfoResponseType;
+/** 重新确定子议题优先级参数类型 */
+interface ReprioritizeSubIssueParamType extends RepoBaseParamType {
+    /** 议题ID */
+    issue_number: IssueNumberParamType['issue_number'];
+    /** 子议题ID */
+    sub_issue_id: IssueNumberParamType['issue_number'];
+    /**
+     * 要优先排序的子问题的 ID（与 before_id 互斥，只能指定其中一个）
+     * 在此 ID 之后放置子问题
+     */
+    after_id?: IssueNumberParamType['issue_number'];
+    /**
+     * 要优先排序的子问题的 ID（与 after_id 互斥，只能指定其中一个）
+     * 在此 ID 之前放置子问题
+     */
+    before_id?: IssueNumberParamType['issue_number'];
 }
+/** 重新确定子议题优先级响应类型 */
+type ReprioritizeSubIssueResponseType = IssueInfoResponseType;
 
 /** 组织信息参数类型 */
 type OrgInfoParamType = OrgNameParamType;
@@ -1221,19 +1379,30 @@ interface PullRequestInfoResponseType {
     merged_at: string | null;
     /** PR作者 */
     user: PrUser;
+    /** PR的目标分支 */
     base: {
+        /** 分支标签 */
         label: string;
+        /** 分支名称 */
         ref: string;
+        /** 当前分支最新提交的 SHA 值 */
         sha: string;
+        /** 分支的用户信息 */
         user: PrUser;
+        /** 分支的仓库信息 */
         repo: PrRepo;
     };
     /** PR的源分支信息 */
     head: {
+        /** 分支标签 */
         label: string;
+        /** 分支名称 */
         ref: string;
+        /** 当前分支最新提交的 SHA 值 */
         sha: string;
+        /** 分支的用户信息 */
         user: PrUser;
+        /** 分支的仓库信息 */
         repo: PrRepo;
     };
     /** 指派人 */
@@ -1591,8 +1760,6 @@ interface DeleteReleaseResponseType {
 }
 
 interface WebHookSignatureParamType {
-    /** WebHook 的 secret */
-    secret?: string;
     /** 请求体 */
     payload: string;
     /** GitHub 发送的签名头 */
@@ -1613,10 +1780,11 @@ interface WebHookSignatureResponseType {
  * @returns 格式化后的日期字符串
  * @example
  * ```ts
- * console.log(await formatDate('2025-04-16T10:00:00') // 输出 "2025-04-16 10:00:00"
+ * console.log(await format_date('2025-04-16T10:00:00')
+ * -> '2025-04-16 10:00:00'
  * ```
  */
-declare function formatDate(dateString: string, locale?: string, format?: string): Promise<string>;
+declare function format_date(dateString: string, locale?: string, format?: string): Promise<string>;
 /**
  * 获取相对时间
  * @param dateString - 日期字符串
@@ -1629,33 +1797,14 @@ declare function formatDate(dateString: string, locale?: string, format?: string
  * ```
  */
 declare function get_relative_time(dateString: string, locale?: string): Promise<string>;
-/**
- * 获取本地仓库的默认分支
- * @param local_path - 本地仓库路径
- * @returns 默认分支名称
- * @example
- * ```ts
- * console.log(await get_local_repo_default_branch('/path/to/repo')) // 输出 'main'
- * ```
- */
-declare function get_local_repo_default_branch(local_path: string): Promise<string>;
-/**
- * 获取远程仓库的默认分支
- * @param remote_url - 远程仓库URL
- * @returns 默认分支名称
- * @example
- * ```ts
- * console.log(await get_remote_repo_default_branch('https://github.com/CandriaJS/git-neko-kit')) // 输出 'main'
- * ```
- */
-declare function get_remote_repo_default_branch(remote_url: string): Promise<string>;
 /**
  * 根据语言名称获取对应的颜色值
  * @param language - 语言名称
  * @returns 颜色值的十六进制字符串
  * @example
  * ```ts
- * console.log(get_langage_color('JavaScript')) // 输出 "#f1e05a"
+ * console.log(get_langage_color('JavaScript'))
+ * -> '#f1e05a'
  * ```
  */
 declare function get_langage_color(language: string): string;
@@ -1665,7 +1814,8 @@ declare function get_langage_color(language: string): string;
  * @returns 生成的唯一标识符
  * @example
  * ```ts
- * const stateId = await create_state_id() // 输出 "34523452345234523452345234523452"
+ * const stateId = await create_state_id()
+ * -> '34523452345234523452345234523452'
  * ```
  */
 declare function create_state_id(): Promise<string>;
@@ -1690,7 +1840,7 @@ declare class Auth extends GitHubClient {
      * @example
      * ```ts
      * const token = await auth.get_token_by_code({ code: 'code' })
-     * console.log(token) // 输出token对象
+     * -> { info: '获取'access_token: 'token', refresh_token: 'refresh_token' }
      * ```
      */
     get_token_by_code(options: AccessCodeType): Promise<ApiResponseType<TokenResponseType>>;
@@ -1753,7 +1903,7 @@ declare class Commit extends GitHubClient {
      * @example
      * ```ts
      * const commitInfo = await commit.get_commit_info({ owner: 'owner', repo: 'repo' })
-     * console.log(commitInfo)
+     * -> 提交信息对象
      * ```
      */
     get_commit_info(options: CommitInfoParamType): Promise<ApiResponseType<CommitInfoResponseType>>;
@@ -1775,7 +1925,7 @@ declare class Commit extends GitHubClient {
      * @example
      * ```ts
      * const commitList = await commit.get_commit_list({ owner: 'owner', repo:'repo' })
-     * console.log(commitList)
+     * -> 提交对象列表
      * ```
      */
     get_commit_list(options: CommitListParamType): Promise<ApiResponseType<CommitListResponseType>>;
@@ -1807,9 +1957,8 @@ declare class Issue extends GitHubClient {
      * @returns 包含Issue信息的响应对象
      * @example
      * ```ts
-     * const issue = get_issue() // 获取issue实例
      * const res = await issue.get_issue_info({ owner: 'owner', repo:'repo', issue_number:1 })
-     * console.log(res) // { data: IssueInfoResponseType }
+     * -> 议题信息对象
      * ```
      */
     get_issue_info(options: IssueInfoParamType): Promise<ApiResponseType<IssueInfoResponseType>>;
@@ -1835,9 +1984,8 @@ declare class Issue extends GitHubClient {
      * @returns 包含Issue列表的响应对象
      * @example
      * ```ts
-     * const issue = get_issue() // 获取issue实例
      * const res = await issue.get_issue_list({ owner: 'owner', repo: 'repo' })
-     * console.log(res) // { data: IssueListResponseType[] }
+     * -> 议题信息对象列表
      * ```
      */
     get_issues_list(options: RepoIssueListParamType): Promise<ApiResponseType<IssueListResponseType>>;
@@ -1857,9 +2005,8 @@ declare class Issue extends GitHubClient {
      * @returns 包含Issue信息的响应对象
      * @example
      * ```ts
-     * const issue = get_issue() // 获取issue实例
      * const res = await issue.create_issue({ owner: 'owner', repo:'repo', title:'title', body:'body' })
-     * console.log(res) // { data: CreateIssueResponseType }
+     * -> 创建议题信息对象
      * ```
      */
     create_issue(options: CreteIssueParamType): Promise<ApiResponseType<CreateIssueResponseType>>;
@@ -1882,9 +2029,8 @@ declare class Issue extends GitHubClient {
      * @returns 包含Issue信息的响应对象
      * @example
      * ```ts
-     * const issue = get_issue() // 获取issue实例
      * const res = await issue.update_issue({ owner: 'owner', repo:'repo', issue_number:1, title:'title', body:'body' })
-     * console.log(res) // { data: CreateIssueResponseType }
+     * -> 更新议题信息对象
      * ```
      */
     update_issue(options: UpdateIssueParamType): Promise<ApiResponseType<UpdateIssueResponseType>>;
@@ -1901,9 +2047,8 @@ declare class Issue extends GitHubClient {
      * @returns 包含Issue信息的响应对象
      * @example
      * ```ts
-     * const issue = get_issue() // 获取issue实例
      * const res = await issue.open_issue({ owner: 'owner', repo:'repo', issue_number:1 })
-     * console.log(res) // { data: CreateIssueResponseType }
+     * -> 打开议题信息对象
      * ```
      */
     open_issue(options: OpenIssueParamType): Promise<ApiResponseType<OpenIssueResponseType>>;
@@ -1930,14 +2075,14 @@ declare class Issue extends GitHubClient {
      * @returns 包含Issue信息的响应对象
      * @example
      * ```ts
-     * const issue = get_issue() // 获取issue实例
      * const res = await issue.close_issue({ owner: 'owner', repo:'repo', issue_number:1, state_reason:'completed' })
-     * console.log(res) // { data: CreateIssueResponseType }
+     * -> 关闭议题信息对象
      * ```
      */
     close_issue(options: CloseIssueParamType): Promise<ApiResponseType<CloseIssueResponseType>>;
     /**
      * 锁定一个议题
+     * @github
      * 仅GitHub平台可用
      * 权限:
      * - Issues: Write
@@ -1951,14 +2096,14 @@ declare class Issue extends GitHubClient {
      * @returns 锁定状态信息
      * @example
      * ```ts
-     * const issue = get_issue() // 获取issue实例
      * const res = await issue.lock_issue({ owner: 'owner', repo:'repo', issue_number:1, lock_reason:'off-topic' })
-     * console.log(res) // { data: LockIssueResponseType }
+     * -> 锁定议题信息对象
      * ```
      */
     lock_issue(options: LockIssueParamType): Promise<ApiResponseType<LockIssueResponseType>>;
     /**
      * 解锁一个议题
+     * @github
      * 仅GitHub平台可用
      * 权限:
      * - Issues: Write
@@ -1971,9 +2116,8 @@ declare class Issue extends GitHubClient {
      * @returns 解锁状态信息
      * @example
      * ```ts
-     * const issue = get_issue() // 获取issue实例
      * const res = await issue.unlock_issue({ owner: 'owner', repo:'repo', issue_number})
-     * console.log(res) // { data: UnLockIssueResponseType }
+     * -> 解锁议题信息对象
      * ```
      */
     unlock_issue(options: UnLockIssueParamType): Promise<ApiResponseType<UnLockIssueResponseType>>;
@@ -1994,9 +2138,8 @@ declare class Issue extends GitHubClient {
      * @returns 包含Issue评论列表的响应对象
      * @example
      * ```ts
-     * const issue = get_issue() // 获取issue实例
      * const res = await issue.get_issue_comments_list({ owner: 'owner', repo:'repo', issue_number:1 })
-     * console.log(res) // { data: IssueCommentListResponseType[] }
+     * -> 议题评论对象列表
      * ```
      */
     get_repo_comments_list(options: RepoCommentListParamType): Promise<ApiResponseType<RepoCommentListResponseType>>;
@@ -2016,9 +2159,8 @@ declare class Issue extends GitHubClient {
      * @returns 包含Issue评论列表的响应对象
      * @example
      * ```ts
-     * const issue = get_issue() // 获取issue实例
      * const res = await issue.get_issue_comments_list({ owner: 'owner', repo:'repo', issue_number:1 })
-     * console.log(res) // { data: IssueCommentListResponseType[] }
+     * -> 议题评论对象列表
      * ```
      */
     get_issue_comments_list(options: IssueCommentListParamType): Promise<ApiResponseType<IssueCommentListResponseType>>;
@@ -2035,9 +2177,8 @@ declare class Issue extends GitHubClient {
      * @returns Issue评论信息
      * @example
      * ```ts
-     * const issue = get_issue() // 获取issue实例
      * const res = await issue.get_issue_comment({ owner: 'owner', repo:'repo', comment_id:1 })
-     * console.log(res) // { data: IssueCommentInfoResponseType }
+     * -> 议题评论对象
      * ```
      */
     get_issue_comment_info(options: IssueCommentInfoParamType): Promise<ApiResponseType<IssueCommentInfoResponseType>>;
@@ -2057,7 +2198,7 @@ declare class Issue extends GitHubClient {
      * ```ts
      * const issue = get_issue() // 获取issue实例
      * const res = await issue.create_issue_comment({ owner: 'owner', repo:'repo', issue_number:1, body:'comment' })
-     * console.log(res) // { data: CreteIssueCommentResponseType }
+     * -> 创建议题评论对象
      * ```
      */
     create_issue_comment(options: CreteIssueCommentParamType): Promise<ApiResponseType<CreteIssueCommentResponseType>>;
@@ -2075,9 +2216,8 @@ declare class Issue extends GitHubClient {
      * @returns 更新后的Issue评论信息
      * @example
      * ```ts
-     * const issue = get_issue() // 获取issue实例
      * const res = await issue.update_issue_comment({ owner: 'owner', repo:'repo', comment_id:1, body:'body' })
-     * console.log(res) // { data: UpdateIssueCommentResponseType }
+     * -> 更新议题评论对象
      * ```
      */
     update_issue_comment(options: UpdateIssueCommentParamType): Promise<ApiResponseType<UpdateIssueCommentResponseType>>;
@@ -2094,9 +2234,8 @@ declare class Issue extends GitHubClient {
      * @returns 删除结果信息
      * @example
      * ```ts
-     * const issue = get_issue() // 获取issue实例
      * const res = awaitissue.remove_issue_comment()
-     * console.log(res) // { data: RemoveIssueCommentResponseType }
+     * -> 删除议题评论对象
      * ```
      */
     remove_issue_comment(options: RemoveIssueCommentParamType): Promise<ApiResponseType<RemoveCollaboratorResponseType>>;
@@ -2124,14 +2263,13 @@ declare class Issue extends GitHubClient {
      * @returns 子议题列表
      * @example
      * ```ts
-     * const issue = get_issue() // 获取issue实例
      * const res = await issue.get_sub_issue_list({ owner: 'owner', repo:'repo', issue_number:1 })
-     * console.log(res) // { data: SubIssueListResponseType }
+     * -> 子议题信息对象列表
      * ```
      */
     get_sub_issue_list(options: SubIssueListParamType): Promise<ApiResponseType<SubIssueListResponseType>>;
     /**
-     * 添加子议题
+     * 创建子议题
      * 添加一个子议题到指定的议题中
      * @github
      * 仅GitHub 平台使用
@@ -2146,12 +2284,19 @@ declare class Issue extends GitHubClient {
      * @returns 添加结果信息
      * @example
      * ```ts
-     * const issue = get_issue() // 获取issue实例
      * const res = await issue.add_sub_issue({ owner: 'owner', repo:'repo', issue_number:1, sub_issue_id:1, replace_parent:true })
-     * console.log(res) // { data: AddSubIssueResponseType }
+     * -> 创建子议题信息对象
      * ```
      */
-    add_sub_issue(options: AddSubIssueParamType): Promise<ApiResponseType<AddSubIssueResponseType>>;
+    create_sub_issue(options: CreateSubIssueParamType): Promise<ApiResponseType<CreateSubIssueResponseType>>;
+    /**
+     * 添加子议题
+     * 添加一个子议题到指定的议题中
+     * @github
+     * 仅GitHub 平台使用
+     * @deprecated 已弃用，请使用`create_sub_issue`方法
+     */
+    add_sub_issue(options: CreateSubIssueParamType): Promise<ApiResponseType<CreateSubIssueResponseType>>;
     /**
      * 删除子议题
      * @github
@@ -2166,9 +2311,8 @@ declare class Issue extends GitHubClient {
      * @returns 删除结果信息
      * @example
      * ```ts
-     * const issue = get_issue() // 获取issue实例
      * const res = await issue.remove_sub_issue({ owner: 'owner', repo:'repo', issue_number:1, sub_issue_id:1 })
-     * console.log(res) // { data: RemoveSubIssueResponseType }
+     * -> 删除子议题信息对象
      * ```
      */
     remove_sub_issue(options: RemoveSubIssueParamType): Promise<ApiResponseType<RemoveSubIssueResponseType>>;
@@ -2196,9 +2340,8 @@ declare class Issue extends GitHubClient {
      * - after_id 指定要在哪个子议题之后插入，传入目标子议题的编号
      * @example
      * ```ts
-     * const issue = get_issue() // 获取issue实例
      * const res = await issue.reprioritize_sub_issue({ owner: 'owner', repo:'repo', issue_number:1, sub_issue_id:1, before_id:1 })
-     * console.log(res) // { data: ReprioritizeSubIssueResponseType }
+     * -> 排序子议题信息对象
      * ```
      */
     reprioritize_sub_issue(options: ReprioritizeSubIssueParamType): Promise<ApiResponseType<ReprioritizeSubIssueResponseType>>;
@@ -2222,7 +2365,7 @@ declare class Org extends GitHubClient {
      * @example
      * ```ts
      * const orgInfo = await org.get_org_info({ org: 'org' })
-     * console.log(orgInfo)
+     * -> 组织信息对象
      * ```
      */
     get_org_info(options: OrgInfoParamType): Promise<ApiResponseType<OrgInfoResponseType>>;
@@ -2237,7 +2380,7 @@ declare class Org extends GitHubClient {
      * @example
      * ```ts
      * const orgInfo = await org.add_member({ org: 'org', username: 'username' })
-     * console.log(orgInfo)
+     * -> 添加组织成员对象
      * ```
      */
     add_member(options: AddMemberParamType): Promise<ApiResponseType<AddMemberResponseType>>;
@@ -2267,9 +2410,8 @@ declare class Pull_Request extends GitHubClient {
      * @returns 包含pull_request信息的响应对象
      * @example
      * ```ts
-     * const pull_request = get_pull_request() // 获取pull_request实例
      * const res = await pull_request.get_pull_request_info({ owner: 'owner', repo:'repo', pr_number:1 })
-     * console.log(res) // { data: PullRequestInfoResponseType }
+     * -> 拉取提交信息对象
      * ```
      */
     get_pull_request_info(options: PullRequestInfoParamType): Promise<ApiResponseType<PullRequestInfoResponseType>>;
@@ -2290,9 +2432,8 @@ declare class Pull_Request extends GitHubClient {
      * @returns 包含pull_request信息的响应对象
      * @example
      * ```ts
-     * const pull_request = get_pull_request() // 获取pull_request实例
      * const res = await pull_request.get_get_pull_request_list({ owner: 'owner', repo:'repo' })
-     * console.log(res) // { data: PullRequestListResponseType }
+     * -> 拉取提交信息对象列表
      * ```
      */
     get_get_pull_request_list(options: PullRequestListParamType): Promise<ApiResponseType<PullRequestListResponseType>>;
@@ -2314,9 +2455,8 @@ declare class Pull_Request extends GitHubClient {
      * @returns 包含pull_request信息的响应对象
      * @example
      * ```ts
-     * const pull_request = get_pull_request() // 获取pull_request实例
      * const res = await pull_request.create_pull_requestt({ owner: 'owner', repo:'repo', issue: 1, head: 'head', base: 'base' })
-     * console.log(res) // { data: CreatePullRequestResponseType }
+     * -> 创建拉取提交信息对象
      */
     create_pull_request(options: CreatePullRequestParamType): Promise<ApiResponseType<CreatePullRequestResponseType>>;
     /**
@@ -2332,9 +2472,8 @@ declare class Pull_Request extends GitHubClient {
      * @returns 包含pull_request信息的响应对象
      * @example
      * ```ts
-     * const pull_request = get_pull_request() // 获取pull_request实例
      * const res = await pull_request.create_pull_requestt({ owner: 'owner', repo:'repo', pr_number:1, state:'open' })
-     * console.log(res) // { data: CreatePullRequestResponseType }
+     * -> 更新拉取提交信息对象
      */
     update_pull_request(options: UpdatePullRequestParamType): Promise<ApiResponseType<UpdatePullRequestResponseType>>;
     /**
@@ -2352,9 +2491,8 @@ declare class Pull_Request extends GitHubClient {
      * @returns 包含pull_request信息的响应对象
      * @example
      * ```ts
-     * const pull_request = get_pull_request() // 获取pull_request实例
      * const res = await pull_request.merge_pull_request({ owner: 'owner', repo:'repo', pr_number:1 })
-     * console.log(res) // { data: CreatePullRequestResponseType }
+     * -> 合并拉取提交信息对象
      * ```
      */
     merge_pull_request(options: MergePullRequestParamType): Promise<ApiResponseType<MergePullRequestResponseType>>;
@@ -2371,9 +2509,8 @@ declare class Pull_Request extends GitHubClient {
      * @returns 包含拉取请求文件列表的响应对象
      * @example
      * ```ts
-     * const pull_request = get_pull_request() // 获取pull_request实例
      * const res = await pull_request.get_pull_request_files_list({ owner: 'owner', repo:'repo', pr_number:1 })
-     * console.log(res) // { data: GetPullRequestFilesListResponseType }
+     * -> 拉取提交文件信息对象列表
      * ```
      */
     get_pull_request_files_list(options: GetPullRequestFilesListParamType): Promise<ApiResponseType<GetPullRequestFilesListResponseType>>;
@@ -2388,9 +2525,8 @@ declare class Pull_Request extends GitHubClient {
      * @returns 包含拉取请求指定的评论id的信息
      * @example
      * ```ts
-     * const pull_request = get_pull_request() // 获取pull_request实例
      * const res = await pull_request.get_pull_request_comment_info({ owner: 'owner', repo:'repo', comment_id:1 })
-     * console.log(res) // { data: GetPullRequestCommentInfoResponseType }
+     * -> 拉取提交评论信息对象
      * ```
      */
     get_pull_request_comment_info(options: GetPullRequestCommentInfoParamType): Promise<ApiResponseType<GetPullRequestCommentInfoResponseType>>;
@@ -2408,9 +2544,8 @@ declare class Pull_Request extends GitHubClient {
      * @returns 包含拉取请求评论列表响应信息列表
      * @example
      * ```ts
-     * const pull_request = get_pull_request() // 获取pull_request实例
      * const res = await pull_request.get_pull_request_comments_list({ owner: 'owner', repo:'repo', pr_number:1 })
-     * console.log(res) // { data: GetPullRequestCommentsListResponseType }
+     * -> 拉取提交评论信息对象
      * ```
      */
     get_pull_request_comments_list(options: GetPullRequestCommentsListParamType): Promise<ApiResponseType<GetPullRequestCommentsListResponseType>>;
@@ -2426,9 +2561,8 @@ declare class Pull_Request extends GitHubClient {
      * @returns 包含创建拉取请求评论响应信息
      * @example
      * ```ts
-     * const pull_request = get_pull_request() // 获取pull_request实例
      * const res = await pull_request.create_pull_request_comment({ owner: 'owner', repo:'repo', pr_number:1， body: 'loli' })
-     * console.log(res) // { data: CreatePullRequestCommentResponseType }
+     * -> 创建拉取提交评论信息对象
      * ```
      */
     create_pull_request_comment(options: CreatePullRequestCommentParamType): Promise<ApiResponseType<CreatePullRequestCommentResponseType>>;
@@ -2444,25 +2578,18 @@ declare class Pull_Request extends GitHubClient {
      * @returns 包含更新拉取请求评论响应信息
      * @example
      * ```ts
-     * const pull_request = get_pull_request() // 获取pull_request实例
      * const res = await pull_request.update_pull_request_comment({ owner: 'owner', repo:'repo', comment_id:1， body: 'loli' })
-     * console.log(res) // { data: CreatePullRequestCommentResponseType }
+     * -> 更新拉取提交评论信息对象
      * ```
      */
     update_pull_request_comment(options: UpdatePullRequestCommentParamType): Promise<ApiResponseType<UpdatePullRequestCommentResponseType>>;
     /**
-     * 删除拉取请求评论
+     * 编辑拉取请求评论
      * @deprecated  请使用update_issue_comment方法
      * 权限:
      * - Pull requests: Read-And-Write
      * @param options - 删除拉取请求评论参数对象
      * @returns 删除结果
-     * @example
-     * ```ts
-     * const pull_request = get_pull_request() // 获取pull_request实例
-     * const res = await pull_request.  public async edit_pull_request_comment (
-  ({ owner: 'owner', repo:'repo', comment_id:1， body: 'loli' })
-     * console.log(res) // { data: CreatePullRequestCommentResponseType }
      * ```
      */
     edit_pull_request_comment(options: UpdatePullRequestCommentParamType): Promise<ApiResponseType<UpdatePullRequestCommentResponseType>>;
@@ -2477,9 +2604,8 @@ declare class Pull_Request extends GitHubClient {
      * @returns 包含更新拉取请求评论响应信息
      * @example
      * ```ts
-     * const pull_request = get_pull_request() // 获取pull_request实例
      * const res = await pull_request.delete_pull_request_comment({ owner: 'owner', repo:'repo', comment_id: 1 })
-     * console.log(res) // { data: DeletePullRequestCommentResponseType }
+     * -> 更新拉取提交评论信息对象
      * ```
      */
     delete_pull_request_comment(options: DeletePullRequestCommentParamType): Promise<ApiResponseType<DeletePullRequestCommentResponseType>>;
@@ -2511,7 +2637,7 @@ declare class Repo extends GitHubClient {
      * @example
      * ```ts
      * const repos = await repo.get_org_repos_list({ org: 'org' })
-     * console.log(repos)
+     * -> 组织仓库信息对象列表
      * ```
      */
     get_org_repos_list(options: OrgRepoListParmType): Promise<ApiResponseType<OrgRepoListResponseType>>;
@@ -2530,7 +2656,7 @@ declare class Repo extends GitHubClient {
      * @example
      * ```ts
      * const repos = await repo.get_repos_list({ username: 'username' })
-     * console.log(repos)
+     * -> 用户仓库信息对象列表
      * ```
      */
     get_user_repos_list_by_token(options?: UserByTokenRepoListParamType): Promise<ApiResponseType<UserRepoListType>>;
@@ -2547,6 +2673,11 @@ declare class Repo extends GitHubClient {
      * - per_page - 每页数量（1-100）, 默认值：30
      * - page - 页码 默认值：1
      * @returns 用户仓库列表
+     * @example
+     * ```ts
+     * const repos = await github.get_user_repos_list({ username: 'loli' })
+     * -> 用户仓库信息对象列表
+     * ```
      */
     get_user_repos_list(options: UserRepoListParamType): Promise<ApiResponseType<UserRepoListType>>;
     /**
@@ -2559,7 +2690,7 @@ declare class Repo extends GitHubClient {
      * @example
      * ```ts
      * const repo = await repo.get_repo_info({ owner: 'owner', repo: 'repo' })
-     * console.log(repo)
+     * -> 仓库信息对象
      * ```
      */
     get_repo_info(options: RepoInfoParamType): Promise<ApiResponseType<RepoInfoResponseType>>;
@@ -2573,7 +2704,7 @@ declare class Repo extends GitHubClient {
      * @example
      * ```ts
      * const repo = await repo.get_repo_languages_list({ owner: 'owner', repo: 'repo' })
-     * console.log(repo)
+     * -> 仓库语言对象列表
      * ```
      */
     get_repo_languages_list(options: RepoLanguagesListParamType): Promise<ApiResponseType<RepoLanguagesListResponseType>>;
@@ -2591,6 +2722,11 @@ declare class Repo extends GitHubClient {
      * - has_wiki: 是否启用wiki功能, 默认值：true
      * - auto_init: 是否自动初始化仓库 默认值：false
      * @returns 返回创建成功的仓库信息
+     * @example
+     * ```ts
+     * const repoInfo = await org.create_org_repo({org: 'loli', repo: 'git-neko-kit'})
+     * -> 创建组织仓库信息对象
+     * ```
      */
     create_org_repo(options: OrgRepoCreateParamType): Promise<ApiResponseType<OrgRepoCreateResponseType>>;
     /**
@@ -2607,6 +2743,11 @@ declare class Repo extends GitHubClient {
      * - has_wiki: 是否启用wiki功能, 默认值：true
      * - auto_init: 是否自动初始化仓库 默认值：false
      * @returns 返回创建成功的仓库信息
+     * @example
+     * ```ts
+     * const repoInfo = await repo.create_user_repo({org: 'loli', repo: 'git-neko-kit'})
+     * -> 创建用户仓库信息对象
+     * ```
      */
     create_user_repo(options: UserRepoCreateParamType): Promise<ApiResponseType<UserRepoCreateResponseType>>;
     /**
@@ -2643,7 +2784,7 @@ declare class Repo extends GitHubClient {
      * @example
      * ```ts
      * const result = await collaborator.get_collaborators_list(options)
-     * console.log(result)
+     * -> 仓库协作者信息对象列表
      * ```
      */
     get_collaborators_list(options: GetCollaboratorListParamType): Promise<ApiResponseType<GetCollaboratorListResponseType>>;
@@ -2667,7 +2808,7 @@ declare class Repo extends GitHubClient {
      *  username: 'username',
      *  permission: 'pull'
      * })
-     * console.log(result)
+     * -> 邀请仓库协作者信息对象
      * ```
      */
     add_collaborator(options: CollaboratorParamType): Promise<ApiResponseType<AddCollaboratorResponseType>>;
@@ -2678,8 +2819,6 @@ declare class Repo extends GitHubClient {
      * @param options 删除协作者对象
      * - owner: 仓库拥有者
      * - repo: 仓库名称
-     * - url: 仓库地址
-     * owner和repo或者url选择一个即可
      * - username: 要删除协作者用户名
      * @returns 返回删除协作者结果
      * @example
@@ -2689,7 +2828,7 @@ declare class Repo extends GitHubClient {
      *  repo:'repo',
      *  username: 'username'
      * })
-     * console.log(result)
+     * -> 移除仓库协作者信息对象
      * ```
      */
     remove_collaborator(options: RemoveCollaboratorParamType): Promise<ApiResponseType<RemoveCollaboratorResponseType>>;
@@ -2698,15 +2837,6 @@ declare class Repo extends GitHubClient {
      * @deprecated 请使用remove_collaborator方法
      * @param options 删除协作者对象
      * @returns 返回删除协作者结果
-     * @example
-     * ```ts
-     * const result = await collaborator.delete_collaborator({
-     *  owner: 'owner',
-     *  repo:'repo',
-     *  username: 'username'
-     * })
-     * console.log(result)
-    * ```
     */
     delete_collaborator(options: RemoveCollaboratorParamType): Promise<ApiResponseType<RemoveCollaboratorResponseType>>;
     /**
@@ -2722,8 +2852,12 @@ declare class Repo extends GitHubClient {
      * @returns 仓库可见性，
      * @example
      * ```ts
+     * // 公开仓库
      * const visibility = await repo.get_repo_visibility({url: 'https://github.com/CandriaJS/git-neko-kit'})
-     * console.log(visibility) // 输出 public 或 private
+     * -> 'public'
+     * // 私有仓库
+     * const visibility = await repo.get_repo_visibility({url: 'https://github.com/CandriaJS/git-neko-kit'})
+     * -> 'private'
      * ```
      */
     get_repo_visibility(options: GetRepoVisibilityParamType): Promise<GetRepoVisibilityResponseType>;
@@ -2737,7 +2871,7 @@ declare class Repo extends GitHubClient {
      * @example
      * ```ts
      * const defaultBranch = await repo.get_repo_default_branch({owner: CandriaJS, repo: meme-plugin)}
-     * console.log(defaultBranch) // 输出 main
+     * -> 'main'
      * ```ts
      */
     get_repo_default_branch(options: GetRepoDefaultBranchParamType): Promise<GetRepoDefaultBranchResponseType | null>;
@@ -2753,7 +2887,7 @@ declare class Repo extends GitHubClient {
      * @example
      * ```ts
      * const language =  await repo.get_repo_language({url: 'URL_ADDRESS.com/CandriaJS/meme-plugin')}
-     * console.log(language) // 输出 JavaScript
+     * -> 'JavaScript'
      * ```ts
      */
     get_repo_main_language(options: GetRepoMainLanguageParamType): Promise<GetRepoMainLanguageResponseType>;
@@ -2777,7 +2911,7 @@ declare class User extends GitHubClient {
      * @example
      * ```ts
      * const userInfo = await user.get_user_info({ username: 'username' })
-     * console.log(userInfo)
+     * -> 用户信息对象
      * ```
      */
     get_user_info(options: UserInfoParamType): Promise<ApiResponseType<UserInfoResponseType>>;
@@ -2791,7 +2925,7 @@ declare class User extends GitHubClient {
      * @example
      * ```ts
      * const userInfo = await user.get_user_info_by_user_id({ user_id: 123456789 })
-     * console.log(userInfo)
+     * -> 用户信息对象
      * ```
      */
     get_user_info_by_user_id(options: UserInfoByIdParamType): Promise<ApiResponseType<UserInfoResponseType>>;
@@ -2801,7 +2935,7 @@ declare class User extends GitHubClient {
      * @example
      * ```ts
      * const userInfo = await user.get_user_info_by_token()
-     * console.log(userInfo)
+     * -> 用户信息对象
      * ```
      */
     get_user_info_by_auth(): Promise<ApiResponseType<UserInfoResponseType>>;
@@ -2809,10 +2943,6 @@ declare class User extends GitHubClient {
      * 通过访问令牌获取用户信息
      * 权限：无需任何权限
      * @deprecated 该方法已过时，请使用get_user_info_by_auth方法牌
-     * @example
-     * ```ts
-     * const userInfo = await user.get_user_info_by_token()
-     * console.log(userInfo)
      * ```
      */
     get_user_info_by_token(): Promise<ApiResponseType<UserInfoResponseType>>;
@@ -2825,7 +2955,14 @@ declare class User extends GitHubClient {
      * @example
      * ```ts
      * const contribution = await user.get_user_contribution({ username: 'username' })
-     * console.log(contribution)
+     * ->
+     * {
+     * success: true,
+     * status: 'ok',
+     * statusCode: 200,
+     * msg: '请求成功',
+     * data: { total: 5, contributions: [[{ date: '2023-04-16', count: 5 }]] }
+     * }
      * ```
      */
     get_user_contribution(options: UserNameParamType): Promise<ApiResponseType<ContributionResult>>;
@@ -2837,9 +2974,9 @@ declare class User extends GitHubClient {
      * @example
      * ```ts
      * const userId = await user.get_user_id()
-     * console.log(userId)
+     * -> 114514
      */
-    get_user_id(): Promise<number | null>;
+    get_user_id(): Promise<number>;
     /**
      * 快速获取获取用户名
      * 权限：无需任何权限
@@ -2848,20 +2985,19 @@ declare class User extends GitHubClient {
      * @example
      * ```ts
      * const username = await user.get_username()
-     * console.log(username)
+     * -> 'loli'
      * ```
      */
-    get_username(): Promise<string | null>;
+    get_username(): Promise<string>;
     /**
      * 快速获取获取用户昵称
      * 该方法会自动获取当前用户的昵称，需要传入token
      * 权限：无需任何权限
-     * @remarks 用户昵称可能会为null
      * @returns 昵称
      * @example
      * ```ts
      * const nickname = await user.get_nickname()
-     * console.log(nickname)
+     * -> 'loli'
      * ```
      */
     get_nickname(): Promise<string | null>;
@@ -2873,7 +3009,7 @@ declare class User extends GitHubClient {
      * @example
      * ```ts
      * const email = await user.get_email()
-     * console.log(email)
+     * -> '114514@gmail.com'
      * ```
      */
     get_user_email(): Promise<string | null>;
@@ -2885,7 +3021,7 @@ declare class User extends GitHubClient {
      * @example
      * ```ts
      * const avatarUrl = await user.get_avatar_url()
-     * console.log(avatarUrl)
+     * -> 'https://avatars.githubusercontent.com/u/12345678?v=4'
      * ```
      */
     get_avatar_url(): Promise<string>;
@@ -2903,7 +3039,6 @@ declare class WebHook extends GitHubClient {
      * 检查WebHook签名是否正确
      * 权限：无需任何权限
      * @param options - WebHook参数对象，必须包含以下参数：
-     * - secret: WebHook的密钥, 可以从Base类入口传递
      * - payload: 要验证的签名主体
      * - signature: 要验证的签名
      * @returns 验证结果
@@ -2914,6 +3049,16 @@ declare class WebHook extends GitHubClient {
      *   payload: 'your_payload',
      *   signature: 'your_signature'
      * })
+     * ->
+     * {
+     *   success: true,
+     *   status: 'ok',
+     *   msg: '请求成功'
+     *   data: {
+     *     success: true,
+     *     info: '验证成功'
+     *   }
+     * }
      * ```
      */
     check_webhook_signature(options: WebHookSignatureParamType): Promise<ApiResponseType<WebHookSignatureResponseType>>;
@@ -3081,6 +3226,11 @@ declare class GitHubClient {
      * @param options.APP_ID GitHub App ID
      * @param options.Private_Key 私钥内容
      * @returns 返回生成的 JWT
+     * @example
+     * ```ts
+     * const jwt = await client.generate_jwt()
+     * -> 'eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2MjYxNjEyMjAsImlhdCI6MTYyNjE2MTIyMCwiaXNzIjoiMTIzNDU2Nzg5In0.XxXxXxXxXx
+     * ```
      */
     private generate_jwt;
     /**
@@ -3155,9 +3305,15 @@ declare class App extends GitHubClient {
     /**
      * 获取应用基本信息
      * 权限：
-     * - `none` 此节点仅App Client可用
+     * - `none` 无
      * @param options - 应用标识符
      * @returns 应用基本信息
+     * @example
+     * ```ts
+     * const app = base.get_app()
+     * console.log(app.get_app_info({ app_slug: 'loli' }))
+     * -> app的信息
+     * ```
      */
     get_app_info(options: AppInfoParamType): Promise<ApiResponseType<AppInfoResponseType>>;
     /**
@@ -3168,10 +3324,11 @@ declare class App extends GitHubClient {
      * @example
      * ```ts
      * const app = base.get_app()
-     * console.log(app.get_app_info_by_auth()) // 输出App信息
+     * console.log(app.get_app_info_by_auth())
+     * -> app的信息
      * ```
      */
-    private get_app_info_by_auth;
+    get_app_info_by_auth(): Promise<ApiResponseType<AppInfoResponseType>>;
     /**
      * 获取仓库的应用安装信息
      * 权限：
@@ -3179,22 +3336,66 @@ declare class App extends GitHubClient {
      * @param options - 仓库安装应用参数对象
      * - owner 拥有者
      * - repo 仓库名
-     * - url 仓库地址
-     * ownwe和repo与url只能二选一
      * @returns 返回应用安装信息
      * @example
      * ```ts
-     * const app = base.get_app()
-     * console.log(app.get_app_installation_by_repo({owner: 'owner', repo: 'repo'})) // 输出仓库的应用信息
+     * console.log(app.get_app_installation_by_repo({owner: 'owner', repo: 'repo'}))
+     * -> 仓库安装应用信息
+     * ```
+     */
+    get_app_installation_by_repo(options: GetAppInfoByRepoParamType): Promise<ApiResponseType<GetAppInfoByRepoResponseType>>;
+    /**
+     * 获取用户的应用安装信息
+     * 权限：
+     * - `none` 此节点仅App Client可用
+     * @param options - 仓库安装应用参数对象
+     * - owner 拥有者
+     * - repo 仓库名
+     * @returns 返回应用安装信息
+     * @example
+     * ```ts
+     * console.log(app.get_app_installation_by_repo({owner: 'owner', repo: 'repo'}))
+     * -> 用户安装应用信息
+     * ```
+     */
+    get_app_installation_by_user(options: GetAppInfoByUserParamType): Promise<ApiResponseType<GetAppInfoByUserResponseType>>;
+    /**
+     * 获取组织的应用安装信息
+     * 权限：
+     * - `none` 此节点仅App Client可用
+     * @param options - 仓库安装应用参数对象
+     * - owner 拥有者
+     * - repo 仓库名
+     * @returns 返回应用安装信息
+     * @example
+     * ```ts
+     * console.log(app.get_app_installation_by_repo({owner: 'owner', repo: 'repo'}))
+     * -> 组织安装应用信息
+     * ```
+     */
+    get_app_installation_by_org(options: GetAppInfoByOrgParamType): Promise<ApiResponseType<GetAppInfoByOrgResponseType>>;
+    /**
+     * 为应用程序创建访问令牌
+     * @param options
+     * - installation_id - 安装 ID
+     * @returns 创建访问令牌对象
+     * @example
+     * ```ts
+     * const accessToken = await app.create_access_token_for_app({ installation_id: 123456 })
+     * -> 创建访问令牌对象
      * ```
      */
-    get_app_installation_by_repo(options: RepoInfoParamType): Promise<ApiResponseType<AppRepoInfoResponseType>>;
+    create_access_token_for_app(options: CreateAccessTokenForAppParamType): Promise<ApiResponseType<CreateAccessTokenForAppResponseType>>;
+    revoke_access_token_for_app(): Promise<ApiResponseType<RevokeAccessTokenResponseType>>;
     /**
      * 生成Github App 安装链接
      * @param state_id - 随机生成的 state_id，用于验证授权请求的状态，可选，默认不使用
-     * @returns 返回安装链接对象
-     * @returns state_id 随机生成的字符串，用于验证
      * @returns install_link 安装链接，用于跳转 Github 安装页
+     * @example
+     * ```ts
+     * const link = await app.create_install_link('state_id')
+     * -> https://github.com/apps/<app_name>/installations/new?state=<state_id>
+     * ```
      */
     create_install_link(state_id?: string): Promise<string>;
     /**
@@ -3205,7 +3406,7 @@ declare class App extends GitHubClient {
       * @example
       * ```ts
       * const link = await app.create_config_install_link('state_id')
-      * console.log(link) // https://github.com/apps/<app_name>/installations/new?state=<state_id></state_id>
+      * -> // https://github.com/apps/<app_name>/installations/new?state=<state_id></state_id>
       * ```
       */
     create_config_install_link(state_id?: string): Promise<string>;
@@ -3214,8 +3415,8 @@ declare class App extends GitHubClient {
      * @returns 返回 Github App 名称
      * @example
      * ```ts
-     * const app = base.get_app()
-     * console.log(app.get_app_name()) // 输出AppName
+     * console.log(app.get_app_name())
+     * ->  输出AppName
      * ```
      */
     get_app_name(): Promise<string>;
@@ -3227,9 +3428,12 @@ declare class App extends GitHubClient {
      * @returns 是否安装
      * @example
      * ```ts
+     * // 当前App已安装在此仓库
+     * const isInstalled = await app.is_app_inttalled_in_repo({ owner: 'owner', repo: 'repo' })
+     * -> true
+     * // 当前App未安装此仓库
      * const isInstalled = await app.is_app_inttalled_in_repo({ owner: 'owner', repo: 'repo' })
-     * console.log(isInstalled) // 输出是否安装
-     * ·
+     * -> false
      */
     is_app_installed_in_repo(options: RepoBaseParamType): Promise<boolean>;
 }
@@ -3264,4 +3468,4 @@ declare class Client {
     constructor(options: ClientType);
 }
 
-export { type AccessCodeType, type AccessTokenClentTYpe, type AccessTokenType, type AddCollaboratorResponseType, type AddMemberParamType, type AddMemberResponseType, type AddSubIssueParamType, type AddSubIssueResponseType, type ApiResponseType, type AppClientType, type AppInfoParamType, type AppInfoResponseType, type AppPermissions, type AppRepoInfoResponseType, type AppUser, type CheckTokenResponseType, Client, type ClientType, type CloseIssueParamType, type CloseIssueResponseType, type CollaboratorInfoResponseType, type CollaboratorParamType, type CollaboratorPermissionType, type CommentIdParamType, type Commit$1 as Commit, type CommitInfoCommonParamType, type CommitInfoParamType, type CommitInfoResponseType, type CommitListParamType, type CommitListResponseType, type CommitStats, type CommonProxyType, type ContributionData, type ContributionResult, type CreateIssueResponseType, type CreatePullRequestCommentParamType, type CreatePullRequestCommentResponseType, type CreatePullRequestParamType, type CreatePullRequestResponseType, type CreateReleaseParamType, type CreateReleaseResponseType, type CreteIssueCommentParamType, type CreteIssueCommentResponseType, type CreteIssueParamType, type DeletePullRequestCommentParamType, type DeletePullRequestCommentResponseType, type DeleteReleaseParamType, type DeleteReleaseResponseType, type DiffEntry, type ExecOptions, type ExecReturn, type ExecType, type GetCollaboratorListParamType, type GetCollaboratorListResponseType, type GetPullRequestCommentInfoParamType, type GetPullRequestCommentInfoResponseType, type GetPullRequestCommentsListParamType, type GetPullRequestCommentsListResponseType, type GetPullRequestFilesListParamType, type GetPullRequestFilesListResponseType, type GetRepoDefaultBranchParamType, type GetRepoDefaultBranchResponseType, type GetRepoMainLanguageParamType, type GetRepoMainLanguageResponseType, type GetRepoVisibilityParamType, type GetRepoVisibilityResponseType, type GitHubBaseClient, GitHubClient, type GitHubClientType, type GitType, type GitUser, type HttpProxyType, type HttpsProxyType, type IssueCommentInfoParamType, type IssueCommentInfoResponseType, type IssueCommentListParamType, type IssueCommentListResponseType, type IssueInfoParamType, type IssueInfoResponseType, type IssueLabelType, type IssueListResponseType, type IssueNumberParamType, type IssueUser, type LanguageInfo, type LockIssueParamType, type LockIssueResponseType, type MergeMethodType, type MergePullRequestParamType, type MergePullRequestResponseType, type MilestoneType, type OpenIssueParamType, type OpenIssueResponseType, type OrgInfoParamType, type OrgInfoResponseType, type OrgNameParamType, type OrgRepoCreateParamType, type OrgRepoCreateResponseType, type OrgRepoListParmType, type OrgRepoListResponseType, type ParentCommit, type PkgInfoType, type PrRepo, type PrUser, type ProxyParamsType, type ProxyType, type ProxyUrlType, type PullRequestFilesListType, type PullRequestInfoParamType, type PullRequestInfoResponseType, type PullRequestListParamType, type PullRequestListResponseType, type PullRequestNumberParamType, type ReactionInfoType, type RefreshTokenResponseType, type RefreshTokenType, type ReleaseAssetsType, type ReleaseInfoByTagParamType, type ReleaseInfoByTagResponseType, type ReleaseInfoParamType, type ReleaseInfoResponseType, type ReleaseLatestParamTypeType, type ReleaseLatestResponseType, type ReleaseListParamType, type ReleaseListResponseType, type ReleaseUser, type RemoveCollaboratorParamType, type RemoveCollaboratorResponseType, type RemoveIssueCommentParamType, type RemoveIssueCommentResponseType, type RemoveSubIssueParamType, type RemoveSubIssueResponseType, type RepoBaseParamType, type RepoCommentListParamType, type RepoCommentListResponseType, type RepoInfoParamType, type RepoInfoResponseType, type RepoIssueListParamType, type RepoLanguagesListParamType, type RepoLanguagesListResponseType, type RepoListBaseParamType, type RepoNameParamType, type RepoOwnerParamType, type RepoParamType, type RepoUrlParamType, type RepoUser, type ReprioritizeSubIssueParamType, type ReprioritizeSubIssueResponseType, type RequestConfigType, type RequestTokenType, type ResponseHeadersType, type ResponseMsgType, type ResponseStatusCodeType, type ResponseSuccessType, type ResponseType, type ReverseProxyType, type ShaParamType, type Socks5ProxyType, type SocksProxyType, type SubIssueListParamType, type SubIssueListResponseType, type TokenResponseType, type UnLockIssueParamType, type UnLockIssueResponseType, type UpdateIssueCommentParamType, type UpdateIssueCommentResponseType, type UpdateIssueParamType, type UpdateIssueResponseType, type UpdatePullRequestCommentParamType, type UpdatePullRequestCommentResponseType, type UpdatePullRequestParamType, type UpdatePullRequestResponseType, type UpdateReleaseParamType, type UpdateReleaseResponseType, type UserByTokenRepoListParamType, type UserIdParamType, type UserInfoByAuthParamType, type UserInfoByIdParamType, type UserInfoParamType, type UserInfoResponseType, type UserNameParamType, type UserRepoCreateParamType, type UserRepoCreateResponseType, type UserRepoListParamType, type UserRepoListType, type WebHookSignatureParamType, type WebHookSignatureResponseType, create_state_id, Client as default, formatDate, type formatParamType, get_langage_color, get_local_repo_default_branch, get_relative_time, get_remote_repo_default_branch, index as github };
+export { type AccessCodeType, type AccessTokenClentTYpe, type AccessTokenPermissionsType, type AccessTokenType, type AddCollaboratorResponseType, type AddMemberParamType, type AddMemberResponseType, type ApiResponseType, type AppClientType, type AppInfoParamType, type AppInfoResponseType, type AppPermissions, type AppRepoInfoResponseType, type AppUser, type CheckTokenResponseType, Client, type ClientType, type CloseIssueParamType, type CloseIssueResponseType, type CollaboratorInfoResponseType, type CollaboratorParamType, type CollaboratorPermissionType, type CommentIdParamType, type Commit$1 as Commit, type CommitInfoCommonParamType, type CommitInfoParamType, type CommitInfoResponseType, type CommitListParamType, type CommitListResponseType, type CommitStats, type CommonProxyType, type ContributionData, type ContributionResult, type CreateAccessTokenForAppParamType, type CreateAccessTokenForAppResponseType, type CreateIssueResponseType, type CreatePullRequestCommentParamType, type CreatePullRequestCommentResponseType, type CreatePullRequestParamType, type CreatePullRequestResponseType, type CreateReleaseParamType, type CreateReleaseResponseType, type CreateSubIssueParamType, type CreateSubIssueResponseType, type CreteIssueCommentParamType, type CreteIssueCommentResponseType, type CreteIssueParamType, type DeletePullRequestCommentParamType, type DeletePullRequestCommentResponseType, type DeleteReleaseParamType, type DeleteReleaseResponseType, type DiffEntry, type ExecOptions, type ExecReturn, type ExecType, type GetAppInfoByOrgParamType, type GetAppInfoByOrgResponseType, type GetAppInfoByRepoParamType, type GetAppInfoByRepoResponseType, type GetAppInfoByUserParamType, type GetAppInfoByUserResponseType, type GetCollaboratorListParamType, type GetCollaboratorListResponseType, type GetPullRequestCommentInfoParamType, type GetPullRequestCommentInfoResponseType, type GetPullRequestCommentsListParamType, type GetPullRequestCommentsListResponseType, type GetPullRequestFilesListParamType, type GetPullRequestFilesListResponseType, type GetRepoDefaultBranchParamType, type GetRepoDefaultBranchResponseType, type GetRepoMainLanguageParamType, type GetRepoMainLanguageResponseType, type GetRepoVisibilityParamType, type GetRepoVisibilityResponseType, type GitHubBaseClient, GitHubClient, type GitHubClientType, type GitType, type GitUser, type HttpProxyType, type HttpsProxyType, type IssueCommentInfoParamType, type IssueCommentInfoResponseType, type IssueCommentListParamType, type IssueCommentListResponseType, type IssueInfoParamType, type IssueInfoResponseType, type IssueLabelType, type IssueListResponseType, type IssueNumberParamType, type IssueUser, type LanguageInfo, type LockIssueParamType, type LockIssueResponseType, type MergeMethodType, type MergePullRequestParamType, type MergePullRequestResponseType, type MilestoneType, type OpenIssueParamType, type OpenIssueResponseType, type OrgInfoParamType, type OrgInfoResponseType, type OrgNameParamType, type OrgRepoCreateParamType, type OrgRepoCreateResponseType, type OrgRepoListParmType, type OrgRepoListResponseType, type ParentCommit, type PkgInfoType, type PrRepo, type PrUser, type ProxyParamsType, type ProxyType, type ProxyUrlType, type PullRequestFilesListType, type PullRequestInfoParamType, type PullRequestInfoResponseType, type PullRequestListParamType, type PullRequestListResponseType, type PullRequestNumberParamType, type ReactionInfoType, type RefreshTokenResponseType, type RefreshTokenType, type ReleaseAssetsType, type ReleaseInfoByTagParamType, type ReleaseInfoByTagResponseType, type ReleaseInfoParamType, type ReleaseInfoResponseType, type ReleaseLatestParamTypeType, type ReleaseLatestResponseType, type ReleaseListParamType, type ReleaseListResponseType, type ReleaseUser, type RemoveCollaboratorParamType, type RemoveCollaboratorResponseType, type RemoveIssueCommentParamType, type RemoveIssueCommentResponseType, type RemoveSubIssueParamType, type RemoveSubIssueResponseType, type RepoBaseParamType, type RepoCommentListParamType, type RepoCommentListResponseType, type RepoInfoParamType, type RepoInfoResponseType, type RepoIssueListParamType, type RepoLanguagesListParamType, type RepoLanguagesListResponseType, type RepoListBaseParamType, type RepoNameParamType, type RepoOwnerParamType, type RepoParamType, type RepoUrlParamType, type RepoUser, type ReprioritizeSubIssueParamType, type ReprioritizeSubIssueResponseType, type RequestConfigType, type RequestTokenType, type ResponseHeadersType, type ResponseMsgType, type ResponseStatusCodeType, type ResponseSuccessType, type ResponseType, type ReverseProxyType, type RevokeAccessTokenResponseType, type ShaParamType, type Socks5ProxyType, type SocksProxyType, type SubIssueListParamType, type SubIssueListResponseType, type TokenResponseType, type UnLockIssueParamType, type UnLockIssueResponseType, type UpdateIssueCommentParamType, type UpdateIssueCommentResponseType, type UpdateIssueParamType, type UpdateIssueResponseType, type UpdatePullRequestCommentParamType, type UpdatePullRequestCommentResponseType, type UpdatePullRequestParamType, type UpdatePullRequestResponseType, type UpdateReleaseParamType, type UpdateReleaseResponseType, type UserByTokenRepoListParamType, type UserIdParamType, type UserInfoByIdParamType, type UserInfoParamType, type UserInfoResponseType, type UserNameParamType, type UserRepoCreateParamType, type UserRepoCreateResponseType, type UserRepoListParamType, type UserRepoListType, type WebHookSignatureParamType, type WebHookSignatureResponseType, create_state_id, Client as default, type formatParamType, format_date, get_langage_color, get_local_repo_default_branch, get_relative_time, get_remote_repo_default_branch, index as github };