@octokit/rest/index.js.flow

GitHub REST API client for Node.js

declare module "github" {
  declare type Header = string;

  declare type EmptyParams = {};

  declare type Options = {
    timeout?: number,
    host?: string,
    pathPrefix?: string,
    protocol?: string,
    port?: number,
    proxy?: string,
    ca?: string,
    headers?: { [header: Header]: any },
    rejectUnauthorized?: boolean,
    family?: number
  };

  declare type AuthBasic = {
    type: "basic",
    username: string,
    password: string
  };

  declare type AuthOAuthToken = {
    type: "oauth",
    token: string
  };

  declare type AuthOAuthSecret = {
    type: "oauth",
    key: string,
    secret: string
  };

  declare type AuthUserToken = {
    type: "token",
    token: string
  };

  declare type AuthJWT = {
    type: "integration",
    token: string
  };

  /* @deprecated Use "app" instead of "integration */
  declare type AuthDeprecatedJWT = {
    type: "integration",
    token: string
  };

  declare type Auth =
    | AuthBasic
    | AuthOAuthToken
    | AuthOAuthSecret
    | AuthUserToken
    | AuthJWT
    | AuthDeprecatedJWT;

  declare type Link =
    | { link: string }
    | { headers: { link: string } }
    | string
    | any;

  declare type Callback = (error: ?Error, result: ?any) => any;

  declare type ActivityCheckStarringRepoParams = {
    owner: string,
    repo: string
  };
  declare type ActivityDeleteRepoSubscriptionParams = {
    owner: string,
    repo: string
  };
  declare type ActivityDeleteThreadSubscriptionParams = {
    thread_id: number
  };
  declare type ActivityGetRepoSubscriptionParams = {
    owner: string,
    repo: string
  };
  declare type ActivityGetThreadParams = {
    thread_id: number
  };
  declare type ActivityGetThreadSubscriptionParams = {
    thread_id: number
  };
  declare type ActivityListEventsForOrgParams = {
    username: string,
    org: string,
    per_page?: number,
    page?: number
  };
  declare type ActivityListEventsForUserParams = {
    username: string,
    per_page?: number,
    page?: number
  };
  declare type ActivityListNotificationsParams = {
    all?: boolean,
    participating?: boolean,
    since?: string,
    before?: string,
    per_page?: number,
    page?: number
  };
  declare type ActivityListNotificationsForRepoParams = {
    owner: string,
    repo: string,
    all?: boolean,
    participating?: boolean,
    since?: string,
    before?: string,
    per_page?: number,
    page?: number
  };
  declare type ActivityListPublicEventsParams = {
    per_page?: number,
    page?: number
  };
  declare type ActivityListPublicEventsForOrgParams = {
    org: string,
    per_page?: number,
    page?: number
  };
  declare type ActivityListPublicEventsForRepoNetworkParams = {
    owner: string,
    repo: string,
    per_page?: number,
    page?: number
  };
  declare type ActivityListPublicEventsForUserParams = {
    username: string,
    per_page?: number,
    page?: number
  };
  declare type ActivityListReceivedEventsForUserParams = {
    username: string,
    per_page?: number,
    page?: number
  };
  declare type ActivityListReceivedPublicEventsForUserParams = {
    username: string,
    per_page?: number,
    page?: number
  };
  declare type ActivityListRepoEventsParams = {
    owner: string,
    repo: string,
    per_page?: number,
    page?: number
  };
  declare type ActivityListReposStarredByAuthenticatedUserParams = {
    sort?: "created" | "updated",
    direction?: "asc" | "desc",
    per_page?: number,
    page?: number
  };
  declare type ActivityListReposStarredByUserParams = {
    username: string,
    sort?: "created" | "updated",
    direction?: "asc" | "desc",
    per_page?: number,
    page?: number
  };
  declare type ActivityListReposWatchedByUserParams = {
    username: string,
    per_page?: number,
    page?: number
  };
  declare type ActivityListStargazersForRepoParams = {
    owner: string,
    repo: string,
    per_page?: number,
    page?: number
  };
  declare type ActivityListWatchedReposForAuthenticatedUserParams = {
    per_page?: number,
    page?: number
  };
  declare type ActivityListWatchersForRepoParams = {
    owner: string,
    repo: string,
    per_page?: number,
    page?: number
  };
  declare type ActivityMarkAsReadParams = {
    last_read_at?: string
  };
  declare type ActivityMarkNotificationsAsReadForRepoParams = {
    owner: string,
    repo: string,
    last_read_at?: string
  };
  declare type ActivityMarkThreadAsReadParams = {
    thread_id: number
  };
  declare type ActivitySetRepoSubscriptionParams = {
    owner: string,
    repo: string,
    subscribed?: boolean,
    ignored?: boolean
  };
  declare type ActivitySetThreadSubscriptionParams = {
    thread_id: number,
    ignored?: boolean
  };
  declare type ActivityStarRepoParams = {
    owner: string,
    repo: string
  };
  declare type ActivityUnstarRepoParams = {
    owner: string,
    repo: string
  };
  declare type AppsAddRepoToInstallationParams = {
    installation_id: number,
    repository_id: number
  };
  declare type AppsCheckAccountIsAssociatedWithAnyParams = {
    account_id: number,
    per_page?: number,
    page?: number
  };
  declare type AppsCheckAccountIsAssociatedWithAnyStubbedParams = {
    account_id: number,
    per_page?: number,
    page?: number
  };
  declare type AppsCreateFromManifestParams = {
    code: string
  };
  declare type AppsCreateInstallationTokenParams = {
    installation_id: number
  };
  declare type AppsFindOrgInstallationParams = {
    org: string
  };
  declare type AppsFindRepoInstallationParams = {
    owner: string,
    repo: string
  };
  declare type AppsFindUserInstallationParams = {
    username: string
  };
  declare type AppsGetBySlugParams = {
    app_slug: string
  };
  declare type AppsGetInstallationParams = {
    installation_id: number
  };
  declare type AppsListAccountsUserOrOrgOnPlanParams = {
    plan_id: number,
    sort?: "created" | "updated",
    direction?: "asc" | "desc",
    per_page?: number,
    page?: number
  };
  declare type AppsListAccountsUserOrOrgOnPlanStubbedParams = {
    plan_id: number,
    sort?: "created" | "updated",
    direction?: "asc" | "desc",
    per_page?: number,
    page?: number
  };
  declare type AppsListInstallationReposForAuthenticatedUserParams = {
    installation_id: number,
    per_page?: number,
    page?: number
  };
  declare type AppsListInstallationsParams = {
    per_page?: number,
    page?: number
  };
  declare type AppsListInstallationsForAuthenticatedUserParams = {
    per_page?: number,
    page?: number
  };
  declare type AppsListMarketplacePurchasesForAuthenticatedUserParams = {
    per_page?: number,
    page?: number
  };
  declare type AppsListMarketplacePurchasesForAuthenticatedUserStubbedParams = {
    per_page?: number,
    page?: number
  };
  declare type AppsListPlansParams = {
    per_page?: number,
    page?: number
  };
  declare type AppsListPlansStubbedParams = {
    per_page?: number,
    page?: number
  };
  declare type AppsListReposParams = {
    per_page?: number,
    page?: number
  };
  declare type AppsRemoveRepoFromInstallationParams = {
    installation_id: number,
    repository_id: number
  };
  declare type AuthorizationCheckAuthorizationParams = {
    client_id: string,
    access_token: string
  };
  declare type AuthorizationCreateAuthorizationParams = {
    scopes?: string[],
    note: string,
    note_url?: string,
    client_id?: string,
    client_secret?: string,
    fingerprint?: string
  };
  declare type AuthorizationDeleteAuthorizationParams = {
    authorization_id: number
  };
  declare type AuthorizationDeleteGrantParams = {
    grant_id: number
  };
  declare type AuthorizationGetAuthorizationParams = {
    authorization_id: number
  };
  declare type AuthorizationGetGrantParams = {
    grant_id: number
  };
  declare type AuthorizationGetOrCreateAuthorizationForAppParams = {
    client_id: string,
    client_secret: string,
    scopes?: string[],
    note?: string,
    note_url?: string,
    fingerprint?: string
  };
  declare type AuthorizationGetOrCreateAuthorizationForAppFingerprintParams = {
    client_id: string,
    fingerprint: string,
    client_secret: string,
    scopes?: string[],
    note?: string,
    note_url?: string
  };
  declare type AuthorizationListAuthorizationsParams = {
    per_page?: number,
    page?: number
  };
  declare type AuthorizationListGrantsParams = {
    per_page?: number,
    page?: number
  };
  declare type AuthorizationResetAuthorizationParams = {
    client_id: string,
    access_token: string
  };
  declare type AuthorizationRevokeAuthorizationForApplicationParams = {
    client_id: string,
    access_token: string
  };
  declare type AuthorizationRevokeGrantForApplicationParams = {
    client_id: string,
    access_token: string
  };
  declare type AuthorizationUpdateAuthorizationParams = {
    authorization_id: number,
    scopes?: string[],
    add_scopes?: string[],
    remove_scopes?: string[],
    note?: string,
    note_url?: string,
    fingerprint?: string
  };
  declare type ChecksCreateParams = {
    owner: string,
    repo: string,
    name: string,
    head_sha: string,
    details_url?: string,
    external_id?: string,
    status?: "queued" | "in_progress" | "completed",
    started_at?: string,
    conclusion?:
      | "success"
      | "failure"
      | "neutral"
      | "cancelled"
      | "timed_out"
      | "action_required",
    completed_at?: string,
    output?: ChecksCreateParamsOutput,
    actions?: ChecksCreateParamsActions[]
  };
  declare type ChecksCreateSuiteParams = {
    owner: string,
    repo: string,
    head_sha: string
  };
  declare type ChecksGetParams = {
    owner: string,
    repo: string,
    check_run_id: number
  };
  declare type ChecksGetSuiteParams = {
    owner: string,
    repo: string,
    check_suite_id: number
  };
  declare type ChecksListAnnotationsParams = {
    owner: string,
    repo: string,
    check_run_id: number,
    per_page?: number,
    page?: number
  };
  declare type ChecksListForRefParams = {
    owner: string,
    repo: string,
    ref: string,
    check_name?: string,
    status?: "queued" | "in_progress" | "completed",
    filter?: "latest" | "all",
    per_page?: number,
    page?: number
  };
  declare type ChecksListForSuiteParams = {
    owner: string,
    repo: string,
    check_suite_id: number,
    check_name?: string,
    status?: "queued" | "in_progress" | "completed",
    filter?: "latest" | "all",
    per_page?: number,
    page?: number
  };
  declare type ChecksListSuitesForRefParams = {
    owner: string,
    repo: string,
    ref: string,
    app_id?: number,
    check_name?: string,
    per_page?: number,
    page?: number
  };
  declare type ChecksRerequestSuiteParams = {
    owner: string,
    repo: string,
    check_suite_id: number
  };
  declare type ChecksSetSuitesPreferencesParams = {
    owner: string,
    repo: string,
    auto_trigger_checks?: ChecksSetSuitesPreferencesParamsAutoTriggerChecks[]
  };
  declare type ChecksUpdateParams = {
    owner: string,
    repo: string,
    check_run_id: number,
    name?: string,
    details_url?: string,
    external_id?: string,
    started_at?: string,
    status?: "queued" | "in_progress" | "completed",
    conclusion?:
      | "success"
      | "failure"
      | "neutral"
      | "cancelled"
      | "timed_out"
      | "action_required",
    completed_at?: string,
    output?: ChecksUpdateParamsOutput,
    actions?: ChecksUpdateParamsActions[]
  };
  declare type CodesOfConductGetConductCodeParams = {
    key: string
  };
  declare type CodesOfConductGetForRepoParams = {
    owner: string,
    repo: string
  };
  declare type GistsCheckIsStarredParams = {
    gist_id: string
  };
  declare type GistsCreateParams = {
    files: GistsCreateParamsFiles,
    description?: string,
    public?: boolean
  };
  declare type GistsCreateCommentParams = {
    gist_id: string,
    body: string
  };
  declare type GistsDeleteParams = {
    gist_id: string
  };
  declare type GistsDeleteCommentParams = {
    gist_id: string,
    comment_id: number
  };
  declare type GistsForkParams = {
    gist_id: string
  };
  declare type GistsGetParams = {
    gist_id: string
  };
  declare type GistsGetCommentParams = {
    gist_id: string,
    comment_id: number
  };
  declare type GistsGetRevisionParams = {
    gist_id: string,
    sha: string
  };
  declare type GistsListParams = {
    since?: string,
    per_page?: number,
    page?: number
  };
  declare type GistsListCommentsParams = {
    gist_id: string,
    per_page?: number,
    page?: number
  };
  declare type GistsListCommitsParams = {
    gist_id: string,
    per_page?: number,
    page?: number
  };
  declare type GistsListForksParams = {
    gist_id: string,
    per_page?: number,
    page?: number
  };
  declare type GistsListPublicParams = {
    since?: string,
    per_page?: number,
    page?: number
  };
  declare type GistsListPublicForUserParams = {
    username: string,
    since?: string,
    per_page?: number,
    page?: number
  };
  declare type GistsListStarredParams = {
    since?: string,
    per_page?: number,
    page?: number
  };
  declare type GistsStarParams = {
    gist_id: string
  };
  declare type GistsUnstarParams = {
    gist_id: string
  };
  declare type GistsUpdateParams = {
    gist_id: string,
    description?: string,
    files?: GistsUpdateParamsFiles
  };
  declare type GistsUpdateCommentParams = {
    gist_id: string,
    comment_id: number,
    body: string
  };
  declare type GitdataCreateBlobParams = {
    owner: string,
    repo: string,
    content: string,
    encoding?: string
  };
  declare type GitdataCreateCommitParams = {
    owner: string,
    repo: string,
    message: string,
    tree: string,
    parents: string[],
    committer?: GitdataCreateCommitParamsCommitter,
    author?: GitdataCreateCommitParamsAuthor
  };
  declare type GitdataCreateRefParams = {
    owner: string,
    repo: string,
    ref: string,
    sha: string
  };
  declare type GitdataCreateTagParams = {
    owner: string,
    repo: string,
    tag: string,
    message: string,
    object: string,
    type: "commit" | "tree" | "blob",
    tagger?: GitdataCreateTagParamsTagger
  };
  declare type GitdataCreateTreeParams = {
    owner: string,
    repo: string,
    tree: GitdataCreateTreeParamsTree[],
    base_tree?: string
  };
  declare type GitdataDeleteRefParams = {
    owner: string,
    repo: string,
    ref: string
  };
  declare type GitdataGetBlobParams = {
    owner: string,
    repo: string,
    file_sha: string
  };
  declare type GitdataGetCommitParams = {
    owner: string,
    repo: string,
    commit_sha: string
  };
  declare type GitdataGetRefParams = {
    owner: string,
    repo: string,
    ref: string
  };
  declare type GitdataGetTagParams = {
    owner: string,
    repo: string,
    tag_sha: string
  };
  declare type GitdataGetTreeParams = {
    owner: string,
    repo: string,
    tree_sha: string,
    recursive?: 1
  };
  declare type GitdataListRefsParams = {
    owner: string,
    repo: string,
    namespace?: string,
    per_page?: number,
    page?: number
  };
  declare type GitdataUpdateRefParams = {
    owner: string,
    repo: string,
    ref: string,
    sha: string,
    force?: boolean
  };
  declare type GitignoreGetTemplateParams = {
    name: string
  };
  declare type IssuesAddAssigneesParams = {
    owner: string,
    repo: string,
    number: number,
    assignees?: string[]
  };
  declare type IssuesAddLabelsParams = {
    owner: string,
    repo: string,
    number: number,
    labels: string[]
  };
  declare type IssuesCheckAssigneeParams = {
    owner: string,
    repo: string,
    assignee: string
  };
  declare type IssuesCreateParams = {
    owner: string,
    repo: string,
    title: string,
    body?: string,
    assignee?: string,
    milestone?: number,
    labels?: string[],
    assignees?: string[]
  };
  declare type IssuesCreateCommentParams = {
    owner: string,
    repo: string,
    number: number,
    body: string
  };
  declare type IssuesCreateLabelParams = {
    owner: string,
    repo: string,
    name: string,
    color: string,
    description?: string
  };
  declare type IssuesCreateMilestoneParams = {
    owner: string,
    repo: string,
    title: string,
    state?: "open" | "closed",
    description?: string,
    due_on?: string
  };
  declare type IssuesDeleteCommentParams = {
    owner: string,
    repo: string,
    comment_id: number
  };
  declare type IssuesDeleteLabelParams = {
    owner: string,
    repo: string,
    name: string
  };
  declare type IssuesDeleteMilestoneParams = {
    owner: string,
    repo: string,
    number: number
  };
  declare type IssuesGetParams = {
    owner: string,
    repo: string,
    number: number
  };
  declare type IssuesGetCommentParams = {
    owner: string,
    repo: string,
    comment_id: number,
    per_page?: number,
    page?: number
  };
  declare type IssuesGetEventParams = {
    owner: string,
    repo: string,
    event_id: number
  };
  declare type IssuesGetLabelParams = {
    owner: string,
    repo: string,
    name: string
  };
  declare type IssuesGetMilestoneParams = {
    owner: string,
    repo: string,
    number: number
  };
  declare type IssuesListParams = {
    filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all",
    state?: "open" | "closed" | "all",
    labels?: string,
    sort?: "created" | "updated" | "comments",
    direction?: "asc" | "desc",
    since?: string,
    per_page?: number,
    page?: number
  };
  declare type IssuesListAssigneesParams = {
    owner: string,
    repo: string,
    per_page?: number,
    page?: number
  };
  declare type IssuesListCommentsParams = {
    owner: string,
    repo: string,
    number: number,
    since?: string,
    per_page?: number,
    page?: number
  };
  declare type IssuesListCommentsForRepoParams = {
    owner: string,
    repo: string,
    sort?: "created" | "updated",
    direction?: "asc" | "desc",
    since?: string
  };
  declare type IssuesListEventsParams = {
    owner: string,
    repo: string,
    number: number,
    per_page?: number,
    page?: number
  };
  declare type IssuesListEventsForRepoParams = {
    owner: string,
    repo: string,
    per_page?: number,
    page?: number
  };
  declare type IssuesListEventsForTimelineParams = {
    owner: string,
    repo: string,
    number: number,
    per_page?: number,
    page?: number
  };
  declare type IssuesListForAuthenticatedUserParams = {
    filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all",
    state?: "open" | "closed" | "all",
    labels?: string,
    sort?: "created" | "updated" | "comments",
    direction?: "asc" | "desc",
    since?: string,
    per_page?: number,
    page?: number
  };
  declare type IssuesListForOrgParams = {
    org: string,
    filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all",
    state?: "open" | "closed" | "all",
    labels?: string,
    sort?: "created" | "updated" | "comments",
    direction?: "asc" | "desc",
    since?: string,
    per_page?: number,
    page?: number
  };
  declare type IssuesListForRepoParams = {
    owner: string,
    repo: string,
    milestone?: string,
    state?: "open" | "closed" | "all",
    assignee?: string,
    creator?: string,
    mentioned?: string,
    labels?: string,
    sort?: "created" | "updated" | "comments",
    direction?: "asc" | "desc",
    since?: string,
    per_page?: number,
    page?: number
  };
  declare type IssuesListLabelsForMilestoneParams = {
    owner: string,
    repo: string,
    number: number,
    per_page?: number,
    page?: number
  };
  declare type IssuesListLabelsForRepoParams = {
    owner: string,
    repo: string,
    per_page?: number,
    page?: number
  };
  declare type IssuesListLabelsOnIssueParams = {
    owner: string,
    repo: string,
    number: number,
    per_page?: number,
    page?: number
  };
  declare type IssuesListMilestonesForRepoParams = {
    owner: string,
    repo: string,
    state?: "open" | "closed" | "all",
    sort?: "due_on" | "completeness",
    direction?: "asc" | "desc",
    per_page?: number,
    page?: number
  };
  declare type IssuesLockParams = {
    owner: string,
    repo: string,
    number: number,
    lock_reason?: "off-topic" | "too heated" | "resolved" | "spam"
  };
  declare type IssuesRemoveAssigneesParams = {
    owner: string,
    repo: string,
    number: number,
    assignees?: string[]
  };
  declare type IssuesRemoveLabelParams = {
    owner: string,
    repo: string,
    number: number,
    name: string
  };
  declare type IssuesRemoveLabelsParams = {
    owner: string,
    repo: string,
    number: number
  };
  declare type IssuesReplaceLabelsParams = {
    owner: string,
    repo: string,
    number: number,
    labels?: string[]
  };
  declare type IssuesUnlockParams = {
    owner: string,
    repo: string,
    number: number
  };
  declare type IssuesUpdateParams = {
    owner: string,
    repo: string,
    number: number,
    title?: string,
    body?: string,
    assignee?: string,
    state?: "open" | "closed",
    milestone?: number,
    labels?: string[],
    assignees?: string[]
  };
  declare type IssuesUpdateCommentParams = {
    owner: string,
    repo: string,
    comment_id: number,
    body: string
  };
  declare type IssuesUpdateLabelParams = {
    owner: string,
    repo: string,
    current_name: string,
    name?: string,
    color?: string,
    description?: string
  };
  declare type IssuesUpdateMilestoneParams = {
    owner: string,
    repo: string,
    number: number,
    title?: string,
    state?: "open" | "closed",
    description?: string,
    due_on?: string
  };
  declare type LicensesGetParams = {
    license: string
  };
  declare type LicensesGetForRepoParams = {
    owner: string,
    repo: string
  };
  declare type MarkdownRenderParams = {
    text: string,
    mode?: "markdown" | "gfm",
    context?: string
  };
  declare type MarkdownRenderRawParams = {
    data: string
  };
  declare type MigrationsCancelImportParams = {
    owner: string,
    repo: string
  };
  declare type MigrationsDeleteArchiveForAuthenticatedUserParams = {
    migration_id: number
  };
  declare type MigrationsDeleteArchiveForOrgParams = {
    org: string,
    migration_id: number
  };
  declare type MigrationsGetArchiveForAuthenticatedUserParams = {
    migration_id: number
  };
  declare type MigrationsGetArchiveForOrgParams = {
    org: string,
    migration_id: number
  };
  declare type MigrationsGetCommitAuthorsParams = {
    owner: string,
    repo: string,
    since?: string
  };
  declare type MigrationsGetImportProgressParams = {
    owner: string,
    repo: string
  };
  declare type MigrationsGetLargeFilesParams = {
    owner: string,
    repo: string
  };
  declare type MigrationsGetStatusForAuthenticatedUserParams = {
    migration_id: number
  };
  declare type MigrationsGetStatusForOrgParams = {
    org: string,
    migration_id: number
  };
  declare type MigrationsListForAuthenticatedUserParams = {
    per_page?: number,
    page?: number
  };
  declare type MigrationsListForOrgParams = {
    org: string,
    per_page?: number,
    page?: number
  };
  declare type MigrationsMapCommitAuthorParams = {
    owner: string,
    repo: string,
    author_id: number,
    email?: string,
    name?: string
  };
  declare type MigrationsSetLfsPreferenceParams = {
    owner: string,
    repo: string,
    use_lfs: "opt_in" | "opt_out"
  };
  declare type MigrationsStartForAuthenticatedUserParams = {
    repositories: string[],
    lock_repositories?: boolean,
    exclude_attachments?: boolean
  };
  declare type MigrationsStartForOrgParams = {
    org: string,
    repositories: string[],
    lock_repositories?: boolean,
    exclude_attachments?: boolean
  };
  declare type MigrationsStartImportParams = {
    owner: string,
    repo: string,
    vcs_url: string,
    vcs?: "subversion" | "git" | "mercurial" | "tfvc",
    vcs_username?: string,
    vcs_password?: string,
    tfvc_project?: string
  };
  declare type MigrationsUnlockRepoForAuthenticatedUserParams = {
    migration_id: number,
    repo_name: string
  };
  declare type MigrationsUnlockRepoForOrgParams = {
    org: string,
    migration_id: number,
    repo_name: string
  };
  declare type MigrationsUpdateImportParams = {
    owner: string,
    repo: string,
    vcs_username?: string,
    vcs_password?: string
  };
  declare type OrgsAddOrUpdateMembershipParams = {
    org: string,
    username: string,
    role?: "admin" | "member"
  };
  declare type OrgsBlockUserParams = {
    org: string,
    username: string
  };
  declare type OrgsCheckBlockedUserParams = {
    org: string,
    username: string
  };
  declare type OrgsCheckMembershipParams = {
    org: string,
    username: string
  };
  declare type OrgsCheckPublicMembershipParams = {
    org: string,
    username: string
  };
  declare type OrgsConcealMembershipParams = {
    org: string,
    username: string
  };
  declare type OrgsConvertMemberToOutsideCollaboratorParams = {
    org: string,
    username: string
  };
  declare type OrgsCreateHookParams = {
    org: string,
    name: string,
    config: OrgsCreateHookParamsConfig,
    events?: string[],
    active?: boolean
  };
  declare type OrgsCreateInvitationParams = {
    org: string,
    invitee_id?: number,
    email?: string,
    role?: "admin" | "direct_member" | "billing_manager",
    team_ids?: number[]
  };
  declare type OrgsDeleteHookParams = {
    org: string,
    hook_id: number
  };
  declare type OrgsGetParams = {
    org: string
  };
  declare type OrgsGetHookParams = {
    org: string,
    hook_id: number
  };
  declare type OrgsGetMembershipParams = {
    org: string,
    username: string
  };
  declare type OrgsGetMembershipForAuthenticatedUserParams = {
    org: string
  };
  declare type OrgsListParams = {
    since?: string,
    per_page?: number,
    page?: number
  };
  declare type OrgsListBlockedUsersParams = {
    org: string
  };
  declare type OrgsListForAuthenticatedUserParams = {
    per_page?: number,
    page?: number
  };
  declare type OrgsListForUserParams = {
    username: string,
    per_page?: number,
    page?: number
  };
  declare type OrgsListHooksParams = {
    org: string,
    per_page?: number,
    page?: number
  };
  declare type OrgsListInvitationTeamsParams = {
    org: string,
    invitation_id: number,
    per_page?: number,
    page?: number
  };
  declare type OrgsListMembersParams = {
    org: string,
    filter?: "2fa_disabled" | "all",
    role?: "all" | "admin" | "member",
    per_page?: number,
    page?: number
  };
  declare type OrgsListMembershipsParams = {
    state?: "active" | "pending",
    per_page?: number,
    page?: number
  };
  declare type OrgsListOutsideCollaboratorsParams = {
    org: string,
    filter?: "2fa_disabled" | "all",
    per_page?: number,
    page?: number
  };
  declare type OrgsListPendingInvitationsParams = {
    org: string,
    per_page?: number,
    page?: number
  };
  declare type OrgsListPublicMembersParams = {
    org: string,
    per_page?: number,
    page?: number
  };
  declare type OrgsPingHookParams = {
    org: string,
    hook_id: number
  };
  declare type OrgsPublicizeMembershipParams = {
    org: string,
    username: string
  };
  declare type OrgsRemoveMemberParams = {
    org: string,
    username: string
  };
  declare type OrgsRemoveMembershipParams = {
    org: string,
    username: string
  };
  declare type OrgsRemoveOutsideCollaboratorParams = {
    org: string,
    username: string
  };
  declare type OrgsUnblockUserParams = {
    org: string,
    username: string
  };
  declare type OrgsUpdateParams = {
    org: string,
    billing_email?: string,
    company?: string,
    email?: string,
    location?: string,
    name?: string,
    description?: string,
    has_organization_projects?: boolean,
    has_repository_projects?: boolean,
    default_repository_permission?: "read" | "write" | "admin" | "none",
    members_can_create_repositories?: boolean
  };
  declare type OrgsUpdateHookParams = {
    org: string,
    hook_id: number,
    config?: OrgsUpdateHookParamsConfig,
    events?: string[],
    active?: boolean
  };
  declare type OrgsUpdateMembershipParams = {
    org: string,
    state: "active"
  };
  declare type ProjectsAddCollaboratorParams = {
    project_id: number,
    username: string,
    permission?: "read" | "write" | "admin"
  };
  declare type ProjectsCreateCardParams = {
    column_id: number,
    note?: string,
    content_id?: number,
    content_type?: string
  };
  declare type ProjectsCreateColumnParams = {
    project_id: number,
    name: string
  };
  declare type ProjectsCreateForOrgParams = {
    org: string,
    name: string,
    body?: string,
    per_page?: number,
    page?: number
  };
  declare type ProjectsCreateForRepoParams = {
    owner: string,
    repo: string,
    name: string,
    body?: string,
    per_page?: number,
    page?: number
  };
  declare type ProjectsDeleteParams = {
    project_id: number
  };
  declare type ProjectsDeleteCardParams = {
    card_id: number
  };
  declare type ProjectsDeleteColumnParams = {
    column_id: number
  };
  declare type ProjectsGetParams = {
    project_id: number,
    per_page?: number,
    page?: number
  };
  declare type ProjectsGetCardParams = {
    card_id: number
  };
  declare type ProjectsGetColumnParams = {
    column_id: number
  };
  declare type ProjectsListCardsParams = {
    column_id: number,
    archived_state?: "all" | "archived" | "not_archived",
    per_page?: number,
    page?: number
  };
  declare type ProjectsListCollaboratorsParams = {
    project_id: number,
    affiliation?: "outside" | "direct" | "all",
    per_page?: number,
    page?: number
  };
  declare type ProjectsListColumnsParams = {
    project_id: number,
    per_page?: number,
    page?: number
  };
  declare type ProjectsListForOrgParams = {
    org: string,
    state?: "open" | "closed" | "all",
    per_page?: number,
    page?: number
  };
  declare type ProjectsListForRepoParams = {
    owner: string,
    repo: string,
    state?: "open" | "closed" | "all",
    per_page?: number,
    page?: number
  };
  declare type ProjectsMoveCardParams = {
    card_id: number,
    position: string,
    column_id?: number
  };
  declare type ProjectsMoveColumnParams = {
    column_id: number,
    position: string
  };
  declare type ProjectsRemoveCollaboratorParams = {
    project_id: number,
    username: string
  };
  declare type ProjectsReviewUserPermissionLevelParams = {
    project_id: number,
    username: string
  };
  declare type ProjectsUpdateParams = {
    project_id: number,
    name?: string,
    body?: string,
    state?: "open" | "closed",
    organization_permission?: string,
    public?: boolean,
    per_page?: number,
    page?: number
  };
  declare type ProjectsUpdateCardParams = {
    card_id: number,
    note?: string,
    archived?: boolean
  };
  declare type ProjectsUpdateColumnParams = {
    column_id: number,
    name: string
  };
  declare type PullRequestsCheckIfMergedParams = {
    owner: string,
    repo: string,
    number: number
  };
  declare type PullRequestsCreateParams = {
    owner: string,
    repo: string,
    title: string,
    head: string,
    base: string,
    body?: string,
    maintainer_can_modify?: boolean
  };
  declare type PullRequestsCreateCommentParams = {
    owner: string,
    repo: string,
    number: number,
    body: string,
    commit_id: string,
    path: string,
    position: number
  };
  declare type PullRequestsCreateCommentReplyParams = {
    owner: string,
    repo: string,
    number: number,
    body: string,
    in_reply_to: number
  };
  declare type PullRequestsCreateFromIssueParams = {
    owner: string,
    repo: string,
    issue: number,
    head: string,
    base: string,
    maintainer_can_modify?: boolean
  };
  declare type PullRequestsCreateReviewParams = {
    owner: string,
    repo: string,
    number: number,
    commit_id?: string,
    body?: string,
    event?: "APPROVE" | "REQUEST_CHANGES" | "COMMENT",
    comments?: PullRequestsCreateReviewParamsComments[]
  };
  declare type PullRequestsCreateReviewRequestParams = {
    owner: string,
    repo: string,
    number: number,
    reviewers?: string[],
    team_reviewers?: string[]
  };
  declare type PullRequestsDeleteCommentParams = {
    owner: string,
    repo: string,
    comment_id: number
  };
  declare type PullRequestsDeletePendingReviewParams = {
    owner: string,
    repo: string,
    number: number,
    review_id: number
  };
  declare type PullRequestsDeleteReviewRequestParams = {
    owner: string,
    repo: string,
    number: number,
    reviewers?: string[],
    team_reviewers?: string[]
  };
  declare type PullRequestsDismissReviewParams = {
    owner: string,
    repo: string,
    number: number,
    review_id: number,
    message: string
  };
  declare type PullRequestsGetParams = {
    owner: string,
    repo: string,
    number: number
  };
  declare type PullRequestsGetCommentParams = {
    owner: string,
    repo: string,
    comment_id: number
  };
  declare type PullRequestsGetCommentsForReviewParams = {
    owner: string,
    repo: string,
    number: number,
    review_id: number,
    per_page?: number,
    page?: number
  };
  declare type PullRequestsGetReviewParams = {
    owner: string,
    repo: string,
    number: number,
    review_id: number
  };
  declare type PullRequestsListParams = {
    owner: string,
    repo: string,
    state?: "open" | "closed" | "all",
    head?: string,
    base?: string,
    sort?: "created" | "updated" | "popularity" | "long-running",
    direction?: "asc" | "desc",
    per_page?: number,
    page?: number
  };
  declare type PullRequestsListCommentsParams = {
    owner: string,
    repo: string,
    number: number,
    sort?: "created" | "updated",
    direction?: "asc" | "desc",
    since?: string,
    per_page?: number,
    page?: number
  };
  declare type PullRequestsListCommentsForRepoParams = {
    owner: string,
    repo: string,
    sort?: "created" | "updated",
    direction?: "asc" | "desc",
    since?: string,
    per_page?: number,
    page?: number
  };
  declare type PullRequestsListCommitsParams = {
    owner: string,
    repo: string,
    number: number,
    per_page?: number,
    page?: number
  };
  declare type PullRequestsListFilesParams = {
    owner: string,
    repo: string,
    number: number,
    per_page?: number,
    page?: number
  };
  declare type PullRequestsListReviewRequestsParams = {
    owner: string,
    repo: string,
    number: number,
    per_page?: number,
    page?: number
  };
  declare type PullRequestsListReviewsParams = {
    owner: string,
    repo: string,
    number: number,
    per_page?: number,
    page?: number
  };
  declare type PullRequestsMergeParams = {
    owner: string,
    repo: string,
    number: number,
    commit_title?: string,
    commit_message?: string,
    sha?: string,
    merge_method?: "merge" | "squash" | "rebase"
  };
  declare type PullRequestsSubmitReviewParams = {
    owner: string,
    repo: string,
    number: number,
    review_id: number,
    body?: string,
    event: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"
  };
  declare type PullRequestsUpdateParams = {
    owner: string,
    repo: string,
    number: number,
    title?: string,
    body?: string,
    state?: "open" | "closed",
    base?: string,
    maintainer_can_modify?: boolean
  };
  declare type PullRequestsUpdateCommentParams = {
    owner: string,
    repo: string,
    comment_id: number,
    body: string
  };
  declare type ReactionsCreateForCommitCommentParams = {
    owner: string,
    repo: string,
    comment_id: number,
    content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray"
  };
  declare type ReactionsCreateForIssueParams = {
    owner: string,
    repo: string,
    number: number,
    content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray"
  };
  declare type ReactionsCreateForIssueCommentParams = {
    owner: string,
    repo: string,
    comment_id: number,
    content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray"
  };
  declare type ReactionsCreateForPullRequestReviewCommentParams = {
    owner: string,
    repo: string,
    comment_id: number,
    content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray"
  };
  declare type ReactionsCreateForTeamDiscussionParams = {
    team_id: number,
    discussion_number: number,
    content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray"
  };
  declare type ReactionsCreateForTeamDiscussionCommentParams = {
    team_id: number,
    discussion_number: number,
    comment_number: number,
    content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray"
  };
  declare type ReactionsDeleteParams = {
    reaction_id: number
  };
  declare type ReactionsListForCommitCommentParams = {
    owner: string,
    repo: string,
    comment_id: number,
    content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray",
    per_page?: number,
    page?: number
  };
  declare type ReactionsListForIssueParams = {
    owner: string,
    repo: string,
    number: number,
    content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray",
    per_page?: number,
    page?: number
  };
  declare type ReactionsListForIssueCommentParams = {
    owner: string,
    repo: string,
    comment_id: number,
    content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray",
    per_page?: number,
    page?: number
  };
  declare type ReactionsListForPullRequestReviewCommentParams = {
    owner: string,
    repo: string,
    comment_id: number,
    content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray",
    per_page?: number,
    page?: number
  };
  declare type ReactionsListForTeamDiscussionParams = {
    team_id: number,
    discussion_number: number,
    content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray",
    per_page?: number,
    page?: number
  };
  declare type ReactionsListForTeamDiscussionCommentParams = {
    team_id: number,
    discussion_number: number,
    comment_number: number,
    content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray",
    per_page?: number,
    page?: number
  };
  declare type ReposAcceptInvitationParams = {
    invitation_id: number
  };
  declare type ReposAddCollaboratorParams = {
    owner: string,
    repo: string,
    username: string,
    permission?: "pull" | "push" | "admin"
  };
  declare type ReposAddDeployKeyParams = {
    owner: string,
    repo: string,
    title?: string,
    key: string,
    read_only?: boolean
  };
  declare type ReposAddProtectedBranchAdminEnforcementParams = {
    owner: string,
    repo: string,
    branch: string
  };
  declare type ReposAddProtectedBranchRequiredSignaturesParams = {
    owner: string,
    repo: string,
    branch: string
  };
  declare type ReposAddProtectedBranchRequiredStatusChecksContextsParams = {
    owner: string,
    repo: string,
    branch: string,
    contexts: string[]
  };
  declare type ReposAddProtectedBranchTeamRestrictionsParams = {
    owner: string,
    repo: string,
    branch: string,
    teams: string[]
  };
  declare type ReposAddProtectedBranchUserRestrictionsParams = {
    owner: string,
    repo: string,
    branch: string,
    users: string[]
  };
  declare type ReposCheckCollaboratorParams = {
    owner: string,
    repo: string,
    username: string
  };
  declare type ReposCompareCommitsParams = {
    owner: string,
    repo: string,
    base: string,
    head: string
  };
  declare type ReposCreateCommitCommentParams = {
    owner: string,
    repo: string,
    sha: string,
    body: string,
    path?: string,
    position?: number,
    line?: number
  };
  declare type ReposCreateDeploymentParams = {
    owner: string,
    repo: string,
    ref: string,
    task?: string,
    auto_merge?: boolean,
    required_contexts?: string[],
    payload?: string,
    environment?: string,
    description?: string,
    transient_environment?: boolean,
    production_environment?: boolean
  };
  declare type ReposCreateDeploymentStatusParams = {
    owner: string,
    repo: string,
    deployment_id: number,
    state:
      | "error"
      | "failure"
      | "inactive"
      | "in_progress"
      | "queued"
      | "pending"
      | "success",
    target_url?: string,
    log_url?: string,
    description?: string,
    environment?: "production" | "staging" | "qa",
    environment_url?: string,
    auto_inactive?: boolean
  };
  declare type ReposCreateFileParams = {
    owner: string,
    repo: string,
    path: string,
    message: string,
    content: string,
    branch?: string,
    committer?: ReposCreateFileParamsCommitter,
    author?: ReposCreateFileParamsAuthor
  };
  declare type ReposCreateForAuthenticatedUserParams = {
    name: string,
    description?: string,
    homepage?: string,
    private?: boolean,
    has_issues?: boolean,
    has_projects?: boolean,
    has_wiki?: boolean,
    team_id?: number,
    auto_init?: boolean,
    gitignore_template?: string,
    license_template?: string,
    allow_squash_merge?: boolean,
    allow_merge_commit?: boolean,
    allow_rebase_merge?: boolean
  };
  declare type ReposCreateForkParams = {
    owner: string,
    repo: string,
    organization?: string
  };
  declare type ReposCreateHookParams = {
    owner: string,
    repo: string,
    name: string,
    config: ReposCreateHookParamsConfig,
    events?: string[],
    active?: boolean
  };
  declare type ReposCreateInOrgParams = {
    org: string,
    name: string,
    description?: string,
    homepage?: string,
    private?: boolean,
    has_issues?: boolean,
    has_projects?: boolean,
    has_wiki?: boolean,
    team_id?: number,
    auto_init?: boolean,
    gitignore_template?: string,
    license_template?: string,
    allow_squash_merge?: boolean,
    allow_merge_commit?: boolean,
    allow_rebase_merge?: boolean
  };
  declare type ReposCreateReleaseParams = {
    owner: string,
    repo: string,
    tag_name: string,
    target_commitish?: string,
    name?: string,
    body?: string,
    draft?: boolean,
    prerelease?: boolean
  };
  declare type ReposCreateStatusParams = {
    owner: string,
    repo: string,
    sha: string,
    state: "error" | "failure" | "pending" | "success",
    target_url?: string,
    description?: string,
    context?: string
  };
  declare type ReposDeclineInvitationParams = {
    invitation_id: number
  };
  declare type ReposDeleteParams = {
    owner: string,
    repo: string
  };
  declare type ReposDeleteCommitCommentParams = {
    owner: string,
    repo: string,
    comment_id: number
  };
  declare type ReposDeleteDownloadParams = {
    owner: string,
    repo: string,
    download_id: number
  };
  declare type ReposDeleteFileParams = {
    owner: string,
    repo: string,
    path: string,
    message: string,
    sha: string,
    branch?: string,
    committer?: ReposDeleteFileParamsCommitter,
    author?: ReposDeleteFileParamsAuthor
  };
  declare type ReposDeleteHookParams = {
    owner: string,
    repo: string,
    hook_id: number
  };
  declare type ReposDeleteInvitationParams = {
    owner: string,
    repo: string,
    invitation_id: number
  };
  declare type ReposDeleteReleaseParams = {
    owner: string,
    repo: string,
    release_id: number
  };
  declare type ReposDeleteReleaseAssetParams = {
    owner: string,
    repo: string,
    asset_id: number
  };
  declare type ReposGetParams = {
    owner: string,
    repo: string
  };
  declare type ReposGetArchiveLinkParams = {
    owner: string,
    repo: string,
    archive_format: string,
    ref: string
  };
  declare type ReposGetBranchParams = {
    owner: string,
    repo: string,
    branch: string
  };
  declare type ReposGetBranchProtectionParams = {
    owner: string,
    repo: string,
    branch: string
  };
  declare type ReposGetClonesParams = {
    owner: string,
    repo: string,
    per?: "day" | "week"
  };
  declare type ReposGetCodeFrequencyStatsParams = {
    owner: string,
    repo: string
  };
  declare type ReposGetCollaboratorPermissionLevelParams = {
    owner: string,
    repo: string,
    username: string
  };
  declare type ReposGetCombinedStatusForRefParams = {
    owner: string,
    repo: string,
    ref: string
  };
  declare type ReposGetCommitParams = {
    owner: string,
    repo: string,
    sha: string
  };
  declare type ReposGetCommitActivityStatsParams = {
    owner: string,
    repo: string
  };
  declare type ReposGetCommitCommentParams = {
    owner: string,
    repo: string,
    comment_id: number
  };
  declare type ReposGetCommitRefShaParams = {
    owner: string,
    repo: string,
    ref: string
  };
  declare type ReposGetContentsParams = {
    owner: string,
    repo: string,
    path: string,
    ref?: string
  };
  declare type ReposGetContributorsStatsParams = {
    owner: string,
    repo: string
  };
  declare type ReposGetDeployKeyParams = {
    owner: string,
    repo: string,
    key_id: number
  };
  declare type ReposGetDeploymentParams = {
    owner: string,
    repo: string,
    deployment_id: number
  };
  declare type ReposGetDeploymentStatusParams = {
    owner: string,
    repo: string,
    deployment_id: number,
    status_id: number
  };
  declare type ReposGetDownloadParams = {
    owner: string,
    repo: string,
    download_id: number
  };
  declare type ReposGetHookParams = {
    owner: string,
    repo: string,
    hook_id: number
  };
  declare type ReposGetLatestPagesBuildParams = {
    owner: string,
    repo: string
  };
  declare type ReposGetLatestReleaseParams = {
    owner: string,
    repo: string
  };
  declare type ReposGetPagesParams = {
    owner: string,
    repo: string
  };
  declare type ReposGetPagesBuildParams = {
    owner: string,
    repo: string,
    build_id: number
  };
  declare type ReposGetParticipationStatsParams = {
    owner: string,
    repo: string
  };
  declare type ReposGetProtectedBranchAdminEnforcementParams = {
    owner: string,
    repo: string,
    branch: string
  };
  declare type ReposGetProtectedBranchPullRequestReviewEnforcementParams = {
    owner: string,
    repo: string,
    branch: string
  };
  declare type ReposGetProtectedBranchRequiredSignaturesParams = {
    owner: string,
    repo: string,
    branch: string
  };
  declare type ReposGetProtectedBranchRequiredStatusChecksParams = {
    owner: string,
    repo: string,
    branch: string
  };
  declare type ReposGetProtectedBranchRestrictionsParams = {
    owner: string,
    repo: string,
    branch: string
  };
  declare type ReposGetPunchCardStatsParams = {
    owner: string,
    repo: string
  };
  declare type ReposGetReadmeParams = {
    owner: string,
    repo: string,
    ref?: string
  };
  declare type ReposGetReleaseParams = {
    owner: string,
    repo: string,
    release_id: number
  };
  declare type ReposGetReleaseAssetParams = {
    owner: string,
    repo: string,
    asset_id: number
  };
  declare type ReposGetReleaseByTagParams = {
    owner: string,
    repo: string,
    tag: string
  };
  declare type ReposGetTopPathsParams = {
    owner: string,
    repo: string
  };
  declare type ReposGetTopReferrersParams = {
    owner: string,
    repo: string
  };
  declare type ReposGetViewsParams = {
    owner: string,
    repo: string,
    per?: "day" | "week"
  };
  declare type ReposListParams = {
    visibility?: "all" | "public" | "private",
    affiliation?: "owner" | "collaborator" | "organization_member",
    type?: "all" | "owner" | "public" | "private" | "member",
    sort?: "created" | "updated" | "pushed" | "full_name",
    direction?: "asc" | "desc",
    per_page?: number,
    page?: number
  };
  declare type ReposListAssetsForReleaseParams = {
    owner: string,
    repo: string,
    release_id: number,
    per_page?: number,
    page?: number
  };
  declare type ReposListBranchesParams = {
    owner: string,
    repo: string,
    protected?: boolean,
    per_page?: number,
    page?: number
  };
  declare type ReposListCollaboratorsParams = {
    owner: string,
    repo: string,
    affiliation?: "outside" | "direct" | "all",
    per_page?: number,
    page?: number
  };
  declare type ReposListCommentsForCommitParams = {
    owner: string,
    repo: string,
    ref: string,
    per_page?: number,
    page?: number
  };
  declare type ReposListCommitCommentsParams = {
    owner: string,
    repo: string,
    per_page?: number,
    page?: number
  };
  declare type ReposListCommitsParams = {
    owner: string,
    repo: string,
    sha?: string,
    path?: string,
    author?: string,
    since?: string,
    until?: string,
    per_page?: number,
    page?: number
  };
  declare type ReposListContributorsParams = {
    owner: string,
    repo: string,
    anon?: string,
    per_page?: number,
    page?: number
  };
  declare type ReposListDeployKeysParams = {
    owner: string,
    repo: string,
    per_page?: number,
    page?: number
  };
  declare type ReposListDeploymentStatusesParams = {
    owner: string,
    repo: string,
    deployment_id: number,
    per_page?: number,
    page?: number
  };
  declare type ReposListDeploymentsParams = {
    owner: string,
    repo: string,
    sha?: string,
    ref?: string,
    task?: string,
    environment?: string,
    per_page?: number,
    page?: number
  };
  declare type ReposListDownloadsParams = {
    owner: string,
    repo: string,
    per_page?: number,
    page?: number
  };
  declare type ReposListForOrgParams = {
    org: string,
    type?: "all" | "public" | "private" | "forks" | "sources" | "member",
    per_page?: number,
    page?: number
  };
  declare type ReposListForUserParams = {
    username: string,
    type?: "all" | "owner" | "memb