probot
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Octokit
    • GitHubAPI

Index

Interfaces

Type aliases

Constructors

Properties

Methods

Type aliases

ActionsCancelWorkflowRunParams

ActionsCancelWorkflowRunParams: { owner: string; repo: string; run_id: number }

Type declaration

  • owner: string
  • repo: string
  • run_id: number

ActionsCreateOrUpdateSecretForRepoParams

ActionsCreateOrUpdateSecretForRepoParams: { encrypted_value?: undefined | string; key_id?: undefined | string; name: string; owner: string; repo: string }

Type declaration

  • Optional encrypted_value?: undefined | string

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get your public key endpoint.

  • Optional key_id?: undefined | string

    ID of the key you used to encrypt the secret.

  • name: string
  • owner: string
  • repo: string

ActionsCreateRegistrationTokenParams

ActionsCreateRegistrationTokenParams: { owner: string; repo: string }

Type declaration

  • owner: string
  • repo: string

ActionsCreateRegistrationTokenResponse

ActionsCreateRegistrationTokenResponse: { expires_at: string; token: string }

Type declaration

  • expires_at: string
  • token: string

ActionsCreateRemoveTokenParams

ActionsCreateRemoveTokenParams: { owner: string; repo: string }

Type declaration

  • owner: string
  • repo: string

ActionsCreateRemoveTokenResponse

ActionsCreateRemoveTokenResponse: { expires_at: string; token: string }

Type declaration

  • expires_at: string
  • token: string

ActionsDeleteArtifactParams

ActionsDeleteArtifactParams: { artifact_id: number; owner: string; repo: string }

Type declaration

  • artifact_id: number
  • owner: string
  • repo: string

ActionsDeleteSecretFromRepoParams

ActionsDeleteSecretFromRepoParams: { name: string; owner: string; repo: string }

Type declaration

  • name: string
  • owner: string
  • repo: string

ActionsDownloadArtifactParams

ActionsDownloadArtifactParams: { archive_format: string; artifact_id: number; owner: string; repo: string }

Type declaration

  • archive_format: string
  • artifact_id: number
  • owner: string
  • repo: string

ActionsGetArtifactParams

ActionsGetArtifactParams: { artifact_id: number; owner: string; repo: string }

Type declaration

  • artifact_id: number
  • owner: string
  • repo: string

ActionsGetArtifactResponse

ActionsGetArtifactResponse: { archive_download_url: string; created_at: string; expired: string; expires_at: string; id: number; name: string; node_id: string; size_in_bytes: number }

Type declaration

  • archive_download_url: string
  • created_at: string
  • expired: string
  • expires_at: string
  • id: number
  • name: string
  • node_id: string
  • size_in_bytes: number

ActionsGetPublicKeyParams

ActionsGetPublicKeyParams: { owner: string; repo: string }

Type declaration

  • owner: string
  • repo: string

ActionsGetPublicKeyResponse

ActionsGetPublicKeyResponse: { key: string; key_id: string }

Type declaration

  • key: string
  • key_id: string

ActionsGetSecretParams

ActionsGetSecretParams: { name: string; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

Type declaration

  • name: string
  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ActionsGetSecretResponse

ActionsGetSecretResponse: { created_at: string; name: string; updated_at: string }

Type declaration

  • created_at: string
  • name: string
  • updated_at: string

ActionsGetSelfHostedRunnerParams

ActionsGetSelfHostedRunnerParams: { owner: string; repo: string; runner_id: number }

Type declaration

  • owner: string
  • repo: string
  • runner_id: number

ActionsGetSelfHostedRunnerResponse

ActionsGetSelfHostedRunnerResponse: { id: number; name: string; os: string; status: string }

Type declaration

  • id: number
  • name: string
  • os: string
  • status: string

ActionsGetWorkflowJobParams

ActionsGetWorkflowJobParams: { job_id: number; owner: string; repo: string }

Type declaration

  • job_id: number
  • owner: string
  • repo: string

ActionsGetWorkflowJobResponse

ActionsGetWorkflowJobResponse: { check_run_url: string; completed_at: string; conclusion: string; head_sha: string; html_url: string; id: number; name: string; node_id: string; run_id: number; run_url: string; started_at: string; status: string; steps: Array<ActionsGetWorkflowJobResponseStepsItem>; url: string }

Type declaration

  • check_run_url: string
  • completed_at: string
  • conclusion: string
  • head_sha: string
  • html_url: string
  • id: number
  • name: string
  • node_id: string
  • run_id: number
  • run_url: string
  • started_at: string
  • status: string
  • steps: Array<ActionsGetWorkflowJobResponseStepsItem>
  • url: string

ActionsGetWorkflowJobResponseStepsItem

ActionsGetWorkflowJobResponseStepsItem: { completed_at: string; conclusion: string; name: string; number: number; started_at: string; status: string }

Type declaration

  • completed_at: string
  • conclusion: string
  • name: string
  • number: number
  • started_at: string
  • status: string

ActionsGetWorkflowParams

ActionsGetWorkflowParams: { owner: string; repo: string; workflow_id: number }

Type declaration

  • owner: string
  • repo: string
  • workflow_id: number

ActionsGetWorkflowResponse

ActionsGetWorkflowResponse: { badge_url: string; created_at: string; html_url: string; id: number; name: string; node_id: string; path: string; state: string; updated_at: string; url: string }

Type declaration

  • badge_url: string
  • created_at: string
  • html_url: string
  • id: number
  • name: string
  • node_id: string
  • path: string
  • state: string
  • updated_at: string
  • url: string

ActionsGetWorkflowRunParams

ActionsGetWorkflowRunParams: { owner: string; repo: string; run_id: number }

Type declaration

  • owner: string
  • repo: string
  • run_id: number

ActionsGetWorkflowRunResponse

ActionsGetWorkflowRunResponse: { artifacts_url: string; cancel_url: string; check_suite_id: number; conclusion: null; created_at: string; event: string; head_branch: string; head_commit: ActionsGetWorkflowRunResponseHeadCommit; head_repository: ActionsGetWorkflowRunResponseHeadRepository; head_sha: string; html_url: string; id: number; jobs_url: string; logs_url: string; node_id: string; pull_requests: Array<any>; repository: ActionsGetWorkflowRunResponseRepository; rerun_url: string; run_number: number; status: string; updated_at: string; url: string; workflow_url: string }

Type declaration

ActionsGetWorkflowRunResponseHeadCommit

ActionsGetWorkflowRunResponseHeadCommit: { author: ActionsGetWorkflowRunResponseHeadCommitAuthor; committer: ActionsGetWorkflowRunResponseHeadCommitCommitter; id: string; message: string; timestamp: string; tree_id: string }

Type declaration

ActionsGetWorkflowRunResponseHeadCommitAuthor

ActionsGetWorkflowRunResponseHeadCommitAuthor: { email: string; name: string }

Type declaration

  • email: string
  • name: string

ActionsGetWorkflowRunResponseHeadCommitCommitter

ActionsGetWorkflowRunResponseHeadCommitCommitter: { email: string; name: string }

Type declaration

  • email: string
  • name: string

ActionsGetWorkflowRunResponseHeadRepository

ActionsGetWorkflowRunResponseHeadRepository: { archive_url: string; assignees_url: string; blobs_url: string; branches_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; deployments_url: string; description: null; downloads_url: string; events_url: string; fork: boolean; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; hooks_url: string; html_url: string; id: number; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; languages_url: string; merges_url: string; milestones_url: string; name: string; node_id: string; notifications_url: string; owner: ActionsGetWorkflowRunResponseHeadRepositoryOwner; private: boolean; pulls_url: string; releases_url: string; stargazers_url: string; statuses_url: string; subscribers_url: string; subscription_url: string; tags_url: string; teams_url: string; trees_url: string; url: string }

Type declaration

  • archive_url: string
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • deployments_url: string
  • description: null
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • hooks_url: string
  • html_url: string
  • id: number
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • name: string
  • node_id: string
  • notifications_url: string
  • owner: ActionsGetWorkflowRunResponseHeadRepositoryOwner
  • private: boolean
  • pulls_url: string
  • releases_url: string
  • stargazers_url: string
  • statuses_url: string
  • subscribers_url: string
  • subscription_url: string
  • tags_url: string
  • teams_url: string
  • trees_url: string
  • url: string

ActionsGetWorkflowRunResponseHeadRepositoryOwner

ActionsGetWorkflowRunResponseHeadRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ActionsGetWorkflowRunResponseRepository

ActionsGetWorkflowRunResponseRepository: { archive_url: string; assignees_url: string; blobs_url: string; branches_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; deployments_url: string; description: string; downloads_url: string; events_url: string; fork: boolean; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; html_url: string; id: number; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; languages_url: string; merges_url: string; milestones_url: string; name: string; node_id: string; notifications_url: string; owner: ActionsGetWorkflowRunResponseRepositoryOwner; private: boolean; pulls_url: string; releases_url: string; ssh_url: string; stargazers_url: string; statuses_url: string; subscribers_url: string; subscription_url: string; tags_url: string; teams_url: string; trees_url: string; url: string }

Type declaration

  • archive_url: string
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • deployments_url: string
  • description: string
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • html_url: string
  • id: number
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • name: string
  • node_id: string
  • notifications_url: string
  • owner: ActionsGetWorkflowRunResponseRepositoryOwner
  • private: boolean
  • pulls_url: string
  • releases_url: string
  • ssh_url: string
  • stargazers_url: string
  • statuses_url: string
  • subscribers_url: string
  • subscription_url: string
  • tags_url: string
  • teams_url: string
  • trees_url: string
  • url: string

ActionsGetWorkflowRunResponseRepositoryOwner

ActionsGetWorkflowRunResponseRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ActionsListDownloadsForSelfHostedRunnerApplicationParams

ActionsListDownloadsForSelfHostedRunnerApplicationParams: { owner: string; repo: string }

Type declaration

  • owner: string
  • repo: string

ActionsListDownloadsForSelfHostedRunnerApplicationResponse

ActionsListDownloadsForSelfHostedRunnerApplicationResponse: Array<ActionsListDownloadsForSelfHostedRunnerApplicationResponseItem>

ActionsListDownloadsForSelfHostedRunnerApplicationResponseItem

ActionsListDownloadsForSelfHostedRunnerApplicationResponseItem: { architecture: string; download_url: string; filename: string; os: string }

Type declaration

  • architecture: string
  • download_url: string
  • filename: string
  • os: string

ActionsListJobsForWorkflowRunParams

ActionsListJobsForWorkflowRunParams: { owner: string; page?: undefined | number; per_page?: undefined | number; repo: string; run_id: number }

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string
  • run_id: number

ActionsListJobsForWorkflowRunResponse

ActionsListJobsForWorkflowRunResponse: { jobs: Array<ActionsListJobsForWorkflowRunResponseJobsItem>; total_count: number }

Type declaration

ActionsListJobsForWorkflowRunResponseJobsItem

ActionsListJobsForWorkflowRunResponseJobsItem: { check_run_url: string; completed_at: string; conclusion: string; head_sha: string; html_url: string; id: number; name: string; node_id: string; run_id: number; run_url: string; started_at: string; status: string; steps: Array<ActionsListJobsForWorkflowRunResponseJobsItemStepsItem>; url: string }

Type declaration

  • check_run_url: string
  • completed_at: string
  • conclusion: string
  • head_sha: string
  • html_url: string
  • id: number
  • name: string
  • node_id: string
  • run_id: number
  • run_url: string
  • started_at: string
  • status: string
  • steps: Array<ActionsListJobsForWorkflowRunResponseJobsItemStepsItem>
  • url: string

ActionsListJobsForWorkflowRunResponseJobsItemStepsItem

ActionsListJobsForWorkflowRunResponseJobsItemStepsItem: { completed_at: string; conclusion: string; name: string; number: number; started_at: string; status: string }

Type declaration

  • completed_at: string
  • conclusion: string
  • name: string
  • number: number
  • started_at: string
  • status: string

ActionsListRepoWorkflowRunsParams

ActionsListRepoWorkflowRunsParams: { actor?: undefined | string; branch?: undefined | string; event?: undefined | string; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string; status?: "completed" | "status" | "conclusion" }

Type declaration

  • Optional actor?: undefined | string

    Returns someone's workflow runs. Use the login for the user who created the push associated with the check suite or workflow run.

  • Optional branch?: undefined | string

    Returns workflow runs associated with a branch. Use the name of the branch of the push.

  • Optional event?: undefined | string

    Returns workflow run triggered by the event you specify. For example, push, pull_request or issue. For more information, see "Events that trigger workflows" in the GitHub Help documentation.

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string
  • Optional status?: "completed" | "status" | "conclusion"

    Returns workflow runs associated with the check run status or conclusion you specify. For example, a conclusion can be success or a status can be completed. For more information, see the status and conclusion options available in "Create a check run."

ActionsListRepoWorkflowRunsResponse

ActionsListRepoWorkflowRunsResponse: { total_count: number; workflow_runs: Array<ActionsListRepoWorkflowRunsResponseWorkflowRunsItem> }

Type declaration

ActionsListRepoWorkflowRunsResponseWorkflowRunsItem

ActionsListRepoWorkflowRunsResponseWorkflowRunsItem: { artifacts_url: string; cancel_url: string; check_suite_id: number; conclusion: null; created_at: string; event: string; head_branch: string; head_commit: ActionsListRepoWorkflowRunsResponseWorkflowRunsItemHeadCommit; head_repository: ActionsListRepoWorkflowRunsResponseWorkflowRunsItemHeadRepository; head_sha: string; html_url: string; id: number; jobs_url: string; logs_url: string; node_id: string; pull_requests: Array<any>; repository: ActionsListRepoWorkflowRunsResponseWorkflowRunsItemRepository; rerun_url: string; run_number: number; status: string; updated_at: string; url: string; workflow_url: string }

Type declaration

ActionsListRepoWorkflowRunsResponseWorkflowRunsItemHeadCommit

ActionsListRepoWorkflowRunsResponseWorkflowRunsItemHeadCommit: { author: ActionsListRepoWorkflowRunsResponseWorkflowRunsItemHeadCommitAuthor; committer: ActionsListRepoWorkflowRunsResponseWorkflowRunsItemHeadCommitCommitter; id: string; message: string; timestamp: string; tree_id: string }

Type declaration

ActionsListRepoWorkflowRunsResponseWorkflowRunsItemHeadCommitAuthor

ActionsListRepoWorkflowRunsResponseWorkflowRunsItemHeadCommitAuthor: { email: string; name: string }

Type declaration

  • email: string
  • name: string

ActionsListRepoWorkflowRunsResponseWorkflowRunsItemHeadCommitCommitter

ActionsListRepoWorkflowRunsResponseWorkflowRunsItemHeadCommitCommitter: { email: string; name: string }

Type declaration

  • email: string
  • name: string

ActionsListRepoWorkflowRunsResponseWorkflowRunsItemHeadRepository

ActionsListRepoWorkflowRunsResponseWorkflowRunsItemHeadRepository: { archive_url: string; assignees_url: string; blobs_url: string; branches_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; deployments_url: string; description: null; downloads_url: string; events_url: string; fork: boolean; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; hooks_url: string; html_url: string; id: number; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; languages_url: string; merges_url: string; milestones_url: string; name: string; node_id: string; notifications_url: string; owner: ActionsListRepoWorkflowRunsResponseWorkflowRunsItemHeadRepositoryOwner; private: boolean; pulls_url: string; releases_url: string; stargazers_url: string; statuses_url: string; subscribers_url: string; subscription_url: string; tags_url: string; teams_url: string; trees_url: string; url: string }

Type declaration

  • archive_url: string
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • deployments_url: string
  • description: null
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • hooks_url: string
  • html_url: string
  • id: number
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • name: string
  • node_id: string
  • notifications_url: string
  • owner: ActionsListRepoWorkflowRunsResponseWorkflowRunsItemHeadRepositoryOwner
  • private: boolean
  • pulls_url: string
  • releases_url: string
  • stargazers_url: string
  • statuses_url: string
  • subscribers_url: string
  • subscription_url: string
  • tags_url: string
  • teams_url: string
  • trees_url: string
  • url: string

ActionsListRepoWorkflowRunsResponseWorkflowRunsItemHeadRepositoryOwner

ActionsListRepoWorkflowRunsResponseWorkflowRunsItemHeadRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ActionsListRepoWorkflowRunsResponseWorkflowRunsItemRepository

ActionsListRepoWorkflowRunsResponseWorkflowRunsItemRepository: { archive_url: string; assignees_url: string; blobs_url: string; branches_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; deployments_url: string; description: string; downloads_url: string; events_url: string; fork: boolean; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; html_url: string; id: number; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; languages_url: string; merges_url: string; milestones_url: string; name: string; node_id: string; notifications_url: string; owner: ActionsListRepoWorkflowRunsResponseWorkflowRunsItemRepositoryOwner; private: boolean; pulls_url: string; releases_url: string; ssh_url: string; stargazers_url: string; statuses_url: string; subscribers_url: string; subscription_url: string; tags_url: string; teams_url: string; trees_url: string; url: string }

Type declaration

  • archive_url: string
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • deployments_url: string
  • description: string
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • html_url: string
  • id: number
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • name: string
  • node_id: string
  • notifications_url: string
  • owner: ActionsListRepoWorkflowRunsResponseWorkflowRunsItemRepositoryOwner
  • private: boolean
  • pulls_url: string
  • releases_url: string
  • ssh_url: string
  • stargazers_url: string
  • statuses_url: string
  • subscribers_url: string
  • subscription_url: string
  • tags_url: string
  • teams_url: string
  • trees_url: string
  • url: string

ActionsListRepoWorkflowRunsResponseWorkflowRunsItemRepositoryOwner

ActionsListRepoWorkflowRunsResponseWorkflowRunsItemRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ActionsListRepoWorkflowsParams

ActionsListRepoWorkflowsParams: { owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ActionsListRepoWorkflowsResponse

ActionsListRepoWorkflowsResponse: { total_count: number; workflows: Array<ActionsListRepoWorkflowsResponseWorkflowsItem> }

Type declaration

ActionsListRepoWorkflowsResponseWorkflowsItem

ActionsListRepoWorkflowsResponseWorkflowsItem: { badge_url: string; created_at: string; html_url: string; id: number; name: string; node_id: string; path: string; state: string; updated_at: string; url: string }

Type declaration

  • badge_url: string
  • created_at: string
  • html_url: string
  • id: number
  • name: string
  • node_id: string
  • path: string
  • state: string
  • updated_at: string
  • url: string

ActionsListSecretsForRepoParams

ActionsListSecretsForRepoParams: { owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ActionsListSecretsForRepoResponse

ActionsListSecretsForRepoResponse: { secrets: Array<ActionsListSecretsForRepoResponseSecretsItem>; total_count: number }

Type declaration

ActionsListSecretsForRepoResponseSecretsItem

ActionsListSecretsForRepoResponseSecretsItem: { created_at: string; name: string; updated_at: string }

Type declaration

  • created_at: string
  • name: string
  • updated_at: string

ActionsListSelfHostedRunnersForRepoParams

ActionsListSelfHostedRunnersForRepoParams: { owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ActionsListSelfHostedRunnersForRepoResponse

ActionsListSelfHostedRunnersForRepoResponse: Array<Array<ActionsListSelfHostedRunnersForRepoResponseItemItem>>

ActionsListSelfHostedRunnersForRepoResponseItemItem

ActionsListSelfHostedRunnersForRepoResponseItemItem: { id: number; name: string; os: string; status: string }

Type declaration

  • id: number
  • name: string
  • os: string
  • status: string

ActionsListWorkflowJobLogsParams

ActionsListWorkflowJobLogsParams: { job_id: number; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

Type declaration

  • job_id: number
  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ActionsListWorkflowRunArtifactsParams

ActionsListWorkflowRunArtifactsParams: { owner: string; page?: undefined | number; per_page?: undefined | number; repo: string; run_id: number }

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string
  • run_id: number

ActionsListWorkflowRunArtifactsResponse

ActionsListWorkflowRunArtifactsResponse: { artifacts: Array<ActionsListWorkflowRunArtifactsResponseArtifactsItem>; total_count: number }

Type declaration

ActionsListWorkflowRunArtifactsResponseArtifactsItem

ActionsListWorkflowRunArtifactsResponseArtifactsItem: { archive_download_url: string; created_at: string; expired: string; expires_at: string; id: number; name: string; node_id: string; size_in_bytes: number }

Type declaration

  • archive_download_url: string
  • created_at: string
  • expired: string
  • expires_at: string
  • id: number
  • name: string
  • node_id: string
  • size_in_bytes: number

ActionsListWorkflowRunLogsParams

ActionsListWorkflowRunLogsParams: { owner: string; page?: undefined | number; per_page?: undefined | number; repo: string; run_id: number }

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string
  • run_id: number

ActionsListWorkflowRunsParams

ActionsListWorkflowRunsParams: { actor?: undefined | string; branch?: undefined | string; event?: undefined | string; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string; status?: "completed" | "status" | "conclusion"; workflow_id: number }

Type declaration

  • Optional actor?: undefined | string

    Returns someone's workflow runs. Use the login for the user who created the push associated with the check suite or workflow run.

  • Optional branch?: undefined | string

    Returns workflow runs associated with a branch. Use the name of the branch of the push.

  • Optional event?: undefined | string

    Returns workflow run triggered by the event you specify. For example, push, pull_request or issue. For more information, see "Events that trigger workflows" in the GitHub Help documentation.

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string
  • Optional status?: "completed" | "status" | "conclusion"

    Returns workflow runs associated with the check run status or conclusion you specify. For example, a conclusion can be success or a status can be completed. For more information, see the status and conclusion options available in "Create a check run."

  • workflow_id: number

ActionsListWorkflowRunsResponse

ActionsListWorkflowRunsResponse: { total_count: number; workflow_runs: Array<ActionsListWorkflowRunsResponseWorkflowRunsItem> }

Type declaration

ActionsListWorkflowRunsResponseWorkflowRunsItem

ActionsListWorkflowRunsResponseWorkflowRunsItem: { artifacts_url: string; cancel_url: string; check_suite_id: number; conclusion: null; created_at: string; event: string; head_branch: string; head_commit: ActionsListWorkflowRunsResponseWorkflowRunsItemHeadCommit; head_repository: ActionsListWorkflowRunsResponseWorkflowRunsItemHeadRepository; head_sha: string; html_url: string; id: number; jobs_url: string; logs_url: string; node_id: string; pull_requests: Array<any>; repository: ActionsListWorkflowRunsResponseWorkflowRunsItemRepository; rerun_url: string; run_number: number; status: string; updated_at: string; url: string; workflow_url: string }

Type declaration

ActionsListWorkflowRunsResponseWorkflowRunsItemHeadCommit

ActionsListWorkflowRunsResponseWorkflowRunsItemHeadCommit: { author: ActionsListWorkflowRunsResponseWorkflowRunsItemHeadCommitAuthor; committer: ActionsListWorkflowRunsResponseWorkflowRunsItemHeadCommitCommitter; id: string; message: string; timestamp: string; tree_id: string }

Type declaration

ActionsListWorkflowRunsResponseWorkflowRunsItemHeadCommitAuthor

ActionsListWorkflowRunsResponseWorkflowRunsItemHeadCommitAuthor: { email: string; name: string }

Type declaration

  • email: string
  • name: string

ActionsListWorkflowRunsResponseWorkflowRunsItemHeadCommitCommitter

ActionsListWorkflowRunsResponseWorkflowRunsItemHeadCommitCommitter: { email: string; name: string }

Type declaration

  • email: string
  • name: string

ActionsListWorkflowRunsResponseWorkflowRunsItemHeadRepository

ActionsListWorkflowRunsResponseWorkflowRunsItemHeadRepository: { archive_url: string; assignees_url: string; blobs_url: string; branches_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; deployments_url: string; description: null; downloads_url: string; events_url: string; fork: boolean; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; hooks_url: string; html_url: string; id: number; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; languages_url: string; merges_url: string; milestones_url: string; name: string; node_id: string; notifications_url: string; owner: ActionsListWorkflowRunsResponseWorkflowRunsItemHeadRepositoryOwner; private: boolean; pulls_url: string; releases_url: string; stargazers_url: string; statuses_url: string; subscribers_url: string; subscription_url: string; tags_url: string; teams_url: string; trees_url: string; url: string }

Type declaration

  • archive_url: string
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • deployments_url: string
  • description: null
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • hooks_url: string
  • html_url: string
  • id: number
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • name: string
  • node_id: string
  • notifications_url: string
  • owner: ActionsListWorkflowRunsResponseWorkflowRunsItemHeadRepositoryOwner
  • private: boolean
  • pulls_url: string
  • releases_url: string
  • stargazers_url: string
  • statuses_url: string
  • subscribers_url: string
  • subscription_url: string
  • tags_url: string
  • teams_url: string
  • trees_url: string
  • url: string

ActionsListWorkflowRunsResponseWorkflowRunsItemHeadRepositoryOwner

ActionsListWorkflowRunsResponseWorkflowRunsItemHeadRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ActionsListWorkflowRunsResponseWorkflowRunsItemRepository

ActionsListWorkflowRunsResponseWorkflowRunsItemRepository: { archive_url: string; assignees_url: string; blobs_url: string; branches_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; deployments_url: string; description: string; downloads_url: string; events_url: string; fork: boolean; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; html_url: string; id: number; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; languages_url: string; merges_url: string; milestones_url: string; name: string; node_id: string; notifications_url: string; owner: ActionsListWorkflowRunsResponseWorkflowRunsItemRepositoryOwner; private: boolean; pulls_url: string; releases_url: string; ssh_url: string; stargazers_url: string; statuses_url: string; subscribers_url: string; subscription_url: string; tags_url: string; teams_url: string; trees_url: string; url: string }

Type declaration

  • archive_url: string
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • deployments_url: string
  • description: string
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • html_url: string
  • id: number
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • name: string
  • node_id: string
  • notifications_url: string
  • owner: ActionsListWorkflowRunsResponseWorkflowRunsItemRepositoryOwner
  • private: boolean
  • pulls_url: string
  • releases_url: string
  • ssh_url: string
  • stargazers_url: string
  • statuses_url: string
  • subscribers_url: string
  • subscription_url: string
  • tags_url: string
  • teams_url: string
  • trees_url: string
  • url: string

ActionsListWorkflowRunsResponseWorkflowRunsItemRepositoryOwner

ActionsListWorkflowRunsResponseWorkflowRunsItemRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ActionsReRunWorkflowParams

ActionsReRunWorkflowParams: { owner: string; repo: string; run_id: number }

Type declaration

  • owner: string
  • repo: string
  • run_id: number

ActionsRemoveSelfHostedRunnerParams

ActionsRemoveSelfHostedRunnerParams: { owner: string; repo: string; runner_id: number }

Type declaration

  • owner: string
  • repo: string
  • runner_id: number

ActivityCheckStarringRepoParams

ActivityCheckStarringRepoParams: { owner: string; repo: string }

Type declaration

  • owner: string
  • repo: string

ActivityCheckWatchingRepoLegacyParams

ActivityCheckWatchingRepoLegacyParams: { owner: string; repo: string }

Type declaration

  • owner: string
  • repo: string

ActivityDeleteRepoSubscriptionParams

ActivityDeleteRepoSubscriptionParams: { owner: string; repo: string }

Type declaration

  • owner: string
  • repo: string

ActivityDeleteThreadSubscriptionParams

ActivityDeleteThreadSubscriptionParams: { thread_id: number }

Type declaration

  • thread_id: number

ActivityGetRepoSubscriptionParams

ActivityGetRepoSubscriptionParams: { owner: string; repo: string }

Type declaration

  • owner: string
  • repo: string

ActivityGetRepoSubscriptionResponse

ActivityGetRepoSubscriptionResponse: { created_at: string; ignored: boolean; reason: null; repository_url: string; subscribed: boolean; url: string }

Type declaration

  • created_at: string
  • ignored: boolean
  • reason: null
  • repository_url: string
  • subscribed: boolean
  • url: string

ActivityGetThreadParams

ActivityGetThreadParams: { thread_id: number }

Type declaration

  • thread_id: number

ActivityGetThreadResponse

ActivityGetThreadResponse: { id: string; last_read_at: string; reason: string; repository: ActivityGetThreadResponseRepository; subject: ActivityGetThreadResponseSubject; unread: boolean; updated_at: string; url: string }

Type declaration

ActivityGetThreadResponseRepository

ActivityGetThreadResponseRepository: { archive_url: string; assignees_url: string; blobs_url: string; branches_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; deployments_url: string; description: string; downloads_url: string; events_url: string; fork: boolean; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; html_url: string; id: number; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; languages_url: string; merges_url: string; milestones_url: string; name: string; node_id: string; notifications_url: string; owner: ActivityGetThreadResponseRepositoryOwner; private: boolean; pulls_url: string; releases_url: string; ssh_url: string; stargazers_url: string; statuses_url: string; subscribers_url: string; subscription_url: string; tags_url: string; teams_url: string; trees_url: string; url: string }

Type declaration

  • archive_url: string
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • deployments_url: string
  • description: string
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • html_url: string
  • id: number
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • name: string
  • node_id: string
  • notifications_url: string
  • owner: ActivityGetThreadResponseRepositoryOwner
  • private: boolean
  • pulls_url: string
  • releases_url: string
  • ssh_url: string
  • stargazers_url: string
  • statuses_url: string
  • subscribers_url: string
  • subscription_url: string
  • tags_url: string
  • teams_url: string
  • trees_url: string
  • url: string

ActivityGetThreadResponseRepositoryOwner

ActivityGetThreadResponseRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ActivityGetThreadResponseSubject

ActivityGetThreadResponseSubject: { latest_comment_url: string; title: string; type: string; url: string }

Type declaration

  • latest_comment_url: string
  • title: string
  • type: string
  • url: string

ActivityGetThreadSubscriptionParams

ActivityGetThreadSubscriptionParams: { thread_id: number }

Type declaration

  • thread_id: number

ActivityGetThreadSubscriptionResponse

ActivityGetThreadSubscriptionResponse: { created_at: string; ignored: boolean; reason: null; subscribed: boolean; thread_url: string; url: string }

Type declaration

  • created_at: string
  • ignored: boolean
  • reason: null
  • subscribed: boolean
  • thread_url: string
  • url: string

ActivityListEventsForOrgParams

ActivityListEventsForOrgParams: { org: string; page?: undefined | number; per_page?: undefined | number; username: string }

Type declaration

  • org: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • username: string

ActivityListEventsForUserParams

ActivityListEventsForUserParams: { page?: undefined | number; per_page?: undefined | number; username: string }

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • username: string

ActivityListFeedsResponse

ActivityListFeedsResponse: { _links: ActivityListFeedsResponseLinks; current_user_actor_url: string; current_user_organization_url: string; current_user_organization_urls: Array<string>; current_user_public_url: string; current_user_url: string; security_advisories_url: string; timeline_url: string; user_url: string }

Type declaration

  • _links: ActivityListFeedsResponseLinks
  • current_user_actor_url: string
  • current_user_organization_url: string
  • current_user_organization_urls: Array<string>
  • current_user_public_url: string
  • current_user_url: string
  • security_advisories_url: string
  • timeline_url: string
  • user_url: string

ActivityListFeedsResponseLinks

ActivityListFeedsResponseLinks: { current_user: ActivityListFeedsResponseLinksCurrentUser; current_user_actor: ActivityListFeedsResponseLinksCurrentUserActor; current_user_organization: ActivityListFeedsResponseLinksCurrentUserOrganization; current_user_organizations: Array<ActivityListFeedsResponseLinksCurrentUserOrganizationsItem>; current_user_public: ActivityListFeedsResponseLinksCurrentUserPublic; security_advisories: ActivityListFeedsResponseLinksSecurityAdvisories; timeline: ActivityListFeedsResponseLinksTimeline; user: ActivityListFeedsResponseLinksUser }

Type declaration

ActivityListFeedsResponseLinksCurrentUser

ActivityListFeedsResponseLinksCurrentUser: { href: string; type: string }

Type declaration

  • href: string
  • type: string

ActivityListFeedsResponseLinksCurrentUserActor

ActivityListFeedsResponseLinksCurrentUserActor: { href: string; type: string }

Type declaration

  • href: string
  • type: string

ActivityListFeedsResponseLinksCurrentUserOrganization

ActivityListFeedsResponseLinksCurrentUserOrganization: { href: string; type: string }

Type declaration

  • href: string
  • type: string

ActivityListFeedsResponseLinksCurrentUserOrganizationsItem

ActivityListFeedsResponseLinksCurrentUserOrganizationsItem: { href: string; type: string }

Type declaration

  • href: string
  • type: string

ActivityListFeedsResponseLinksCurrentUserPublic

ActivityListFeedsResponseLinksCurrentUserPublic: { href: string; type: string }

Type declaration

  • href: string
  • type: string

ActivityListFeedsResponseLinksSecurityAdvisories

ActivityListFeedsResponseLinksSecurityAdvisories: { href: string; type: string }

Type declaration

  • href: string
  • type: string

ActivityListFeedsResponseLinksTimeline

ActivityListFeedsResponseLinksTimeline: { href: string; type: string }

Type declaration

  • href: string
  • type: string

ActivityListFeedsResponseLinksUser

ActivityListFeedsResponseLinksUser: { href: string; type: string }

Type declaration

  • href: string
  • type: string

ActivityListNotificationsForRepoParams

ActivityListNotificationsForRepoParams: { all?: undefined | false | true; before?: undefined | string; owner: string; page?: undefined | number; participating?: undefined | false | true; per_page?: undefined | number; repo: string; since?: undefined | string }

Type declaration

  • Optional all?: undefined | false | true

    If true, show notifications marked as read.

  • Optional before?: undefined | string

    Only show notifications updated before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional participating?: undefined | false | true

    If true, only shows notifications in which the user is directly participating or mentioned.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string
  • Optional since?: undefined | string

    Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

ActivityListNotificationsForRepoResponse

ActivityListNotificationsForRepoResponse: Array<ActivityListNotificationsForRepoResponseItem>

ActivityListNotificationsForRepoResponseItem

ActivityListNotificationsForRepoResponseItem: { id: string; last_read_at: string; reason: string; repository: ActivityListNotificationsForRepoResponseItemRepository; subject: ActivityListNotificationsForRepoResponseItemSubject; unread: boolean; updated_at: string; url: string }

Type declaration

ActivityListNotificationsForRepoResponseItemRepository

ActivityListNotificationsForRepoResponseItemRepository: { archive_url: string; assignees_url: string; blobs_url: string; branches_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; deployments_url: string; description: string; downloads_url: string; events_url: string; fork: boolean; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; html_url: string; id: number; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; languages_url: string; merges_url: string; milestones_url: string; name: string; node_id: string; notifications_url: string; owner: ActivityListNotificationsForRepoResponseItemRepositoryOwner; private: boolean; pulls_url: string; releases_url: string; ssh_url: string; stargazers_url: string; statuses_url: string; subscribers_url: string; subscription_url: string; tags_url: string; teams_url: string; trees_url: string; url: string }

Type declaration

  • archive_url: string
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • deployments_url: string
  • description: string
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • html_url: string
  • id: number
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • name: string
  • node_id: string
  • notifications_url: string
  • owner: ActivityListNotificationsForRepoResponseItemRepositoryOwner
  • private: boolean
  • pulls_url: string
  • releases_url: string
  • ssh_url: string
  • stargazers_url: string
  • statuses_url: string
  • subscribers_url: string
  • subscription_url: string
  • tags_url: string
  • teams_url: string
  • trees_url: string
  • url: string

ActivityListNotificationsForRepoResponseItemRepositoryOwner

ActivityListNotificationsForRepoResponseItemRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ActivityListNotificationsForRepoResponseItemSubject

ActivityListNotificationsForRepoResponseItemSubject: { latest_comment_url: string; title: string; type: string; url: string }

Type declaration

  • latest_comment_url: string
  • title: string
  • type: string
  • url: string

ActivityListNotificationsParams

ActivityListNotificationsParams: { all?: undefined | false | true; before?: undefined | string; page?: undefined | number; participating?: undefined | false | true; per_page?: undefined | number; since?: undefined | string }

Type declaration

  • Optional all?: undefined | false | true

    If true, show notifications marked as read.

  • Optional before?: undefined | string

    Only show notifications updated before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional participating?: undefined | false | true

    If true, only shows notifications in which the user is directly participating or mentioned.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • Optional since?: undefined | string

    Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

ActivityListNotificationsResponse

ActivityListNotificationsResponse: Array<ActivityListNotificationsResponseItem>

ActivityListNotificationsResponseItem

ActivityListNotificationsResponseItem: { id: string; last_read_at: string; reason: string; repository: ActivityListNotificationsResponseItemRepository; subject: ActivityListNotificationsResponseItemSubject; unread: boolean; updated_at: string; url: string }

Type declaration

ActivityListNotificationsResponseItemRepository

ActivityListNotificationsResponseItemRepository: { archive_url: string; assignees_url: string; blobs_url: string; branches_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; deployments_url: string; description: string; downloads_url: string; events_url: string; fork: boolean; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; html_url: string; id: number; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; languages_url: string; merges_url: string; milestones_url: string; name: string; node_id: string; notifications_url: string; owner: ActivityListNotificationsResponseItemRepositoryOwner; private: boolean; pulls_url: string; releases_url: string; ssh_url: string; stargazers_url: string; statuses_url: string; subscribers_url: string; subscription_url: string; tags_url: string; teams_url: string; trees_url: string; url: string }

Type declaration

  • archive_url: string
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • deployments_url: string
  • description: string
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • html_url: string
  • id: number
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • name: string
  • node_id: string
  • notifications_url: string
  • owner: ActivityListNotificationsResponseItemRepositoryOwner
  • private: boolean
  • pulls_url: string
  • releases_url: string
  • ssh_url: string
  • stargazers_url: string
  • statuses_url: string
  • subscribers_url: string
  • subscription_url: string
  • tags_url: string
  • teams_url: string
  • trees_url: string
  • url: string

ActivityListNotificationsResponseItemRepositoryOwner

ActivityListNotificationsResponseItemRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ActivityListNotificationsResponseItemSubject

ActivityListNotificationsResponseItemSubject: { latest_comment_url: string; title: string; type: string; url: string }

Type declaration

  • latest_comment_url: string
  • title: string
  • type: string
  • url: string

ActivityListPublicEventsForOrgParams

ActivityListPublicEventsForOrgParams: { org: string; page?: undefined | number; per_page?: undefined | number }

Type declaration

  • org: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

ActivityListPublicEventsForRepoNetworkParams

ActivityListPublicEventsForRepoNetworkParams: { owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ActivityListPublicEventsForUserParams

ActivityListPublicEventsForUserParams: { page?: undefined | number; per_page?: undefined | number; username: string }

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • username: string

ActivityListPublicEventsParams

ActivityListPublicEventsParams: { page?: undefined | number; per_page?: undefined | number }

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

ActivityListReceivedEventsForUserParams

ActivityListReceivedEventsForUserParams: { page?: undefined | number; per_page?: undefined | number; username: string }

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • username: string

ActivityListReceivedPublicEventsForUserParams

ActivityListReceivedPublicEventsForUserParams: { page?: undefined | number; per_page?: undefined | number; username: string }

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • username: string

ActivityListRepoEventsParams

ActivityListRepoEventsParams: { owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ActivityListReposStarredByAuthenticatedUserParams

ActivityListReposStarredByAuthenticatedUserParams: { direction?: "asc" | "desc"; page?: undefined | number; per_page?: undefined | number; sort?: "created" | "updated" }

Type declaration

  • Optional direction?: "asc" | "desc"

    One of asc (ascending) or desc (descending).

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • Optional sort?: "created" | "updated"

    One of created (when the repository was starred) or updated (when it was last pushed to).

ActivityListReposStarredByAuthenticatedUserResponse

ActivityListReposStarredByAuthenticatedUserResponse: Array<ActivityListReposStarredByAuthenticatedUserResponseItem>

ActivityListReposStarredByAuthenticatedUserResponseItem

ActivityListReposStarredByAuthenticatedUserResponseItem: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: ActivityListReposStarredByAuthenticatedUserResponseItemOwner; permissions: ActivityListReposStarredByAuthenticatedUserResponseItemPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • allow_merge_commit: boolean
  • allow_rebase_merge: boolean
  • allow_squash_merge: boolean
  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: ActivityListReposStarredByAuthenticatedUserResponseItemOwner
  • permissions: ActivityListReposStarredByAuthenticatedUserResponseItemPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

ActivityListReposStarredByAuthenticatedUserResponseItemOwner

ActivityListReposStarredByAuthenticatedUserResponseItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ActivityListReposStarredByAuthenticatedUserResponseItemPermissions

ActivityListReposStarredByAuthenticatedUserResponseItemPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

ActivityListReposStarredByUserParams

ActivityListReposStarredByUserParams: { direction?: "asc" | "desc"; page?: undefined | number; per_page?: undefined | number; sort?: "created" | "updated"; username: string }

Type declaration

  • Optional direction?: "asc" | "desc"

    One of asc (ascending) or desc (descending).

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • Optional sort?: "created" | "updated"

    One of created (when the repository was starred) or updated (when it was last pushed to).

  • username: string

ActivityListReposStarredByUserResponse

ActivityListReposStarredByUserResponse: Array<ActivityListReposStarredByUserResponseItem>

ActivityListReposStarredByUserResponseItem

ActivityListReposStarredByUserResponseItem: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: ActivityListReposStarredByUserResponseItemOwner; permissions: ActivityListReposStarredByUserResponseItemPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • allow_merge_commit: boolean
  • allow_rebase_merge: boolean
  • allow_squash_merge: boolean
  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: ActivityListReposStarredByUserResponseItemOwner
  • permissions: ActivityListReposStarredByUserResponseItemPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

ActivityListReposStarredByUserResponseItemOwner

ActivityListReposStarredByUserResponseItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ActivityListReposStarredByUserResponseItemPermissions

ActivityListReposStarredByUserResponseItemPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

ActivityListReposWatchedByUserParams

ActivityListReposWatchedByUserParams: { page?: undefined | number; per_page?: undefined | number; username: string }

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • username: string

ActivityListReposWatchedByUserResponse

ActivityListReposWatchedByUserResponse: Array<ActivityListReposWatchedByUserResponseItem>

ActivityListReposWatchedByUserResponseItem

ActivityListReposWatchedByUserResponseItem: { archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; license: ActivityListReposWatchedByUserResponseItemLicense; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: ActivityListReposWatchedByUserResponseItemOwner; permissions: ActivityListReposWatchedByUserResponseItemPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • license: ActivityListReposWatchedByUserResponseItemLicense
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: ActivityListReposWatchedByUserResponseItemOwner
  • permissions: ActivityListReposWatchedByUserResponseItemPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

ActivityListReposWatchedByUserResponseItemLicense

ActivityListReposWatchedByUserResponseItemLicense: { key: string; name: string; node_id: string; spdx_id: string; url: string }

Type declaration

  • key: string
  • name: string
  • node_id: string
  • spdx_id: string
  • url: string

ActivityListReposWatchedByUserResponseItemOwner

ActivityListReposWatchedByUserResponseItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ActivityListReposWatchedByUserResponseItemPermissions

ActivityListReposWatchedByUserResponseItemPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

ActivityListStargazersForRepoParams

ActivityListStargazersForRepoParams: { owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ActivityListStargazersForRepoResponse

ActivityListStargazersForRepoResponse: Array<ActivityListStargazersForRepoResponseItem>

ActivityListStargazersForRepoResponseItem

ActivityListStargazersForRepoResponseItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ActivityListWatchedReposForAuthenticatedUserParams

ActivityListWatchedReposForAuthenticatedUserParams: { page?: undefined | number; per_page?: undefined | number }

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

ActivityListWatchedReposForAuthenticatedUserResponse

ActivityListWatchedReposForAuthenticatedUserResponse: Array<ActivityListWatchedReposForAuthenticatedUserResponseItem>

ActivityListWatchedReposForAuthenticatedUserResponseItem

ActivityListWatchedReposForAuthenticatedUserResponseItem: { archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; license: ActivityListWatchedReposForAuthenticatedUserResponseItemLicense; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: ActivityListWatchedReposForAuthenticatedUserResponseItemOwner; permissions: ActivityListWatchedReposForAuthenticatedUserResponseItemPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

Type declaration

  • archive_url: string
  • archived: boolean
  • assignees_url: string
  • blobs_url: string
  • branches_url: string
  • clone_url: string
  • collaborators_url: string
  • comments_url: string
  • commits_url: string
  • compare_url: string
  • contents_url: string
  • contributors_url: string
  • created_at: string
  • default_branch: string
  • deployments_url: string
  • description: string
  • disabled: boolean
  • downloads_url: string
  • events_url: string
  • fork: boolean
  • forks_count: number
  • forks_url: string
  • full_name: string
  • git_commits_url: string
  • git_refs_url: string
  • git_tags_url: string
  • git_url: string
  • has_downloads: boolean
  • has_issues: boolean
  • has_pages: boolean
  • has_projects: boolean
  • has_wiki: boolean
  • homepage: string
  • hooks_url: string
  • html_url: string
  • id: number
  • is_template: boolean
  • issue_comment_url: string
  • issue_events_url: string
  • issues_url: string
  • keys_url: string
  • labels_url: string
  • language: null
  • languages_url: string
  • license: ActivityListWatchedReposForAuthenticatedUserResponseItemLicense
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: ActivityListWatchedReposForAuthenticatedUserResponseItemOwner
  • permissions: ActivityListWatchedReposForAuthenticatedUserResponseItemPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • temp_clone_token: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • visibility: string
  • watchers_count: number

ActivityListWatchedReposForAuthenticatedUserResponseItemLicense

ActivityListWatchedReposForAuthenticatedUserResponseItemLicense: { key: string; name: string; node_id: string; spdx_id: string; url: string }

Type declaration

  • key: string
  • name: string
  • node_id: string
  • spdx_id: string
  • url: string

ActivityListWatchedReposForAuthenticatedUserResponseItemOwner

ActivityListWatchedReposForAuthenticatedUserResponseItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ActivityListWatchedReposForAuthenticatedUserResponseItemPermissions

ActivityListWatchedReposForAuthenticatedUserResponseItemPermissions: { admin: boolean; pull: boolean; push: boolean }

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

ActivityListWatchersForRepoParams

ActivityListWatchersForRepoParams: { owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ActivityListWatchersForRepoResponse

ActivityListWatchersForRepoResponse: Array<ActivityListWatchersForRepoResponseItem>

ActivityListWatchersForRepoResponseItem

ActivityListWatchersForRepoResponseItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ActivityMarkAsReadParams

ActivityMarkAsReadParams: { last_read_at?: undefined | string }

Type declaration

  • Optional last_read_at?: undefined | string

    Describes the last point that notifications were checked. Anything updated since this time will not be updated. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

ActivityMarkNotificationsAsReadForRepoParams

ActivityMarkNotificationsAsReadForRepoParams: { last_read_at?: undefined | string; owner: string; repo: string }

Type declaration

  • Optional last_read_at?: undefined | string

    Describes the last point that notifications were checked. Anything updated since this time will not be updated. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

  • owner: string
  • repo: string

ActivityMarkThreadAsReadParams

ActivityMarkThreadAsReadParams: { thread_id: number }

Type declaration

  • thread_id: number

ActivitySetRepoSubscriptionParams

ActivitySetRepoSubscriptionParams: { ignored?: undefined | false | true; owner: string; repo: string; subscribed?: undefined | false | true }

Type declaration

  • Optional ignored?: undefined | false | true

    Determines if all notifications should be blocked from this repository.

  • owner: string
  • repo: string
  • Optional subscribed?: undefined | false | true

    Determines if notifications should be received from this repository.

ActivitySetRepoSubscriptionResponse

ActivitySetRepoSubscriptionResponse: { created_at: string; ignored: boolean; reason: null; repository_url: string; subscribed: boolean; url: string }

Type declaration

  • created_at: string
  • ignored: boolean
  • reason: null
  • repository_url: string
  • subscribed: boolean
  • url: string

ActivitySetThreadSubscriptionParams

ActivitySetThreadSubscriptionParams: { ignored?: undefined | false | true; thread_id: number }

Type declaration

  • Optional ignored?: undefined | false | true

    Unsubscribes and subscribes you to a conversation. Set ignored to true to block all notifications from this thread.

  • thread_id: number

ActivitySetThreadSubscriptionResponse

ActivitySetThreadSubscriptionResponse: { created_at: string; ignored: boolean; reason: null; subscribed: boolean; thread_url: string; url: string }

Type declaration

  • created_at: string
  • ignored: boolean
  • reason: null
  • subscribed: boolean
  • thread_url: string
  • url: string

ActivityStarRepoParams

ActivityStarRepoParams: { owner: string; repo: string }

Type declaration

  • owner: string
  • repo: string

ActivityStopWatchingRepoLegacyParams

ActivityStopWatchingRepoLegacyParams: { owner: string; repo: string }

Type declaration

  • owner: string
  • repo: string

ActivityUnstarRepoParams

ActivityUnstarRepoParams: { owner: string; repo: string }

Type declaration

  • owner: string
  • repo: string

ActivityWatchRepoLegacyParams

ActivityWatchRepoLegacyParams: { owner: string; repo: string }

Type declaration

  • owner: string
  • repo: string

AnyResponse

AnyResponse: Response<any>

AppsAddRepoToInstallationParams

AppsAddRepoToInstallationParams: { installation_id: number; repository_id: number }

Type declaration

  • installation_id: number
  • repository_id: number

AppsCheckAccountIsAssociatedWithAnyParams

AppsCheckAccountIsAssociatedWithAnyParams: { account_id: number }

Type declaration

  • account_id: number

AppsCheckAccountIsAssociatedWithAnyResponse

AppsCheckAccountIsAssociatedWithAnyResponse: { email: null; id: number; login: string; marketplace_pending_change: AppsCheckAccountIsAssociatedWithAnyResponseMarketplacePendingChange; marketplace_purchase: AppsCheckAccountIsAssociatedWithAnyResponseMarketplacePurchase; organization_billing_email: string; type: string; url: string }

Type declaration

AppsCheckAccountIsAssociatedWithAnyResponseMarketplacePendingChange

AppsCheckAccountIsAssociatedWithAnyResponseMarketplacePendingChange: { effective_date: string; id: number; plan: AppsCheckAccountIsAssociatedWithAnyResponseMarketplacePendingChangePlan; unit_count: null }

Type declaration

AppsCheckAccountIsAssociatedWithAnyResponseMarketplacePendingChangePlan

AppsCheckAccountIsAssociatedWithAnyResponseMarketplacePendingChangePlan: { accounts_url: string; bullets: Array<string>; description: string; has_free_trial: boolean; id: number; monthly_price_in_cents: number; name: string; number: number; price_model: string; state: string; unit_name: null; url: string; yearly_price_in_cents: number }

Type declaration

  • accounts_url: string
  • bullets: Array<string>
  • description: string
  • has_free_trial: boolean
  • id: number
  • monthly_price_in_cents: number
  • name: string
  • number: number
  • price_model: string
  • state: string
  • unit_name: null
  • url: string
  • yearly_price_in_cents: number

AppsCheckAccountIsAssociatedWithAnyResponseMarketplacePurchase

AppsCheckAccountIsAssociatedWithAnyResponseMarketplacePurchase: { billing_cycle: string; free_trial_ends_on: string; next_billing_date: string; on_free_trial: boolean; plan: AppsCheckAccountIsAssociatedWithAnyResponseMarketplacePurchasePlan; unit_count: null; updated_at: string }

Type declaration

AppsCheckAccountIsAssociatedWithAnyResponseMarketplacePurchasePlan

AppsCheckAccountIsAssociatedWithAnyResponseMarketplacePurchasePlan: { accounts_url: string; bullets: Array<string>; description: string; has_free_trial: boolean; id: number; monthly_price_in_cents: number; name: string; number: number; price_model: string; state: string; unit_name: null; url: string; yearly_price_in_cents: number }

Type declaration

  • accounts_url: string
  • bullets: Array<string>
  • description: string
  • has_free_trial: boolean
  • id: number
  • monthly_price_in_cents: number
  • name: string
  • number: number
  • price_model: string
  • state: string
  • unit_name: null
  • url: string
  • yearly_price_in_cents: number

AppsCheckAccountIsAssociatedWithAnyStubbedParams

AppsCheckAccountIsAssociatedWithAnyStubbedParams: { account_id: number }

Type declaration

  • account_id: number

AppsCheckAccountIsAssociatedWithAnyStubbedResponse

AppsCheckAccountIsAssociatedWithAnyStubbedResponse: { email: null; id: number; login: string; marketplace_pending_change: AppsCheckAccountIsAssociatedWithAnyStubbedResponseMarketplacePendingChange; marketplace_purchase: AppsCheckAccountIsAssociatedWithAnyStubbedResponseMarketplacePurchase; organization_billing_email: string; type: string; url: string }

Type declaration

AppsCheckAccountIsAssociatedWithAnyStubbedResponseMarketplacePendingChange

AppsCheckAccountIsAssociatedWithAnyStubbedResponseMarketplacePendingChange: { effective_date: string; id: number; plan: AppsCheckAccountIsAssociatedWithAnyStubbedResponseMarketplacePendingChangePlan; unit_count: null }

Type declaration

AppsCheckAccountIsAssociatedWithAnyStubbedResponseMarketplacePendingChangePlan

AppsCheckAccountIsAssociatedWithAnyStubbedResponseMarketplacePendingChangePlan: { accounts_url: string; bullets: Array<string>; description: string; has_free_trial: boolean; id: number; monthly_price_in_cents: number; name: string; number: number; price_model: string; state: string; unit_name: null; url: string; yearly_price_in_cents: number }

Type declaration

  • accounts_url: string
  • bullets: Array<string>
  • description: string
  • has_free_trial: boolean
  • id: number
  • monthly_price_in_cents: number
  • name: string
  • number: number
  • price_model: string
  • state: string
  • unit_name: null
  • url: string
  • yearly_price_in_cents: number

AppsCheckAccountIsAssociatedWithAnyStubbedResponseMarketplacePurchase

AppsCheckAccountIsAssociatedWithAnyStubbedResponseMarketplacePurchase: { billing_cycle: string; free_trial_ends_on: string; next_billing_date: string; on_free_trial: boolean; plan: AppsCheckAccountIsAssociatedWithAnyStubbedResponseMarketplacePurchasePlan; unit_count: null; updated_at: string }

Type declaration

AppsCheckAccountIsAssociatedWithAnyStubbedResponseMarketplacePurchasePlan

AppsCheckAccountIsAssociatedWithAnyStubbedResponseMarketplacePurchasePlan: { accounts_url: string; bullets: Array<string>; description: string; has_free_trial: boolean; id: number; monthly_price_in_cents: number; name: string; number: number; price_model: string; state: string; unit_name: null; url: string; yearly_price_in_cents: number }

Type declaration

  • accounts_url: string
  • bullets: Array<string>
  • description: string
  • has_free_trial: boolean
  • id: number
  • monthly_price_in_cents: number
  • name: string
  • number: number
  • price_model: string
  • state: string
  • unit_name: null
  • url: string
  • yearly_price_in_cents: number

AppsCheckAuthorizationParams

AppsCheckAuthorizationParams: { access_token: string; client_id: string }

Type declaration

  • access_token: string
  • client_id: string

AppsCheckAuthorizationResponse

AppsCheckAuthorizationResponse: { app: AppsCheckAuthorizationResponseApp; created_at: string; fingerprint: string; hashed_token: string; id: number; note: string; note_url: string; scopes: Array<string>; token: string; token_last_eight: string; updated_at: string; url: string; user: AppsCheckAuthorizationResponseUser }

Type declaration

AppsCheckAuthorizationResponseApp

AppsCheckAuthorizationResponseApp: { client_id: string; name: string; url: string }

Type declaration

  • client_id: string
  • name: string
  • url: string

AppsCheckAuthorizationResponseUser

AppsCheckAuthorizationResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

AppsCheckTokenParams

AppsCheckTokenParams: { access_token?: undefined | string; client_id: string }

Type declaration

  • Optional access_token?: undefined | string

    The OAuth access token used to authenticate to the GitHub API.

  • client_id: string

AppsCheckTokenResponse

AppsCheckTokenResponse: { app: AppsCheckTokenResponseApp; created_at: string; fingerprint: string; hashed_token: string; id: number; note: string; note_url: string; scopes: Array<string>; token: string; token_last_eight: string; updated_at: string; url: string; user: AppsCheckTokenResponseUser }

Type declaration

  • app: AppsCheckTokenResponseApp
  • created_at: string
  • fingerprint: string
  • hashed_token: string
  • id: number
  • note: string
  • note_url: string
  • scopes: Array<string>
  • token: string
  • token_last_eight: string
  • updated_at: string
  • url: string
  • user: AppsCheckTokenResponseUser

AppsCheckTokenResponseApp

AppsCheckTokenResponseApp: { client_id: string; name: string; url: string }

Type declaration

  • client_id: string
  • name: string
  • url: string

AppsCheckTokenResponseUser

AppsCheckTokenResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

AppsCreateContentAttachmentParams

AppsCreateContentAttachmentParams: { body: string; content_reference_id: number; title: string }

Type declaration

  • body: string

    The body text of the content attachment displayed in the body or comment of an issue or pull request. This parameter supports markdown.

  • content_reference_id: number
  • title: string

    The title of the content attachment displayed in the body or comment of an issue or pull request.

AppsCreateContentAttachmentResponse

AppsCreateContentAttachmentResponse: { body: string; id: number; title: string }

Type declaration

  • body: string
  • id: number
  • title: string

AppsCreateFromManifestParams

AppsCreateFromManifestParams: { code: string }

Type declaration

  • code: string

AppsCreateFromManifestResponse

AppsCreateFromManifestResponse: { client_id: string; client_secret: string; created_at: string; description: null; external_url: string; html_url: string; id: number; name: string; node_id: string; owner: AppsCreateFromManifestResponseOwner; pem: string; updated_at: string; webhook_secret: string }

Type declaration

  • client_id: string
  • client_secret: string
  • created_at: string
  • description: null
  • external_url: string
  • html_url: string
  • id: number
  • name: string
  • node_id: string
  • owner: AppsCreateFromManifestResponseOwner
  • pem: string
  • updated_at: string
  • webhook_secret: string

AppsCreateFromManifestResponseOwner

AppsCreateFromManifestResponseOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

AppsCreateInstallationTokenParams

AppsCreateInstallationTokenParams: { installation_id: number; permissions?: AppsCreateInstallationTokenParamsPermissions; repository_ids?: number[] }

Type declaration

  • installation_id: number
  • Optional permissions?: AppsCreateInstallationTokenParamsPermissions

    The permissions granted to the access token. The permissions object includes the permission names and their access type. For a complete list of permissions and allowable values, see "GitHub App permissions."

  • Optional repository_ids?: number[]

    The ids of the repositories that the installation token can access. Providing repository ids restricts the access of an installation token to specific repositories. You can use the "List repositories" endpoint to get the id of all repositories that an installation can access. For example, you can select specific repositories when creating an installation token to restrict the number of repositories that can be cloned using the token.

AppsCreateInstallationTokenParamsPermissions

AppsCreateInstallationTokenParamsPermissions: {}

Type declaration

    AppsCreateInstallationTokenResponse

    AppsCreateInstallationTokenResponse: { expires_at: string; permissions: AppsCreateInstallationTokenResponsePermissions; repositories: Array<AppsCreateInstallationTokenResponseRepositoriesItem>; token: string }

    Type declaration

    AppsCreateInstallationTokenResponsePermissions

    AppsCreateInstallationTokenResponsePermissions: { contents: string; issues: string }

    Type declaration

    • contents: string
    • issues: string

    AppsCreateInstallationTokenResponseRepositoriesItem

    AppsCreateInstallationTokenResponseRepositoriesItem: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: AppsCreateInstallationTokenResponseRepositoriesItemOwner; permissions: AppsCreateInstallationTokenResponseRepositoriesItemPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

    Type declaration

    • allow_merge_commit: boolean
    • allow_rebase_merge: boolean
    • allow_squash_merge: boolean
    • archive_url: string
    • archived: boolean
    • assignees_url: string
    • blobs_url: string
    • branches_url: string
    • clone_url: string
    • collaborators_url: string
    • comments_url: string
    • commits_url: string
    • compare_url: string
    • contents_url: string
    • contributors_url: string
    • created_at: string
    • default_branch: string
    • deployments_url: string
    • description: string
    • disabled: boolean
    • downloads_url: string
    • events_url: string
    • fork: boolean
    • forks_count: number
    • forks_url: string
    • full_name: string
    • git_commits_url: string
    • git_refs_url: string
    • git_tags_url: string
    • git_url: string
    • has_downloads: boolean
    • has_issues: boolean
    • has_pages: boolean
    • has_projects: boolean
    • has_wiki: boolean
    • homepage: string
    • hooks_url: string
    • html_url: string
    • id: number
    • is_template: boolean
    • issue_comment_url: string
    • issue_events_url: string
    • issues_url: string
    • keys_url: string
    • labels_url: string
    • language: null
    • languages_url: string
    • merges_url: string
    • milestones_url: string
    • mirror_url: string
    • name: string
    • network_count: number
    • node_id: string
    • notifications_url: string
    • open_issues_count: number
    • owner: AppsCreateInstallationTokenResponseRepositoriesItemOwner
    • permissions: AppsCreateInstallationTokenResponseRepositoriesItemPermissions
    • private: boolean
    • pulls_url: string
    • pushed_at: string
    • releases_url: string
    • size: number
    • ssh_url: string
    • stargazers_count: number
    • stargazers_url: string
    • statuses_url: string
    • subscribers_count: number
    • subscribers_url: string
    • subscription_url: string
    • svn_url: string
    • tags_url: string
    • teams_url: string
    • temp_clone_token: string
    • template_repository: null
    • topics: Array<string>
    • trees_url: string
    • updated_at: string
    • url: string
    • visibility: string
    • watchers_count: number

    AppsCreateInstallationTokenResponseRepositoriesItemOwner

    AppsCreateInstallationTokenResponseRepositoriesItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    AppsCreateInstallationTokenResponseRepositoriesItemPermissions

    AppsCreateInstallationTokenResponseRepositoriesItemPermissions: { admin: boolean; pull: boolean; push: boolean }

    Type declaration

    • admin: boolean
    • pull: boolean
    • push: boolean

    AppsDeleteAuthorizationParams

    AppsDeleteAuthorizationParams: { access_token?: undefined | string; client_id: string }

    Type declaration

    • Optional access_token?: undefined | string

      The OAuth access token used to authenticate to the GitHub API.

    • client_id: string

    AppsDeleteInstallationParams

    AppsDeleteInstallationParams: { installation_id: number }

    Type declaration

    • installation_id: number

    AppsDeleteTokenParams

    AppsDeleteTokenParams: { access_token?: undefined | string; client_id: string }

    Type declaration

    • Optional access_token?: undefined | string

      The OAuth access token used to authenticate to the GitHub API.

    • client_id: string

    AppsFindOrgInstallationParams

    AppsFindOrgInstallationParams: { org: string }

    Type declaration

    • org: string

    AppsFindOrgInstallationResponse

    AppsFindOrgInstallationResponse: { access_tokens_url: string; account: AppsFindOrgInstallationResponseAccount; app_id: number; created_at: string; events: Array<string>; html_url: string; id: number; permissions: AppsFindOrgInstallationResponsePermissions; repositories_url: string; repository_selection: string; single_file_name: null; target_id: number; target_type: string; updated_at: string }

    Type declaration

    AppsFindOrgInstallationResponseAccount

    AppsFindOrgInstallationResponseAccount: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    AppsFindOrgInstallationResponsePermissions

    AppsFindOrgInstallationResponsePermissions: { checks: string; contents: string; metadata: string }

    Type declaration

    • checks: string
    • contents: string
    • metadata: string

    AppsFindRepoInstallationParams

    AppsFindRepoInstallationParams: { owner: string; repo: string }

    Type declaration

    • owner: string
    • repo: string

    AppsFindRepoInstallationResponse

    AppsFindRepoInstallationResponse: { access_tokens_url: string; account: AppsFindRepoInstallationResponseAccount; app_id: number; created_at: string; events: Array<string>; html_url: string; id: number; permissions: AppsFindRepoInstallationResponsePermissions; repositories_url: string; repository_selection: string; single_file_name: null; target_id: number; target_type: string; updated_at: string }

    Type declaration

    AppsFindRepoInstallationResponseAccount

    AppsFindRepoInstallationResponseAccount: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    AppsFindRepoInstallationResponsePermissions

    AppsFindRepoInstallationResponsePermissions: { checks: string; contents: string; metadata: string }

    Type declaration

    • checks: string
    • contents: string
    • metadata: string

    AppsFindUserInstallationParams

    AppsFindUserInstallationParams: { username: string }

    Type declaration

    • username: string

    AppsFindUserInstallationResponse

    AppsFindUserInstallationResponse: { access_tokens_url: string; account: AppsFindUserInstallationResponseAccount; app_id: number; created_at: string; events: Array<string>; html_url: string; id: number; permissions: AppsFindUserInstallationResponsePermissions; repositories_url: string; repository_selection: string; single_file_name: null; target_id: number; target_type: string; updated_at: string }

    Type declaration

    AppsFindUserInstallationResponseAccount

    AppsFindUserInstallationResponseAccount: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    AppsFindUserInstallationResponsePermissions

    AppsFindUserInstallationResponsePermissions: { checks: string; contents: string; metadata: string }

    Type declaration

    • checks: string
    • contents: string
    • metadata: string

    AppsGetAuthenticatedResponse

    AppsGetAuthenticatedResponse: { created_at: string; description: string; events: Array<string>; external_url: string; html_url: string; id: number; installations_count: number; name: string; node_id: string; owner: AppsGetAuthenticatedResponseOwner; permissions: AppsGetAuthenticatedResponsePermissions; slug: string; updated_at: string }

    Type declaration

    AppsGetAuthenticatedResponseOwner

    AppsGetAuthenticatedResponseOwner: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

    Type declaration

    • avatar_url: string
    • description: string
    • events_url: string
    • hooks_url: string
    • id: number
    • issues_url: string
    • login: string
    • members_url: string
    • node_id: string
    • public_members_url: string
    • repos_url: string
    • url: string

    AppsGetAuthenticatedResponsePermissions

    AppsGetAuthenticatedResponsePermissions: { contents: string; issues: string; metadata: string; single_file: string }

    Type declaration

    • contents: string
    • issues: string
    • metadata: string
    • single_file: string

    AppsGetBySlugParams

    AppsGetBySlugParams: { app_slug: string }

    Type declaration

    • app_slug: string

    AppsGetBySlugResponse

    AppsGetBySlugResponse: { created_at: string; description: string; events: Array<string>; external_url: string; html_url: string; id: number; name: string; node_id: string; owner: AppsGetBySlugResponseOwner; permissions: AppsGetBySlugResponsePermissions; slug: string; updated_at: string }

    Type declaration

    AppsGetBySlugResponseOwner

    AppsGetBySlugResponseOwner: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

    Type declaration

    • avatar_url: string
    • description: string
    • events_url: string
    • hooks_url: string
    • id: number
    • issues_url: string
    • login: string
    • members_url: string
    • node_id: string
    • public_members_url: string
    • repos_url: string
    • url: string

    AppsGetBySlugResponsePermissions

    AppsGetBySlugResponsePermissions: { contents: string; issues: string; metadata: string; single_file: string }

    Type declaration

    • contents: string
    • issues: string
    • metadata: string
    • single_file: string

    AppsGetInstallationParams

    AppsGetInstallationParams: { installation_id: number }

    Type declaration

    • installation_id: number

    AppsGetInstallationResponse

    AppsGetInstallationResponse: { access_tokens_url: string; account: AppsGetInstallationResponseAccount; app_id: number; events: Array<string>; html_url: string; id: number; permissions: AppsGetInstallationResponsePermissions; repositories_url: string; repository_selection: string; single_file_name: string; target_id: number; target_type: string }

    Type declaration

    AppsGetInstallationResponseAccount

    AppsGetInstallationResponseAccount: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

    Type declaration

    • avatar_url: string
    • description: string
    • events_url: string
    • hooks_url: string
    • id: number
    • issues_url: string
    • login: string
    • members_url: string
    • node_id: string
    • public_members_url: string
    • repos_url: string
    • url: string

    AppsGetInstallationResponsePermissions

    AppsGetInstallationResponsePermissions: { contents: string; issues: string; metadata: string; single_file: string }

    Type declaration

    • contents: string
    • issues: string
    • metadata: string
    • single_file: string

    AppsGetOrgInstallationParams

    AppsGetOrgInstallationParams: { org: string }

    Type declaration

    • org: string

    AppsGetOrgInstallationResponse

    AppsGetOrgInstallationResponse: { access_tokens_url: string; account: AppsGetOrgInstallationResponseAccount; app_id: number; created_at: string; events: Array<string>; html_url: string; id: number; permissions: AppsGetOrgInstallationResponsePermissions; repositories_url: string; repository_selection: string; single_file_name: null; target_id: number; target_type: string; updated_at: string }

    Type declaration

    AppsGetOrgInstallationResponseAccount

    AppsGetOrgInstallationResponseAccount: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    AppsGetOrgInstallationResponsePermissions

    AppsGetOrgInstallationResponsePermissions: { checks: string; contents: string; metadata: string }

    Type declaration

    • checks: string
    • contents: string
    • metadata: string

    AppsGetRepoInstallationParams

    AppsGetRepoInstallationParams: { owner: string; repo: string }

    Type declaration

    • owner: string
    • repo: string

    AppsGetRepoInstallationResponse

    AppsGetRepoInstallationResponse: { access_tokens_url: string; account: AppsGetRepoInstallationResponseAccount; app_id: number; created_at: string; events: Array<string>; html_url: string; id: number; permissions: AppsGetRepoInstallationResponsePermissions; repositories_url: string; repository_selection: string; single_file_name: null; target_id: number; target_type: string; updated_at: string }

    Type declaration

    AppsGetRepoInstallationResponseAccount

    AppsGetRepoInstallationResponseAccount: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    AppsGetRepoInstallationResponsePermissions

    AppsGetRepoInstallationResponsePermissions: { checks: string; contents: string; metadata: string }

    Type declaration

    • checks: string
    • contents: string
    • metadata: string

    AppsGetUserInstallationParams

    AppsGetUserInstallationParams: { username: string }

    Type declaration

    • username: string

    AppsGetUserInstallationResponse

    AppsGetUserInstallationResponse: { access_tokens_url: string; account: AppsGetUserInstallationResponseAccount; app_id: number; created_at: string; events: Array<string>; html_url: string; id: number; permissions: AppsGetUserInstallationResponsePermissions; repositories_url: string; repository_selection: string; single_file_name: null; target_id: number; target_type: string; updated_at: string }

    Type declaration

    AppsGetUserInstallationResponseAccount

    AppsGetUserInstallationResponseAccount: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    AppsGetUserInstallationResponsePermissions

    AppsGetUserInstallationResponsePermissions: { checks: string; contents: string; metadata: string }

    Type declaration

    • checks: string
    • contents: string
    • metadata: string

    AppsListAccountsUserOrOrgOnPlanParams

    AppsListAccountsUserOrOrgOnPlanParams: { direction?: "asc" | "desc"; page?: undefined | number; per_page?: undefined | number; plan_id: number; sort?: "created" | "updated" }

    Type declaration

    • Optional direction?: "asc" | "desc"

      To return the oldest accounts first, set to asc. Can be one of asc or desc. Ignored without the sort parameter.

    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • plan_id: number
    • Optional sort?: "created" | "updated"

      Sorts the GitHub accounts by the date they were created or last updated. Can be one of created or updated.

    AppsListAccountsUserOrOrgOnPlanResponse

    AppsListAccountsUserOrOrgOnPlanResponse: Array<AppsListAccountsUserOrOrgOnPlanResponseItem>

    AppsListAccountsUserOrOrgOnPlanResponseItem

    AppsListAccountsUserOrOrgOnPlanResponseItem: { email: null; id: number; login: string; marketplace_pending_change: AppsListAccountsUserOrOrgOnPlanResponseItemMarketplacePendingChange; marketplace_purchase: AppsListAccountsUserOrOrgOnPlanResponseItemMarketplacePurchase; organization_billing_email: string; type: string; url: string }

    Type declaration

    AppsListAccountsUserOrOrgOnPlanResponseItemMarketplacePendingChange

    AppsListAccountsUserOrOrgOnPlanResponseItemMarketplacePendingChange: { effective_date: string; id: number; plan: AppsListAccountsUserOrOrgOnPlanResponseItemMarketplacePendingChangePlan; unit_count: null }

    Type declaration

    AppsListAccountsUserOrOrgOnPlanResponseItemMarketplacePendingChangePlan

    AppsListAccountsUserOrOrgOnPlanResponseItemMarketplacePendingChangePlan: { accounts_url: string; bullets: Array<string>; description: string; has_free_trial: boolean; id: number; monthly_price_in_cents: number; name: string; number: number; price_model: string; state: string; unit_name: null; url: string; yearly_price_in_cents: number }

    Type declaration

    • accounts_url: string
    • bullets: Array<string>
    • description: string
    • has_free_trial: boolean
    • id: number
    • monthly_price_in_cents: number
    • name: string
    • number: number
    • price_model: string
    • state: string
    • unit_name: null
    • url: string
    • yearly_price_in_cents: number

    AppsListAccountsUserOrOrgOnPlanResponseItemMarketplacePurchase

    AppsListAccountsUserOrOrgOnPlanResponseItemMarketplacePurchase: { billing_cycle: string; free_trial_ends_on: string; next_billing_date: string; on_free_trial: boolean; plan: AppsListAccountsUserOrOrgOnPlanResponseItemMarketplacePurchasePlan; unit_count: null; updated_at: string }

    Type declaration

    AppsListAccountsUserOrOrgOnPlanResponseItemMarketplacePurchasePlan

    AppsListAccountsUserOrOrgOnPlanResponseItemMarketplacePurchasePlan: { accounts_url: string; bullets: Array<string>; description: string; has_free_trial: boolean; id: number; monthly_price_in_cents: number; name: string; number: number; price_model: string; state: string; unit_name: null; url: string; yearly_price_in_cents: number }

    Type declaration

    • accounts_url: string
    • bullets: Array<string>
    • description: string
    • has_free_trial: boolean
    • id: number
    • monthly_price_in_cents: number
    • name: string
    • number: number
    • price_model: string
    • state: string
    • unit_name: null
    • url: string
    • yearly_price_in_cents: number

    AppsListAccountsUserOrOrgOnPlanStubbedParams

    AppsListAccountsUserOrOrgOnPlanStubbedParams: { direction?: "asc" | "desc"; page?: undefined | number; per_page?: undefined | number; plan_id: number; sort?: "created" | "updated" }

    Type declaration

    • Optional direction?: "asc" | "desc"

      To return the oldest accounts first, set to asc. Can be one of asc or desc. Ignored without the sort parameter.

    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • plan_id: number
    • Optional sort?: "created" | "updated"

      Sorts the GitHub accounts by the date they were created or last updated. Can be one of created or updated.

    AppsListAccountsUserOrOrgOnPlanStubbedResponse

    AppsListAccountsUserOrOrgOnPlanStubbedResponse: Array<AppsListAccountsUserOrOrgOnPlanStubbedResponseItem>

    AppsListAccountsUserOrOrgOnPlanStubbedResponseItem

    AppsListAccountsUserOrOrgOnPlanStubbedResponseItem: { email: null; id: number; login: string; marketplace_pending_change: AppsListAccountsUserOrOrgOnPlanStubbedResponseItemMarketplacePendingChange; marketplace_purchase: AppsListAccountsUserOrOrgOnPlanStubbedResponseItemMarketplacePurchase; organization_billing_email: string; type: string; url: string }

    Type declaration

    AppsListAccountsUserOrOrgOnPlanStubbedResponseItemMarketplacePendingChange

    AppsListAccountsUserOrOrgOnPlanStubbedResponseItemMarketplacePendingChange: { effective_date: string; id: number; plan: AppsListAccountsUserOrOrgOnPlanStubbedResponseItemMarketplacePendingChangePlan; unit_count: null }

    Type declaration

    AppsListAccountsUserOrOrgOnPlanStubbedResponseItemMarketplacePendingChangePlan

    AppsListAccountsUserOrOrgOnPlanStubbedResponseItemMarketplacePendingChangePlan: { accounts_url: string; bullets: Array<string>; description: string; has_free_trial: boolean; id: number; monthly_price_in_cents: number; name: string; number: number; price_model: string; state: string; unit_name: null; url: string; yearly_price_in_cents: number }

    Type declaration

    • accounts_url: string
    • bullets: Array<string>
    • description: string
    • has_free_trial: boolean
    • id: number
    • monthly_price_in_cents: number
    • name: string
    • number: number
    • price_model: string
    • state: string
    • unit_name: null
    • url: string
    • yearly_price_in_cents: number

    AppsListAccountsUserOrOrgOnPlanStubbedResponseItemMarketplacePurchase

    AppsListAccountsUserOrOrgOnPlanStubbedResponseItemMarketplacePurchase: { billing_cycle: string; free_trial_ends_on: string; next_billing_date: string; on_free_trial: boolean; plan: AppsListAccountsUserOrOrgOnPlanStubbedResponseItemMarketplacePurchasePlan; unit_count: null; updated_at: string }

    Type declaration

    AppsListAccountsUserOrOrgOnPlanStubbedResponseItemMarketplacePurchasePlan

    AppsListAccountsUserOrOrgOnPlanStubbedResponseItemMarketplacePurchasePlan: { accounts_url: string; bullets: Array<string>; description: string; has_free_trial: boolean; id: number; monthly_price_in_cents: number; name: string; number: number; price_model: string; state: string; unit_name: null; url: string; yearly_price_in_cents: number }

    Type declaration

    • accounts_url: string
    • bullets: Array<string>
    • description: string
    • has_free_trial: boolean
    • id: number
    • monthly_price_in_cents: number
    • name: string
    • number: number
    • price_model: string
    • state: string
    • unit_name: null
    • url: string
    • yearly_price_in_cents: number

    AppsListInstallationReposForAuthenticatedUserParams

    AppsListInstallationReposForAuthenticatedUserParams: { installation_id: number; page?: undefined | number; per_page?: undefined | number }

    Type declaration

    • installation_id: number
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    AppsListInstallationReposForAuthenticatedUserResponse

    AppsListInstallationReposForAuthenticatedUserResponse: { repositories: Array<AppsListInstallationReposForAuthenticatedUserResponseRepositoriesItem>; total_count: number }

    Type declaration

    AppsListInstallationReposForAuthenticatedUserResponseRepositoriesItem

    AppsListInstallationReposForAuthenticatedUserResponseRepositoriesItem: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: AppsListInstallationReposForAuthenticatedUserResponseRepositoriesItemOwner; permissions: AppsListInstallationReposForAuthenticatedUserResponseRepositoriesItemPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

    Type declaration

    • allow_merge_commit: boolean
    • allow_rebase_merge: boolean
    • allow_squash_merge: boolean
    • archive_url: string
    • archived: boolean
    • assignees_url: string
    • blobs_url: string
    • branches_url: string
    • clone_url: string
    • collaborators_url: string
    • comments_url: string
    • commits_url: string
    • compare_url: string
    • contents_url: string
    • contributors_url: string
    • created_at: string
    • default_branch: string
    • deployments_url: string
    • description: string
    • disabled: boolean
    • downloads_url: string
    • events_url: string
    • fork: boolean
    • forks_count: number
    • forks_url: string
    • full_name: string
    • git_commits_url: string
    • git_refs_url: string
    • git_tags_url: string
    • git_url: string
    • has_downloads: boolean
    • has_issues: boolean
    • has_pages: boolean
    • has_projects: boolean
    • has_wiki: boolean
    • homepage: string
    • hooks_url: string
    • html_url: string
    • id: number
    • is_template: boolean
    • issue_comment_url: string
    • issue_events_url: string
    • issues_url: string
    • keys_url: string
    • labels_url: string
    • language: null
    • languages_url: string
    • merges_url: string
    • milestones_url: string
    • mirror_url: string
    • name: string
    • network_count: number
    • node_id: string
    • notifications_url: string
    • open_issues_count: number
    • owner: AppsListInstallationReposForAuthenticatedUserResponseRepositoriesItemOwner
    • permissions: AppsListInstallationReposForAuthenticatedUserResponseRepositoriesItemPermissions
    • private: boolean
    • pulls_url: string
    • pushed_at: string
    • releases_url: string
    • size: number
    • ssh_url: string
    • stargazers_count: number
    • stargazers_url: string
    • statuses_url: string
    • subscribers_count: number
    • subscribers_url: string
    • subscription_url: string
    • svn_url: string
    • tags_url: string
    • teams_url: string
    • temp_clone_token: string
    • template_repository: null
    • topics: Array<string>
    • trees_url: string
    • updated_at: string
    • url: string
    • visibility: string
    • watchers_count: number

    AppsListInstallationReposForAuthenticatedUserResponseRepositoriesItemOwner

    AppsListInstallationReposForAuthenticatedUserResponseRepositoriesItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    AppsListInstallationReposForAuthenticatedUserResponseRepositoriesItemPermissions

    AppsListInstallationReposForAuthenticatedUserResponseRepositoriesItemPermissions: { admin: boolean; pull: boolean; push: boolean }

    Type declaration

    • admin: boolean
    • pull: boolean
    • push: boolean

    AppsListInstallationsForAuthenticatedUserParams

    AppsListInstallationsForAuthenticatedUserParams: { page?: undefined | number; per_page?: undefined | number }

    Type declaration

    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    AppsListInstallationsForAuthenticatedUserResponse

    AppsListInstallationsForAuthenticatedUserResponse: { installations: Array<AppsListInstallationsForAuthenticatedUserResponseInstallationsItem>; total_count: number }

    Type declaration

    AppsListInstallationsForAuthenticatedUserResponseInstallationsItem

    AppsListInstallationsForAuthenticatedUserResponseInstallationsItem: { access_tokens_url: string; account: AppsListInstallationsForAuthenticatedUserResponseInstallationsItemAccount; app_id: number; events: Array<string>; html_url: string; id: number; permissions: AppsListInstallationsForAuthenticatedUserResponseInstallationsItemPermissions; repositories_url: string; single_file_name: string; target_id: number; target_type: string }

    Type declaration

    AppsListInstallationsForAuthenticatedUserResponseInstallationsItemAccount

    AppsListInstallationsForAuthenticatedUserResponseInstallationsItemAccount: { avatar_url: string; description?: undefined | string; events_url: string; followers_url?: undefined | string; following_url?: undefined | string; gists_url?: undefined | string; gravatar_id?: undefined | string; hooks_url?: undefined | string; html_url?: undefined | string; id: number; issues_url?: undefined | string; login: string; members_url?: undefined | string; node_id: string; organizations_url?: undefined | string; public_members_url?: undefined | string; received_events_url?: undefined | string; repos_url: string; site_admin?: undefined | false | true; starred_url?: undefined | string; subscriptions_url?: undefined | string; type?: undefined | string; url: string }

    Type declaration

    • avatar_url: string
    • Optional description?: undefined | string
    • events_url: string
    • Optional followers_url?: undefined | string
    • Optional following_url?: undefined | string
    • Optional gists_url?: undefined | string
    • Optional gravatar_id?: undefined | string
    • Optional hooks_url?: undefined | string
    • Optional html_url?: undefined | string
    • id: number
    • Optional issues_url?: undefined | string
    • login: string
    • Optional members_url?: undefined | string
    • node_id: string
    • Optional organizations_url?: undefined | string
    • Optional public_members_url?: undefined | string
    • Optional received_events_url?: undefined | string
    • repos_url: string
    • Optional site_admin?: undefined | false | true
    • Optional starred_url?: undefined | string
    • Optional subscriptions_url?: undefined | string
    • Optional type?: undefined | string
    • url: string

    AppsListInstallationsForAuthenticatedUserResponseInstallationsItemPermissions

    AppsListInstallationsForAuthenticatedUserResponseInstallationsItemPermissions: { contents: string; issues: string; metadata: string; single_file: string }

    Type declaration

    • contents: string
    • issues: string
    • metadata: string
    • single_file: string

    AppsListInstallationsParams

    AppsListInstallationsParams: { page?: undefined | number; per_page?: undefined | number }

    Type declaration

    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    AppsListInstallationsResponse

    AppsListInstallationsResponse: Array<AppsListInstallationsResponseItem>

    AppsListInstallationsResponseItem

    AppsListInstallationsResponseItem: { access_tokens_url: string; account: AppsListInstallationsResponseItemAccount; app_id: number; events: Array<string>; html_url: string; id: number; permissions: AppsListInstallationsResponseItemPermissions; repositories_url: string; repository_selection: string; single_file_name: string; target_id: number; target_type: string }

    Type declaration

    AppsListInstallationsResponseItemAccount

    AppsListInstallationsResponseItemAccount: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

    Type declaration

    • avatar_url: string
    • description: string
    • events_url: string
    • hooks_url: string
    • id: number
    • issues_url: string
    • login: string
    • members_url: string
    • node_id: string
    • public_members_url: string
    • repos_url: string
    • url: string

    AppsListInstallationsResponseItemPermissions

    AppsListInstallationsResponseItemPermissions: { contents: string; issues: string; metadata: string; single_file: string }

    Type declaration

    • contents: string
    • issues: string
    • metadata: string
    • single_file: string

    AppsListMarketplacePurchasesForAuthenticatedUserParams

    AppsListMarketplacePurchasesForAuthenticatedUserParams: { page?: undefined | number; per_page?: undefined | number }

    Type declaration

    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    AppsListMarketplacePurchasesForAuthenticatedUserResponse

    AppsListMarketplacePurchasesForAuthenticatedUserResponse: Array<AppsListMarketplacePurchasesForAuthenticatedUserResponseItem>

    AppsListMarketplacePurchasesForAuthenticatedUserResponseItem

    AppsListMarketplacePurchasesForAuthenticatedUserResponseItem: { account: AppsListMarketplacePurchasesForAuthenticatedUserResponseItemAccount; billing_cycle: string; free_trial_ends_on: string; next_billing_date: string; on_free_trial: boolean; plan: AppsListMarketplacePurchasesForAuthenticatedUserResponseItemPlan; unit_count: null; updated_at: string }

    Type declaration

    AppsListMarketplacePurchasesForAuthenticatedUserResponseItemAccount

    AppsListMarketplacePurchasesForAuthenticatedUserResponseItemAccount: { email: null; id: number; login: string; organization_billing_email: string; type: string; url: string }

    Type declaration

    • email: null
    • id: number
    • login: string
    • organization_billing_email: string
    • type: string
    • url: string

    AppsListMarketplacePurchasesForAuthenticatedUserResponseItemPlan

    AppsListMarketplacePurchasesForAuthenticatedUserResponseItemPlan: { accounts_url: string; bullets: Array<string>; description: string; has_free_trial: boolean; id: number; monthly_price_in_cents: number; name: string; number: number; price_model: string; state: string; unit_name: null; url: string; yearly_price_in_cents: number }

    Type declaration

    • accounts_url: string
    • bullets: Array<string>
    • description: string
    • has_free_trial: boolean
    • id: number
    • monthly_price_in_cents: number
    • name: string
    • number: number
    • price_model: string
    • state: string
    • unit_name: null
    • url: string
    • yearly_price_in_cents: number

    AppsListMarketplacePurchasesForAuthenticatedUserStubbedParams

    AppsListMarketplacePurchasesForAuthenticatedUserStubbedParams: { page?: undefined | number; per_page?: undefined | number }

    Type declaration

    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    AppsListMarketplacePurchasesForAuthenticatedUserStubbedResponse

    AppsListMarketplacePurchasesForAuthenticatedUserStubbedResponse: Array<AppsListMarketplacePurchasesForAuthenticatedUserStubbedResponseItem>

    AppsListMarketplacePurchasesForAuthenticatedUserStubbedResponseItem

    AppsListMarketplacePurchasesForAuthenticatedUserStubbedResponseItem: { account: AppsListMarketplacePurchasesForAuthenticatedUserStubbedResponseItemAccount; billing_cycle: string; free_trial_ends_on: string; next_billing_date: string; on_free_trial: boolean; plan: AppsListMarketplacePurchasesForAuthenticatedUserStubbedResponseItemPlan; unit_count: null; updated_at: string }

    Type declaration

    AppsListMarketplacePurchasesForAuthenticatedUserStubbedResponseItemAccount

    AppsListMarketplacePurchasesForAuthenticatedUserStubbedResponseItemAccount: { email: null; id: number; login: string; organization_billing_email: string; type: string; url: string }

    Type declaration

    • email: null
    • id: number
    • login: string
    • organization_billing_email: string
    • type: string
    • url: string

    AppsListMarketplacePurchasesForAuthenticatedUserStubbedResponseItemPlan

    AppsListMarketplacePurchasesForAuthenticatedUserStubbedResponseItemPlan: { accounts_url: string; bullets: Array<string>; description: string; has_free_trial: boolean; id: number; monthly_price_in_cents: number; name: string; number: number; price_model: string; state: string; unit_name: null; url: string; yearly_price_in_cents: number }

    Type declaration

    • accounts_url: string
    • bullets: Array<string>
    • description: string
    • has_free_trial: boolean
    • id: number
    • monthly_price_in_cents: number
    • name: string
    • number: number
    • price_model: string
    • state: string
    • unit_name: null
    • url: string
    • yearly_price_in_cents: number

    AppsListPlansParams

    AppsListPlansParams: { page?: undefined | number; per_page?: undefined | number }

    Type declaration

    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    AppsListPlansResponse

    AppsListPlansResponse: Array<AppsListPlansResponseItem>

    AppsListPlansResponseItem

    AppsListPlansResponseItem: { accounts_url: string; bullets: Array<string>; description: string; has_free_trial: boolean; id: number; monthly_price_in_cents: number; name: string; number: number; price_model: string; state: string; unit_name: null; url: string; yearly_price_in_cents: number }

    Type declaration

    • accounts_url: string
    • bullets: Array<string>
    • description: string
    • has_free_trial: boolean
    • id: number
    • monthly_price_in_cents: number
    • name: string
    • number: number
    • price_model: string
    • state: string
    • unit_name: null
    • url: string
    • yearly_price_in_cents: number

    AppsListPlansStubbedParams

    AppsListPlansStubbedParams: { page?: undefined | number; per_page?: undefined | number }

    Type declaration

    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    AppsListPlansStubbedResponse

    AppsListPlansStubbedResponse: Array<AppsListPlansStubbedResponseItem>

    AppsListPlansStubbedResponseItem

    AppsListPlansStubbedResponseItem: { accounts_url: string; bullets: Array<string>; description: string; has_free_trial: boolean; id: number; monthly_price_in_cents: number; name: string; number: number; price_model: string; state: string; unit_name: null; url: string; yearly_price_in_cents: number }

    Type declaration

    • accounts_url: string
    • bullets: Array<string>
    • description: string
    • has_free_trial: boolean
    • id: number
    • monthly_price_in_cents: number
    • name: string
    • number: number
    • price_model: string
    • state: string
    • unit_name: null
    • url: string
    • yearly_price_in_cents: number

    AppsListReposParams

    AppsListReposParams: { page?: undefined | number; per_page?: undefined | number }

    Type declaration

    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    AppsListReposResponse

    AppsListReposResponse: { repositories: Array<AppsListReposResponseRepositoriesItem>; total_count: number }

    Type declaration

    AppsListReposResponseRepositoriesItem

    AppsListReposResponseRepositoriesItem: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: AppsListReposResponseRepositoriesItemOwner; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

    Type declaration

    • allow_merge_commit: boolean
    • allow_rebase_merge: boolean
    • allow_squash_merge: boolean
    • archive_url: string
    • archived: boolean
    • assignees_url: string
    • blobs_url: string
    • branches_url: string
    • clone_url: string
    • collaborators_url: string
    • comments_url: string
    • commits_url: string
    • compare_url: string
    • contents_url: string
    • contributors_url: string
    • created_at: string
    • default_branch: string
    • deployments_url: string
    • description: string
    • disabled: boolean
    • downloads_url: string
    • events_url: string
    • fork: boolean
    • forks_count: number
    • forks_url: string
    • full_name: string
    • git_commits_url: string
    • git_refs_url: string
    • git_tags_url: string
    • git_url: string
    • has_downloads: boolean
    • has_issues: boolean
    • has_pages: boolean
    • has_projects: boolean
    • has_wiki: boolean
    • homepage: string
    • hooks_url: string
    • html_url: string
    • id: number
    • is_template: boolean
    • issue_comment_url: string
    • issue_events_url: string
    • issues_url: string
    • keys_url: string
    • labels_url: string
    • language: null
    • languages_url: string
    • merges_url: string
    • milestones_url: string
    • mirror_url: string
    • name: string
    • network_count: number
    • node_id: string
    • notifications_url: string
    • open_issues_count: number
    • owner: AppsListReposResponseRepositoriesItemOwner
    • private: boolean
    • pulls_url: string
    • pushed_at: string
    • releases_url: string
    • size: number
    • ssh_url: string
    • stargazers_count: number
    • stargazers_url: string
    • statuses_url: string
    • subscribers_count: number
    • subscribers_url: string
    • subscription_url: string
    • svn_url: string
    • tags_url: string
    • teams_url: string
    • temp_clone_token: string
    • template_repository: null
    • topics: Array<string>
    • trees_url: string
    • updated_at: string
    • url: string
    • visibility: string
    • watchers_count: number

    AppsListReposResponseRepositoriesItemOwner

    AppsListReposResponseRepositoriesItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    AppsRemoveRepoFromInstallationParams

    AppsRemoveRepoFromInstallationParams: { installation_id: number; repository_id: number }

    Type declaration

    • installation_id: number
    • repository_id: number

    AppsResetAuthorizationParams

    AppsResetAuthorizationParams: { access_token: string; client_id: string }

    Type declaration

    • access_token: string
    • client_id: string

    AppsResetAuthorizationResponse

    AppsResetAuthorizationResponse: { app: AppsResetAuthorizationResponseApp; created_at: string; fingerprint: string; hashed_token: string; id: number; note: string; note_url: string; scopes: Array<string>; token: string; token_last_eight: string; updated_at: string; url: string; user: AppsResetAuthorizationResponseUser }

    Type declaration

    AppsResetAuthorizationResponseApp

    AppsResetAuthorizationResponseApp: { client_id: string; name: string; url: string }

    Type declaration

    • client_id: string
    • name: string
    • url: string

    AppsResetAuthorizationResponseUser

    AppsResetAuthorizationResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    AppsResetTokenParams

    AppsResetTokenParams: { access_token?: undefined | string; client_id: string }

    Type declaration

    • Optional access_token?: undefined | string

      The OAuth access token used to authenticate to the GitHub API.

    • client_id: string

    AppsResetTokenResponse

    AppsResetTokenResponse: { app: AppsResetTokenResponseApp; created_at: string; fingerprint: string; hashed_token: string; id: number; note: string; note_url: string; scopes: Array<string>; token: string; token_last_eight: string; updated_at: string; url: string; user: AppsResetTokenResponseUser }

    Type declaration

    • app: AppsResetTokenResponseApp
    • created_at: string
    • fingerprint: string
    • hashed_token: string
    • id: number
    • note: string
    • note_url: string
    • scopes: Array<string>
    • token: string
    • token_last_eight: string
    • updated_at: string
    • url: string
    • user: AppsResetTokenResponseUser

    AppsResetTokenResponseApp

    AppsResetTokenResponseApp: { client_id: string; name: string; url: string }

    Type declaration

    • client_id: string
    • name: string
    • url: string

    AppsResetTokenResponseUser

    AppsResetTokenResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    AppsRevokeAuthorizationForApplicationParams

    AppsRevokeAuthorizationForApplicationParams: { access_token: string; client_id: string }

    Type declaration

    • access_token: string
    • client_id: string

    AppsRevokeGrantForApplicationParams

    AppsRevokeGrantForApplicationParams: { access_token: string; client_id: string }

    Type declaration

    • access_token: string
    • client_id: string

    ChecksCreateParams

    ChecksCreateParams: { actions?: ChecksCreateParamsActions[]; completed_at?: undefined | string; conclusion?: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required"; details_url?: undefined | string; external_id?: undefined | string; head_sha: string; name: string; output?: ChecksCreateParamsOutput; owner: string; repo: string; started_at?: undefined | string; status?: "queued" | "in_progress" | "completed" }

    Type declaration

    • Optional actions?: ChecksCreateParamsActions[]

      Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the check_run.requested_action webhook to your app. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see "Check runs and requested actions." To learn more about check runs and requested actions, see "Check runs and requested actions."

    • Optional completed_at?: undefined | string

      The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    • Optional conclusion?: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required"

      Required if you provide completed_at or a status of completed. The final conclusion of the check. Can be one of success, failure, neutral, cancelled, timed_out, or action_required. When the conclusion is action_required, additional details should be provided on the site specified by details_url. Note: Providing conclusion will automatically set the status parameter to completed.

    • Optional details_url?: undefined | string

      The URL of the integrator's site that has the full details of the check.

    • Optional external_id?: undefined | string

      A reference for the run on the integrator's system.

    • head_sha: string

      The SHA of the commit.

    • name: string

      The name of the check. For example, "code-coverage".

    • Optional output?: ChecksCreateParamsOutput

      Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run. See the output object description.

    • owner: string
    • repo: string
    • Optional started_at?: undefined | string

      The time that the check run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    • Optional status?: "queued" | "in_progress" | "completed"

      The current status. Can be one of queued, in_progress, or completed.

    ChecksCreateParamsActions

    ChecksCreateParamsActions: { description: string; identifier: string; label: string }

    Type declaration

    • description: string
    • identifier: string
    • label: string

    ChecksCreateParamsOutput

    ChecksCreateParamsOutput: { annotations?: ChecksCreateParamsOutputAnnotations[]; images?: ChecksCreateParamsOutputImages[]; summary: string; text?: undefined | string; title: string }

    Type declaration

    ChecksCreateParamsOutputAnnotations

    ChecksCreateParamsOutputAnnotations: { annotation_level: "notice" | "warning" | "failure"; end_column?: undefined | number; end_line: number; message: string; path: string; raw_details?: undefined | string; start_column?: undefined | number; start_line: number; title?: undefined | string }

    Type declaration

    • annotation_level: "notice" | "warning" | "failure"
    • Optional end_column?: undefined | number
    • end_line: number
    • message: string
    • path: string
    • Optional raw_details?: undefined | string
    • Optional start_column?: undefined | number
    • start_line: number
    • Optional title?: undefined | string

    ChecksCreateParamsOutputImages

    ChecksCreateParamsOutputImages: { alt: string; caption?: undefined | string; image_url: string }

    Type declaration

    • alt: string
    • Optional caption?: undefined | string
    • image_url: string

    ChecksCreateResponse

    ChecksCreateResponse: { app: ChecksCreateResponseApp; check_suite: ChecksCreateResponseCheckSuite; completed_at: null | string; conclusion: null | string; details_url: string; external_id: string; head_sha: string; html_url: string; id: number; name: string; node_id: string; output: ChecksCreateResponseOutput; pull_requests: Array<ChecksCreateResponsePullRequestsItem>; started_at: string; status: string; url: string }

    Type declaration

    ChecksCreateResponseApp

    ChecksCreateResponseApp: { created_at: string; description: string; events: Array<string>; external_url: string; html_url: string; id: number; name: string; node_id: string; owner: ChecksCreateResponseAppOwner; permissions: ChecksCreateResponseAppPermissions; slug: string; updated_at: string }

    Type declaration

    ChecksCreateResponseAppOwner

    ChecksCreateResponseAppOwner: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

    Type declaration

    • avatar_url: string
    • description: string
    • events_url: string
    • hooks_url: string
    • id: number
    • issues_url: string
    • login: string
    • members_url: string
    • node_id: string
    • public_members_url: string
    • repos_url: string
    • url: string

    ChecksCreateResponseAppPermissions

    ChecksCreateResponseAppPermissions: { contents: string; issues: string; metadata: string; single_file: string }

    Type declaration

    • contents: string
    • issues: string
    • metadata: string
    • single_file: string

    ChecksCreateResponseCheckSuite

    ChecksCreateResponseCheckSuite: { id: number }

    Type declaration

    • id: number

    ChecksCreateResponseOutput

    ChecksCreateResponseOutput: { annotations_count?: undefined | number; annotations_url?: undefined | string; summary: string; text: string; title: string }

    Type declaration

    • Optional annotations_count?: undefined | number
    • Optional annotations_url?: undefined | string
    • summary: string
    • text: string
    • title: string

    ChecksCreateResponsePullRequestsItem

    ChecksCreateResponsePullRequestsItem: { base: ChecksCreateResponsePullRequestsItemBase; head: ChecksCreateResponsePullRequestsItemHead; id: number; number: number; url: string }

    Type declaration

    ChecksCreateResponsePullRequestsItemBase

    ChecksCreateResponsePullRequestsItemBase: { ref: string; repo: ChecksCreateResponsePullRequestsItemBaseRepo; sha: string }

    Type declaration

    ChecksCreateResponsePullRequestsItemBaseRepo

    ChecksCreateResponsePullRequestsItemBaseRepo: { id: number; name: string; url: string }

    Type declaration

    • id: number
    • name: string
    • url: string

    ChecksCreateResponsePullRequestsItemHead

    ChecksCreateResponsePullRequestsItemHead: { ref: string; repo: ChecksCreateResponsePullRequestsItemHeadRepo; sha: string }

    Type declaration

    ChecksCreateResponsePullRequestsItemHeadRepo

    ChecksCreateResponsePullRequestsItemHeadRepo: { id: number; name: string; url: string }

    Type declaration

    • id: number
    • name: string
    • url: string

    ChecksCreateSuiteParams

    ChecksCreateSuiteParams: { head_sha: string; owner: string; repo: string }

    Type declaration

    • head_sha: string

      The sha of the head commit.

    • owner: string
    • repo: string

    ChecksCreateSuiteResponse

    ChecksCreateSuiteResponse: { after: string; app: ChecksCreateSuiteResponseApp; before: string; conclusion: string; head_branch: string; head_sha: string; id: number; node_id: string; pull_requests: Array<any>; repository: ChecksCreateSuiteResponseRepository; status: string; url: string }

    Type declaration

    ChecksCreateSuiteResponseApp

    ChecksCreateSuiteResponseApp: { created_at: string; description: string; events: Array<string>; external_url: string; html_url: string; id: number; name: string; node_id: string; owner: ChecksCreateSuiteResponseAppOwner; permissions: ChecksCreateSuiteResponseAppPermissions; slug: string; updated_at: string }

    Type declaration

    ChecksCreateSuiteResponseAppOwner

    ChecksCreateSuiteResponseAppOwner: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

    Type declaration

    • avatar_url: string
    • description: string
    • events_url: string
    • hooks_url: string
    • id: number
    • issues_url: string
    • login: string
    • members_url: string
    • node_id: string
    • public_members_url: string
    • repos_url: string
    • url: string

    ChecksCreateSuiteResponseAppPermissions

    ChecksCreateSuiteResponseAppPermissions: { contents: string; issues: string; metadata: string; single_file: string }

    Type declaration

    • contents: string
    • issues: string
    • metadata: string
    • single_file: string

    ChecksCreateSuiteResponseRepository

    ChecksCreateSuiteResponseRepository: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: ChecksCreateSuiteResponseRepositoryOwner; permissions: ChecksCreateSuiteResponseRepositoryPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

    Type declaration

    • allow_merge_commit: boolean
    • allow_rebase_merge: boolean
    • allow_squash_merge: boolean
    • archive_url: string
    • archived: boolean
    • assignees_url: string
    • blobs_url: string
    • branches_url: string
    • clone_url: string
    • collaborators_url: string
    • comments_url: string
    • commits_url: string
    • compare_url: string
    • contents_url: string
    • contributors_url: string
    • created_at: string
    • default_branch: string
    • deployments_url: string
    • description: string
    • disabled: boolean
    • downloads_url: string
    • events_url: string
    • fork: boolean
    • forks_count: number
    • forks_url: string
    • full_name: string
    • git_commits_url: string
    • git_refs_url: string
    • git_tags_url: string
    • git_url: string
    • has_downloads: boolean
    • has_issues: boolean
    • has_pages: boolean
    • has_projects: boolean
    • has_wiki: boolean
    • homepage: string
    • hooks_url: string
    • html_url: string
    • id: number
    • is_template: boolean
    • issue_comment_url: string
    • issue_events_url: string
    • issues_url: string
    • keys_url: string
    • labels_url: string
    • language: null
    • languages_url: string
    • merges_url: string
    • milestones_url: string
    • mirror_url: string
    • name: string
    • network_count: number
    • node_id: string
    • notifications_url: string
    • open_issues_count: number
    • owner: ChecksCreateSuiteResponseRepositoryOwner
    • permissions: ChecksCreateSuiteResponseRepositoryPermissions
    • private: boolean
    • pulls_url: string
    • pushed_at: string
    • releases_url: string
    • size: number
    • ssh_url: string
    • stargazers_count: number
    • stargazers_url: string
    • statuses_url: string
    • subscribers_count: number
    • subscribers_url: string
    • subscription_url: string
    • svn_url: string
    • tags_url: string
    • teams_url: string
    • temp_clone_token: string
    • template_repository: null
    • topics: Array<string>
    • trees_url: string
    • updated_at: string
    • url: string
    • visibility: string
    • watchers_count: number

    ChecksCreateSuiteResponseRepositoryOwner

    ChecksCreateSuiteResponseRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ChecksCreateSuiteResponseRepositoryPermissions

    ChecksCreateSuiteResponseRepositoryPermissions: { admin: boolean; pull: boolean; push: boolean }

    Type declaration

    • admin: boolean
    • pull: boolean
    • push: boolean

    ChecksGetParams

    ChecksGetParams: { check_run_id: number; owner: string; repo: string }

    Type declaration

    • check_run_id: number
    • owner: string
    • repo: string

    ChecksGetResponse

    ChecksGetResponse: { app: ChecksGetResponseApp; check_suite: ChecksGetResponseCheckSuite; completed_at: string; conclusion: string; details_url: string; external_id: string; head_sha: string; html_url: string; id: number; name: string; node_id: string; output: ChecksGetResponseOutput; pull_requests: Array<ChecksGetResponsePullRequestsItem>; started_at: string; status: string; url: string }

    Type declaration

    ChecksGetResponseApp

    ChecksGetResponseApp: { created_at: string; description: string; events: Array<string>; external_url: string; html_url: string; id: number; name: string; node_id: string; owner: ChecksGetResponseAppOwner; permissions: ChecksGetResponseAppPermissions; slug: string; updated_at: string }

    Type declaration

    ChecksGetResponseAppOwner

    ChecksGetResponseAppOwner: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

    Type declaration

    • avatar_url: string
    • description: string
    • events_url: string
    • hooks_url: string
    • id: number
    • issues_url: string
    • login: string
    • members_url: string
    • node_id: string
    • public_members_url: string
    • repos_url: string
    • url: string

    ChecksGetResponseAppPermissions

    ChecksGetResponseAppPermissions: { contents: string; issues: string; metadata: string; single_file: string }

    Type declaration

    • contents: string
    • issues: string
    • metadata: string
    • single_file: string

    ChecksGetResponseCheckSuite

    ChecksGetResponseCheckSuite: { id: number }

    Type declaration

    • id: number

    ChecksGetResponseOutput

    ChecksGetResponseOutput: { annotations_count: number; annotations_url: string; summary: string; text: string; title: string }

    Type declaration

    • annotations_count: number
    • annotations_url: string
    • summary: string
    • text: string
    • title: string

    ChecksGetResponsePullRequestsItem

    ChecksGetResponsePullRequestsItem: { base: ChecksGetResponsePullRequestsItemBase; head: ChecksGetResponsePullRequestsItemHead; id: number; number: number; url: string }

    Type declaration

    ChecksGetResponsePullRequestsItemBase

    ChecksGetResponsePullRequestsItemBase: { ref: string; repo: ChecksGetResponsePullRequestsItemBaseRepo; sha: string }

    Type declaration

    ChecksGetResponsePullRequestsItemBaseRepo

    ChecksGetResponsePullRequestsItemBaseRepo: { id: number; name: string; url: string }

    Type declaration

    • id: number
    • name: string
    • url: string

    ChecksGetResponsePullRequestsItemHead

    ChecksGetResponsePullRequestsItemHead: { ref: string; repo: ChecksGetResponsePullRequestsItemHeadRepo; sha: string }

    Type declaration

    ChecksGetResponsePullRequestsItemHeadRepo

    ChecksGetResponsePullRequestsItemHeadRepo: { id: number; name: string; url: string }

    Type declaration

    • id: number
    • name: string
    • url: string

    ChecksGetSuiteParams

    ChecksGetSuiteParams: { check_suite_id: number; owner: string; repo: string }

    Type declaration

    • check_suite_id: number
    • owner: string
    • repo: string

    ChecksGetSuiteResponse

    ChecksGetSuiteResponse: { after: string; app: ChecksGetSuiteResponseApp; before: string; conclusion: string; head_branch: string; head_sha: string; id: number; node_id: string; pull_requests: Array<any>; repository: ChecksGetSuiteResponseRepository; status: string; url: string }

    Type declaration

    ChecksGetSuiteResponseApp

    ChecksGetSuiteResponseApp: { created_at: string; description: string; events: Array<string>; external_url: string; html_url: string; id: number; name: string; node_id: string; owner: ChecksGetSuiteResponseAppOwner; permissions: ChecksGetSuiteResponseAppPermissions; slug: string; updated_at: string }

    Type declaration

    ChecksGetSuiteResponseAppOwner

    ChecksGetSuiteResponseAppOwner: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

    Type declaration

    • avatar_url: string
    • description: string
    • events_url: string
    • hooks_url: string
    • id: number
    • issues_url: string
    • login: string
    • members_url: string
    • node_id: string
    • public_members_url: string
    • repos_url: string
    • url: string

    ChecksGetSuiteResponseAppPermissions

    ChecksGetSuiteResponseAppPermissions: { contents: string; issues: string; metadata: string; single_file: string }

    Type declaration

    • contents: string
    • issues: string
    • metadata: string
    • single_file: string

    ChecksGetSuiteResponseRepository

    ChecksGetSuiteResponseRepository: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: ChecksGetSuiteResponseRepositoryOwner; permissions: ChecksGetSuiteResponseRepositoryPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

    Type declaration

    • allow_merge_commit: boolean
    • allow_rebase_merge: boolean
    • allow_squash_merge: boolean
    • archive_url: string
    • archived: boolean
    • assignees_url: string
    • blobs_url: string
    • branches_url: string
    • clone_url: string
    • collaborators_url: string
    • comments_url: string
    • commits_url: string
    • compare_url: string
    • contents_url: string
    • contributors_url: string
    • created_at: string
    • default_branch: string
    • deployments_url: string
    • description: string
    • disabled: boolean
    • downloads_url: string
    • events_url: string
    • fork: boolean
    • forks_count: number
    • forks_url: string
    • full_name: string
    • git_commits_url: string
    • git_refs_url: string
    • git_tags_url: string
    • git_url: string
    • has_downloads: boolean
    • has_issues: boolean
    • has_pages: boolean
    • has_projects: boolean
    • has_wiki: boolean
    • homepage: string
    • hooks_url: string
    • html_url: string
    • id: number
    • is_template: boolean
    • issue_comment_url: string
    • issue_events_url: string
    • issues_url: string
    • keys_url: string
    • labels_url: string
    • language: null
    • languages_url: string
    • merges_url: string
    • milestones_url: string
    • mirror_url: string
    • name: string
    • network_count: number
    • node_id: string
    • notifications_url: string
    • open_issues_count: number
    • owner: ChecksGetSuiteResponseRepositoryOwner
    • permissions: ChecksGetSuiteResponseRepositoryPermissions
    • private: boolean
    • pulls_url: string
    • pushed_at: string
    • releases_url: string
    • size: number
    • ssh_url: string
    • stargazers_count: number
    • stargazers_url: string
    • statuses_url: string
    • subscribers_count: number
    • subscribers_url: string
    • subscription_url: string
    • svn_url: string
    • tags_url: string
    • teams_url: string
    • temp_clone_token: string
    • template_repository: null
    • topics: Array<string>
    • trees_url: string
    • updated_at: string
    • url: string
    • visibility: string
    • watchers_count: number

    ChecksGetSuiteResponseRepositoryOwner

    ChecksGetSuiteResponseRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ChecksGetSuiteResponseRepositoryPermissions

    ChecksGetSuiteResponseRepositoryPermissions: { admin: boolean; pull: boolean; push: boolean }

    Type declaration

    • admin: boolean
    • pull: boolean
    • push: boolean

    ChecksListAnnotationsParams

    ChecksListAnnotationsParams: { check_run_id: number; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

    Type declaration

    • check_run_id: number
    • owner: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • repo: string

    ChecksListAnnotationsResponse

    ChecksListAnnotationsResponse: Array<ChecksListAnnotationsResponseItem>

    ChecksListAnnotationsResponseItem

    ChecksListAnnotationsResponseItem: { annotation_level: string; end_column: number; end_line: number; message: string; path: string; raw_details: string; start_column: number; start_line: number; title: string }

    Type declaration

    • annotation_level: string
    • end_column: number
    • end_line: number
    • message: string
    • path: string
    • raw_details: string
    • start_column: number
    • start_line: number
    • title: string

    ChecksListForRefParams

    ChecksListForRefParams: { check_name?: undefined | string; filter?: "latest" | "all"; owner: string; page?: undefined | number; per_page?: undefined | number; ref: string; repo: string; status?: "queued" | "in_progress" | "completed" }

    Type declaration

    • Optional check_name?: undefined | string

      Returns check runs with the specified name.

    • Optional filter?: "latest" | "all"

      Filters check runs by their completed_at timestamp. Can be one of latest (returning the most recent check runs) or all.

    • owner: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • ref: string
    • repo: string
    • Optional status?: "queued" | "in_progress" | "completed"

      Returns check runs with the specified status. Can be one of queued, in_progress, or completed.

    ChecksListForRefResponse

    ChecksListForRefResponse: { check_runs: Array<ChecksListForRefResponseCheckRunsItem>; total_count: number }

    Type declaration

    ChecksListForRefResponseCheckRunsItem

    ChecksListForRefResponseCheckRunsItem: { app: ChecksListForRefResponseCheckRunsItemApp; check_suite: ChecksListForRefResponseCheckRunsItemCheckSuite; completed_at: string; conclusion: string; details_url: string; external_id: string; head_sha: string; html_url: string; id: number; name: string; node_id: string; output: ChecksListForRefResponseCheckRunsItemOutput; pull_requests: Array<ChecksListForRefResponseCheckRunsItemPullRequestsItem>; started_at: string; status: string; url: string }

    Type declaration

    ChecksListForRefResponseCheckRunsItemApp

    ChecksListForRefResponseCheckRunsItemApp: { created_at: string; description: string; events: Array<string>; external_url: string; html_url: string; id: number; name: string; node_id: string; owner: ChecksListForRefResponseCheckRunsItemAppOwner; permissions: ChecksListForRefResponseCheckRunsItemAppPermissions; slug: string; updated_at: string }

    Type declaration

    ChecksListForRefResponseCheckRunsItemAppOwner

    ChecksListForRefResponseCheckRunsItemAppOwner: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

    Type declaration

    • avatar_url: string
    • description: string
    • events_url: string
    • hooks_url: string
    • id: number
    • issues_url: string
    • login: string
    • members_url: string
    • node_id: string
    • public_members_url: string
    • repos_url: string
    • url: string

    ChecksListForRefResponseCheckRunsItemAppPermissions

    ChecksListForRefResponseCheckRunsItemAppPermissions: { contents: string; issues: string; metadata: string; single_file: string }

    Type declaration

    • contents: string
    • issues: string
    • metadata: string
    • single_file: string

    ChecksListForRefResponseCheckRunsItemCheckSuite

    ChecksListForRefResponseCheckRunsItemCheckSuite: { id: number }

    Type declaration

    • id: number

    ChecksListForRefResponseCheckRunsItemOutput

    ChecksListForRefResponseCheckRunsItemOutput: { annotations_count: number; annotations_url: string; summary: string; text: string; title: string }

    Type declaration

    • annotations_count: number
    • annotations_url: string
    • summary: string
    • text: string
    • title: string

    ChecksListForRefResponseCheckRunsItemPullRequestsItem

    ChecksListForRefResponseCheckRunsItemPullRequestsItem: { base: ChecksListForRefResponseCheckRunsItemPullRequestsItemBase; head: ChecksListForRefResponseCheckRunsItemPullRequestsItemHead; id: number; number: number; url: string }

    Type declaration

    ChecksListForRefResponseCheckRunsItemPullRequestsItemBase

    ChecksListForRefResponseCheckRunsItemPullRequestsItemBase: { ref: string; repo: ChecksListForRefResponseCheckRunsItemPullRequestsItemBaseRepo; sha: string }

    Type declaration

    ChecksListForRefResponseCheckRunsItemPullRequestsItemBaseRepo

    ChecksListForRefResponseCheckRunsItemPullRequestsItemBaseRepo: { id: number; name: string; url: string }

    Type declaration

    • id: number
    • name: string
    • url: string

    ChecksListForRefResponseCheckRunsItemPullRequestsItemHead

    ChecksListForRefResponseCheckRunsItemPullRequestsItemHead: { ref: string; repo: ChecksListForRefResponseCheckRunsItemPullRequestsItemHeadRepo; sha: string }

    Type declaration

    ChecksListForRefResponseCheckRunsItemPullRequestsItemHeadRepo

    ChecksListForRefResponseCheckRunsItemPullRequestsItemHeadRepo: { id: number; name: string; url: string }

    Type declaration

    • id: number
    • name: string
    • url: string

    ChecksListForSuiteParams

    ChecksListForSuiteParams: { check_name?: undefined | string; check_suite_id: number; filter?: "latest" | "all"; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string; status?: "queued" | "in_progress" | "completed" }

    Type declaration

    • Optional check_name?: undefined | string

      Returns check runs with the specified name.

    • check_suite_id: number
    • Optional filter?: "latest" | "all"

      Filters check runs by their completed_at timestamp. Can be one of latest (returning the most recent check runs) or all.

    • owner: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • repo: string
    • Optional status?: "queued" | "in_progress" | "completed"

      Returns check runs with the specified status. Can be one of queued, in_progress, or completed.

    ChecksListForSuiteResponse

    ChecksListForSuiteResponse: { check_runs: Array<ChecksListForSuiteResponseCheckRunsItem>; total_count: number }

    Type declaration

    ChecksListForSuiteResponseCheckRunsItem

    ChecksListForSuiteResponseCheckRunsItem: { app: ChecksListForSuiteResponseCheckRunsItemApp; check_suite: ChecksListForSuiteResponseCheckRunsItemCheckSuite; completed_at: string; conclusion: string; details_url: string; external_id: string; head_sha: string; html_url: string; id: number; name: string; node_id: string; output: ChecksListForSuiteResponseCheckRunsItemOutput; pull_requests: Array<ChecksListForSuiteResponseCheckRunsItemPullRequestsItem>; started_at: string; status: string; url: string }

    Type declaration

    ChecksListForSuiteResponseCheckRunsItemApp

    ChecksListForSuiteResponseCheckRunsItemApp: { created_at: string; description: string; events: Array<string>; external_url: string; html_url: string; id: number; name: string; node_id: string; owner: ChecksListForSuiteResponseCheckRunsItemAppOwner; permissions: ChecksListForSuiteResponseCheckRunsItemAppPermissions; slug: string; updated_at: string }

    Type declaration

    ChecksListForSuiteResponseCheckRunsItemAppOwner

    ChecksListForSuiteResponseCheckRunsItemAppOwner: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

    Type declaration

    • avatar_url: string
    • description: string
    • events_url: string
    • hooks_url: string
    • id: number
    • issues_url: string
    • login: string
    • members_url: string
    • node_id: string
    • public_members_url: string
    • repos_url: string
    • url: string

    ChecksListForSuiteResponseCheckRunsItemAppPermissions

    ChecksListForSuiteResponseCheckRunsItemAppPermissions: { contents: string; issues: string; metadata: string; single_file: string }

    Type declaration

    • contents: string
    • issues: string
    • metadata: string
    • single_file: string

    ChecksListForSuiteResponseCheckRunsItemCheckSuite

    ChecksListForSuiteResponseCheckRunsItemCheckSuite: { id: number }

    Type declaration

    • id: number

    ChecksListForSuiteResponseCheckRunsItemOutput

    ChecksListForSuiteResponseCheckRunsItemOutput: { annotations_count: number; annotations_url: string; summary: string; text: string; title: string }

    Type declaration

    • annotations_count: number
    • annotations_url: string
    • summary: string
    • text: string
    • title: string

    ChecksListForSuiteResponseCheckRunsItemPullRequestsItem

    ChecksListForSuiteResponseCheckRunsItemPullRequestsItem: { base: ChecksListForSuiteResponseCheckRunsItemPullRequestsItemBase; head: ChecksListForSuiteResponseCheckRunsItemPullRequestsItemHead; id: number; number: number; url: string }

    Type declaration

    ChecksListForSuiteResponseCheckRunsItemPullRequestsItemBase

    ChecksListForSuiteResponseCheckRunsItemPullRequestsItemBase: { ref: string; repo: ChecksListForSuiteResponseCheckRunsItemPullRequestsItemBaseRepo; sha: string }

    Type declaration

    ChecksListForSuiteResponseCheckRunsItemPullRequestsItemBaseRepo

    ChecksListForSuiteResponseCheckRunsItemPullRequestsItemBaseRepo: { id: number; name: string; url: string }

    Type declaration

    • id: number
    • name: string
    • url: string

    ChecksListForSuiteResponseCheckRunsItemPullRequestsItemHead

    ChecksListForSuiteResponseCheckRunsItemPullRequestsItemHead: { ref: string; repo: ChecksListForSuiteResponseCheckRunsItemPullRequestsItemHeadRepo; sha: string }

    Type declaration

    ChecksListForSuiteResponseCheckRunsItemPullRequestsItemHeadRepo

    ChecksListForSuiteResponseCheckRunsItemPullRequestsItemHeadRepo: { id: number; name: string; url: string }

    Type declaration

    • id: number
    • name: string
    • url: string

    ChecksListSuitesForRefParams

    ChecksListSuitesForRefParams: { app_id?: undefined | number; check_name?: undefined | string; owner: string; page?: undefined | number; per_page?: undefined | number; ref: string; repo: string }

    Type declaration

    • Optional app_id?: undefined | number

      Filters check suites by GitHub App id.

    • Optional check_name?: undefined | string

      Filters checks suites by the name of the check run.

    • owner: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • ref: string
    • repo: string

    ChecksListSuitesForRefResponse

    ChecksListSuitesForRefResponse: { check_suites: Array<ChecksListSuitesForRefResponseCheckSuitesItem>; total_count: number }

    Type declaration

    ChecksListSuitesForRefResponseCheckSuitesItem

    ChecksListSuitesForRefResponseCheckSuitesItem: { after: string; app: ChecksListSuitesForRefResponseCheckSuitesItemApp; before: string; conclusion: string; head_branch: string; head_sha: string; id: number; node_id: string; pull_requests: Array<any>; repository: ChecksListSuitesForRefResponseCheckSuitesItemRepository; status: string; url: string }

    Type declaration

    ChecksListSuitesForRefResponseCheckSuitesItemApp

    ChecksListSuitesForRefResponseCheckSuitesItemApp: { created_at: string; description: string; events: Array<string>; external_url: string; html_url: string; id: number; name: string; node_id: string; owner: ChecksListSuitesForRefResponseCheckSuitesItemAppOwner; permissions: ChecksListSuitesForRefResponseCheckSuitesItemAppPermissions; slug: string; updated_at: string }

    Type declaration

    ChecksListSuitesForRefResponseCheckSuitesItemAppOwner

    ChecksListSuitesForRefResponseCheckSuitesItemAppOwner: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

    Type declaration

    • avatar_url: string
    • description: string
    • events_url: string
    • hooks_url: string
    • id: number
    • issues_url: string
    • login: string
    • members_url: string
    • node_id: string
    • public_members_url: string
    • repos_url: string
    • url: string

    ChecksListSuitesForRefResponseCheckSuitesItemAppPermissions

    ChecksListSuitesForRefResponseCheckSuitesItemAppPermissions: { contents: string; issues: string; metadata: string; single_file: string }

    Type declaration

    • contents: string
    • issues: string
    • metadata: string
    • single_file: string

    ChecksListSuitesForRefResponseCheckSuitesItemRepository

    ChecksListSuitesForRefResponseCheckSuitesItemRepository: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: ChecksListSuitesForRefResponseCheckSuitesItemRepositoryOwner; permissions: ChecksListSuitesForRefResponseCheckSuitesItemRepositoryPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

    Type declaration

    • allow_merge_commit: boolean
    • allow_rebase_merge: boolean
    • allow_squash_merge: boolean
    • archive_url: string
    • archived: boolean
    • assignees_url: string
    • blobs_url: string
    • branches_url: string
    • clone_url: string
    • collaborators_url: string
    • comments_url: string
    • commits_url: string
    • compare_url: string
    • contents_url: string
    • contributors_url: string
    • created_at: string
    • default_branch: string
    • deployments_url: string
    • description: string
    • disabled: boolean
    • downloads_url: string
    • events_url: string
    • fork: boolean
    • forks_count: number
    • forks_url: string
    • full_name: string
    • git_commits_url: string
    • git_refs_url: string
    • git_tags_url: string
    • git_url: string
    • has_downloads: boolean
    • has_issues: boolean
    • has_pages: boolean
    • has_projects: boolean
    • has_wiki: boolean
    • homepage: string
    • hooks_url: string
    • html_url: string
    • id: number
    • is_template: boolean
    • issue_comment_url: string
    • issue_events_url: string
    • issues_url: string
    • keys_url: string
    • labels_url: string
    • language: null
    • languages_url: string
    • merges_url: string
    • milestones_url: string
    • mirror_url: string
    • name: string
    • network_count: number
    • node_id: string
    • notifications_url: string
    • open_issues_count: number
    • owner: ChecksListSuitesForRefResponseCheckSuitesItemRepositoryOwner
    • permissions: ChecksListSuitesForRefResponseCheckSuitesItemRepositoryPermissions
    • private: boolean
    • pulls_url: string
    • pushed_at: string
    • releases_url: string
    • size: number
    • ssh_url: string
    • stargazers_count: number
    • stargazers_url: string
    • statuses_url: string
    • subscribers_count: number
    • subscribers_url: string
    • subscription_url: string
    • svn_url: string
    • tags_url: string
    • teams_url: string
    • temp_clone_token: string
    • template_repository: null
    • topics: Array<string>
    • trees_url: string
    • updated_at: string
    • url: string
    • visibility: string
    • watchers_count: number

    ChecksListSuitesForRefResponseCheckSuitesItemRepositoryOwner

    ChecksListSuitesForRefResponseCheckSuitesItemRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ChecksListSuitesForRefResponseCheckSuitesItemRepositoryPermissions

    ChecksListSuitesForRefResponseCheckSuitesItemRepositoryPermissions: { admin: boolean; pull: boolean; push: boolean }

    Type declaration

    • admin: boolean
    • pull: boolean
    • push: boolean

    ChecksRerequestSuiteParams

    ChecksRerequestSuiteParams: { check_suite_id: number; owner: string; repo: string }

    Type declaration

    • check_suite_id: number
    • owner: string
    • repo: string

    ChecksSetSuitesPreferencesParams

    ChecksSetSuitesPreferencesParams: { auto_trigger_checks?: ChecksSetSuitesPreferencesParamsAutoTriggerChecks[]; owner: string; repo: string }

    Type declaration

    ChecksSetSuitesPreferencesParamsAutoTriggerChecks

    ChecksSetSuitesPreferencesParamsAutoTriggerChecks: { app_id: number; setting: boolean }

    Type declaration

    • app_id: number
    • setting: boolean

    ChecksSetSuitesPreferencesResponse

    ChecksSetSuitesPreferencesResponse: { preferences: ChecksSetSuitesPreferencesResponsePreferences; repository: ChecksSetSuitesPreferencesResponseRepository }

    Type declaration

    ChecksSetSuitesPreferencesResponsePreferences

    ChecksSetSuitesPreferencesResponsePreferences: { auto_trigger_checks: Array<ChecksSetSuitesPreferencesResponsePreferencesAutoTriggerChecksItem> }

    Type declaration

    ChecksSetSuitesPreferencesResponsePreferencesAutoTriggerChecksItem

    ChecksSetSuitesPreferencesResponsePreferencesAutoTriggerChecksItem: { app_id: number; setting: boolean }

    Type declaration

    • app_id: number
    • setting: boolean

    ChecksSetSuitesPreferencesResponseRepository

    ChecksSetSuitesPreferencesResponseRepository: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: ChecksSetSuitesPreferencesResponseRepositoryOwner; permissions: ChecksSetSuitesPreferencesResponseRepositoryPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

    Type declaration

    • allow_merge_commit: boolean
    • allow_rebase_merge: boolean
    • allow_squash_merge: boolean
    • archive_url: string
    • archived: boolean
    • assignees_url: string
    • blobs_url: string
    • branches_url: string
    • clone_url: string
    • collaborators_url: string
    • comments_url: string
    • commits_url: string
    • compare_url: string
    • contents_url: string
    • contributors_url: string
    • created_at: string
    • default_branch: string
    • deployments_url: string
    • description: string
    • disabled: boolean
    • downloads_url: string
    • events_url: string
    • fork: boolean
    • forks_count: number
    • forks_url: string
    • full_name: string
    • git_commits_url: string
    • git_refs_url: string
    • git_tags_url: string
    • git_url: string
    • has_downloads: boolean
    • has_issues: boolean
    • has_pages: boolean
    • has_projects: boolean
    • has_wiki: boolean
    • homepage: string
    • hooks_url: string
    • html_url: string
    • id: number
    • is_template: boolean
    • issue_comment_url: string
    • issue_events_url: string
    • issues_url: string
    • keys_url: string
    • labels_url: string
    • language: null
    • languages_url: string
    • merges_url: string
    • milestones_url: string
    • mirror_url: string
    • name: string
    • network_count: number
    • node_id: string
    • notifications_url: string
    • open_issues_count: number
    • owner: ChecksSetSuitesPreferencesResponseRepositoryOwner
    • permissions: ChecksSetSuitesPreferencesResponseRepositoryPermissions
    • private: boolean
    • pulls_url: string
    • pushed_at: string
    • releases_url: string
    • size: number
    • ssh_url: string
    • stargazers_count: number
    • stargazers_url: string
    • statuses_url: string
    • subscribers_count: number
    • subscribers_url: string
    • subscription_url: string
    • svn_url: string
    • tags_url: string
    • teams_url: string
    • temp_clone_token: string
    • template_repository: null
    • topics: Array<string>
    • trees_url: string
    • updated_at: string
    • url: string
    • visibility: string
    • watchers_count: number

    ChecksSetSuitesPreferencesResponseRepositoryOwner

    ChecksSetSuitesPreferencesResponseRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ChecksSetSuitesPreferencesResponseRepositoryPermissions

    ChecksSetSuitesPreferencesResponseRepositoryPermissions: { admin: boolean; pull: boolean; push: boolean }

    Type declaration

    • admin: boolean
    • pull: boolean
    • push: boolean

    ChecksUpdateParams

    ChecksUpdateParams: { actions?: ChecksUpdateParamsActions[]; check_run_id: number; completed_at?: undefined | string; conclusion?: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required"; details_url?: undefined | string; external_id?: undefined | string; name?: undefined | string; output?: ChecksUpdateParamsOutput; owner: string; repo: string; started_at?: undefined | string; status?: "queued" | "in_progress" | "completed" }

    Type declaration

    • Optional actions?: ChecksUpdateParamsActions[]

      Possible further actions the integrator can perform, which a user may trigger. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see "Check runs and requested actions."

    • check_run_id: number
    • Optional completed_at?: undefined | string

      The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    • Optional conclusion?: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required"

      Required if you provide completed_at or a status of completed. The final conclusion of the check. Can be one of success, failure, neutral, cancelled, timed_out, or action_required. Note: Providing conclusion will automatically set the status parameter to completed.

    • Optional details_url?: undefined | string

      The URL of the integrator's site that has the full details of the check.

    • Optional external_id?: undefined | string

      A reference for the run on the integrator's system.

    • Optional name?: undefined | string

      The name of the check. For example, "code-coverage".

    • Optional output?: ChecksUpdateParamsOutput

      Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run. See the output object description.

    • owner: string
    • repo: string
    • Optional started_at?: undefined | string

      This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    • Optional status?: "queued" | "in_progress" | "completed"

      The current status. Can be one of queued, in_progress, or completed.

    ChecksUpdateParamsActions

    ChecksUpdateParamsActions: { description: string; identifier: string; label: string }

    Type declaration

    • description: string
    • identifier: string
    • label: string

    ChecksUpdateParamsOutput

    ChecksUpdateParamsOutput: { annotations?: ChecksUpdateParamsOutputAnnotations[]; images?: ChecksUpdateParamsOutputImages[]; summary: string; text?: undefined | string; title?: undefined | string }

    Type declaration

    ChecksUpdateParamsOutputAnnotations

    ChecksUpdateParamsOutputAnnotations: { annotation_level: "notice" | "warning" | "failure"; end_column?: undefined | number; end_line: number; message: string; path: string; raw_details?: undefined | string; start_column?: undefined | number; start_line: number; title?: undefined | string }

    Type declaration

    • annotation_level: "notice" | "warning" | "failure"
    • Optional end_column?: undefined | number
    • end_line: number
    • message: string
    • path: string
    • Optional raw_details?: undefined | string
    • Optional start_column?: undefined | number
    • start_line: number
    • Optional title?: undefined | string

    ChecksUpdateParamsOutputImages

    ChecksUpdateParamsOutputImages: { alt: string; caption?: undefined | string; image_url: string }

    Type declaration

    • alt: string
    • Optional caption?: undefined | string
    • image_url: string

    ChecksUpdateResponse

    ChecksUpdateResponse: { app: ChecksUpdateResponseApp; check_suite: ChecksUpdateResponseCheckSuite; completed_at: string; conclusion: string; details_url: string; external_id: string; head_sha: string; html_url: string; id: number; name: string; node_id: string; output: ChecksUpdateResponseOutput; pull_requests: Array<ChecksUpdateResponsePullRequestsItem>; started_at: string; status: string; url: string }

    Type declaration

    ChecksUpdateResponseApp

    ChecksUpdateResponseApp: { created_at: string; description: string; events: Array<string>; external_url: string; html_url: string; id: number; name: string; node_id: string; owner: ChecksUpdateResponseAppOwner; permissions: ChecksUpdateResponseAppPermissions; slug: string; updated_at: string }

    Type declaration

    ChecksUpdateResponseAppOwner

    ChecksUpdateResponseAppOwner: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

    Type declaration

    • avatar_url: string
    • description: string
    • events_url: string
    • hooks_url: string
    • id: number
    • issues_url: string
    • login: string
    • members_url: string
    • node_id: string
    • public_members_url: string
    • repos_url: string
    • url: string

    ChecksUpdateResponseAppPermissions

    ChecksUpdateResponseAppPermissions: { contents: string; issues: string; metadata: string; single_file: string }

    Type declaration

    • contents: string
    • issues: string
    • metadata: string
    • single_file: string

    ChecksUpdateResponseCheckSuite

    ChecksUpdateResponseCheckSuite: { id: number }

    Type declaration

    • id: number

    ChecksUpdateResponseOutput

    ChecksUpdateResponseOutput: { annotations_count: number; annotations_url: string; summary: string; text: string; title: string }

    Type declaration

    • annotations_count: number
    • annotations_url: string
    • summary: string
    • text: string
    • title: string

    ChecksUpdateResponsePullRequestsItem

    ChecksUpdateResponsePullRequestsItem: { base: ChecksUpdateResponsePullRequestsItemBase; head: ChecksUpdateResponsePullRequestsItemHead; id: number; number: number; url: string }

    Type declaration

    ChecksUpdateResponsePullRequestsItemBase

    ChecksUpdateResponsePullRequestsItemBase: { ref: string; repo: ChecksUpdateResponsePullRequestsItemBaseRepo; sha: string }

    Type declaration

    ChecksUpdateResponsePullRequestsItemBaseRepo

    ChecksUpdateResponsePullRequestsItemBaseRepo: { id: number; name: string; url: string }

    Type declaration

    • id: number
    • name: string
    • url: string

    ChecksUpdateResponsePullRequestsItemHead

    ChecksUpdateResponsePullRequestsItemHead: { ref: string; repo: ChecksUpdateResponsePullRequestsItemHeadRepo; sha: string }

    Type declaration

    ChecksUpdateResponsePullRequestsItemHeadRepo

    ChecksUpdateResponsePullRequestsItemHeadRepo: { id: number; name: string; url: string }

    Type declaration

    • id: number
    • name: string
    • url: string

    CodesOfConductGetConductCodeParams

    CodesOfConductGetConductCodeParams: { key: string }

    Type declaration

    • key: string

    CodesOfConductGetConductCodeResponse

    CodesOfConductGetConductCodeResponse: { body: string; key: string; name: string; url: string }

    Type declaration

    • body: string
    • key: string
    • name: string
    • url: string

    CodesOfConductGetForRepoParams

    CodesOfConductGetForRepoParams: { owner: string; repo: string }

    Type declaration

    • owner: string
    • repo: string

    CodesOfConductGetForRepoResponse

    CodesOfConductGetForRepoResponse: { body: string; key: string; name: string; url: string }

    Type declaration

    • body: string
    • key: string
    • name: string
    • url: string

    CodesOfConductListConductCodesResponse

    CodesOfConductListConductCodesResponse: Array<CodesOfConductListConductCodesResponseItem>

    CodesOfConductListConductCodesResponseItem

    CodesOfConductListConductCodesResponseItem: { key: string; name: string; url: string }

    Type declaration

    • key: string
    • name: string
    • url: string

    GistsCheckIsStarredParams

    GistsCheckIsStarredParams: { gist_id: string }

    Type declaration

    • gist_id: string

    GistsCreateCommentParams

    GistsCreateCommentParams: { body: string; gist_id: string }

    Type declaration

    • body: string

      The comment text.

    • gist_id: string

    GistsCreateCommentResponse

    GistsCreateCommentResponse: { body: string; created_at: string; id: number; node_id: string; updated_at: string; url: string; user: GistsCreateCommentResponseUser }

    Type declaration

    GistsCreateCommentResponseUser

    GistsCreateCommentResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    GistsCreateParams

    GistsCreateParams: { description?: undefined | string; files: GistsCreateParamsFiles; public?: undefined | false | true }

    Type declaration

    • Optional description?: undefined | string

      A descriptive name for this gist.

    • files: GistsCreateParamsFiles

      The filenames and content of each file in the gist. The keys in the files object represent the filename and have the type string.

    • Optional public?: undefined | false | true

      When true, the gist will be public and available for anyone to see.

    GistsCreateParamsFiles

    GistsCreateParamsFiles: { content?: undefined | string }

    Type declaration

    • Optional content?: undefined | string

    GistsCreateResponse

    GistsCreateResponse: { comments: number; comments_url: string; commits_url: string; created_at: string; description: string; files: GistsCreateResponseFiles; forks: Array<GistsCreateResponseForksItem>; forks_url: string; git_pull_url: string; git_push_url: string; history: Array<GistsCreateResponseHistoryItem>; html_url: string; id: string; node_id: string; owner: GistsCreateResponseOwner; public: boolean; truncated: boolean; updated_at: string; url: string; user: null }

    Type declaration

    GistsCreateResponseFiles

    GistsCreateResponseFiles: { hello_world.py: GistsCreateResponseFilesHelloWorldPy; hello_world.rb: GistsCreateResponseFilesHelloWorldRb; hello_world_python.txt: GistsCreateResponseFilesHelloWorldPythonTxt; hello_world_ruby.txt: GistsCreateResponseFilesHelloWorldRubyTxt }

    Type declaration

    GistsCreateResponseFilesHelloWorldPy

    GistsCreateResponseFilesHelloWorldPy: { content: string; filename: string; language: string; raw_url: string; size: number; truncated: boolean; type: string }

    Type declaration

    • content: string
    • filename: string
    • language: string
    • raw_url: string
    • size: number
    • truncated: boolean
    • type: string

    GistsCreateResponseFilesHelloWorldPythonTxt

    GistsCreateResponseFilesHelloWorldPythonTxt: { content: string; filename: string; language: string; raw_url: string; size: number; truncated: boolean; type: string }

    Type declaration

    • content: string
    • filename: string
    • language: string
    • raw_url: string
    • size: number
    • truncated: boolean
    • type: string

    GistsCreateResponseFilesHelloWorldRb

    GistsCreateResponseFilesHelloWorldRb: { content: string; filename: string; language: string; raw_url: string; size: number; truncated: boolean; type: string }

    Type declaration

    • content: string
    • filename: string
    • language: string
    • raw_url: string
    • size: number
    • truncated: boolean
    • type: string

    GistsCreateResponseFilesHelloWorldRubyTxt

    GistsCreateResponseFilesHelloWorldRubyTxt: { content: string; filename: string; language: string; raw_url: string; size: number; truncated: boolean; type: string }

    Type declaration

    • content: string
    • filename: string
    • language: string
    • raw_url: string
    • size: number
    • truncated: boolean
    • type: string

    GistsCreateResponseForksItem

    GistsCreateResponseForksItem: { created_at: string; id: string; updated_at: string; url: string; user: GistsCreateResponseForksItemUser }

    Type declaration

    GistsCreateResponseForksItemUser

    GistsCreateResponseForksItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    GistsCreateResponseHistoryItem

    GistsCreateResponseHistoryItem: { change_status: GistsCreateResponseHistoryItemChangeStatus; committed_at: string; url: string; user: GistsCreateResponseHistoryItemUser; version: string }

    Type declaration

    GistsCreateResponseHistoryItemChangeStatus

    GistsCreateResponseHistoryItemChangeStatus: { additions: number; deletions: number; total: number }

    Type declaration

    • additions: number
    • deletions: number
    • total: number

    GistsCreateResponseHistoryItemUser

    GistsCreateResponseHistoryItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    GistsCreateResponseOwner

    GistsCreateResponseOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    GistsDeleteCommentParams

    GistsDeleteCommentParams: { comment_id: number; gist_id: string }

    Type declaration

    • comment_id: number
    • gist_id: string

    GistsDeleteParams

    GistsDeleteParams: { gist_id: string }

    Type declaration

    • gist_id: string

    GistsForkParams

    GistsForkParams: { gist_id: string }

    Type declaration

    • gist_id: string

    GistsForkResponse

    GistsForkResponse: { comments: number; comments_url: string; commits_url: string; created_at: string; description: string; files: GistsForkResponseFiles; forks_url: string; git_pull_url: string; git_push_url: string; html_url: string; id: string; node_id: string; owner: GistsForkResponseOwner; public: boolean; truncated: boolean; updated_at: string; url: string; user: null }

    Type declaration

    • comments: number
    • comments_url: string
    • commits_url: string
    • created_at: string
    • description: string
    • files: GistsForkResponseFiles
    • forks_url: string
    • git_pull_url: string
    • git_push_url: string
    • html_url: string
    • id: string
    • node_id: string
    • owner: GistsForkResponseOwner
    • public: boolean
    • truncated: boolean
    • updated_at: string
    • url: string
    • user: null

    GistsForkResponseFiles

    GistsForkResponseFiles: { hello_world.rb: GistsForkResponseFilesHelloWorldRb }

    Type declaration

    GistsForkResponseFilesHelloWorldRb

    GistsForkResponseFilesHelloWorldRb: { filename: string; language: string; raw_url: string; size: number; type: string }

    Type declaration

    • filename: string
    • language: string
    • raw_url: string
    • size: number
    • type: string

    GistsForkResponseOwner

    GistsForkResponseOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    GistsGetCommentParams

    GistsGetCommentParams: { comment_id: number; gist_id: string }

    Type declaration

    • comment_id: number
    • gist_id: string

    GistsGetCommentResponse

    GistsGetCommentResponse: { body: string; created_at: string; id: number; node_id: string; updated_at: string; url: string; user: GistsGetCommentResponseUser }

    Type declaration

    GistsGetCommentResponseUser

    GistsGetCommentResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    GistsGetParams

    GistsGetParams: { gist_id: string }

    Type declaration

    • gist_id: string

    GistsGetResponse

    GistsGetResponse: { comments: number; comments_url: string; commits_url: string; created_at: string; description: string; files: GistsGetResponseFiles; forks: Array<GistsGetResponseForksItem>; forks_url: string; git_pull_url: string; git_push_url: string; history: Array<GistsGetResponseHistoryItem>; html_url: string; id: string; node_id: string; owner: GistsGetResponseOwner; public: boolean; truncated: boolean; updated_at: string; url: string; user: null }

    Type declaration

    GistsGetResponseFiles

    GistsGetResponseFiles: { hello_world.py: GistsGetResponseFilesHelloWorldPy; hello_world.rb: GistsGetResponseFilesHelloWorldRb; hello_world_python.txt: GistsGetResponseFilesHelloWorldPythonTxt; hello_world_ruby.txt: GistsGetResponseFilesHelloWorldRubyTxt }

    Type declaration

    GistsGetResponseFilesHelloWorldPy

    GistsGetResponseFilesHelloWorldPy: { content: string; filename: string; language: string; raw_url: string; size: number; truncated: boolean; type: string }

    Type declaration

    • content: string
    • filename: string
    • language: string
    • raw_url: string
    • size: number
    • truncated: boolean
    • type: string

    GistsGetResponseFilesHelloWorldPythonTxt

    GistsGetResponseFilesHelloWorldPythonTxt: { content: string; filename: string; language: string; raw_url: string; size: number; truncated: boolean; type: string }

    Type declaration

    • content: string
    • filename: string
    • language: string
    • raw_url: string
    • size: number
    • truncated: boolean
    • type: string

    GistsGetResponseFilesHelloWorldRb

    GistsGetResponseFilesHelloWorldRb: { content: string; filename: string; language: string; raw_url: string; size: number; truncated: boolean; type: string }

    Type declaration

    • content: string
    • filename: string
    • language: string
    • raw_url: string
    • size: number
    • truncated: boolean
    • type: string

    GistsGetResponseFilesHelloWorldRubyTxt

    GistsGetResponseFilesHelloWorldRubyTxt: { content: string; filename: string; language: string; raw_url: string; size: number; truncated: boolean; type: string }

    Type declaration

    • content: string
    • filename: string
    • language: string
    • raw_url: string
    • size: number
    • truncated: boolean
    • type: string

    GistsGetResponseForksItem

    GistsGetResponseForksItem: { created_at: string; id: string; updated_at: string; url: string; user: GistsGetResponseForksItemUser }

    Type declaration

    GistsGetResponseForksItemUser

    GistsGetResponseForksItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    GistsGetResponseHistoryItem

    GistsGetResponseHistoryItem: { change_status: GistsGetResponseHistoryItemChangeStatus; committed_at: string; url: string; user: GistsGetResponseHistoryItemUser; version: string }

    Type declaration

    GistsGetResponseHistoryItemChangeStatus

    GistsGetResponseHistoryItemChangeStatus: { additions: number; deletions: number; total: number }

    Type declaration

    • additions: number
    • deletions: number
    • total: number

    GistsGetResponseHistoryItemUser

    GistsGetResponseHistoryItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    GistsGetResponseOwner

    GistsGetResponseOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    GistsGetRevisionParams

    GistsGetRevisionParams: { gist_id: string; sha: string }

    Type declaration

    • gist_id: string
    • sha: string

    GistsGetRevisionResponse

    GistsGetRevisionResponse: { comments: number; comments_url: string; commits_url: string; created_at: string; description: string; files: GistsGetRevisionResponseFiles; forks: Array<GistsGetRevisionResponseForksItem>; forks_url: string; git_pull_url: string; git_push_url: string; history: Array<GistsGetRevisionResponseHistoryItem>; html_url: string; id: string; node_id: string; owner: GistsGetRevisionResponseOwner; public: boolean; truncated: boolean; updated_at: string; url: string; user: null }

    Type declaration

    GistsGetRevisionResponseFiles

    GistsGetRevisionResponseFiles: { hello_world.py: GistsGetRevisionResponseFilesHelloWorldPy; hello_world.rb: GistsGetRevisionResponseFilesHelloWorldRb; hello_world_python.txt: GistsGetRevisionResponseFilesHelloWorldPythonTxt; hello_world_ruby.txt: GistsGetRevisionResponseFilesHelloWorldRubyTxt }

    Type declaration

    GistsGetRevisionResponseFilesHelloWorldPy

    GistsGetRevisionResponseFilesHelloWorldPy: { content: string; filename: string; language: string; raw_url: string; size: number; truncated: boolean; type: string }

    Type declaration

    • content: string
    • filename: string
    • language: string
    • raw_url: string
    • size: number
    • truncated: boolean
    • type: string

    GistsGetRevisionResponseFilesHelloWorldPythonTxt

    GistsGetRevisionResponseFilesHelloWorldPythonTxt: { content: string; filename: string; language: string; raw_url: string; size: number; truncated: boolean; type: string }

    Type declaration

    • content: string
    • filename: string
    • language: string
    • raw_url: string
    • size: number
    • truncated: boolean
    • type: string

    GistsGetRevisionResponseFilesHelloWorldRb

    GistsGetRevisionResponseFilesHelloWorldRb: { content: string; filename: string; language: string; raw_url: string; size: number; truncated: boolean; type: string }

    Type declaration

    • content: string
    • filename: string
    • language: string
    • raw_url: string
    • size: number
    • truncated: boolean
    • type: string

    GistsGetRevisionResponseFilesHelloWorldRubyTxt

    GistsGetRevisionResponseFilesHelloWorldRubyTxt: { content: string; filename: string; language: string; raw_url: string; size: number; truncated: boolean; type: string }

    Type declaration

    • content: string
    • filename: string
    • language: string
    • raw_url: string
    • size: number
    • truncated: boolean
    • type: string

    GistsGetRevisionResponseForksItem

    GistsGetRevisionResponseForksItem: { created_at: string; id: string; updated_at: string; url: string; user: GistsGetRevisionResponseForksItemUser }

    Type declaration

    GistsGetRevisionResponseForksItemUser

    GistsGetRevisionResponseForksItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    GistsGetRevisionResponseHistoryItem

    GistsGetRevisionResponseHistoryItem: { change_status: GistsGetRevisionResponseHistoryItemChangeStatus; committed_at: string; url: string; user: GistsGetRevisionResponseHistoryItemUser; version: string }

    Type declaration

    GistsGetRevisionResponseHistoryItemChangeStatus

    GistsGetRevisionResponseHistoryItemChangeStatus: { additions: number; deletions: number; total: number }

    Type declaration

    • additions: number
    • deletions: number
    • total: number

    GistsGetRevisionResponseHistoryItemUser

    GistsGetRevisionResponseHistoryItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    GistsGetRevisionResponseOwner

    GistsGetRevisionResponseOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    GistsListCommentsParams

    GistsListCommentsParams: { gist_id: string; page?: undefined | number; per_page?: undefined | number }

    Type declaration

    • gist_id: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    GistsListCommentsResponse

    GistsListCommentsResponse: Array<GistsListCommentsResponseItem>

    GistsListCommentsResponseItem

    GistsListCommentsResponseItem: { body: string; created_at: string; id: number; node_id: string; updated_at: string; url: string; user: GistsListCommentsResponseItemUser }

    Type declaration

    GistsListCommentsResponseItemUser

    GistsListCommentsResponseItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    GistsListCommitsParams

    GistsListCommitsParams: { gist_id: string; page?: undefined | number; per_page?: undefined | number }

    Type declaration

    • gist_id: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    GistsListCommitsResponse

    GistsListCommitsResponse: Array<GistsListCommitsResponseItem>

    GistsListCommitsResponseItem

    GistsListCommitsResponseItem: { change_status: GistsListCommitsResponseItemChangeStatus; committed_at: string; url: string; user: GistsListCommitsResponseItemUser; version: string }

    Type declaration

    GistsListCommitsResponseItemChangeStatus

    GistsListCommitsResponseItemChangeStatus: { additions: number; deletions: number; total: number }

    Type declaration

    • additions: number
    • deletions: number
    • total: number

    GistsListCommitsResponseItemUser

    GistsListCommitsResponseItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    GistsListForksParams

    GistsListForksParams: { gist_id: string; page?: undefined | number; per_page?: undefined | number }

    Type declaration

    • gist_id: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    GistsListForksResponse

    GistsListForksResponse: Array<GistsListForksResponseItem>

    GistsListForksResponseItem

    GistsListForksResponseItem: { created_at: string; id: string; updated_at: string; url: string; user: GistsListForksResponseItemUser }

    Type declaration

    GistsListForksResponseItemUser

    GistsListForksResponseItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    GistsListParams

    GistsListParams: { page?: undefined | number; per_page?: undefined | number; since?: undefined | string }

    Type declaration

    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • Optional since?: undefined | string

      This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only gists updated at or after this time are returned.

    GistsListPublicForUserParams

    GistsListPublicForUserParams: { page?: undefined | number; per_page?: undefined | number; since?: undefined | string; username: string }

    Type declaration

    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • Optional since?: undefined | string

      This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only gists updated at or after this time are returned.

    • username: string

    GistsListPublicForUserResponse

    GistsListPublicForUserResponse: Array<GistsListPublicForUserResponseItem>

    GistsListPublicForUserResponseItem

    GistsListPublicForUserResponseItem: { comments: number; comments_url: string; commits_url: string; created_at: string; description: string; files: GistsListPublicForUserResponseItemFiles; forks_url: string; git_pull_url: string; git_push_url: string; html_url: string; id: string; node_id: string; owner: GistsListPublicForUserResponseItemOwner; public: boolean; truncated: boolean; updated_at: string; url: string; user: null }

    Type declaration

    GistsListPublicForUserResponseItemFiles

    GistsListPublicForUserResponseItemFiles: { hello_world.rb: GistsListPublicForUserResponseItemFilesHelloWorldRb }

    Type declaration

    GistsListPublicForUserResponseItemFilesHelloWorldRb

    GistsListPublicForUserResponseItemFilesHelloWorldRb: { filename: string; language: string; raw_url: string; size: number; type: string }

    Type declaration

    • filename: string
    • language: string
    • raw_url: string
    • size: number
    • type: string

    GistsListPublicForUserResponseItemOwner

    GistsListPublicForUserResponseItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    GistsListPublicParams

    GistsListPublicParams: { page?: undefined | number; per_page?: undefined | number; since?: undefined | string }

    Type declaration

    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • Optional since?: undefined | string

      This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only gists updated at or after this time are returned.

    GistsListPublicResponse

    GistsListPublicResponse: Array<GistsListPublicResponseItem>

    GistsListPublicResponseItem

    GistsListPublicResponseItem: { comments: number; comments_url: string; commits_url: string; created_at: string; description: string; files: GistsListPublicResponseItemFiles; forks_url: string; git_pull_url: string; git_push_url: string; html_url: string; id: string; node_id: string; owner: GistsListPublicResponseItemOwner; public: boolean; truncated: boolean; updated_at: string; url: string; user: null }

    Type declaration

    • comments: number
    • comments_url: string
    • commits_url: string
    • created_at: string
    • description: string
    • files: GistsListPublicResponseItemFiles
    • forks_url: string
    • git_pull_url: string
    • git_push_url: string
    • html_url: string
    • id: string
    • node_id: string
    • owner: GistsListPublicResponseItemOwner
    • public: boolean
    • truncated: boolean
    • updated_at: string
    • url: string
    • user: null

    GistsListPublicResponseItemFiles

    GistsListPublicResponseItemFiles: { hello_world.rb: GistsListPublicResponseItemFilesHelloWorldRb }

    Type declaration

    GistsListPublicResponseItemFilesHelloWorldRb

    GistsListPublicResponseItemFilesHelloWorldRb: { filename: string; language: string; raw_url: string; size: number; type: string }

    Type declaration

    • filename: string
    • language: string
    • raw_url: string
    • size: number
    • type: string

    GistsListPublicResponseItemOwner

    GistsListPublicResponseItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    GistsListResponse

    GistsListResponse: Array<GistsListResponseItem>

    GistsListResponseItem

    GistsListResponseItem: { comments: number; comments_url: string; commits_url: string; created_at: string; description: string; files: GistsListResponseItemFiles; forks_url: string; git_pull_url: string; git_push_url: string; html_url: string; id: string; node_id: string; owner: GistsListResponseItemOwner; public: boolean; truncated: boolean; updated_at: string; url: string; user: null }

    Type declaration

    • comments: number
    • comments_url: string
    • commits_url: string
    • created_at: string
    • description: string
    • files: GistsListResponseItemFiles
    • forks_url: string
    • git_pull_url: string
    • git_push_url: string
    • html_url: string
    • id: string
    • node_id: string
    • owner: GistsListResponseItemOwner
    • public: boolean
    • truncated: boolean
    • updated_at: string
    • url: string
    • user: null

    GistsListResponseItemFiles

    GistsListResponseItemFiles: { hello_world.rb: GistsListResponseItemFilesHelloWorldRb }

    Type declaration

    GistsListResponseItemFilesHelloWorldRb

    GistsListResponseItemFilesHelloWorldRb: { filename: string; language: string; raw_url: string; size: number; type: string }

    Type declaration

    • filename: string
    • language: string
    • raw_url: string
    • size: number
    • type: string

    GistsListResponseItemOwner

    GistsListResponseItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    GistsListStarredParams

    GistsListStarredParams: { page?: undefined | number; per_page?: undefined | number; since?: undefined | string }

    Type declaration

    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • Optional since?: undefined | string

      This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only gists updated at or after this time are returned.

    GistsListStarredResponse

    GistsListStarredResponse: Array<GistsListStarredResponseItem>

    GistsListStarredResponseItem

    GistsListStarredResponseItem: { comments: number; comments_url: string; commits_url: string; created_at: string; description: string; files: GistsListStarredResponseItemFiles; forks_url: string; git_pull_url: string; git_push_url: string; html_url: string; id: string; node_id: string; owner: GistsListStarredResponseItemOwner; public: boolean; truncated: boolean; updated_at: string; url: string; user: null }

    Type declaration

    • comments: number
    • comments_url: string
    • commits_url: string
    • created_at: string
    • description: string
    • files: GistsListStarredResponseItemFiles
    • forks_url: string
    • git_pull_url: string
    • git_push_url: string
    • html_url: string
    • id: string
    • node_id: string
    • owner: GistsListStarredResponseItemOwner
    • public: boolean
    • truncated: boolean
    • updated_at: string
    • url: string
    • user: null

    GistsListStarredResponseItemFiles

    GistsListStarredResponseItemFiles: { hello_world.rb: GistsListStarredResponseItemFilesHelloWorldRb }

    Type declaration

    GistsListStarredResponseItemFilesHelloWorldRb

    GistsListStarredResponseItemFilesHelloWorldRb: { filename: string; language: string; raw_url: string; size: number; type: string }

    Type declaration

    • filename: string
    • language: string
    • raw_url: string
    • size: number
    • type: string

    GistsListStarredResponseItemOwner

    GistsListStarredResponseItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    GistsStarParams

    GistsStarParams: { gist_id: string }

    Type declaration

    • gist_id: string

    GistsUnstarParams

    GistsUnstarParams: { gist_id: string }

    Type declaration

    • gist_id: string

    GistsUpdateCommentParams

    GistsUpdateCommentParams: { body: string; comment_id: number; gist_id: string }

    Type declaration

    • body: string

      The comment text.

    • comment_id: number
    • gist_id: string

    GistsUpdateCommentResponse

    GistsUpdateCommentResponse: { body: string; created_at: string; id: number; node_id: string; updated_at: string; url: string; user: GistsUpdateCommentResponseUser }

    Type declaration

    GistsUpdateCommentResponseUser

    GistsUpdateCommentResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    GistsUpdateParams

    GistsUpdateParams: { description?: undefined | string; files?: GistsUpdateParamsFiles; gist_id: string }

    Type declaration

    • Optional description?: undefined | string

      A descriptive name for this gist.

    • Optional files?: GistsUpdateParamsFiles

      The filenames and content that make up this gist.

    • gist_id: string

    GistsUpdateParamsFiles

    GistsUpdateParamsFiles: { content?: undefined | string; filename?: undefined | string }

    Type declaration

    • Optional content?: undefined | string
    • Optional filename?: undefined | string

    GistsUpdateResponse

    GistsUpdateResponse: { comments: number; comments_url: string; commits_url: string; created_at: string; description: string; files: GistsUpdateResponseFiles; forks: Array<GistsUpdateResponseForksItem>; forks_url: string; git_pull_url: string; git_push_url: string; history: Array<GistsUpdateResponseHistoryItem>; html_url: string; id: string; node_id: string; owner: GistsUpdateResponseOwner; public: boolean; truncated: boolean; updated_at: string; url: string; user: null }

    Type declaration

    GistsUpdateResponseFiles

    GistsUpdateResponseFiles: { hello_world.md: GistsUpdateResponseFilesHelloWorldMd; hello_world.py: GistsUpdateResponseFilesHelloWorldPy; hello_world.rb: GistsUpdateResponseFilesHelloWorldRb; new_file.txt: GistsUpdateResponseFilesNewFileTxt }

    Type declaration

    GistsUpdateResponseFilesHelloWorldMd

    GistsUpdateResponseFilesHelloWorldMd: { content: string; filename: string; language: string; raw_url: string; size: number; truncated: boolean; type: string }

    Type declaration

    • content: string
    • filename: string
    • language: string
    • raw_url: string
    • size: number
    • truncated: boolean
    • type: string

    GistsUpdateResponseFilesHelloWorldPy

    GistsUpdateResponseFilesHelloWorldPy: { content: string; filename: string; language: string; raw_url: string; size: number; truncated: boolean; type: string }

    Type declaration

    • content: string
    • filename: string
    • language: string
    • raw_url: string
    • size: number
    • truncated: boolean
    • type: string

    GistsUpdateResponseFilesHelloWorldRb

    GistsUpdateResponseFilesHelloWorldRb: { content: string; filename: string; language: string; raw_url: string; size: number; truncated: boolean; type: string }

    Type declaration

    • content: string
    • filename: string
    • language: string
    • raw_url: string
    • size: number
    • truncated: boolean
    • type: string

    GistsUpdateResponseFilesNewFileTxt

    GistsUpdateResponseFilesNewFileTxt: { content: string; filename: string; language: string; raw_url: string; size: number; truncated: boolean; type: string }

    Type declaration

    • content: string
    • filename: string
    • language: string
    • raw_url: string
    • size: number
    • truncated: boolean
    • type: string

    GistsUpdateResponseForksItem

    GistsUpdateResponseForksItem: { created_at: string; id: string; updated_at: string; url: string; user: GistsUpdateResponseForksItemUser }

    Type declaration

    GistsUpdateResponseForksItemUser

    GistsUpdateResponseForksItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    GistsUpdateResponseHistoryItem

    GistsUpdateResponseHistoryItem: { change_status: GistsUpdateResponseHistoryItemChangeStatus; committed_at: string; url: string; user: GistsUpdateResponseHistoryItemUser; version: string }

    Type declaration

    GistsUpdateResponseHistoryItemChangeStatus

    GistsUpdateResponseHistoryItemChangeStatus: { additions: number; deletions: number; total: number }

    Type declaration

    • additions: number
    • deletions: number
    • total: number

    GistsUpdateResponseHistoryItemUser

    GistsUpdateResponseHistoryItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    GistsUpdateResponseOwner

    GistsUpdateResponseOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    GitCreateBlobParams

    GitCreateBlobParams: { content: string; encoding?: undefined | string; owner: string; repo: string }

    Type declaration

    • content: string

      The new blob's content.

    • Optional encoding?: undefined | string

      The encoding used for content. Currently, "utf-8" and "base64" are supported.

    • owner: string
    • repo: string

    GitCreateBlobResponse

    GitCreateBlobResponse: { sha: string; url: string }

    Type declaration

    • sha: string
    • url: string

    GitCreateCommitParams

    GitCreateCommitParams: { author?: GitCreateCommitParamsAuthor; committer?: GitCreateCommitParamsCommitter; message: string; owner: string; parents: string[]; repo: string; signature?: undefined | string; tree: string }

    Type declaration

    • Optional author?: GitCreateCommitParamsAuthor

      Information about the author of the commit. By default, the author will be the authenticated user and the current date. See the author and committer object below for details.

    • Optional committer?: GitCreateCommitParamsCommitter

      Information about the person who is making the commit. By default, committer will use the information set in author. See the author and committer object below for details.

    • message: string

      The commit message

    • owner: string
    • parents: string[]

      The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.

    • repo: string
    • Optional signature?: undefined | string

      The PGP signature of the commit. GitHub adds the signature to the gpgsig header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a signature parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to use the command line to create signed commits.

    • tree: string

      The SHA of the tree object this commit points to

    GitCreateCommitParamsAuthor

    GitCreateCommitParamsAuthor: { date?: undefined | string; email?: undefined | string; name?: undefined | string }

    Type declaration

    • Optional date?: undefined | string
    • Optional email?: undefined | string
    • Optional name?: undefined | string

    GitCreateCommitParamsCommitter

    GitCreateCommitParamsCommitter: { date?: undefined | string; email?: undefined | string; name?: undefined | string }

    Type declaration

    • Optional date?: undefined | string
    • Optional email?: undefined | string
    • Optional name?: undefined | string

    GitCreateCommitResponse

    GitCreateCommitResponse: { author: GitCreateCommitResponseAuthor; committer: GitCreateCommitResponseCommitter; message: string; node_id: string; parents: Array<GitCreateCommitResponseParentsItem>; sha: string; tree: GitCreateCommitResponseTree; url: string; verification: GitCreateCommitResponseVerification }

    Type declaration

    GitCreateCommitResponseAuthor

    GitCreateCommitResponseAuthor: { date: string; email: string; name: string }

    Type declaration

    • date: string
    • email: string
    • name: string

    GitCreateCommitResponseCommitter

    GitCreateCommitResponseCommitter: { date: string; email: string; name: string }

    Type declaration

    • date: string
    • email: string
    • name: string

    GitCreateCommitResponseParentsItem

    GitCreateCommitResponseParentsItem: { sha: string; url: string }

    Type declaration

    • sha: string
    • url: string

    GitCreateCommitResponseTree

    GitCreateCommitResponseTree: { sha: string; url: string }

    Type declaration

    • sha: string
    • url: string

    GitCreateCommitResponseVerification

    GitCreateCommitResponseVerification: { payload: null; reason: string; signature: null; verified: boolean }

    Type declaration

    • payload: null
    • reason: string
    • signature: null
    • verified: boolean

    GitCreateRefParams

    GitCreateRefParams: { owner: string; ref: string; repo: string; sha: string }

    Type declaration

    • owner: string
    • ref: string

      The name of the fully qualified reference (ie: refs/heads/master). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.

    • repo: string
    • sha: string

      The SHA1 value for this reference.

    GitCreateRefResponse

    GitCreateRefResponse: { node_id: string; object: GitCreateRefResponseObject; ref: string; url: string }

    Type declaration

    GitCreateRefResponseObject

    GitCreateRefResponseObject: { sha: string; type: string; url: string }

    Type declaration

    • sha: string
    • type: string
    • url: string

    GitCreateTagParams

    GitCreateTagParams: { message: string; object: string; owner: string; repo: string; tag: string; tagger?: GitCreateTagParamsTagger; type: "commit" | "tree" | "blob" }

    Type declaration

    • message: string

      The tag message.

    • object: string

      The SHA of the git object this is tagging.

    • owner: string
    • repo: string
    • tag: string

      The tag's name. This is typically a version (e.g., "v0.0.1").

    • Optional tagger?: GitCreateTagParamsTagger

      An object with information about the individual creating the tag.

    • type: "commit" | "tree" | "blob"

      The type of the object we're tagging. Normally this is a commit but it can also be a tree or a blob.

    GitCreateTagParamsTagger

    GitCreateTagParamsTagger: { date?: undefined | string; email?: undefined | string; name?: undefined | string }

    Type declaration

    • Optional date?: undefined | string
    • Optional email?: undefined | string
    • Optional name?: undefined | string

    GitCreateTagResponse

    GitCreateTagResponse: { message: string; node_id: string; object: GitCreateTagResponseObject; sha: string; tag: string; tagger: GitCreateTagResponseTagger; url: string; verification: GitCreateTagResponseVerification }

    Type declaration

    GitCreateTagResponseObject

    GitCreateTagResponseObject: { sha: string; type: string; url: string }

    Type declaration

    • sha: string
    • type: string
    • url: string

    GitCreateTagResponseTagger

    GitCreateTagResponseTagger: { date: string; email: string; name: string }

    Type declaration

    • date: string
    • email: string
    • name: string

    GitCreateTagResponseVerification

    GitCreateTagResponseVerification: { payload: null; reason: string; signature: null; verified: boolean }

    Type declaration

    • payload: null
    • reason: string
    • signature: null
    • verified: boolean

    GitCreateTreeParams

    GitCreateTreeParams: { base_tree?: undefined | string; owner: string; repo: string; tree: GitCreateTreeParamsTree[] }

    Type declaration

    • Optional base_tree?: undefined | string

      The SHA1 of the tree you want to update with new data. If you don't set this, the commit will be created on top of everything; however, it will only contain your change, the rest of your files will show up as deleted.

    • owner: string
    • repo: string
    • tree: GitCreateTreeParamsTree[]

      Objects (of path, mode, type, and sha) specifying a tree structure.

    GitCreateTreeParamsTree

    GitCreateTreeParamsTree: { content?: undefined | string; mode?: "100644" | "100755" | "040000" | "160000" | "120000"; path?: undefined | string; sha?: undefined | string; type?: "blob" | "tree" | "commit" }

    Type declaration

    • Optional content?: undefined | string
    • Optional mode?: "100644" | "100755" | "040000" | "160000" | "120000"
    • Optional path?: undefined | string
    • Optional sha?: undefined | string
    • Optional type?: "blob" | "tree" | "commit"

    GitCreateTreeResponse

    GitCreateTreeResponse: { sha: string; tree: Array<GitCreateTreeResponseTreeItem>; url: string }

    Type declaration

    GitCreateTreeResponseTreeItem

    GitCreateTreeResponseTreeItem: { mode: string; path: string; sha: string; size: number; type: string; url: string }

    Type declaration

    • mode: string
    • path: string
    • sha: string
    • size: number
    • type: string
    • url: string

    GitDeleteRefParams

    GitDeleteRefParams: { owner: string; ref: string; repo: string }

    Type declaration

    • owner: string
    • ref: string
    • repo: string

    GitGetBlobParams

    GitGetBlobParams: { file_sha: string; owner: string; repo: string }

    Type declaration

    • file_sha: string
    • owner: string
    • repo: string

    GitGetBlobResponse

    GitGetBlobResponse: { content: string; encoding: string; sha: string; size: number; url: string }

    Type declaration

    • content: string
    • encoding: string
    • sha: string
    • size: number
    • url: string

    GitGetCommitParams

    GitGetCommitParams: { commit_sha: string; owner: string; repo: string }

    Type declaration

    • commit_sha: string
    • owner: string
    • repo: string

    GitGetCommitResponse

    GitGetCommitResponse: { author: GitGetCommitResponseAuthor; committer: GitGetCommitResponseCommitter; message: string; parents: Array<GitGetCommitResponseParentsItem>; sha: string; tree: GitGetCommitResponseTree; url: string; verification: GitGetCommitResponseVerification }

    Type declaration

    GitGetCommitResponseAuthor

    GitGetCommitResponseAuthor: { date: string; email: string; name: string }

    Type declaration

    • date: string
    • email: string
    • name: string

    GitGetCommitResponseCommitter

    GitGetCommitResponseCommitter: { date: string; email: string; name: string }

    Type declaration

    • date: string
    • email: string
    • name: string

    GitGetCommitResponseParentsItem

    GitGetCommitResponseParentsItem: { sha: string; url: string }

    Type declaration

    • sha: string
    • url: string

    GitGetCommitResponseTree

    GitGetCommitResponseTree: { sha: string; url: string }

    Type declaration

    • sha: string
    • url: string

    GitGetCommitResponseVerification

    GitGetCommitResponseVerification: { payload: null; reason: string; signature: null; verified: boolean }

    Type declaration

    • payload: null
    • reason: string
    • signature: null
    • verified: boolean

    GitGetRefParams

    GitGetRefParams: { owner: string; ref: string; repo: string }

    Type declaration

    • owner: string
    • ref: string
    • repo: string

    GitGetRefResponse

    GitGetRefResponse: { node_id: string; object: GitGetRefResponseObject; ref: string; url: string }

    Type declaration

    GitGetRefResponseObject

    GitGetRefResponseObject: { sha: string; type: string; url: string }

    Type declaration

    • sha: string
    • type: string
    • url: string

    GitGetTagParams

    GitGetTagParams: { owner: string; repo: string; tag_sha: string }

    Type declaration

    • owner: string
    • repo: string
    • tag_sha: string

    GitGetTagResponse

    GitGetTagResponse: { message: string; node_id: string; object: GitGetTagResponseObject; sha: string; tag: string; tagger: GitGetTagResponseTagger; url: string; verification: GitGetTagResponseVerification }

    Type declaration

    GitGetTagResponseObject

    GitGetTagResponseObject: { sha: string; type: string; url: string }

    Type declaration

    • sha: string
    • type: string
    • url: string

    GitGetTagResponseTagger

    GitGetTagResponseTagger: { date: string; email: string; name: string }

    Type declaration

    • date: string
    • email: string
    • name: string

    GitGetTagResponseVerification

    GitGetTagResponseVerification: { payload: null; reason: string; signature: null; verified: boolean }

    Type declaration

    • payload: null
    • reason: string
    • signature: null
    • verified: boolean

    GitGetTreeParams

    GitGetTreeParams: { owner: string; recursive?: undefined | "1"; repo: string; tree_sha: string }

    Type declaration

    • owner: string
    • Optional recursive?: undefined | "1"
    • repo: string
    • tree_sha: string

    GitGetTreeResponse

    GitGetTreeResponse: { sha: string; tree: Array<GitGetTreeResponseTreeItem>; truncated: boolean; url: string }

    Type declaration

    GitGetTreeResponseTreeItem

    GitGetTreeResponseTreeItem: { mode: string; path: string; sha: string; size?: undefined | number; type: string; url: string }

    Type declaration

    • mode: string
    • path: string
    • sha: string
    • Optional size?: undefined | number
    • type: string
    • url: string

    GitListMatchingRefsParams

    GitListMatchingRefsParams: { owner: string; page?: undefined | number; per_page?: undefined | number; ref: string; repo: string }

    Type declaration

    • owner: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • ref: string
    • repo: string

    GitListMatchingRefsResponse

    GitListMatchingRefsResponse: Array<GitListMatchingRefsResponseItem>

    GitListMatchingRefsResponseItem

    GitListMatchingRefsResponseItem: { node_id: string; object: GitListMatchingRefsResponseItemObject; ref: string; url: string }

    Type declaration

    GitListMatchingRefsResponseItemObject

    GitListMatchingRefsResponseItemObject: { sha: string; type: string; url: string }

    Type declaration

    • sha: string
    • type: string
    • url: string

    GitListRefsParams

    GitListRefsParams: { namespace?: undefined | string; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

    Type declaration

    • Optional namespace?: undefined | string

      Filter by sub-namespace (reference prefix). Most commen examples would be 'heads/' and 'tags/' to retrieve branches or tags

    • owner: string
    • Optional page?: undefined | number
    • Optional per_page?: undefined | number
    • repo: string

    GitUpdateRefParams

    GitUpdateRefParams: { force?: undefined | false | true; owner: string; ref: string; repo: string; sha: string }

    Type declaration

    • Optional force?: undefined | false | true

      Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to false will make sure you're not overwriting work.

    • owner: string
    • ref: string
    • repo: string
    • sha: string

      The SHA1 value to set this reference to

    GitUpdateRefResponse

    GitUpdateRefResponse: { node_id: string; object: GitUpdateRefResponseObject; ref: string; url: string }

    Type declaration

    GitUpdateRefResponseObject

    GitUpdateRefResponseObject: { sha: string; type: string; url: string }

    Type declaration

    • sha: string
    • type: string
    • url: string

    GitignoreGetTemplateParams

    GitignoreGetTemplateParams: { name: string }

    Type declaration

    • name: string

    GitignoreGetTemplateResponse

    GitignoreGetTemplateResponse: { name: string; source: string }

    Type declaration

    • name: string
    • source: string

    GitignoreListTemplatesResponse

    GitignoreListTemplatesResponse: Array<string>

    HookError

    HookError: Error & { documentation_url?: undefined | string; errors?: [{ code: string; field: string; resource: string }]; headers: {}; status: number }

    HookOptions

    HookOptions: { baseUrl: string; data: any; headers: {}; method: string; request: { agent?: string | null; compress?: undefined | false | true; follow?: undefined | number; size?: undefined | number; timeout?: undefined | number }; url: string }

    Type declaration

    • [index: string]: any
    • baseUrl: string
    • data: any
    • headers: {}
      • [header: string]: string
    • method: string
    • request: { agent?: string | null; compress?: undefined | false | true; follow?: undefined | number; size?: undefined | number; timeout?: undefined | number }
      • Optional agent?: string | null
      • Optional compress?: undefined | false | true
      • Optional follow?: undefined | number
      • Optional size?: undefined | number
      • Optional timeout?: undefined | number
    • url: string

    InteractionsAddOrUpdateRestrictionsForOrgParams

    InteractionsAddOrUpdateRestrictionsForOrgParams: { limit: "existing_users" | "contributors_only" | "collaborators_only"; org: string }

    Type declaration

    • limit: "existing_users" | "contributors_only" | "collaborators_only"

      Specifies the group of GitHub users who can comment, open issues, or create pull requests in public repositories for the given organization. Must be one of: existing_users, contributors_only, or collaborators_only.

    • org: string

    InteractionsAddOrUpdateRestrictionsForOrgResponse

    InteractionsAddOrUpdateRestrictionsForOrgResponse: { expires_at: string; limit: string; origin: string }

    Type declaration

    • expires_at: string
    • limit: string
    • origin: string

    InteractionsAddOrUpdateRestrictionsForRepoParams

    InteractionsAddOrUpdateRestrictionsForRepoParams: { limit: "existing_users" | "contributors_only" | "collaborators_only"; owner: string; repo: string }

    Type declaration

    • limit: "existing_users" | "contributors_only" | "collaborators_only"

      Specifies the group of GitHub users who can comment, open issues, or create pull requests for the given repository. Must be one of: existing_users, contributors_only, or collaborators_only.

    • owner: string
    • repo: string

    InteractionsAddOrUpdateRestrictionsForRepoResponse

    InteractionsAddOrUpdateRestrictionsForRepoResponse: { expires_at: string; limit: string; origin: string }

    Type declaration

    • expires_at: string
    • limit: string
    • origin: string

    InteractionsGetRestrictionsForOrgParams

    InteractionsGetRestrictionsForOrgParams: { org: string }

    Type declaration

    • org: string

    InteractionsGetRestrictionsForOrgResponse

    InteractionsGetRestrictionsForOrgResponse: { expires_at: string; limit: string; origin: string }

    Type declaration

    • expires_at: string
    • limit: string
    • origin: string

    InteractionsGetRestrictionsForRepoParams

    InteractionsGetRestrictionsForRepoParams: { owner: string; repo: string }

    Type declaration

    • owner: string
    • repo: string

    InteractionsGetRestrictionsForRepoResponse

    InteractionsGetRestrictionsForRepoResponse: { expires_at: string; limit: string; origin: string }

    Type declaration

    • expires_at: string
    • limit: string
    • origin: string

    InteractionsRemoveRestrictionsForOrgParams

    InteractionsRemoveRestrictionsForOrgParams: { org: string }

    Type declaration

    • org: string

    InteractionsRemoveRestrictionsForRepoParams

    InteractionsRemoveRestrictionsForRepoParams: { owner: string; repo: string }

    Type declaration

    • owner: string
    • repo: string

    IssuesAddAssigneesParams

    IssuesAddAssigneesParams: { assignees?: string[]; issue_number: number; owner: string; repo: string }

    Type declaration

    • Optional assignees?: string[]

      Usernames of people to assign this issue to. NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise.

    • issue_number: number
    • owner: string
    • repo: string

    IssuesAddAssigneesParamsDeprecatedNumber

    IssuesAddAssigneesParamsDeprecatedNumber: { assignees?: string[]; number: number; owner: string; repo: string }

    Type declaration

    • Optional assignees?: string[]

      Usernames of people to assign this issue to. NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise.

    • number: number
      deprecated

      "number" parameter renamed to "issue_number"

    • owner: string
    • repo: string

    IssuesAddAssigneesResponse

    IssuesAddAssigneesResponse: { active_lock_reason: string; assignee: IssuesAddAssigneesResponseAssignee; assignees: Array<IssuesAddAssigneesResponseAssigneesItem>; body: string; closed_at: null; comments: number; comments_url: string; created_at: string; events_url: string; html_url: string; id: number; labels: Array<IssuesAddAssigneesResponseLabelsItem>; labels_url: string; locked: boolean; milestone: IssuesAddAssigneesResponseMilestone; node_id: string; number: number; pull_request: IssuesAddAssigneesResponsePullRequest; repository_url: string; state: string; title: string; updated_at: string; url: string; user: IssuesAddAssigneesResponseUser }

    Type declaration

    IssuesAddAssigneesResponseAssignee

    IssuesAddAssigneesResponseAssignee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesAddAssigneesResponseAssigneesItem

    IssuesAddAssigneesResponseAssigneesItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesAddAssigneesResponseLabelsItem

    IssuesAddAssigneesResponseLabelsItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

    Type declaration

    • color: string
    • default: boolean
    • description: string
    • id: number
    • name: string
    • node_id: string
    • url: string

    IssuesAddAssigneesResponseMilestone

    IssuesAddAssigneesResponseMilestone: { closed_at: string; closed_issues: number; created_at: string; creator: IssuesAddAssigneesResponseMilestoneCreator; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }

    Type declaration

    • closed_at: string
    • closed_issues: number
    • created_at: string
    • creator: IssuesAddAssigneesResponseMilestoneCreator
    • description: string
    • due_on: string
    • html_url: string
    • id: number
    • labels_url: string
    • node_id: string
    • number: number
    • open_issues: number
    • state: string
    • title: string
    • updated_at: string
    • url: string

    IssuesAddAssigneesResponseMilestoneCreator

    IssuesAddAssigneesResponseMilestoneCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesAddAssigneesResponsePullRequest

    IssuesAddAssigneesResponsePullRequest: { diff_url: string; html_url: string; patch_url: string; url: string }

    Type declaration

    • diff_url: string
    • html_url: string
    • patch_url: string
    • url: string

    IssuesAddAssigneesResponseUser

    IssuesAddAssigneesResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesAddLabelsParams

    IssuesAddLabelsParams: { issue_number: number; labels: string[]; owner: string; repo: string }

    Type declaration

    • issue_number: number
    • labels: string[]

      The name of the label to add to the issue. Must contain at least one label. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

    • owner: string
    • repo: string

    IssuesAddLabelsParamsDeprecatedNumber

    IssuesAddLabelsParamsDeprecatedNumber: { labels: string[]; number: number; owner: string; repo: string }

    Type declaration

    • labels: string[]

      The name of the label to add to the issue. Must contain at least one label. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

    • number: number
      deprecated

      "number" parameter renamed to "issue_number"

    • owner: string
    • repo: string

    IssuesAddLabelsResponse

    IssuesAddLabelsResponse: Array<IssuesAddLabelsResponseItem>

    IssuesAddLabelsResponseItem

    IssuesAddLabelsResponseItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

    Type declaration

    • color: string
    • default: boolean
    • description: string
    • id: number
    • name: string
    • node_id: string
    • url: string

    IssuesCheckAssigneeParams

    IssuesCheckAssigneeParams: { assignee: string; owner: string; repo: string }

    Type declaration

    • assignee: string
    • owner: string
    • repo: string

    IssuesCreateCommentParams

    IssuesCreateCommentParams: { body: string; issue_number: number; owner: string; repo: string }

    Type declaration

    • body: string

      The contents of the comment.

    • issue_number: number
    • owner: string
    • repo: string

    IssuesCreateCommentParamsDeprecatedNumber

    IssuesCreateCommentParamsDeprecatedNumber: { body: string; number: number; owner: string; repo: string }

    Type declaration

    • body: string

      The contents of the comment.

    • number: number
      deprecated

      "number" parameter renamed to "issue_number"

    • owner: string
    • repo: string

    IssuesCreateCommentResponse

    IssuesCreateCommentResponse: { body: string; created_at: string; html_url: string; id: number; node_id: string; updated_at: string; url: string; user: IssuesCreateCommentResponseUser }

    Type declaration

    IssuesCreateCommentResponseUser

    IssuesCreateCommentResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesCreateLabelParams

    IssuesCreateLabelParams: { color: string; description?: undefined | string; name: string; owner: string; repo: string }

    Type declaration

    • color: string

      The hexadecimal color code for the label, without the leading #.

    • Optional description?: undefined | string

      A short description of the label.

    • name: string

      The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji :strawberry:. For a full list of available emoji and codes, see emoji-cheat-sheet.com.

    • owner: string
    • repo: string

    IssuesCreateLabelResponse

    IssuesCreateLabelResponse: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

    Type declaration

    • color: string
    • default: boolean
    • description: string
    • id: number
    • name: string
    • node_id: string
    • url: string

    IssuesCreateMilestoneParams

    IssuesCreateMilestoneParams: { description?: undefined | string; due_on?: undefined | string; owner: string; repo: string; state?: "open" | "closed"; title: string }

    Type declaration

    • Optional description?: undefined | string

      A description of the milestone.

    • Optional due_on?: undefined | string

      The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    • owner: string
    • repo: string
    • Optional state?: "open" | "closed"

      The state of the milestone. Either open or closed.

    • title: string

      The title of the milestone.

    IssuesCreateMilestoneResponse

    IssuesCreateMilestoneResponse: { closed_at: string; closed_issues: number; created_at: string; creator: IssuesCreateMilestoneResponseCreator; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }

    Type declaration

    • closed_at: string
    • closed_issues: number
    • created_at: string
    • creator: IssuesCreateMilestoneResponseCreator
    • description: string
    • due_on: string
    • html_url: string
    • id: number
    • labels_url: string
    • node_id: string
    • number: number
    • open_issues: number
    • state: string
    • title: string
    • updated_at: string
    • url: string

    IssuesCreateMilestoneResponseCreator

    IssuesCreateMilestoneResponseCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesCreateParams

    IssuesCreateParams: { assignees?: string[]; body?: undefined | string; labels?: string[]; milestone?: undefined | number; owner: string; repo: string; title: string }

    Type declaration

    • Optional assignees?: string[]

      Logins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

    • Optional body?: undefined | string

      The contents of the issue.

    • Optional labels?: string[]

      Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

    • Optional milestone?: undefined | number

      The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

    • owner: string
    • repo: string
    • title: string

      The title of the issue.

    IssuesCreateParamsDeprecatedAssignee

    IssuesCreateParamsDeprecatedAssignee: { assignee?: undefined | string; assignees?: string[]; body?: undefined | string; labels?: string[]; milestone?: undefined | number; owner: string; repo: string; title: string }

    Type declaration

    • Optional assignee?: undefined | string

      Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

      deprecated

      "assignee" parameter has been deprecated and will be removed in future

    • Optional assignees?: string[]

      Logins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

    • Optional body?: undefined | string

      The contents of the issue.

    • Optional labels?: string[]

      Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

    • Optional milestone?: undefined | number

      The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

    • owner: string
    • repo: string
    • title: string

      The title of the issue.

    IssuesCreateResponse

    IssuesCreateResponse: { active_lock_reason: string; assignee: IssuesCreateResponseAssignee; assignees: Array<IssuesCreateResponseAssigneesItem>; body: string; closed_at: null; closed_by: IssuesCreateResponseClosedBy; comments: number; comments_url: string; created_at: string; events_url: string; html_url: string; id: number; labels: Array<IssuesCreateResponseLabelsItem>; labels_url: string; locked: boolean; milestone: IssuesCreateResponseMilestone; node_id: string; number: number; pull_request: IssuesCreateResponsePullRequest; repository_url: string; state: string; title: string; updated_at: string; url: string; user: IssuesCreateResponseUser }

    Type declaration

    IssuesCreateResponseAssignee

    IssuesCreateResponseAssignee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesCreateResponseAssigneesItem

    IssuesCreateResponseAssigneesItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesCreateResponseClosedBy

    IssuesCreateResponseClosedBy: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesCreateResponseLabelsItem

    IssuesCreateResponseLabelsItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

    Type declaration

    • color: string
    • default: boolean
    • description: string
    • id: number
    • name: string
    • node_id: string
    • url: string

    IssuesCreateResponseMilestone

    IssuesCreateResponseMilestone: { closed_at: string; closed_issues: number; created_at: string; creator: IssuesCreateResponseMilestoneCreator; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }

    Type declaration

    • closed_at: string
    • closed_issues: number
    • created_at: string
    • creator: IssuesCreateResponseMilestoneCreator
    • description: string
    • due_on: string
    • html_url: string
    • id: number
    • labels_url: string
    • node_id: string
    • number: number
    • open_issues: number
    • state: string
    • title: string
    • updated_at: string
    • url: string

    IssuesCreateResponseMilestoneCreator

    IssuesCreateResponseMilestoneCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesCreateResponsePullRequest

    IssuesCreateResponsePullRequest: { diff_url: string; html_url: string; patch_url: string; url: string }

    Type declaration

    • diff_url: string
    • html_url: string
    • patch_url: string
    • url: string

    IssuesCreateResponseUser

    IssuesCreateResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesDeleteCommentParams

    IssuesDeleteCommentParams: { comment_id: number; owner: string; repo: string }

    Type declaration

    • comment_id: number
    • owner: string
    • repo: string

    IssuesDeleteLabelParams

    IssuesDeleteLabelParams: { name: string; owner: string; repo: string }

    Type declaration

    • name: string
    • owner: string
    • repo: string

    IssuesDeleteMilestoneParams

    IssuesDeleteMilestoneParams: { milestone_number: number; owner: string; repo: string }

    Type declaration

    • milestone_number: number
    • owner: string
    • repo: string

    IssuesDeleteMilestoneParamsDeprecatedNumber

    IssuesDeleteMilestoneParamsDeprecatedNumber: { number: number; owner: string; repo: string }

    Type declaration

    • number: number
      deprecated

      "number" parameter renamed to "milestone_number"

    • owner: string
    • repo: string

    IssuesGetCommentParams

    IssuesGetCommentParams: { comment_id: number; owner: string; repo: string }

    Type declaration

    • comment_id: number
    • owner: string
    • repo: string

    IssuesGetCommentResponse

    IssuesGetCommentResponse: { body: string; created_at: string; html_url: string; id: number; node_id: string; updated_at: string; url: string; user: IssuesGetCommentResponseUser }

    Type declaration

    • body: string
    • created_at: string
    • html_url: string
    • id: number
    • node_id: string
    • updated_at: string
    • url: string
    • user: IssuesGetCommentResponseUser

    IssuesGetCommentResponseUser

    IssuesGetCommentResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesGetEventParams

    IssuesGetEventParams: { event_id: number; owner: string; repo: string }

    Type declaration

    • event_id: number
    • owner: string
    • repo: string

    IssuesGetEventResponse

    IssuesGetEventResponse: { actor: IssuesGetEventResponseActor; commit_id: string; commit_url: string; created_at: string; event: string; id: number; issue: IssuesGetEventResponseIssue; node_id: string; url: string }

    Type declaration

    IssuesGetEventResponseActor

    IssuesGetEventResponseActor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesGetEventResponseIssue

    IssuesGetEventResponseIssue: { active_lock_reason: string; assignee: IssuesGetEventResponseIssueAssignee; assignees: Array<IssuesGetEventResponseIssueAssigneesItem>; body: string; closed_at: null; comments: number; comments_url: string; created_at: string; events_url: string; html_url: string; id: number; labels: Array<IssuesGetEventResponseIssueLabelsItem>; labels_url: string; locked: boolean; milestone: IssuesGetEventResponseIssueMilestone; node_id: string; number: number; pull_request: IssuesGetEventResponseIssuePullRequest; repository_url: string; state: string; title: string; updated_at: string; url: string; user: IssuesGetEventResponseIssueUser }

    Type declaration

    IssuesGetEventResponseIssueAssignee

    IssuesGetEventResponseIssueAssignee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesGetEventResponseIssueAssigneesItem

    IssuesGetEventResponseIssueAssigneesItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesGetEventResponseIssueLabelsItem

    IssuesGetEventResponseIssueLabelsItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

    Type declaration

    • color: string
    • default: boolean
    • description: string
    • id: number
    • name: string
    • node_id: string
    • url: string

    IssuesGetEventResponseIssueMilestone

    IssuesGetEventResponseIssueMilestone: { closed_at: string; closed_issues: number; created_at: string; creator: IssuesGetEventResponseIssueMilestoneCreator; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }

    Type declaration

    • closed_at: string
    • closed_issues: number
    • created_at: string
    • creator: IssuesGetEventResponseIssueMilestoneCreator
    • description: string
    • due_on: string
    • html_url: string
    • id: number
    • labels_url: string
    • node_id: string
    • number: number
    • open_issues: number
    • state: string
    • title: string
    • updated_at: string
    • url: string

    IssuesGetEventResponseIssueMilestoneCreator

    IssuesGetEventResponseIssueMilestoneCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesGetEventResponseIssuePullRequest

    IssuesGetEventResponseIssuePullRequest: { diff_url: string; html_url: string; patch_url: string; url: string }

    Type declaration

    • diff_url: string
    • html_url: string
    • patch_url: string
    • url: string

    IssuesGetEventResponseIssueUser

    IssuesGetEventResponseIssueUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesGetLabelParams

    IssuesGetLabelParams: { name: string; owner: string; repo: string }

    Type declaration

    • name: string
    • owner: string
    • repo: string

    IssuesGetLabelResponse

    IssuesGetLabelResponse: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

    Type declaration

    • color: string
    • default: boolean
    • description: string
    • id: number
    • name: string
    • node_id: string
    • url: string

    IssuesGetMilestoneParams

    IssuesGetMilestoneParams: { milestone_number: number; owner: string; repo: string }

    Type declaration

    • milestone_number: number
    • owner: string
    • repo: string

    IssuesGetMilestoneParamsDeprecatedNumber

    IssuesGetMilestoneParamsDeprecatedNumber: { number: number; owner: string; repo: string }

    Type declaration

    • number: number
      deprecated

      "number" parameter renamed to "milestone_number"

    • owner: string
    • repo: string

    IssuesGetMilestoneResponse

    IssuesGetMilestoneResponse: { closed_at: string; closed_issues: number; created_at: string; creator: IssuesGetMilestoneResponseCreator; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }

    Type declaration

    • closed_at: string
    • closed_issues: number
    • created_at: string
    • creator: IssuesGetMilestoneResponseCreator
    • description: string
    • due_on: string
    • html_url: string
    • id: number
    • labels_url: string
    • node_id: string
    • number: number
    • open_issues: number
    • state: string
    • title: string
    • updated_at: string
    • url: string

    IssuesGetMilestoneResponseCreator

    IssuesGetMilestoneResponseCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesGetParams

    IssuesGetParams: { issue_number: number; owner: string; repo: string }

    Type declaration

    • issue_number: number
    • owner: string
    • repo: string

    IssuesGetParamsDeprecatedNumber

    IssuesGetParamsDeprecatedNumber: { number: number; owner: string; repo: string }

    Type declaration

    • number: number
      deprecated

      "number" parameter renamed to "issue_number"

    • owner: string
    • repo: string

    IssuesGetResponse

    IssuesGetResponse: { active_lock_reason: string; assignee: IssuesGetResponseAssignee; assignees: Array<IssuesGetResponseAssigneesItem>; body: string; closed_at: null; closed_by: IssuesGetResponseClosedBy; comments: number; comments_url: string; created_at: string; events_url: string; html_url: string; id: number; labels: Array<IssuesGetResponseLabelsItem>; labels_url: string; locked: boolean; milestone: IssuesGetResponseMilestone; node_id: string; number: number; pull_request: IssuesGetResponsePullRequest; repository_url: string; state: string; title: string; updated_at: string; url: string; user: IssuesGetResponseUser }

    Type declaration

    IssuesGetResponseAssignee

    IssuesGetResponseAssignee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesGetResponseAssigneesItem

    IssuesGetResponseAssigneesItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesGetResponseClosedBy

    IssuesGetResponseClosedBy: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesGetResponseLabelsItem

    IssuesGetResponseLabelsItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

    Type declaration

    • color: string
    • default: boolean
    • description: string
    • id: number
    • name: string
    • node_id: string
    • url: string

    IssuesGetResponseMilestone

    IssuesGetResponseMilestone: { closed_at: string; closed_issues: number; created_at: string; creator: IssuesGetResponseMilestoneCreator; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }

    Type declaration

    • closed_at: string
    • closed_issues: number
    • created_at: string
    • creator: IssuesGetResponseMilestoneCreator
    • description: string
    • due_on: string
    • html_url: string
    • id: number
    • labels_url: string
    • node_id: string
    • number: number
    • open_issues: number
    • state: string
    • title: string
    • updated_at: string
    • url: string

    IssuesGetResponseMilestoneCreator

    IssuesGetResponseMilestoneCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesGetResponsePullRequest

    IssuesGetResponsePullRequest: { diff_url: string; html_url: string; patch_url: string; url: string }

    Type declaration

    • diff_url: string
    • html_url: string
    • patch_url: string
    • url: string

    IssuesGetResponseUser

    IssuesGetResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesListAssigneesParams

    IssuesListAssigneesParams: { owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

    Type declaration

    • owner: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • repo: string

    IssuesListAssigneesResponse

    IssuesListAssigneesResponse: Array<IssuesListAssigneesResponseItem>

    IssuesListAssigneesResponseItem

    IssuesListAssigneesResponseItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesListCommentsForRepoParams

    IssuesListCommentsForRepoParams: { direction?: "asc" | "desc"; owner: string; repo: string; since?: undefined | string; sort?: "created" | "updated" }

    Type declaration

    • Optional direction?: "asc" | "desc"

      Either asc or desc. Ignored without the sort parameter.

    • owner: string
    • repo: string
    • Optional since?: undefined | string

      Only comments updated at or after this time are returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    • Optional sort?: "created" | "updated"

      Either created or updated.

    IssuesListCommentsForRepoResponse

    IssuesListCommentsForRepoResponse: Array<IssuesListCommentsForRepoResponseItem>

    IssuesListCommentsForRepoResponseItem

    IssuesListCommentsForRepoResponseItem: { body: string; created_at: string; html_url: string; id: number; node_id: string; updated_at: string; url: string; user: IssuesListCommentsForRepoResponseItemUser }

    Type declaration

    IssuesListCommentsForRepoResponseItemUser

    IssuesListCommentsForRepoResponseItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesListCommentsParams

    IssuesListCommentsParams: { issue_number: number; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string; since?: undefined | string }

    Type declaration

    • issue_number: number
    • owner: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • repo: string
    • Optional since?: undefined | string

      Only comments updated at or after this time are returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    IssuesListCommentsParamsDeprecatedNumber

    IssuesListCommentsParamsDeprecatedNumber: { number: number; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string; since?: undefined | string }

    Type declaration

    • number: number
      deprecated

      "number" parameter renamed to "issue_number"

    • owner: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • repo: string
    • Optional since?: undefined | string

      Only comments updated at or after this time are returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    IssuesListCommentsResponse

    IssuesListCommentsResponse: Array<IssuesListCommentsResponseItem>

    IssuesListCommentsResponseItem

    IssuesListCommentsResponseItem: { body: string; created_at: string; html_url: string; id: number; node_id: string; updated_at: string; url: string; user: IssuesListCommentsResponseItemUser }

    Type declaration

    IssuesListCommentsResponseItemUser

    IssuesListCommentsResponseItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesListEventsForRepoParams

    IssuesListEventsForRepoParams: { owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

    Type declaration

    • owner: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • repo: string

    IssuesListEventsForRepoResponse

    IssuesListEventsForRepoResponse: Array<IssuesListEventsForRepoResponseItem>

    IssuesListEventsForRepoResponseItem

    IssuesListEventsForRepoResponseItem: { actor: IssuesListEventsForRepoResponseItemActor; commit_id: string; commit_url: string; created_at: string; event: string; id: number; issue: IssuesListEventsForRepoResponseItemIssue; node_id: string; url: string }

    Type declaration

    IssuesListEventsForRepoResponseItemActor

    IssuesListEventsForRepoResponseItemActor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesListEventsForRepoResponseItemIssue

    IssuesListEventsForRepoResponseItemIssue: { active_lock_reason: string; assignee: IssuesListEventsForRepoResponseItemIssueAssignee; assignees: Array<IssuesListEventsForRepoResponseItemIssueAssigneesItem>; body: string; closed_at: null; comments: number; comments_url: string; created_at: string; events_url: string; html_url: string; id: number; labels: Array<IssuesListEventsForRepoResponseItemIssueLabelsItem>; labels_url: string; locked: boolean; milestone: IssuesListEventsForRepoResponseItemIssueMilestone; node_id: string; number: number; pull_request: IssuesListEventsForRepoResponseItemIssuePullRequest; repository_url: string; state: string; title: string; updated_at: string; url: string; user: IssuesListEventsForRepoResponseItemIssueUser }

    Type declaration

    IssuesListEventsForRepoResponseItemIssueAssignee

    IssuesListEventsForRepoResponseItemIssueAssignee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesListEventsForRepoResponseItemIssueAssigneesItem

    IssuesListEventsForRepoResponseItemIssueAssigneesItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesListEventsForRepoResponseItemIssueLabelsItem

    IssuesListEventsForRepoResponseItemIssueLabelsItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

    Type declaration

    • color: string
    • default: boolean
    • description: string
    • id: number
    • name: string
    • node_id: string
    • url: string

    IssuesListEventsForRepoResponseItemIssueMilestone

    IssuesListEventsForRepoResponseItemIssueMilestone: { closed_at: string; closed_issues: number; created_at: string; creator: IssuesListEventsForRepoResponseItemIssueMilestoneCreator; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }

    Type declaration

    • closed_at: string
    • closed_issues: number
    • created_at: string
    • creator: IssuesListEventsForRepoResponseItemIssueMilestoneCreator
    • description: string
    • due_on: string
    • html_url: string
    • id: number
    • labels_url: string
    • node_id: string
    • number: number
    • open_issues: number
    • state: string
    • title: string
    • updated_at: string
    • url: string

    IssuesListEventsForRepoResponseItemIssueMilestoneCreator

    IssuesListEventsForRepoResponseItemIssueMilestoneCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesListEventsForRepoResponseItemIssuePullRequest

    IssuesListEventsForRepoResponseItemIssuePullRequest: { diff_url: string; html_url: string; patch_url: string; url: string }

    Type declaration

    • diff_url: string
    • html_url: string
    • patch_url: string
    • url: string

    IssuesListEventsForRepoResponseItemIssueUser

    IssuesListEventsForRepoResponseItemIssueUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesListEventsForTimelineParams

    IssuesListEventsForTimelineParams: { issue_number: number; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

    Type declaration

    • issue_number: number
    • owner: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • repo: string

    IssuesListEventsForTimelineParamsDeprecatedNumber

    IssuesListEventsForTimelineParamsDeprecatedNumber: { number: number; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

    Type declaration

    • number: number
      deprecated

      "number" parameter renamed to "issue_number"

    • owner: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • repo: string

    IssuesListEventsForTimelineResponse

    IssuesListEventsForTimelineResponse: Array<IssuesListEventsForTimelineResponseItem>

    IssuesListEventsForTimelineResponseItem

    IssuesListEventsForTimelineResponseItem: { actor: IssuesListEventsForTimelineResponseItemActor; commit_id: string; commit_url: string; created_at: string; event: string; id: number; node_id: string; url: string }

    Type declaration

    IssuesListEventsForTimelineResponseItemActor

    IssuesListEventsForTimelineResponseItemActor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesListEventsParams

    IssuesListEventsParams: { issue_number: number; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

    Type declaration

    • issue_number: number
    • owner: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • repo: string

    IssuesListEventsParamsDeprecatedNumber

    IssuesListEventsParamsDeprecatedNumber: { number: number; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

    Type declaration

    • number: number
      deprecated

      "number" parameter renamed to "issue_number"

    • owner: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • repo: string

    IssuesListEventsResponse

    IssuesListEventsResponse: Array<IssuesListEventsResponseItem>

    IssuesListEventsResponseItem

    IssuesListEventsResponseItem: { actor: IssuesListEventsResponseItemActor; commit_id: string; commit_url: string; created_at: string; event: string; id: number; node_id: string; url: string }

    Type declaration

    IssuesListEventsResponseItemActor

    IssuesListEventsResponseItemActor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesListForAuthenticatedUserParams

    IssuesListForAuthenticatedUserParams: { direction?: "asc" | "desc"; filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"; labels?: undefined | string; page?: undefined | number; per_page?: undefined | number; since?: undefined | string; sort?: "created" | "updated" | "comments"; state?: "open" | "closed" | "all" }

    Type declaration

    • Optional direction?: "asc" | "desc"

      The direction of the sort. Can be either asc or desc.

    • Optional filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"

      Indicates which sorts of issues to return. Can be one of: * assigned: Issues assigned to you * created: Issues created by you * mentioned: Issues mentioning you * subscribed: Issues you're subscribed to updates for * all: All issues the authenticated user can see, regardless of participation or creation

    • Optional labels?: undefined | string

      A list of comma separated label names. Example: bug,ui,@high

    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • Optional since?: undefined | string

      Only issues updated at or after this time are returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    • Optional sort?: "created" | "updated" | "comments"

      What to sort results by. Can be either created, updated, comments.

    • Optional state?: "open" | "closed" | "all"

      Indicates the state of the issues to return. Can be either open, closed, or all.

    IssuesListForAuthenticatedUserResponse

    IssuesListForAuthenticatedUserResponse: Array<IssuesListForAuthenticatedUserResponseItem>

    IssuesListForAuthenticatedUserResponseItem

    IssuesListForAuthenticatedUserResponseItem: { active_lock_reason: string; assignee: IssuesListForAuthenticatedUserResponseItemAssignee; assignees: Array<IssuesListForAuthenticatedUserResponseItemAssigneesItem>; body: string; closed_at: null; comments: number; comments_url: string; created_at: string; events_url: string; html_url: string; id: number; labels: Array<IssuesListForAuthenticatedUserResponseItemLabelsItem>; labels_url: string; locked: boolean; milestone: IssuesListForAuthenticatedUserResponseItemMilestone; node_id: string; number: number; pull_request: IssuesListForAuthenticatedUserResponseItemPullRequest; repository: IssuesListForAuthenticatedUserResponseItemRepository; repository_url: string; state: string; title: string; updated_at: string; url: string; user: IssuesListForAuthenticatedUserResponseItemUser }

    Type declaration

    IssuesListForAuthenticatedUserResponseItemAssignee

    IssuesListForAuthenticatedUserResponseItemAssignee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesListForAuthenticatedUserResponseItemAssigneesItem

    IssuesListForAuthenticatedUserResponseItemAssigneesItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesListForAuthenticatedUserResponseItemLabelsItem

    IssuesListForAuthenticatedUserResponseItemLabelsItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

    Type declaration

    • color: string
    • default: boolean
    • description: string
    • id: number
    • name: string
    • node_id: string
    • url: string

    IssuesListForAuthenticatedUserResponseItemMilestone

    IssuesListForAuthenticatedUserResponseItemMilestone: { closed_at: string; closed_issues: number; created_at: string; creator: IssuesListForAuthenticatedUserResponseItemMilestoneCreator; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }

    Type declaration

    • closed_at: string
    • closed_issues: number
    • created_at: string
    • creator: IssuesListForAuthenticatedUserResponseItemMilestoneCreator
    • description: string
    • due_on: string
    • html_url: string
    • id: number
    • labels_url: string
    • node_id: string
    • number: number
    • open_issues: number
    • state: string
    • title: string
    • updated_at: string
    • url: string

    IssuesListForAuthenticatedUserResponseItemMilestoneCreator

    IssuesListForAuthenticatedUserResponseItemMilestoneCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesListForAuthenticatedUserResponseItemPullRequest

    IssuesListForAuthenticatedUserResponseItemPullRequest: { diff_url: string; html_url: string; patch_url: string; url: string }

    Type declaration

    • diff_url: string
    • html_url: string
    • patch_url: string
    • url: string

    IssuesListForAuthenticatedUserResponseItemRepository

    IssuesListForAuthenticatedUserResponseItemRepository: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: IssuesListForAuthenticatedUserResponseItemRepositoryOwner; permissions: IssuesListForAuthenticatedUserResponseItemRepositoryPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

    Type declaration

    • allow_merge_commit: boolean
    • allow_rebase_merge: boolean
    • allow_squash_merge: boolean
    • archive_url: string
    • archived: boolean
    • assignees_url: string
    • blobs_url: string
    • branches_url: string
    • clone_url: string
    • collaborators_url: string
    • comments_url: string
    • commits_url: string
    • compare_url: string
    • contents_url: string
    • contributors_url: string
    • created_at: string
    • default_branch: string
    • deployments_url: string
    • description: string
    • disabled: boolean
    • downloads_url: string
    • events_url: string
    • fork: boolean
    • forks_count: number
    • forks_url: string
    • full_name: string
    • git_commits_url: string
    • git_refs_url: string
    • git_tags_url: string
    • git_url: string
    • has_downloads: boolean
    • has_issues: boolean
    • has_pages: boolean
    • has_projects: boolean
    • has_wiki: boolean
    • homepage: string
    • hooks_url: string
    • html_url: string
    • id: number
    • is_template: boolean
    • issue_comment_url: string
    • issue_events_url: string
    • issues_url: string
    • keys_url: string
    • labels_url: string
    • language: null
    • languages_url: string
    • merges_url: string
    • milestones_url: string
    • mirror_url: string
    • name: string
    • network_count: number
    • node_id: string
    • notifications_url: string
    • open_issues_count: number
    • owner: IssuesListForAuthenticatedUserResponseItemRepositoryOwner
    • permissions: IssuesListForAuthenticatedUserResponseItemRepositoryPermissions
    • private: boolean
    • pulls_url: string
    • pushed_at: string
    • releases_url: string
    • size: number
    • ssh_url: string
    • stargazers_count: number
    • stargazers_url: string
    • statuses_url: string
    • subscribers_count: number
    • subscribers_url: string
    • subscription_url: string
    • svn_url: string
    • tags_url: string
    • teams_url: string
    • temp_clone_token: string
    • template_repository: null
    • topics: Array<string>
    • trees_url: string
    • updated_at: string
    • url: string
    • visibility: string
    • watchers_count: number

    IssuesListForAuthenticatedUserResponseItemRepositoryOwner

    IssuesListForAuthenticatedUserResponseItemRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesListForAuthenticatedUserResponseItemRepositoryPermissions

    IssuesListForAuthenticatedUserResponseItemRepositoryPermissions: { admin: boolean; pull: boolean; push: boolean }

    Type declaration

    • admin: boolean
    • pull: boolean
    • push: boolean

    IssuesListForAuthenticatedUserResponseItemUser

    IssuesListForAuthenticatedUserResponseItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesListForOrgParams

    IssuesListForOrgParams: { direction?: "asc" | "desc"; filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"; labels?: undefined | string; org: string; page?: undefined | number; per_page?: undefined | number; since?: undefined | string; sort?: "created" | "updated" | "comments"; state?: "open" | "closed" | "all" }

    Type declaration

    • Optional direction?: "asc" | "desc"

      The direction of the sort. Can be either asc or desc.

    • Optional filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"

      Indicates which sorts of issues to return. Can be one of: * assigned: Issues assigned to you * created: Issues created by you * mentioned: Issues mentioning you * subscribed: Issues you're subscribed to updates for * all: All issues the authenticated user can see, regardless of participation or creation

    • Optional labels?: undefined | string

      A list of comma separated label names. Example: bug,ui,@high

    • org: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • Optional since?: undefined | string

      Only issues updated at or after this time are returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    • Optional sort?: "created" | "updated" | "comments"

      What to sort results by. Can be either created, updated, comments.

    • Optional state?: "open" | "closed" | "all"

      Indicates the state of the issues to return. Can be either open, closed, or all.

    IssuesListForOrgResponse

    IssuesListForOrgResponse: Array<IssuesListForOrgResponseItem>

    IssuesListForOrgResponseItem

    IssuesListForOrgResponseItem: { active_lock_reason: string; assignee: IssuesListForOrgResponseItemAssignee; assignees: Array<IssuesListForOrgResponseItemAssigneesItem>; body: string; closed_at: null; comments: number; comments_url: string; created_at: string; events_url: string; html_url: string; id: number; labels: Array<IssuesListForOrgResponseItemLabelsItem>; labels_url: string; locked: boolean; milestone: IssuesListForOrgResponseItemMilestone; node_id: string; number: number; pull_request: IssuesListForOrgResponseItemPullRequest; repository: IssuesListForOrgResponseItemRepository; repository_url: string; state: string; title: string; updated_at: string; url: string; user: IssuesListForOrgResponseItemUser }

    Type declaration

    IssuesListForOrgResponseItemAssignee

    IssuesListForOrgResponseItemAssignee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesListForOrgResponseItemAssigneesItem

    IssuesListForOrgResponseItemAssigneesItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesListForOrgResponseItemLabelsItem

    IssuesListForOrgResponseItemLabelsItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

    Type declaration

    • color: string
    • default: boolean
    • description: string
    • id: number
    • name: string
    • node_id: string
    • url: string

    IssuesListForOrgResponseItemMilestone

    IssuesListForOrgResponseItemMilestone: { closed_at: string; closed_issues: number; created_at: string; creator: IssuesListForOrgResponseItemMilestoneCreator; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }

    Type declaration

    • closed_at: string
    • closed_issues: number
    • created_at: string
    • creator: IssuesListForOrgResponseItemMilestoneCreator
    • description: string
    • due_on: string
    • html_url: string
    • id: number
    • labels_url: string
    • node_id: string
    • number: number
    • open_issues: number
    • state: string
    • title: string
    • updated_at: string
    • url: string

    IssuesListForOrgResponseItemMilestoneCreator

    IssuesListForOrgResponseItemMilestoneCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesListForOrgResponseItemPullRequest

    IssuesListForOrgResponseItemPullRequest: { diff_url: string; html_url: string; patch_url: string; url: string }

    Type declaration

    • diff_url: string
    • html_url: string
    • patch_url: string
    • url: string

    IssuesListForOrgResponseItemRepository

    IssuesListForOrgResponseItemRepository: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: IssuesListForOrgResponseItemRepositoryOwner; permissions: IssuesListForOrgResponseItemRepositoryPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

    Type declaration

    • allow_merge_commit: boolean
    • allow_rebase_merge: boolean
    • allow_squash_merge: boolean
    • archive_url: string
    • archived: boolean
    • assignees_url: string
    • blobs_url: string
    • branches_url: string
    • clone_url: string
    • collaborators_url: string
    • comments_url: string
    • commits_url: string
    • compare_url: string
    • contents_url: string
    • contributors_url: string
    • created_at: string
    • default_branch: string
    • deployments_url: string
    • description: string
    • disabled: boolean
    • downloads_url: string
    • events_url: string
    • fork: boolean
    • forks_count: number
    • forks_url: string
    • full_name: string
    • git_commits_url: string
    • git_refs_url: string
    • git_tags_url: string
    • git_url: string
    • has_downloads: boolean
    • has_issues: boolean
    • has_pages: boolean
    • has_projects: boolean
    • has_wiki: boolean
    • homepage: string
    • hooks_url: string
    • html_url: string
    • id: number
    • is_template: boolean
    • issue_comment_url: string
    • issue_events_url: string
    • issues_url: string
    • keys_url: string
    • labels_url: string
    • language: null
    • languages_url: string
    • merges_url: string
    • milestones_url: string
    • mirror_url: string
    • name: string
    • network_count: number
    • node_id: string
    • notifications_url: string
    • open_issues_count: number
    • owner: IssuesListForOrgResponseItemRepositoryOwner
    • permissions: IssuesListForOrgResponseItemRepositoryPermissions
    • private: boolean
    • pulls_url: string
    • pushed_at: string
    • releases_url: string
    • size: number
    • ssh_url: string
    • stargazers_count: number
    • stargazers_url: string
    • statuses_url: string
    • subscribers_count: number
    • subscribers_url: string
    • subscription_url: string
    • svn_url: string
    • tags_url: string
    • teams_url: string
    • temp_clone_token: string
    • template_repository: null
    • topics: Array<string>
    • trees_url: string
    • updated_at: string
    • url: string
    • visibility: string
    • watchers_count: number

    IssuesListForOrgResponseItemRepositoryOwner

    IssuesListForOrgResponseItemRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesListForOrgResponseItemRepositoryPermissions

    IssuesListForOrgResponseItemRepositoryPermissions: { admin: boolean; pull: boolean; push: boolean }

    Type declaration

    • admin: boolean
    • pull: boolean
    • push: boolean

    IssuesListForOrgResponseItemUser

    IssuesListForOrgResponseItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesListForRepoParams

    IssuesListForRepoParams: { assignee?: undefined | string; creator?: undefined | string; direction?: "asc" | "desc"; labels?: undefined | string; mentioned?: undefined | string; milestone?: undefined | string; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string; since?: undefined | string; sort?: "created" | "updated" | "comments"; state?: "open" | "closed" | "all" }

    Type declaration

    • Optional assignee?: undefined | string

      Can be the name of a user. Pass in none for issues with no assigned user, and * for issues assigned to any user.

    • Optional creator?: undefined | string

      The user that created the issue.

    • Optional direction?: "asc" | "desc"

      The direction of the sort. Can be either asc or desc.

    • Optional labels?: undefined | string

      A list of comma separated label names. Example: bug,ui,@high

    • Optional mentioned?: undefined | string

      A user that's mentioned in the issue.

    • Optional milestone?: undefined | string

      If an integer is passed, it should refer to a milestone by its number field. If the string * is passed, issues with any milestone are accepted. If the string none is passed, issues without milestones are returned.

    • owner: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • repo: string
    • Optional since?: undefined | string

      Only issues updated at or after this time are returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    • Optional sort?: "created" | "updated" | "comments"

      What to sort results by. Can be either created, updated, comments.

    • Optional state?: "open" | "closed" | "all"

      Indicates the state of the issues to return. Can be either open, closed, or all.

    IssuesListForRepoResponse

    IssuesListForRepoResponse: Array<IssuesListForRepoResponseItem>

    IssuesListForRepoResponseItem

    IssuesListForRepoResponseItem: { active_lock_reason: string; assignee: IssuesListForRepoResponseItemAssignee; assignees: Array<IssuesListForRepoResponseItemAssigneesItem>; body: string; closed_at: null; comments: number; comments_url: string; created_at: string; events_url: string; html_url: string; id: number; labels: Array<IssuesListForRepoResponseItemLabelsItem>; labels_url: string; locked: boolean; milestone: IssuesListForRepoResponseItemMilestone; node_id: string; number: number; pull_request: IssuesListForRepoResponseItemPullRequest; repository_url: string; state: string; title: string; updated_at: string; url: string; user: IssuesListForRepoResponseItemUser }

    Type declaration

    IssuesListForRepoResponseItemAssignee

    IssuesListForRepoResponseItemAssignee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesListForRepoResponseItemAssigneesItem

    IssuesListForRepoResponseItemAssigneesItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesListForRepoResponseItemLabelsItem

    IssuesListForRepoResponseItemLabelsItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

    Type declaration

    • color: string
    • default: boolean
    • description: string
    • id: number
    • name: string
    • node_id: string
    • url: string

    IssuesListForRepoResponseItemMilestone

    IssuesListForRepoResponseItemMilestone: { closed_at: string; closed_issues: number; created_at: string; creator: IssuesListForRepoResponseItemMilestoneCreator; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }

    Type declaration

    • closed_at: string
    • closed_issues: number
    • created_at: string
    • creator: IssuesListForRepoResponseItemMilestoneCreator
    • description: string
    • due_on: string
    • html_url: string
    • id: number
    • labels_url: string
    • node_id: string
    • number: number
    • open_issues: number
    • state: string
    • title: string
    • updated_at: string
    • url: string

    IssuesListForRepoResponseItemMilestoneCreator

    IssuesListForRepoResponseItemMilestoneCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesListForRepoResponseItemPullRequest

    IssuesListForRepoResponseItemPullRequest: { diff_url: string; html_url: string; patch_url: string; url: string }

    Type declaration

    • diff_url: string
    • html_url: string
    • patch_url: string
    • url: string

    IssuesListForRepoResponseItemUser

    IssuesListForRepoResponseItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesListLabelsForMilestoneParams

    IssuesListLabelsForMilestoneParams: { milestone_number: number; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

    Type declaration

    • milestone_number: number
    • owner: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • repo: string

    IssuesListLabelsForMilestoneParamsDeprecatedNumber

    IssuesListLabelsForMilestoneParamsDeprecatedNumber: { number: number; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

    Type declaration

    • number: number
      deprecated

      "number" parameter renamed to "milestone_number"

    • owner: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • repo: string

    IssuesListLabelsForMilestoneResponse

    IssuesListLabelsForMilestoneResponse: Array<IssuesListLabelsForMilestoneResponseItem>

    IssuesListLabelsForMilestoneResponseItem

    IssuesListLabelsForMilestoneResponseItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

    Type declaration

    • color: string
    • default: boolean
    • description: string
    • id: number
    • name: string
    • node_id: string
    • url: string

    IssuesListLabelsForRepoParams

    IssuesListLabelsForRepoParams: { owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

    Type declaration

    • owner: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • repo: string

    IssuesListLabelsForRepoResponse

    IssuesListLabelsForRepoResponse: Array<IssuesListLabelsForRepoResponseItem>

    IssuesListLabelsForRepoResponseItem

    IssuesListLabelsForRepoResponseItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

    Type declaration

    • color: string
    • default: boolean
    • description: string
    • id: number
    • name: string
    • node_id: string
    • url: string

    IssuesListLabelsOnIssueParams

    IssuesListLabelsOnIssueParams: { issue_number: number; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

    Type declaration

    • issue_number: number
    • owner: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • repo: string

    IssuesListLabelsOnIssueParamsDeprecatedNumber

    IssuesListLabelsOnIssueParamsDeprecatedNumber: { number: number; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

    Type declaration

    • number: number
      deprecated

      "number" parameter renamed to "issue_number"

    • owner: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • repo: string

    IssuesListLabelsOnIssueResponse

    IssuesListLabelsOnIssueResponse: Array<IssuesListLabelsOnIssueResponseItem>

    IssuesListLabelsOnIssueResponseItem

    IssuesListLabelsOnIssueResponseItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

    Type declaration

    • color: string
    • default: boolean
    • description: string
    • id: number
    • name: string
    • node_id: string
    • url: string

    IssuesListMilestonesForRepoParams

    IssuesListMilestonesForRepoParams: { direction?: "asc" | "desc"; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string; sort?: "due_on" | "completeness"; state?: "open" | "closed" | "all" }

    Type declaration

    • Optional direction?: "asc" | "desc"

      The direction of the sort. Either asc or desc.

    • owner: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • repo: string
    • Optional sort?: "due_on" | "completeness"

      What to sort results by. Either due_on or completeness.

    • Optional state?: "open" | "closed" | "all"

      The state of the milestone. Either open, closed, or all.

    IssuesListMilestonesForRepoResponse

    IssuesListMilestonesForRepoResponse: Array<IssuesListMilestonesForRepoResponseItem>

    IssuesListMilestonesForRepoResponseItem

    IssuesListMilestonesForRepoResponseItem: { closed_at: string; closed_issues: number; created_at: string; creator: IssuesListMilestonesForRepoResponseItemCreator; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }

    Type declaration

    • closed_at: string
    • closed_issues: number
    • created_at: string
    • creator: IssuesListMilestonesForRepoResponseItemCreator
    • description: string
    • due_on: string
    • html_url: string
    • id: number
    • labels_url: string
    • node_id: string
    • number: number
    • open_issues: number
    • state: string
    • title: string
    • updated_at: string
    • url: string

    IssuesListMilestonesForRepoResponseItemCreator

    IssuesListMilestonesForRepoResponseItemCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesListParams

    IssuesListParams: { direction?: "asc" | "desc"; filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"; labels?: undefined | string; page?: undefined | number; per_page?: undefined | number; since?: undefined | string; sort?: "created" | "updated" | "comments"; state?: "open" | "closed" | "all" }

    Type declaration

    • Optional direction?: "asc" | "desc"

      The direction of the sort. Can be either asc or desc.

    • Optional filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"

      Indicates which sorts of issues to return. Can be one of: * assigned: Issues assigned to you * created: Issues created by you * mentioned: Issues mentioning you * subscribed: Issues you're subscribed to updates for * all: All issues the authenticated user can see, regardless of participation or creation

    • Optional labels?: undefined | string

      A list of comma separated label names. Example: bug,ui,@high

    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • Optional since?: undefined | string

      Only issues updated at or after this time are returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    • Optional sort?: "created" | "updated" | "comments"

      What to sort results by. Can be either created, updated, comments.

    • Optional state?: "open" | "closed" | "all"

      Indicates the state of the issues to return. Can be either open, closed, or all.

    IssuesListResponse

    IssuesListResponse: Array<IssuesListResponseItem>

    IssuesListResponseItem

    IssuesListResponseItem: { active_lock_reason: string; assignee: IssuesListResponseItemAssignee; assignees: Array<IssuesListResponseItemAssigneesItem>; body: string; closed_at: null; comments: number; comments_url: string; created_at: string; events_url: string; html_url: string; id: number; labels: Array<IssuesListResponseItemLabelsItem>; labels_url: string; locked: boolean; milestone: IssuesListResponseItemMilestone; node_id: string; number: number; pull_request: IssuesListResponseItemPullRequest; repository: IssuesListResponseItemRepository; repository_url: string; state: string; title: string; updated_at: string; url: string; user: IssuesListResponseItemUser }

    Type declaration

    IssuesListResponseItemAssignee

    IssuesListResponseItemAssignee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesListResponseItemAssigneesItem

    IssuesListResponseItemAssigneesItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesListResponseItemLabelsItem

    IssuesListResponseItemLabelsItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

    Type declaration

    • color: string
    • default: boolean
    • description: string
    • id: number
    • name: string
    • node_id: string
    • url: string

    IssuesListResponseItemMilestone

    IssuesListResponseItemMilestone: { closed_at: string; closed_issues: number; created_at: string; creator: IssuesListResponseItemMilestoneCreator; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }

    Type declaration

    • closed_at: string
    • closed_issues: number
    • created_at: string
    • creator: IssuesListResponseItemMilestoneCreator
    • description: string
    • due_on: string
    • html_url: string
    • id: number
    • labels_url: string
    • node_id: string
    • number: number
    • open_issues: number
    • state: string
    • title: string
    • updated_at: string
    • url: string

    IssuesListResponseItemMilestoneCreator

    IssuesListResponseItemMilestoneCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesListResponseItemPullRequest

    IssuesListResponseItemPullRequest: { diff_url: string; html_url: string; patch_url: string; url: string }

    Type declaration

    • diff_url: string
    • html_url: string
    • patch_url: string
    • url: string

    IssuesListResponseItemRepository

    IssuesListResponseItemRepository: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: IssuesListResponseItemRepositoryOwner; permissions: IssuesListResponseItemRepositoryPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

    Type declaration

    • allow_merge_commit: boolean
    • allow_rebase_merge: boolean
    • allow_squash_merge: boolean
    • archive_url: string
    • archived: boolean
    • assignees_url: string
    • blobs_url: string
    • branches_url: string
    • clone_url: string
    • collaborators_url: string
    • comments_url: string
    • commits_url: string
    • compare_url: string
    • contents_url: string
    • contributors_url: string
    • created_at: string
    • default_branch: string
    • deployments_url: string
    • description: string
    • disabled: boolean
    • downloads_url: string
    • events_url: string
    • fork: boolean
    • forks_count: number
    • forks_url: string
    • full_name: string
    • git_commits_url: string
    • git_refs_url: string
    • git_tags_url: string
    • git_url: string
    • has_downloads: boolean
    • has_issues: boolean
    • has_pages: boolean
    • has_projects: boolean
    • has_wiki: boolean
    • homepage: string
    • hooks_url: string
    • html_url: string
    • id: number
    • is_template: boolean
    • issue_comment_url: string
    • issue_events_url: string
    • issues_url: string
    • keys_url: string
    • labels_url: string
    • language: null
    • languages_url: string
    • merges_url: string
    • milestones_url: string
    • mirror_url: string
    • name: string
    • network_count: number
    • node_id: string
    • notifications_url: string
    • open_issues_count: number
    • owner: IssuesListResponseItemRepositoryOwner
    • permissions: IssuesListResponseItemRepositoryPermissions
    • private: boolean
    • pulls_url: string
    • pushed_at: string
    • releases_url: string
    • size: number
    • ssh_url: string
    • stargazers_count: number
    • stargazers_url: string
    • statuses_url: string
    • subscribers_count: number
    • subscribers_url: string
    • subscription_url: string
    • svn_url: string
    • tags_url: string
    • teams_url: string
    • temp_clone_token: string
    • template_repository: null
    • topics: Array<string>
    • trees_url: string
    • updated_at: string
    • url: string
    • visibility: string
    • watchers_count: number

    IssuesListResponseItemRepositoryOwner

    IssuesListResponseItemRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesListResponseItemRepositoryPermissions

    IssuesListResponseItemRepositoryPermissions: { admin: boolean; pull: boolean; push: boolean }

    Type declaration

    • admin: boolean
    • pull: boolean
    • push: boolean

    IssuesListResponseItemUser

    IssuesListResponseItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesLockParams

    IssuesLockParams: { issue_number: number; lock_reason?: "off-topic" | "too heated" | "resolved" | "spam"; owner: string; repo: string }

    Type declaration

    • issue_number: number
    • Optional lock_reason?: "off-topic" | "too heated" | "resolved" | "spam"

      The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: * off-topic * too heated * resolved * spam

    • owner: string
    • repo: string

    IssuesLockParamsDeprecatedNumber

    IssuesLockParamsDeprecatedNumber: { lock_reason?: "off-topic" | "too heated" | "resolved" | "spam"; number: number; owner: string; repo: string }

    Type declaration

    • Optional lock_reason?: "off-topic" | "too heated" | "resolved" | "spam"

      The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: * off-topic * too heated * resolved * spam

    • number: number
      deprecated

      "number" parameter renamed to "issue_number"

    • owner: string
    • repo: string

    IssuesRemoveAssigneesParams

    IssuesRemoveAssigneesParams: { assignees?: string[]; issue_number: number; owner: string; repo: string }

    Type declaration

    • Optional assignees?: string[]

      Usernames of assignees to remove from an issue. NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise.

    • issue_number: number
    • owner: string
    • repo: string

    IssuesRemoveAssigneesParamsDeprecatedNumber

    IssuesRemoveAssigneesParamsDeprecatedNumber: { assignees?: string[]; number: number; owner: string; repo: string }

    Type declaration

    • Optional assignees?: string[]

      Usernames of assignees to remove from an issue. NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise.

    • number: number
      deprecated

      "number" parameter renamed to "issue_number"

    • owner: string
    • repo: string

    IssuesRemoveAssigneesResponse

    IssuesRemoveAssigneesResponse: { active_lock_reason: string; assignee: IssuesRemoveAssigneesResponseAssignee; assignees: Array<IssuesRemoveAssigneesResponseAssigneesItem>; body: string; closed_at: null; comments: number; comments_url: string; created_at: string; events_url: string; html_url: string; id: number; labels: Array<IssuesRemoveAssigneesResponseLabelsItem>; labels_url: string; locked: boolean; milestone: IssuesRemoveAssigneesResponseMilestone; node_id: string; number: number; pull_request: IssuesRemoveAssigneesResponsePullRequest; repository_url: string; state: string; title: string; updated_at: string; url: string; user: IssuesRemoveAssigneesResponseUser }

    Type declaration

    IssuesRemoveAssigneesResponseAssignee

    IssuesRemoveAssigneesResponseAssignee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesRemoveAssigneesResponseAssigneesItem

    IssuesRemoveAssigneesResponseAssigneesItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesRemoveAssigneesResponseLabelsItem

    IssuesRemoveAssigneesResponseLabelsItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

    Type declaration

    • color: string
    • default: boolean
    • description: string
    • id: number
    • name: string
    • node_id: string
    • url: string

    IssuesRemoveAssigneesResponseMilestone

    IssuesRemoveAssigneesResponseMilestone: { closed_at: string; closed_issues: number; created_at: string; creator: IssuesRemoveAssigneesResponseMilestoneCreator; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }

    Type declaration

    • closed_at: string
    • closed_issues: number
    • created_at: string
    • creator: IssuesRemoveAssigneesResponseMilestoneCreator
    • description: string
    • due_on: string
    • html_url: string
    • id: number
    • labels_url: string
    • node_id: string
    • number: number
    • open_issues: number
    • state: string
    • title: string
    • updated_at: string
    • url: string

    IssuesRemoveAssigneesResponseMilestoneCreator

    IssuesRemoveAssigneesResponseMilestoneCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesRemoveAssigneesResponsePullRequest

    IssuesRemoveAssigneesResponsePullRequest: { diff_url: string; html_url: string; patch_url: string; url: string }

    Type declaration

    • diff_url: string
    • html_url: string
    • patch_url: string
    • url: string

    IssuesRemoveAssigneesResponseUser

    IssuesRemoveAssigneesResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesRemoveLabelParams

    IssuesRemoveLabelParams: { issue_number: number; name: string; owner: string; repo: string }

    Type declaration

    • issue_number: number
    • name: string
    • owner: string
    • repo: string

    IssuesRemoveLabelParamsDeprecatedNumber

    IssuesRemoveLabelParamsDeprecatedNumber: { name: string; number: number; owner: string; repo: string }

    Type declaration

    • name: string
    • number: number
      deprecated

      "number" parameter renamed to "issue_number"

    • owner: string
    • repo: string

    IssuesRemoveLabelResponse

    IssuesRemoveLabelResponse: Array<IssuesRemoveLabelResponseItem>

    IssuesRemoveLabelResponseItem

    IssuesRemoveLabelResponseItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

    Type declaration

    • color: string
    • default: boolean
    • description: string
    • id: number
    • name: string
    • node_id: string
    • url: string

    IssuesRemoveLabelsParams

    IssuesRemoveLabelsParams: { issue_number: number; owner: string; repo: string }

    Type declaration

    • issue_number: number
    • owner: string
    • repo: string

    IssuesRemoveLabelsParamsDeprecatedNumber

    IssuesRemoveLabelsParamsDeprecatedNumber: { number: number; owner: string; repo: string }

    Type declaration

    • number: number
      deprecated

      "number" parameter renamed to "issue_number"

    • owner: string
    • repo: string

    IssuesReplaceLabelsParams

    IssuesReplaceLabelsParams: { issue_number: number; labels?: string[]; owner: string; repo: string }

    Type declaration

    • issue_number: number
    • Optional labels?: string[]

      The names of the labels to add to the issue. You can pass an empty array to remove all labels. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

    • owner: string
    • repo: string

    IssuesReplaceLabelsParamsDeprecatedNumber

    IssuesReplaceLabelsParamsDeprecatedNumber: { labels?: string[]; number: number; owner: string; repo: string }

    Type declaration

    • Optional labels?: string[]

      The names of the labels to add to the issue. You can pass an empty array to remove all labels. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

    • number: number
      deprecated

      "number" parameter renamed to "issue_number"

    • owner: string
    • repo: string

    IssuesReplaceLabelsResponse

    IssuesReplaceLabelsResponse: Array<IssuesReplaceLabelsResponseItem>

    IssuesReplaceLabelsResponseItem

    IssuesReplaceLabelsResponseItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

    Type declaration

    • color: string
    • default: boolean
    • description: string
    • id: number
    • name: string
    • node_id: string
    • url: string

    IssuesUnlockParams

    IssuesUnlockParams: { issue_number: number; owner: string; repo: string }

    Type declaration

    • issue_number: number
    • owner: string
    • repo: string

    IssuesUnlockParamsDeprecatedNumber

    IssuesUnlockParamsDeprecatedNumber: { number: number; owner: string; repo: string }

    Type declaration

    • number: number
      deprecated

      "number" parameter renamed to "issue_number"

    • owner: string
    • repo: string

    IssuesUpdateCommentParams

    IssuesUpdateCommentParams: { body: string; comment_id: number; owner: string; repo: string }

    Type declaration

    • body: string

      The contents of the comment.

    • comment_id: number
    • owner: string
    • repo: string

    IssuesUpdateCommentResponse

    IssuesUpdateCommentResponse: { body: string; created_at: string; html_url: string; id: number; node_id: string; updated_at: string; url: string; user: IssuesUpdateCommentResponseUser }

    Type declaration

    IssuesUpdateCommentResponseUser

    IssuesUpdateCommentResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesUpdateLabelParams

    IssuesUpdateLabelParams: { color?: undefined | string; current_name: string; description?: undefined | string; name?: undefined | string; owner: string; repo: string }

    Type declaration

    • Optional color?: undefined | string

      The hexadecimal color code for the label, without the leading #.

    • current_name: string
    • Optional description?: undefined | string

      A short description of the label.

    • Optional name?: undefined | string

      The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji :strawberry:. For a full list of available emoji and codes, see emoji-cheat-sheet.com.

    • owner: string
    • repo: string

    IssuesUpdateLabelResponse

    IssuesUpdateLabelResponse: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

    Type declaration

    • color: string
    • default: boolean
    • description: string
    • id: number
    • name: string
    • node_id: string
    • url: string

    IssuesUpdateMilestoneParams

    IssuesUpdateMilestoneParams: { description?: undefined | string; due_on?: undefined | string; milestone_number: number; owner: string; repo: string; state?: "open" | "closed"; title?: undefined | string }

    Type declaration

    • Optional description?: undefined | string

      A description of the milestone.

    • Optional due_on?: undefined | string

      The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    • milestone_number: number
    • owner: string
    • repo: string
    • Optional state?: "open" | "closed"

      The state of the milestone. Either open or closed.

    • Optional title?: undefined | string

      The title of the milestone.

    IssuesUpdateMilestoneParamsDeprecatedNumber

    IssuesUpdateMilestoneParamsDeprecatedNumber: { description?: undefined | string; due_on?: undefined | string; number: number; owner: string; repo: string; state?: "open" | "closed"; title?: undefined | string }

    Type declaration

    • Optional description?: undefined | string

      A description of the milestone.

    • Optional due_on?: undefined | string

      The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    • number: number
      deprecated

      "number" parameter renamed to "milestone_number"

    • owner: string
    • repo: string
    • Optional state?: "open" | "closed"

      The state of the milestone. Either open or closed.

    • Optional title?: undefined | string

      The title of the milestone.

    IssuesUpdateMilestoneResponse

    IssuesUpdateMilestoneResponse: { closed_at: string; closed_issues: number; created_at: string; creator: IssuesUpdateMilestoneResponseCreator; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }

    Type declaration

    • closed_at: string
    • closed_issues: number
    • created_at: string
    • creator: IssuesUpdateMilestoneResponseCreator
    • description: string
    • due_on: string
    • html_url: string
    • id: number
    • labels_url: string
    • node_id: string
    • number: number
    • open_issues: number
    • state: string
    • title: string
    • updated_at: string
    • url: string

    IssuesUpdateMilestoneResponseCreator

    IssuesUpdateMilestoneResponseCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesUpdateParams

    IssuesUpdateParams: { assignees?: string[]; body?: undefined | string; issue_number: number; labels?: string[]; milestone?: number | null; owner: string; repo: string; state?: "open" | "closed"; title?: undefined | string }

    Type declaration

    • Optional assignees?: string[]

      Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty array ([]) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

    • Optional body?: undefined | string

      The contents of the issue.

    • issue_number: number
    • Optional labels?: string[]

      Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

    • Optional milestone?: number | null

      The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

    • owner: string
    • repo: string
    • Optional state?: "open" | "closed"

      State of the issue. Either open or closed.

    • Optional title?: undefined | string

      The title of the issue.

    IssuesUpdateParamsDeprecatedAssignee

    IssuesUpdateParamsDeprecatedAssignee: { assignee?: undefined | string; assignees?: string[]; body?: undefined | string; issue_number: number; labels?: string[]; milestone?: number | null; owner: string; repo: string; state?: "open" | "closed"; title?: undefined | string }

    Type declaration

    • Optional assignee?: undefined | string

      Login for the user that this issue should be assigned to. This field is deprecated.

      deprecated

      "assignee" parameter has been deprecated and will be removed in future

    • Optional assignees?: string[]

      Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty array ([]) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

    • Optional body?: undefined | string

      The contents of the issue.

    • issue_number: number
    • Optional labels?: string[]

      Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

    • Optional milestone?: number | null

      The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

    • owner: string
    • repo: string
    • Optional state?: "open" | "closed"

      State of the issue. Either open or closed.

    • Optional title?: undefined | string

      The title of the issue.

    IssuesUpdateParamsDeprecatedNumber

    IssuesUpdateParamsDeprecatedNumber: { assignees?: string[]; body?: undefined | string; labels?: string[]; milestone?: number | null; number: number; owner: string; repo: string; state?: "open" | "closed"; title?: undefined | string }

    Type declaration

    • Optional assignees?: string[]

      Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty array ([]) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

    • Optional body?: undefined | string

      The contents of the issue.

    • Optional labels?: string[]

      Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

    • Optional milestone?: number | null

      The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

    • number: number
      deprecated

      "number" parameter renamed to "issue_number"

    • owner: string
    • repo: string
    • Optional state?: "open" | "closed"

      State of the issue. Either open or closed.

    • Optional title?: undefined | string

      The title of the issue.

    IssuesUpdateResponse

    IssuesUpdateResponse: { active_lock_reason: string; assignee: IssuesUpdateResponseAssignee; assignees: Array<IssuesUpdateResponseAssigneesItem>; body: string; closed_at: null; closed_by: IssuesUpdateResponseClosedBy; comments: number; comments_url: string; created_at: string; events_url: string; html_url: string; id: number; labels: Array<IssuesUpdateResponseLabelsItem>; labels_url: string; locked: boolean; milestone: IssuesUpdateResponseMilestone; node_id: string; number: number; pull_request: IssuesUpdateResponsePullRequest; repository_url: string; state: string; title: string; updated_at: string; url: string; user: IssuesUpdateResponseUser }

    Type declaration

    IssuesUpdateResponseAssignee

    IssuesUpdateResponseAssignee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesUpdateResponseAssigneesItem

    IssuesUpdateResponseAssigneesItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesUpdateResponseClosedBy

    IssuesUpdateResponseClosedBy: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesUpdateResponseLabelsItem

    IssuesUpdateResponseLabelsItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

    Type declaration

    • color: string
    • default: boolean
    • description: string
    • id: number
    • name: string
    • node_id: string
    • url: string

    IssuesUpdateResponseMilestone

    IssuesUpdateResponseMilestone: { closed_at: string; closed_issues: number; created_at: string; creator: IssuesUpdateResponseMilestoneCreator; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }

    Type declaration

    • closed_at: string
    • closed_issues: number
    • created_at: string
    • creator: IssuesUpdateResponseMilestoneCreator
    • description: string
    • due_on: string
    • html_url: string
    • id: number
    • labels_url: string
    • node_id: string
    • number: number
    • open_issues: number
    • state: string
    • title: string
    • updated_at: string
    • url: string

    IssuesUpdateResponseMilestoneCreator

    IssuesUpdateResponseMilestoneCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    IssuesUpdateResponsePullRequest

    IssuesUpdateResponsePullRequest: { diff_url: string; html_url: string; patch_url: string; url: string }

    Type declaration

    • diff_url: string
    • html_url: string
    • patch_url: string
    • url: string

    IssuesUpdateResponseUser

    IssuesUpdateResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    LicensesGetForRepoParams

    LicensesGetForRepoParams: { owner: string; repo: string }

    Type declaration

    • owner: string
    • repo: string

    LicensesGetForRepoResponse

    LicensesGetForRepoResponse: { _links: LicensesGetForRepoResponseLinks; content: string; download_url: string; encoding: string; git_url: string; html_url: string; license: LicensesGetForRepoResponseLicense; name: string; path: string; sha: string; size: number; type: string; url: string }

    Type declaration

    LicensesGetForRepoResponseLicense

    LicensesGetForRepoResponseLicense: { key: string; name: string; node_id: string; spdx_id: string; url: string }

    Type declaration

    • key: string
    • name: string
    • node_id: string
    • spdx_id: string
    • url: string

    LicensesGetForRepoResponseLinks

    LicensesGetForRepoResponseLinks: { git: string; html: string; self: string }

    Type declaration

    • git: string
    • html: string
    • self: string

    LicensesGetParams

    LicensesGetParams: { license: string }

    Type declaration

    • license: string

    LicensesGetResponse

    LicensesGetResponse: { body: string; conditions: Array<string>; description: string; featured: boolean; html_url: string; implementation: string; key: string; limitations: Array<string>; name: string; node_id: string; permissions: Array<string>; spdx_id: string; url: string }

    Type declaration

    • body: string
    • conditions: Array<string>
    • description: string
    • featured: boolean
    • html_url: string
    • implementation: string
    • key: string
    • limitations: Array<string>
    • name: string
    • node_id: string
    • permissions: Array<string>
    • spdx_id: string
    • url: string

    LicensesListCommonlyUsedResponse

    LicensesListCommonlyUsedResponse: Array<LicensesListCommonlyUsedResponseItem>

    LicensesListCommonlyUsedResponseItem

    LicensesListCommonlyUsedResponseItem: { key: string; name: string; node_id?: undefined | string; spdx_id: string; url: string }

    Type declaration

    • key: string
    • name: string
    • Optional node_id?: undefined | string
    • spdx_id: string
    • url: string

    LicensesListResponse

    LicensesListResponse: Array<LicensesListResponseItem>

    LicensesListResponseItem

    LicensesListResponseItem: { key: string; name: string; node_id?: undefined | string; spdx_id: string; url: string }

    Type declaration

    • key: string
    • name: string
    • Optional node_id?: undefined | string
    • spdx_id: string
    • url: string

    Link

    Link: { link: string } | { headers: { link: string } } | string

    MarkdownRenderParams

    MarkdownRenderParams: { context?: undefined | string; mode?: "markdown" | "gfm"; text: string }

    Type declaration

    • Optional context?: undefined | string

      The repository context to use when creating references in gfm mode. Omit this parameter when using markdown mode.

    • Optional mode?: "markdown" | "gfm"

      The rendering mode. Can be either: * markdown to render a document in plain Markdown, just like README.md files are rendered. * gfm to render a document in GitHub Flavored Markdown, which creates links for user mentions as well as references to SHA-1 hashes, issues, and pull requests.

    • text: string

      The Markdown text to render in HTML. Markdown content must be 400 KB or less.

    MarkdownRenderRawParams

    MarkdownRenderRawParams: { data: string }

    Type declaration

    • data: string

    MetaGetResponse

    MetaGetResponse: { api: Array<string>; git: Array<string>; hooks: Array<string>; importer: Array<string>; pages: Array<string>; ssh_key_fingerprints: MetaGetResponseSshKeyFingerprints; verifiable_password_authentication: boolean; web: Array<string> }

    Type declaration

    • api: Array<string>
    • git: Array<string>
    • hooks: Array<string>
    • importer: Array<string>
    • pages: Array<string>
    • ssh_key_fingerprints: MetaGetResponseSshKeyFingerprints
    • verifiable_password_authentication: boolean
    • web: Array<string>

    MetaGetResponseSshKeyFingerprints

    MetaGetResponseSshKeyFingerprints: { MD5_DSA: string; MD5_RSA: string; SHA256_DSA: string; SHA256_RSA: string }

    Type declaration

    • MD5_DSA: string
    • MD5_RSA: string
    • SHA256_DSA: string
    • SHA256_RSA: string

    MigrationsCancelImportParams

    MigrationsCancelImportParams: { owner: string; repo: string }

    Type declaration

    • owner: string
    • repo: string

    MigrationsDeleteArchiveForAuthenticatedUserParams

    MigrationsDeleteArchiveForAuthenticatedUserParams: { migration_id: number }

    Type declaration

    • migration_id: number

    MigrationsDeleteArchiveForOrgParams

    MigrationsDeleteArchiveForOrgParams: { migration_id: number; org: string }

    Type declaration

    • migration_id: number
    • org: string

    MigrationsDownloadArchiveForOrgParams

    MigrationsDownloadArchiveForOrgParams: { migration_id: number; org: string }

    Type declaration

    • migration_id: number
    • org: string

    MigrationsGetArchiveForAuthenticatedUserParams

    MigrationsGetArchiveForAuthenticatedUserParams: { migration_id: number }

    Type declaration

    • migration_id: number

    MigrationsGetArchiveForOrgParams

    MigrationsGetArchiveForOrgParams: { migration_id: number; org: string }

    Type declaration

    • migration_id: number
    • org: string

    MigrationsGetCommitAuthorsParams

    MigrationsGetCommitAuthorsParams: { owner: string; repo: string; since?: undefined | string }

    Type declaration

    • owner: string
    • repo: string
    • Optional since?: undefined | string

      Only authors found after this id are returned. Provide the highest author ID you've seen so far. New authors may be added to the list at any point while the importer is performing the raw step.

    MigrationsGetCommitAuthorsResponse

    MigrationsGetCommitAuthorsResponse: Array<MigrationsGetCommitAuthorsResponseItem>

    MigrationsGetCommitAuthorsResponseItem

    MigrationsGetCommitAuthorsResponseItem: { email: string; id: number; import_url: string; name: string; remote_id: string; remote_name: string; url: string }

    Type declaration

    • email: string
    • id: number
    • import_url: string
    • name: string
    • remote_id: string
    • remote_name: string
    • url: string

    MigrationsGetImportProgressParams

    MigrationsGetImportProgressParams: { owner: string; repo: string }

    Type declaration

    • owner: string
    • repo: string

    MigrationsGetImportProgressResponse

    MigrationsGetImportProgressResponse: { authors_count: number; authors_url: string; has_large_files: boolean; html_url: string; large_files_count: number; large_files_size: number; repository_url: string; status: string; status_text: string; url: string; use_lfs: string; vcs: string; vcs_url: string }

    Type declaration

    • authors_count: number
    • authors_url: string
    • has_large_files: boolean
    • html_url: string
    • large_files_count: number
    • large_files_size: number
    • repository_url: string
    • status: string
    • status_text: string
    • url: string
    • use_lfs: string
    • vcs: string
    • vcs_url: string

    MigrationsGetLargeFilesParams

    MigrationsGetLargeFilesParams: { owner: string; repo: string }

    Type declaration

    • owner: string
    • repo: string

    MigrationsGetLargeFilesResponse

    MigrationsGetLargeFilesResponse: Array<MigrationsGetLargeFilesResponseItem>

    MigrationsGetLargeFilesResponseItem

    MigrationsGetLargeFilesResponseItem: { oid: string; path: string; ref_name: string; size: number }

    Type declaration

    • oid: string
    • path: string
    • ref_name: string
    • size: number

    MigrationsGetStatusForAuthenticatedUserParams

    MigrationsGetStatusForAuthenticatedUserParams: { migration_id: number }

    Type declaration

    • migration_id: number

    MigrationsGetStatusForAuthenticatedUserResponse

    MigrationsGetStatusForAuthenticatedUserResponse: { created_at: string; exclude_attachments: boolean; guid: string; id: number; lock_repositories: boolean; owner: MigrationsGetStatusForAuthenticatedUserResponseOwner; repositories: Array<MigrationsGetStatusForAuthenticatedUserResponseRepositoriesItem>; state: string; updated_at: string; url: string }

    Type declaration

    MigrationsGetStatusForAuthenticatedUserResponseOwner

    MigrationsGetStatusForAuthenticatedUserResponseOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    MigrationsGetStatusForAuthenticatedUserResponseRepositoriesItem

    MigrationsGetStatusForAuthenticatedUserResponseRepositoriesItem: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: MigrationsGetStatusForAuthenticatedUserResponseRepositoriesItemOwner; permissions: MigrationsGetStatusForAuthenticatedUserResponseRepositoriesItemPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

    Type declaration

    • allow_merge_commit: boolean
    • allow_rebase_merge: boolean
    • allow_squash_merge: boolean
    • archive_url: string
    • archived: boolean
    • assignees_url: string
    • blobs_url: string
    • branches_url: string
    • clone_url: string
    • collaborators_url: string
    • comments_url: string
    • commits_url: string
    • compare_url: string
    • contents_url: string
    • contributors_url: string
    • created_at: string
    • default_branch: string
    • deployments_url: string
    • description: string
    • disabled: boolean
    • downloads_url: string
    • events_url: string
    • fork: boolean
    • forks_count: number
    • forks_url: string
    • full_name: string
    • git_commits_url: string
    • git_refs_url: string
    • git_tags_url: string
    • git_url: string
    • has_downloads: boolean
    • has_issues: boolean
    • has_pages: boolean
    • has_projects: boolean
    • has_wiki: boolean
    • homepage: string
    • hooks_url: string
    • html_url: string
    • id: number
    • is_template: boolean
    • issue_comment_url: string
    • issue_events_url: string
    • issues_url: string
    • keys_url: string
    • labels_url: string
    • language: null
    • languages_url: string
    • merges_url: string
    • milestones_url: string
    • mirror_url: string
    • name: string
    • network_count: number
    • node_id: string
    • notifications_url: string
    • open_issues_count: number
    • owner: MigrationsGetStatusForAuthenticatedUserResponseRepositoriesItemOwner
    • permissions: MigrationsGetStatusForAuthenticatedUserResponseRepositoriesItemPermissions
    • private: boolean
    • pulls_url: string
    • pushed_at: string
    • releases_url: string
    • size: number
    • ssh_url: string
    • stargazers_count: number
    • stargazers_url: string
    • statuses_url: string
    • subscribers_count: number
    • subscribers_url: string
    • subscription_url: string
    • svn_url: string
    • tags_url: string
    • teams_url: string
    • temp_clone_token: string
    • template_repository: null
    • topics: Array<string>
    • trees_url: string
    • updated_at: string
    • url: string
    • visibility: string
    • watchers_count: number

    MigrationsGetStatusForAuthenticatedUserResponseRepositoriesItemOwner

    MigrationsGetStatusForAuthenticatedUserResponseRepositoriesItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    MigrationsGetStatusForAuthenticatedUserResponseRepositoriesItemPermissions

    MigrationsGetStatusForAuthenticatedUserResponseRepositoriesItemPermissions: { admin: boolean; pull: boolean; push: boolean }

    Type declaration

    • admin: boolean
    • pull: boolean
    • push: boolean

    MigrationsGetStatusForOrgParams

    MigrationsGetStatusForOrgParams: { migration_id: number; org: string }

    Type declaration

    • migration_id: number
    • org: string

    MigrationsGetStatusForOrgResponse

    MigrationsGetStatusForOrgResponse: { created_at: string; exclude_attachments: boolean; guid: string; id: number; lock_repositories: boolean; owner: MigrationsGetStatusForOrgResponseOwner; repositories: Array<MigrationsGetStatusForOrgResponseRepositoriesItem>; state: string; updated_at: string; url: string }

    Type declaration

    MigrationsGetStatusForOrgResponseOwner

    MigrationsGetStatusForOrgResponseOwner: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

    Type declaration

    • avatar_url: string
    • description: string
    • events_url: string
    • hooks_url: string
    • id: number
    • issues_url: string
    • login: string
    • members_url: string
    • node_id: string
    • public_members_url: string
    • repos_url: string
    • url: string

    MigrationsGetStatusForOrgResponseRepositoriesItem

    MigrationsGetStatusForOrgResponseRepositoriesItem: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: MigrationsGetStatusForOrgResponseRepositoriesItemOwner; permissions: MigrationsGetStatusForOrgResponseRepositoriesItemPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

    Type declaration

    • allow_merge_commit: boolean
    • allow_rebase_merge: boolean
    • allow_squash_merge: boolean
    • archive_url: string
    • archived: boolean
    • assignees_url: string
    • blobs_url: string
    • branches_url: string
    • clone_url: string
    • collaborators_url: string
    • comments_url: string
    • commits_url: string
    • compare_url: string
    • contents_url: string
    • contributors_url: string
    • created_at: string
    • default_branch: string
    • deployments_url: string
    • description: string
    • disabled: boolean
    • downloads_url: string
    • events_url: string
    • fork: boolean
    • forks_count: number
    • forks_url: string
    • full_name: string
    • git_commits_url: string
    • git_refs_url: string
    • git_tags_url: string
    • git_url: string
    • has_downloads: boolean
    • has_issues: boolean
    • has_pages: boolean
    • has_projects: boolean
    • has_wiki: boolean
    • homepage: string
    • hooks_url: string
    • html_url: string
    • id: number
    • is_template: boolean
    • issue_comment_url: string
    • issue_events_url: string
    • issues_url: string
    • keys_url: string
    • labels_url: string
    • language: null
    • languages_url: string
    • merges_url: string
    • milestones_url: string
    • mirror_url: string
    • name: string
    • network_count: number
    • node_id: string
    • notifications_url: string
    • open_issues_count: number
    • owner: MigrationsGetStatusForOrgResponseRepositoriesItemOwner
    • permissions: MigrationsGetStatusForOrgResponseRepositoriesItemPermissions
    • private: boolean
    • pulls_url: string
    • pushed_at: string
    • releases_url: string
    • size: number
    • ssh_url: string
    • stargazers_count: number
    • stargazers_url: string
    • statuses_url: string
    • subscribers_count: number
    • subscribers_url: string
    • subscription_url: string
    • svn_url: string
    • tags_url: string
    • teams_url: string
    • temp_clone_token: string
    • template_repository: null
    • topics: Array<string>
    • trees_url: string
    • updated_at: string
    • url: string
    • visibility: string
    • watchers_count: number

    MigrationsGetStatusForOrgResponseRepositoriesItemOwner

    MigrationsGetStatusForOrgResponseRepositoriesItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    MigrationsGetStatusForOrgResponseRepositoriesItemPermissions

    MigrationsGetStatusForOrgResponseRepositoriesItemPermissions: { admin: boolean; pull: boolean; push: boolean }

    Type declaration

    • admin: boolean
    • pull: boolean
    • push: boolean

    MigrationsListForAuthenticatedUserParams

    MigrationsListForAuthenticatedUserParams: { page?: undefined | number; per_page?: undefined | number }

    Type declaration

    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    MigrationsListForAuthenticatedUserResponse

    MigrationsListForAuthenticatedUserResponse: Array<MigrationsListForAuthenticatedUserResponseItem>

    MigrationsListForAuthenticatedUserResponseItem

    MigrationsListForAuthenticatedUserResponseItem: { created_at: string; exclude_attachments: boolean; guid: string; id: number; lock_repositories: boolean; owner: MigrationsListForAuthenticatedUserResponseItemOwner; repositories: Array<MigrationsListForAuthenticatedUserResponseItemRepositoriesItem>; state: string; updated_at: string; url: string }

    Type declaration

    MigrationsListForAuthenticatedUserResponseItemOwner

    MigrationsListForAuthenticatedUserResponseItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    MigrationsListForAuthenticatedUserResponseItemRepositoriesItem

    MigrationsListForAuthenticatedUserResponseItemRepositoriesItem: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: MigrationsListForAuthenticatedUserResponseItemRepositoriesItemOwner; permissions: MigrationsListForAuthenticatedUserResponseItemRepositoriesItemPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

    Type declaration

    • allow_merge_commit: boolean
    • allow_rebase_merge: boolean
    • allow_squash_merge: boolean
    • archive_url: string
    • archived: boolean
    • assignees_url: string
    • blobs_url: string
    • branches_url: string
    • clone_url: string
    • collaborators_url: string
    • comments_url: string
    • commits_url: string
    • compare_url: string
    • contents_url: string
    • contributors_url: string
    • created_at: string
    • default_branch: string
    • deployments_url: string
    • description: string
    • disabled: boolean
    • downloads_url: string
    • events_url: string
    • fork: boolean
    • forks_count: number
    • forks_url: string
    • full_name: string
    • git_commits_url: string
    • git_refs_url: string
    • git_tags_url: string
    • git_url: string
    • has_downloads: boolean
    • has_issues: boolean
    • has_pages: boolean
    • has_projects: boolean
    • has_wiki: boolean
    • homepage: string
    • hooks_url: string
    • html_url: string
    • id: number
    • is_template: boolean
    • issue_comment_url: string
    • issue_events_url: string
    • issues_url: string
    • keys_url: string
    • labels_url: string
    • language: null
    • languages_url: string
    • merges_url: string
    • milestones_url: string
    • mirror_url: string
    • name: string
    • network_count: number
    • node_id: string
    • notifications_url: string
    • open_issues_count: number
    • owner: MigrationsListForAuthenticatedUserResponseItemRepositoriesItemOwner
    • permissions: MigrationsListForAuthenticatedUserResponseItemRepositoriesItemPermissions
    • private: boolean
    • pulls_url: string
    • pushed_at: string
    • releases_url: string
    • size: number
    • ssh_url: string
    • stargazers_count: number
    • stargazers_url: string
    • statuses_url: string
    • subscribers_count: number
    • subscribers_url: string
    • subscription_url: string
    • svn_url: string
    • tags_url: string
    • teams_url: string
    • temp_clone_token: string
    • template_repository: null
    • topics: Array<string>
    • trees_url: string
    • updated_at: string
    • url: string
    • visibility: string
    • watchers_count: number

    MigrationsListForAuthenticatedUserResponseItemRepositoriesItemOwner

    MigrationsListForAuthenticatedUserResponseItemRepositoriesItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    MigrationsListForAuthenticatedUserResponseItemRepositoriesItemPermissions

    MigrationsListForAuthenticatedUserResponseItemRepositoriesItemPermissions: { admin: boolean; pull: boolean; push: boolean }

    Type declaration

    • admin: boolean
    • pull: boolean
    • push: boolean

    MigrationsListForOrgParams

    MigrationsListForOrgParams: { org: string; page?: undefined | number; per_page?: undefined | number }

    Type declaration

    • org: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    MigrationsListForOrgResponse

    MigrationsListForOrgResponse: Array<MigrationsListForOrgResponseItem>

    MigrationsListForOrgResponseItem

    MigrationsListForOrgResponseItem: { created_at: string; exclude_attachments: boolean; guid: string; id: number; lock_repositories: boolean; owner: MigrationsListForOrgResponseItemOwner; repositories: Array<MigrationsListForOrgResponseItemRepositoriesItem>; state: string; updated_at: string; url: string }

    Type declaration

    MigrationsListForOrgResponseItemOwner

    MigrationsListForOrgResponseItemOwner: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

    Type declaration

    • avatar_url: string
    • description: string
    • events_url: string
    • hooks_url: string
    • id: number
    • issues_url: string
    • login: string
    • members_url: string
    • node_id: string
    • public_members_url: string
    • repos_url: string
    • url: string

    MigrationsListForOrgResponseItemRepositoriesItem

    MigrationsListForOrgResponseItemRepositoriesItem: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: MigrationsListForOrgResponseItemRepositoriesItemOwner; permissions: MigrationsListForOrgResponseItemRepositoriesItemPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

    Type declaration

    • allow_merge_commit: boolean
    • allow_rebase_merge: boolean
    • allow_squash_merge: boolean
    • archive_url: string
    • archived: boolean
    • assignees_url: string
    • blobs_url: string
    • branches_url: string
    • clone_url: string
    • collaborators_url: string
    • comments_url: string
    • commits_url: string
    • compare_url: string
    • contents_url: string
    • contributors_url: string
    • created_at: string
    • default_branch: string
    • deployments_url: string
    • description: string
    • disabled: boolean
    • downloads_url: string
    • events_url: string
    • fork: boolean
    • forks_count: number
    • forks_url: string
    • full_name: string
    • git_commits_url: string
    • git_refs_url: string
    • git_tags_url: string
    • git_url: string
    • has_downloads: boolean
    • has_issues: boolean
    • has_pages: boolean
    • has_projects: boolean
    • has_wiki: boolean
    • homepage: string
    • hooks_url: string
    • html_url: string
    • id: number
    • is_template: boolean
    • issue_comment_url: string
    • issue_events_url: string
    • issues_url: string
    • keys_url: string
    • labels_url: string
    • language: null
    • languages_url: string
    • merges_url: string
    • milestones_url: string
    • mirror_url: string
    • name: string
    • network_count: number
    • node_id: string
    • notifications_url: string
    • open_issues_count: number
    • owner: MigrationsListForOrgResponseItemRepositoriesItemOwner
    • permissions: MigrationsListForOrgResponseItemRepositoriesItemPermissions
    • private: boolean
    • pulls_url: string
    • pushed_at: string
    • releases_url: string
    • size: number
    • ssh_url: string
    • stargazers_count: number
    • stargazers_url: string
    • statuses_url: string
    • subscribers_count: number
    • subscribers_url: string
    • subscription_url: string
    • svn_url: string
    • tags_url: string
    • teams_url: string
    • temp_clone_token: string
    • template_repository: null
    • topics: Array<string>
    • trees_url: string
    • updated_at: string
    • url: string
    • visibility: string
    • watchers_count: number

    MigrationsListForOrgResponseItemRepositoriesItemOwner

    MigrationsListForOrgResponseItemRepositoriesItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    MigrationsListForOrgResponseItemRepositoriesItemPermissions

    MigrationsListForOrgResponseItemRepositoriesItemPermissions: { admin: boolean; pull: boolean; push: boolean }

    Type declaration

    • admin: boolean
    • pull: boolean
    • push: boolean

    MigrationsListReposForOrgParams

    MigrationsListReposForOrgParams: { migration_id: number; org: string; page?: undefined | number; per_page?: undefined | number }

    Type declaration

    • migration_id: number
    • org: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    MigrationsListReposForOrgResponse

    MigrationsListReposForOrgResponse: Array<MigrationsListReposForOrgResponseItem>

    MigrationsListReposForOrgResponseItem

    MigrationsListReposForOrgResponseItem: { archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; license: MigrationsListReposForOrgResponseItemLicense; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: MigrationsListReposForOrgResponseItemOwner; permissions: MigrationsListReposForOrgResponseItemPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

    Type declaration

    • archive_url: string
    • archived: boolean
    • assignees_url: string
    • blobs_url: string
    • branches_url: string
    • clone_url: string
    • collaborators_url: string
    • comments_url: string
    • commits_url: string
    • compare_url: string
    • contents_url: string
    • contributors_url: string
    • created_at: string
    • default_branch: string
    • deployments_url: string
    • description: string
    • disabled: boolean
    • downloads_url: string
    • events_url: string
    • fork: boolean
    • forks_count: number
    • forks_url: string
    • full_name: string
    • git_commits_url: string
    • git_refs_url: string
    • git_tags_url: string
    • git_url: string
    • has_downloads: boolean
    • has_issues: boolean
    • has_pages: boolean
    • has_projects: boolean
    • has_wiki: boolean
    • homepage: string
    • hooks_url: string
    • html_url: string
    • id: number
    • is_template: boolean
    • issue_comment_url: string
    • issue_events_url: string
    • issues_url: string
    • keys_url: string
    • labels_url: string
    • language: null
    • languages_url: string
    • license: MigrationsListReposForOrgResponseItemLicense
    • merges_url: string
    • milestones_url: string
    • mirror_url: string
    • name: string
    • network_count: number
    • node_id: string
    • notifications_url: string
    • open_issues_count: number
    • owner: MigrationsListReposForOrgResponseItemOwner
    • permissions: MigrationsListReposForOrgResponseItemPermissions
    • private: boolean
    • pulls_url: string
    • pushed_at: string
    • releases_url: string
    • size: number
    • ssh_url: string
    • stargazers_count: number
    • stargazers_url: string
    • statuses_url: string
    • subscribers_count: number
    • subscribers_url: string
    • subscription_url: string
    • svn_url: string
    • tags_url: string
    • teams_url: string
    • temp_clone_token: string
    • template_repository: null
    • topics: Array<string>
    • trees_url: string
    • updated_at: string
    • url: string
    • visibility: string
    • watchers_count: number

    MigrationsListReposForOrgResponseItemLicense

    MigrationsListReposForOrgResponseItemLicense: { key: string; name: string; node_id: string; spdx_id: string; url: string }

    Type declaration

    • key: string
    • name: string
    • node_id: string
    • spdx_id: string
    • url: string

    MigrationsListReposForOrgResponseItemOwner

    MigrationsListReposForOrgResponseItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    MigrationsListReposForOrgResponseItemPermissions

    MigrationsListReposForOrgResponseItemPermissions: { admin: boolean; pull: boolean; push: boolean }

    Type declaration

    • admin: boolean
    • pull: boolean
    • push: boolean

    MigrationsListReposForUserParams

    MigrationsListReposForUserParams: { migration_id: number; page?: undefined | number; per_page?: undefined | number }

    Type declaration

    • migration_id: number
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    MigrationsListReposForUserResponse

    MigrationsListReposForUserResponse: Array<MigrationsListReposForUserResponseItem>

    MigrationsListReposForUserResponseItem

    MigrationsListReposForUserResponseItem: { archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; license: MigrationsListReposForUserResponseItemLicense; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: MigrationsListReposForUserResponseItemOwner; permissions: MigrationsListReposForUserResponseItemPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

    Type declaration

    • archive_url: string
    • archived: boolean
    • assignees_url: string
    • blobs_url: string
    • branches_url: string
    • clone_url: string
    • collaborators_url: string
    • comments_url: string
    • commits_url: string
    • compare_url: string
    • contents_url: string
    • contributors_url: string
    • created_at: string
    • default_branch: string
    • deployments_url: string
    • description: string
    • disabled: boolean
    • downloads_url: string
    • events_url: string
    • fork: boolean
    • forks_count: number
    • forks_url: string
    • full_name: string
    • git_commits_url: string
    • git_refs_url: string
    • git_tags_url: string
    • git_url: string
    • has_downloads: boolean
    • has_issues: boolean
    • has_pages: boolean
    • has_projects: boolean
    • has_wiki: boolean
    • homepage: string
    • hooks_url: string
    • html_url: string
    • id: number
    • is_template: boolean
    • issue_comment_url: string
    • issue_events_url: string
    • issues_url: string
    • keys_url: string
    • labels_url: string
    • language: null
    • languages_url: string
    • license: MigrationsListReposForUserResponseItemLicense
    • merges_url: string
    • milestones_url: string
    • mirror_url: string
    • name: string
    • network_count: number
    • node_id: string
    • notifications_url: string
    • open_issues_count: number
    • owner: MigrationsListReposForUserResponseItemOwner
    • permissions: MigrationsListReposForUserResponseItemPermissions
    • private: boolean
    • pulls_url: string
    • pushed_at: string
    • releases_url: string
    • size: number
    • ssh_url: string
    • stargazers_count: number
    • stargazers_url: string
    • statuses_url: string
    • subscribers_count: number
    • subscribers_url: string
    • subscription_url: string
    • svn_url: string
    • tags_url: string
    • teams_url: string
    • temp_clone_token: string
    • template_repository: null
    • topics: Array<string>
    • trees_url: string
    • updated_at: string
    • url: string
    • visibility: string
    • watchers_count: number

    MigrationsListReposForUserResponseItemLicense

    MigrationsListReposForUserResponseItemLicense: { key: string; name: string; node_id: string; spdx_id: string; url: string }

    Type declaration

    • key: string
    • name: string
    • node_id: string
    • spdx_id: string
    • url: string

    MigrationsListReposForUserResponseItemOwner

    MigrationsListReposForUserResponseItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    MigrationsListReposForUserResponseItemPermissions

    MigrationsListReposForUserResponseItemPermissions: { admin: boolean; pull: boolean; push: boolean }

    Type declaration

    • admin: boolean
    • pull: boolean
    • push: boolean

    MigrationsMapCommitAuthorParams

    MigrationsMapCommitAuthorParams: { author_id: number; email?: undefined | string; name?: undefined | string; owner: string; repo: string }

    Type declaration

    • author_id: number
    • Optional email?: undefined | string

      The new Git author email.

    • Optional name?: undefined | string

      The new Git author name.

    • owner: string
    • repo: string

    MigrationsMapCommitAuthorResponse

    MigrationsMapCommitAuthorResponse: { email: string; id: number; import_url: string; name: string; remote_id: string; remote_name: string; url: string }

    Type declaration

    • email: string
    • id: number
    • import_url: string
    • name: string
    • remote_id: string
    • remote_name: string
    • url: string

    MigrationsSetLfsPreferenceParams

    MigrationsSetLfsPreferenceParams: { owner: string; repo: string; use_lfs: "opt_in" | "opt_out" }

    Type declaration

    • owner: string
    • repo: string
    • use_lfs: "opt_in" | "opt_out"

      Can be one of opt_in (large files will be stored using Git LFS) or opt_out (large files will be removed during the import).

    MigrationsSetLfsPreferenceResponse

    MigrationsSetLfsPreferenceResponse: { authors_count: number; authors_url: string; has_large_files: boolean; html_url: string; large_files_count: number; large_files_size: number; repository_url: string; status: string; status_text: string; url: string; use_lfs: string; vcs: string; vcs_url: string }

    Type declaration

    • authors_count: number
    • authors_url: string
    • has_large_files: boolean
    • html_url: string
    • large_files_count: number
    • large_files_size: number
    • repository_url: string
    • status: string
    • status_text: string
    • url: string
    • use_lfs: string
    • vcs: string
    • vcs_url: string

    MigrationsStartForAuthenticatedUserParams

    MigrationsStartForAuthenticatedUserParams: { exclude_attachments?: undefined | false | true; lock_repositories?: undefined | false | true; repositories: string[] }

    Type declaration

    • Optional exclude_attachments?: undefined | false | true

      Does not include attachments uploaded to GitHub.com in the migration data when set to true. Excluding attachments will reduce the migration archive file size.

    • Optional lock_repositories?: undefined | false | true

      Locks the repositories to prevent changes during the migration when set to true.

    • repositories: string[]

      An array of repositories to include in the migration.

    MigrationsStartForAuthenticatedUserResponse

    MigrationsStartForAuthenticatedUserResponse: { created_at: string; exclude_attachments: boolean; guid: string; id: number; lock_repositories: boolean; owner: MigrationsStartForAuthenticatedUserResponseOwner; repositories: Array<MigrationsStartForAuthenticatedUserResponseRepositoriesItem>; state: string; updated_at: string; url: string }

    Type declaration

    MigrationsStartForAuthenticatedUserResponseOwner

    MigrationsStartForAuthenticatedUserResponseOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    MigrationsStartForAuthenticatedUserResponseRepositoriesItem

    MigrationsStartForAuthenticatedUserResponseRepositoriesItem: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: MigrationsStartForAuthenticatedUserResponseRepositoriesItemOwner; permissions: MigrationsStartForAuthenticatedUserResponseRepositoriesItemPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

    Type declaration

    • allow_merge_commit: boolean
    • allow_rebase_merge: boolean
    • allow_squash_merge: boolean
    • archive_url: string
    • archived: boolean
    • assignees_url: string
    • blobs_url: string
    • branches_url: string
    • clone_url: string
    • collaborators_url: string
    • comments_url: string
    • commits_url: string
    • compare_url: string
    • contents_url: string
    • contributors_url: string
    • created_at: string
    • default_branch: string
    • deployments_url: string
    • description: string
    • disabled: boolean
    • downloads_url: string
    • events_url: string
    • fork: boolean
    • forks_count: number
    • forks_url: string
    • full_name: string
    • git_commits_url: string
    • git_refs_url: string
    • git_tags_url: string
    • git_url: string
    • has_downloads: boolean
    • has_issues: boolean
    • has_pages: boolean
    • has_projects: boolean
    • has_wiki: boolean
    • homepage: string
    • hooks_url: string
    • html_url: string
    • id: number
    • is_template: boolean
    • issue_comment_url: string
    • issue_events_url: string
    • issues_url: string
    • keys_url: string
    • labels_url: string
    • language: null
    • languages_url: string
    • merges_url: string
    • milestones_url: string
    • mirror_url: string
    • name: string
    • network_count: number
    • node_id: string
    • notifications_url: string
    • open_issues_count: number
    • owner: MigrationsStartForAuthenticatedUserResponseRepositoriesItemOwner
    • permissions: MigrationsStartForAuthenticatedUserResponseRepositoriesItemPermissions
    • private: boolean
    • pulls_url: string
    • pushed_at: string
    • releases_url: string
    • size: number
    • ssh_url: string
    • stargazers_count: number
    • stargazers_url: string
    • statuses_url: string
    • subscribers_count: number
    • subscribers_url: string
    • subscription_url: string
    • svn_url: string
    • tags_url: string
    • teams_url: string
    • temp_clone_token: string
    • template_repository: null
    • topics: Array<string>
    • trees_url: string
    • updated_at: string
    • url: string
    • visibility: string
    • watchers_count: number

    MigrationsStartForAuthenticatedUserResponseRepositoriesItemOwner

    MigrationsStartForAuthenticatedUserResponseRepositoriesItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    MigrationsStartForAuthenticatedUserResponseRepositoriesItemPermissions

    MigrationsStartForAuthenticatedUserResponseRepositoriesItemPermissions: { admin: boolean; pull: boolean; push: boolean }

    Type declaration

    • admin: boolean
    • pull: boolean
    • push: boolean

    MigrationsStartForOrgParams

    MigrationsStartForOrgParams: { exclude_attachments?: undefined | false | true; lock_repositories?: undefined | false | true; org: string; repositories: string[] }

    Type declaration

    • Optional exclude_attachments?: undefined | false | true

      Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).

    • Optional lock_repositories?: undefined | false | true

      Indicates whether repositories should be locked (to prevent manipulation) while migrating data.

    • org: string
    • repositories: string[]

      A list of arrays indicating which repositories should be migrated.

    MigrationsStartForOrgResponse

    MigrationsStartForOrgResponse: { created_at: string; exclude_attachments: boolean; guid: string; id: number; lock_repositories: boolean; owner: MigrationsStartForOrgResponseOwner; repositories: Array<MigrationsStartForOrgResponseRepositoriesItem>; state: string; updated_at: string; url: string }

    Type declaration

    MigrationsStartForOrgResponseOwner

    MigrationsStartForOrgResponseOwner: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

    Type declaration

    • avatar_url: string
    • description: string
    • events_url: string
    • hooks_url: string
    • id: number
    • issues_url: string
    • login: string
    • members_url: string
    • node_id: string
    • public_members_url: string
    • repos_url: string
    • url: string

    MigrationsStartForOrgResponseRepositoriesItem

    MigrationsStartForOrgResponseRepositoriesItem: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: MigrationsStartForOrgResponseRepositoriesItemOwner; permissions: MigrationsStartForOrgResponseRepositoriesItemPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

    Type declaration

    • allow_merge_commit: boolean
    • allow_rebase_merge: boolean
    • allow_squash_merge: boolean
    • archive_url: string
    • archived: boolean
    • assignees_url: string
    • blobs_url: string
    • branches_url: string
    • clone_url: string
    • collaborators_url: string
    • comments_url: string
    • commits_url: string
    • compare_url: string
    • contents_url: string
    • contributors_url: string
    • created_at: string
    • default_branch: string
    • deployments_url: string
    • description: string
    • disabled: boolean
    • downloads_url: string
    • events_url: string
    • fork: boolean
    • forks_count: number
    • forks_url: string
    • full_name: string
    • git_commits_url: string
    • git_refs_url: string
    • git_tags_url: string
    • git_url: string
    • has_downloads: boolean
    • has_issues: boolean
    • has_pages: boolean
    • has_projects: boolean
    • has_wiki: boolean
    • homepage: string
    • hooks_url: string
    • html_url: string
    • id: number
    • is_template: boolean
    • issue_comment_url: string
    • issue_events_url: string
    • issues_url: string
    • keys_url: string
    • labels_url: string
    • language: null
    • languages_url: string
    • merges_url: string
    • milestones_url: string
    • mirror_url: string
    • name: string
    • network_count: number
    • node_id: string
    • notifications_url: string
    • open_issues_count: number
    • owner: MigrationsStartForOrgResponseRepositoriesItemOwner
    • permissions: MigrationsStartForOrgResponseRepositoriesItemPermissions
    • private: boolean
    • pulls_url: string
    • pushed_at: string
    • releases_url: string
    • size: number
    • ssh_url: string
    • stargazers_count: number
    • stargazers_url: string
    • statuses_url: string
    • subscribers_count: number
    • subscribers_url: string
    • subscription_url: string
    • svn_url: string
    • tags_url: string
    • teams_url: string
    • temp_clone_token: string
    • template_repository: null
    • topics: Array<string>
    • trees_url: string
    • updated_at: string
    • url: string
    • visibility: string
    • watchers_count: number

    MigrationsStartForOrgResponseRepositoriesItemOwner

    MigrationsStartForOrgResponseRepositoriesItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    MigrationsStartForOrgResponseRepositoriesItemPermissions

    MigrationsStartForOrgResponseRepositoriesItemPermissions: { admin: boolean; pull: boolean; push: boolean }

    Type declaration

    • admin: boolean
    • pull: boolean
    • push: boolean

    MigrationsStartImportParams

    MigrationsStartImportParams: { owner: string; repo: string; tfvc_project?: undefined | string; vcs?: "subversion" | "git" | "mercurial" | "tfvc"; vcs_password?: undefined | string; vcs_url: string; vcs_username?: undefined | string }

    Type declaration

    • owner: string
    • repo: string
    • Optional tfvc_project?: undefined | string

      For a tfvc import, the name of the project that is being imported.

    • Optional vcs?: "subversion" | "git" | "mercurial" | "tfvc"

      The originating VCS type. Can be one of subversion, git, mercurial, or tfvc. Please be aware that without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response.

    • Optional vcs_password?: undefined | string

      If authentication is required, the password to provide to vcs_url.

    • vcs_url: string

      The URL of the originating repository.

    • Optional vcs_username?: undefined | string

      If authentication is required, the username to provide to vcs_url.

    MigrationsStartImportResponse

    MigrationsStartImportResponse: { authors_count: number; authors_url: string; commit_count: number; has_large_files: boolean; html_url: string; large_files_count: number; large_files_size: number; percent: number; repository_url: string; status: string; status_text: string; url: string; use_lfs: string; vcs: string; vcs_url: string }

    Type declaration

    • authors_count: number
    • authors_url: string
    • commit_count: number
    • has_large_files: boolean
    • html_url: string
    • large_files_count: number
    • large_files_size: number
    • percent: number
    • repository_url: string
    • status: string
    • status_text: string
    • url: string
    • use_lfs: string
    • vcs: string
    • vcs_url: string

    MigrationsUnlockRepoForAuthenticatedUserParams

    MigrationsUnlockRepoForAuthenticatedUserParams: { migration_id: number; repo_name: string }

    Type declaration

    • migration_id: number
    • repo_name: string

    MigrationsUnlockRepoForOrgParams

    MigrationsUnlockRepoForOrgParams: { migration_id: number; org: string; repo_name: string }

    Type declaration

    • migration_id: number
    • org: string
    • repo_name: string

    MigrationsUpdateImportParams

    MigrationsUpdateImportParams: { owner: string; repo: string; vcs_password?: undefined | string; vcs_username?: undefined | string }

    Type declaration

    • owner: string
    • repo: string
    • Optional vcs_password?: undefined | string

      The password to provide to the originating repository.

    • Optional vcs_username?: undefined | string

      The username to provide to the originating repository.

    MigrationsUpdateImportResponse

    MigrationsUpdateImportResponse: { authors_count?: undefined | number; authors_url: string; commit_count?: undefined | number; has_large_files?: undefined | false | true; html_url: string; large_files_count?: undefined | number; large_files_size?: undefined | number; percent?: undefined | number; repository_url: string; status: string; status_text?: undefined | string; tfvc_project?: undefined | string; url: string; use_lfs: string; vcs: string; vcs_url: string }

    Type declaration

    • Optional authors_count?: undefined | number
    • authors_url: string
    • Optional commit_count?: undefined | number
    • Optional has_large_files?: undefined | false | true
    • html_url: string
    • Optional large_files_count?: undefined | number
    • Optional large_files_size?: undefined | number
    • Optional percent?: undefined | number
    • repository_url: string
    • status: string
    • Optional status_text?: undefined | string
    • Optional tfvc_project?: undefined | string
    • url: string
    • use_lfs: string
    • vcs: string
    • vcs_url: string

    OauthAuthorizationsCheckAuthorizationParams

    OauthAuthorizationsCheckAuthorizationParams: { access_token: string; client_id: string }

    Type declaration

    • access_token: string
    • client_id: string

    OauthAuthorizationsCheckAuthorizationResponse

    OauthAuthorizationsCheckAuthorizationResponse: { app: OauthAuthorizationsCheckAuthorizationResponseApp; created_at: string; fingerprint: string; hashed_token: string; id: number; note: string; note_url: string; scopes: Array<string>; token: string; token_last_eight: string; updated_at: string; url: string; user: OauthAuthorizationsCheckAuthorizationResponseUser }

    Type declaration

    OauthAuthorizationsCheckAuthorizationResponseApp

    OauthAuthorizationsCheckAuthorizationResponseApp: { client_id: string; name: string; url: string }

    Type declaration

    • client_id: string
    • name: string
    • url: string

    OauthAuthorizationsCheckAuthorizationResponseUser

    OauthAuthorizationsCheckAuthorizationResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    OauthAuthorizationsCreateAuthorizationParams

    OauthAuthorizationsCreateAuthorizationParams: { client_id?: undefined | string; client_secret?: undefined | string; fingerprint?: undefined | string; note: string; note_url?: undefined | string; scopes?: string[] }

    Type declaration

    • Optional client_id?: undefined | string

      The 20 character OAuth app client key for which to create the token.

    • Optional client_secret?: undefined | string

      The 40 character OAuth app client secret for which to create the token.

    • Optional fingerprint?: undefined | string

      A unique string to distinguish an authorization from others created for the same client ID and user.

    • note: string

      A note to remind you what the OAuth token is for. Tokens not associated with a specific OAuth application (i.e. personal access tokens) must have a unique note.

    • Optional note_url?: undefined | string

      A URL to remind you what app the OAuth token is for.

    • Optional scopes?: string[]

      A list of scopes that this authorization is in.

    OauthAuthorizationsCreateAuthorizationResponse

    OauthAuthorizationsCreateAuthorizationResponse: { app: OauthAuthorizationsCreateAuthorizationResponseApp; created_at: string; fingerprint: string; hashed_token: string; id: number; note: string; note_url: string; scopes: Array<string>; token: string; token_last_eight: string; updated_at: string; url: string }

    Type declaration

    • app: OauthAuthorizationsCreateAuthorizationResponseApp
    • created_at: string
    • fingerprint: string
    • hashed_token: string
    • id: number
    • note: string
    • note_url: string
    • scopes: Array<string>
    • token: string
    • token_last_eight: string
    • updated_at: string
    • url: string

    OauthAuthorizationsCreateAuthorizationResponseApp

    OauthAuthorizationsCreateAuthorizationResponseApp: { client_id: string; name: string; url: string }

    Type declaration

    • client_id: string
    • name: string
    • url: string

    OauthAuthorizationsDeleteAuthorizationParams

    OauthAuthorizationsDeleteAuthorizationParams: { authorization_id: number }

    Type declaration

    • authorization_id: number

    OauthAuthorizationsDeleteGrantParams

    OauthAuthorizationsDeleteGrantParams: { grant_id: number }

    Type declaration

    • grant_id: number

    OauthAuthorizationsGetAuthorizationParams

    OauthAuthorizationsGetAuthorizationParams: { authorization_id: number }

    Type declaration

    • authorization_id: number

    OauthAuthorizationsGetAuthorizationResponse

    OauthAuthorizationsGetAuthorizationResponse: { app: OauthAuthorizationsGetAuthorizationResponseApp; created_at: string; fingerprint: string; hashed_token: string; id: number; note: string; note_url: string; scopes: Array<string>; token: string; token_last_eight: string; updated_at: string; url: string }

    Type declaration

    • app: OauthAuthorizationsGetAuthorizationResponseApp
    • created_at: string
    • fingerprint: string
    • hashed_token: string
    • id: number
    • note: string
    • note_url: string
    • scopes: Array<string>
    • token: string
    • token_last_eight: string
    • updated_at: string
    • url: string

    OauthAuthorizationsGetAuthorizationResponseApp

    OauthAuthorizationsGetAuthorizationResponseApp: { client_id: string; name: string; url: string }

    Type declaration

    • client_id: string
    • name: string
    • url: string

    OauthAuthorizationsGetGrantParams

    OauthAuthorizationsGetGrantParams: { grant_id: number }

    Type declaration

    • grant_id: number

    OauthAuthorizationsGetGrantResponse

    OauthAuthorizationsGetGrantResponse: { app: OauthAuthorizationsGetGrantResponseApp; created_at: string; id: number; scopes: Array<string>; updated_at: string; url: string }

    Type declaration

    OauthAuthorizationsGetGrantResponseApp

    OauthAuthorizationsGetGrantResponseApp: { client_id: string; name: string; url: string }

    Type declaration

    • client_id: string
    • name: string
    • url: string

    OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintParams

    OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintParams: { client_id: string; client_secret: string; fingerprint: string; note?: undefined | string; note_url?: undefined | string; scopes?: string[] }

    Type declaration

    • client_id: string
    • client_secret: string

      The 40 character OAuth app client secret associated with the client ID specified in the URL.

    • fingerprint: string
    • Optional note?: undefined | string

      A note to remind you what the OAuth token is for.

    • Optional note_url?: undefined | string

      A URL to remind you what app the OAuth token is for.

    • Optional scopes?: string[]

      A list of scopes that this authorization is in.

    OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintResponse

    OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintResponse: { app: OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintResponseApp; created_at: string; fingerprint: string; hashed_token: string; id: number; note: string; note_url: string; scopes: Array<string>; token: string; token_last_eight: string; updated_at: string; url: string }

    Type declaration

    OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintResponseApp

    OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintResponseApp: { client_id: string; name: string; url: string }

    Type declaration

    • client_id: string
    • name: string
    • url: string

    OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintParams

    OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintParams: { client_id: string; client_secret: string; fingerprint: string; note?: undefined | string; note_url?: undefined | string; scopes?: string[] }

    Type declaration

    • client_id: string
    • client_secret: string

      The 40 character OAuth app client secret associated with the client ID specified in the URL.

    • fingerprint: string
    • Optional note?: undefined | string

      A note to remind you what the OAuth token is for.

    • Optional note_url?: undefined | string

      A URL to remind you what app the OAuth token is for.

    • Optional scopes?: string[]

      A list of scopes that this authorization is in.

    OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintResponse

    OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintResponse: { app: OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintResponseApp; created_at: string; fingerprint: string; hashed_token: string; id: number; note: string; note_url: string; scopes: Array<string>; token: string; token_last_eight: string; updated_at: string; url: string }

    Type declaration

    OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintResponseApp

    OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintResponseApp: { client_id: string; name: string; url: string }

    Type declaration

    • client_id: string
    • name: string
    • url: string

    OauthAuthorizationsGetOrCreateAuthorizationForAppParams

    OauthAuthorizationsGetOrCreateAuthorizationForAppParams: { client_id: string; client_secret: string; fingerprint?: undefined | string; note?: undefined | string; note_url?: undefined | string; scopes?: string[] }

    Type declaration

    • client_id: string
    • client_secret: string

      The 40 character OAuth app client secret associated with the client ID specified in the URL.

    • Optional fingerprint?: undefined | string

      A unique string to distinguish an authorization from others created for the same client and user. If provided, this API is functionally equivalent to Get-or-create an authorization for a specific app and fingerprint.

    • Optional note?: undefined | string

      A note to remind you what the OAuth token is for.

    • Optional note_url?: undefined | string

      A URL to remind you what app the OAuth token is for.

    • Optional scopes?: string[]

      A list of scopes that this authorization is in.

    OauthAuthorizationsGetOrCreateAuthorizationForAppResponse

    OauthAuthorizationsGetOrCreateAuthorizationForAppResponse: { app: OauthAuthorizationsGetOrCreateAuthorizationForAppResponseApp; created_at: string; fingerprint: string; hashed_token: string; id: number; note: string; note_url: string; scopes: Array<string>; token: string; token_last_eight: string; updated_at: string; url: string }

    Type declaration

    OauthAuthorizationsGetOrCreateAuthorizationForAppResponseApp

    OauthAuthorizationsGetOrCreateAuthorizationForAppResponseApp: { client_id: string; name: string; url: string }

    Type declaration

    • client_id: string
    • name: string
    • url: string

    OauthAuthorizationsListAuthorizationsParams

    OauthAuthorizationsListAuthorizationsParams: { page?: undefined | number; per_page?: undefined | number }

    Type declaration

    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    OauthAuthorizationsListAuthorizationsResponse

    OauthAuthorizationsListAuthorizationsResponse: Array<OauthAuthorizationsListAuthorizationsResponseItem>

    OauthAuthorizationsListAuthorizationsResponseItem

    OauthAuthorizationsListAuthorizationsResponseItem: { app: OauthAuthorizationsListAuthorizationsResponseItemApp; created_at: string; fingerprint: string; hashed_token: string; id: number; note: string; note_url: string; scopes: Array<string>; token: string; token_last_eight: string; updated_at: string; url: string }

    Type declaration

    OauthAuthorizationsListAuthorizationsResponseItemApp

    OauthAuthorizationsListAuthorizationsResponseItemApp: { client_id: string; name: string; url: string }

    Type declaration

    • client_id: string
    • name: string
    • url: string

    OauthAuthorizationsListGrantsParams

    OauthAuthorizationsListGrantsParams: { page?: undefined | number; per_page?: undefined | number }

    Type declaration

    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    OauthAuthorizationsListGrantsResponse

    OauthAuthorizationsListGrantsResponse: Array<OauthAuthorizationsListGrantsResponseItem>

    OauthAuthorizationsListGrantsResponseItem

    OauthAuthorizationsListGrantsResponseItem: { app: OauthAuthorizationsListGrantsResponseItemApp; created_at: string; id: number; scopes: Array<string>; updated_at: string; url: string }

    Type declaration

    OauthAuthorizationsListGrantsResponseItemApp

    OauthAuthorizationsListGrantsResponseItemApp: { client_id: string; name: string; url: string }

    Type declaration

    • client_id: string
    • name: string
    • url: string

    OauthAuthorizationsResetAuthorizationParams

    OauthAuthorizationsResetAuthorizationParams: { access_token: string; client_id: string }

    Type declaration

    • access_token: string
    • client_id: string

    OauthAuthorizationsResetAuthorizationResponse

    OauthAuthorizationsResetAuthorizationResponse: { app: OauthAuthorizationsResetAuthorizationResponseApp; created_at: string; fingerprint: string; hashed_token: string; id: number; note: string; note_url: string; scopes: Array<string>; token: string; token_last_eight: string; updated_at: string; url: string; user: OauthAuthorizationsResetAuthorizationResponseUser }

    Type declaration

    OauthAuthorizationsResetAuthorizationResponseApp

    OauthAuthorizationsResetAuthorizationResponseApp: { client_id: string; name: string; url: string }

    Type declaration

    • client_id: string
    • name: string
    • url: string

    OauthAuthorizationsResetAuthorizationResponseUser

    OauthAuthorizationsResetAuthorizationResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    OauthAuthorizationsRevokeAuthorizationForApplicationParams

    OauthAuthorizationsRevokeAuthorizationForApplicationParams: { access_token: string; client_id: string }

    Type declaration

    • access_token: string
    • client_id: string

    OauthAuthorizationsRevokeGrantForApplicationParams

    OauthAuthorizationsRevokeGrantForApplicationParams: { access_token: string; client_id: string }

    Type declaration

    • access_token: string
    • client_id: string

    OauthAuthorizationsUpdateAuthorizationParams

    OauthAuthorizationsUpdateAuthorizationParams: { add_scopes?: string[]; authorization_id: number; fingerprint?: undefined | string; note?: undefined | string; note_url?: undefined | string; remove_scopes?: string[]; scopes?: string[] }

    Type declaration

    • Optional add_scopes?: string[]

      A list of scopes to add to this authorization.

    • authorization_id: number
    • Optional fingerprint?: undefined | string

      A unique string to distinguish an authorization from others created for the same client ID and user.

    • Optional note?: undefined | string

      A note to remind you what the OAuth token is for. Tokens not associated with a specific OAuth application (i.e. personal access tokens) must have a unique note.

    • Optional note_url?: undefined | string

      A URL to remind you what app the OAuth token is for.

    • Optional remove_scopes?: string[]

      A list of scopes to remove from this authorization.

    • Optional scopes?: string[]

      Replaces the authorization scopes with these.

    OauthAuthorizationsUpdateAuthorizationResponse

    OauthAuthorizationsUpdateAuthorizationResponse: { app: OauthAuthorizationsUpdateAuthorizationResponseApp; created_at: string; fingerprint: string; hashed_token: string; id: number; note: string; note_url: string; scopes: Array<string>; token: string; token_last_eight: string; updated_at: string; url: string }

    Type declaration

    • app: OauthAuthorizationsUpdateAuthorizationResponseApp
    • created_at: string
    • fingerprint: string
    • hashed_token: string
    • id: number
    • note: string
    • note_url: string
    • scopes: Array<string>
    • token: string
    • token_last_eight: string
    • updated_at: string
    • url: string

    OauthAuthorizationsUpdateAuthorizationResponseApp

    OauthAuthorizationsUpdateAuthorizationResponseApp: { client_id: string; name: string; url: string }

    Type declaration

    • client_id: string
    • name: string
    • url: string

    OctokitRequestOptions

    OctokitRequestOptions: { agent?: http.Agent; fetch?: any; signal?: any; timeout?: undefined | number }

    Type declaration

    • [option: string]: any
    • Optional agent?: http.Agent

      Node only. Useful for custom proxy, certificate, or dns lookup.

    • Optional fetch?: any

      Custom replacement for built-in fetch method. Useful for testing or request hooks.

    • Optional signal?: any

      Use an AbortController instance to cancel a request. In node you can only cancel streamed requests.

    • Optional timeout?: undefined | number

      Node only. Request/response timeout in ms, it resets on redirect. 0 to disable (OS limit applies). options.request.signal is recommended instead.

    OrgsAddOrUpdateMembershipParams

    OrgsAddOrUpdateMembershipParams: { org: string; role?: "admin" | "member"; username: string }

    Type declaration

    • org: string
    • Optional role?: "admin" | "member"

      The role to give the user in the organization. Can be one of: * admin - The user will become an owner of the organization. * member - The user will become a non-owner member of the organization.

    • username: string

    OrgsAddOrUpdateMembershipResponse

    OrgsAddOrUpdateMembershipResponse: { organization: OrgsAddOrUpdateMembershipResponseOrganization; organization_url: string; role: string; state: string; url: string; user: OrgsAddOrUpdateMembershipResponseUser }

    Type declaration

    OrgsAddOrUpdateMembershipResponseOrganization

    OrgsAddOrUpdateMembershipResponseOrganization: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

    Type declaration

    • avatar_url: string
    • description: string
    • events_url: string
    • hooks_url: string
    • id: number
    • issues_url: string
    • login: string
    • members_url: string
    • node_id: string
    • public_members_url: string
    • repos_url: string
    • url: string

    OrgsAddOrUpdateMembershipResponseUser

    OrgsAddOrUpdateMembershipResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    OrgsBlockUserParams

    OrgsBlockUserParams: { org: string; username: string }

    Type declaration

    • org: string
    • username: string

    OrgsCheckBlockedUserParams

    OrgsCheckBlockedUserParams: { org: string; username: string }

    Type declaration

    • org: string
    • username: string

    OrgsCheckMembershipParams

    OrgsCheckMembershipParams: { org: string; username: string }

    Type declaration

    • org: string
    • username: string

    OrgsCheckPublicMembershipParams

    OrgsCheckPublicMembershipParams: { org: string; username: string }

    Type declaration

    • org: string
    • username: string

    OrgsConcealMembershipParams

    OrgsConcealMembershipParams: { org: string; username: string }

    Type declaration

    • org: string
    • username: string

    OrgsConvertMemberToOutsideCollaboratorParams

    OrgsConvertMemberToOutsideCollaboratorParams: { org: string; username: string }

    Type declaration

    • org: string
    • username: string

    OrgsConvertMemberToOutsideCollaboratorResponse

    OrgsConvertMemberToOutsideCollaboratorResponse: { documentation_url: string; message: string }

    Type declaration

    • documentation_url: string
    • message: string

    OrgsCreateHookParams

    OrgsCreateHookParams: { active?: undefined | false | true; config: OrgsCreateHookParamsConfig; events?: string[]; name: string; org: string }

    Type declaration

    • Optional active?: undefined | false | true

      Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    • config: OrgsCreateHookParamsConfig

      Key/value pairs to provide settings for this webhook. These are defined below.

    • Optional events?: string[]

      Determines what events the hook is triggered for.

    • name: string

      Must be passed as "web".

    • org: string

    OrgsCreateHookParamsConfig

    OrgsCreateHookParamsConfig: { content_type?: undefined | string; insecure_ssl?: undefined | string; secret?: undefined | string; url: string }

    Type declaration

    • Optional content_type?: undefined | string
    • Optional insecure_ssl?: undefined | string
    • Optional secret?: undefined | string
    • url: string

    OrgsCreateHookResponse

    OrgsCreateHookResponse: { active: boolean; config: OrgsCreateHookResponseConfig; created_at: string; events: Array<string>; id: number; name: string; ping_url: string; updated_at: string; url: string }

    Type declaration

    • active: boolean
    • config: OrgsCreateHookResponseConfig
    • created_at: string
    • events: Array<string>
    • id: number
    • name: string
    • ping_url: string
    • updated_at: string
    • url: string

    OrgsCreateHookResponseConfig

    OrgsCreateHookResponseConfig: { content_type: string; url: string }

    Type declaration

    • content_type: string
    • url: string

    OrgsCreateInvitationParams

    OrgsCreateInvitationParams: { email?: undefined | string; invitee_id?: undefined | number; org: string; role?: "admin" | "direct_member" | "billing_manager"; team_ids?: number[] }

    Type declaration

    • Optional email?: undefined | string

      Required unless you provide invitee_id. Email address of the person you are inviting, which can be an existing GitHub user.

    • Optional invitee_id?: undefined | number

      Required unless you provide email. GitHub user ID for the person you are inviting.

    • org: string
    • Optional role?: "admin" | "direct_member" | "billing_manager"

      Specify role for new member. Can be one of: * admin - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. * direct_member - Non-owner organization members with ability to see other members and join teams by invitation. * billing_manager - Non-owner organization members with ability to manage the billing settings of your organization.

    • Optional team_ids?: number[]

      Specify IDs for the teams you want to invite new members to.

    OrgsCreateInvitationResponse

    OrgsCreateInvitationResponse: { created_at: string; email: string; id: number; invitation_team_url: string; inviter: OrgsCreateInvitationResponseInviter; login: string; role: string; team_count: number }

    Type declaration

    OrgsCreateInvitationResponseInviter

    OrgsCreateInvitationResponseInviter: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    OrgsDeleteHookParams

    OrgsDeleteHookParams: { hook_id: number; org: string }

    Type declaration

    • hook_id: number
    • org: string

    OrgsGetHookParams

    OrgsGetHookParams: { hook_id: number; org: string }

    Type declaration

    • hook_id: number
    • org: string

    OrgsGetHookResponse

    OrgsGetHookResponse: { active: boolean; config: OrgsGetHookResponseConfig; created_at: string; events: Array<string>; id: number; name: string; ping_url: string; updated_at: string; url: string }

    Type declaration

    • active: boolean
    • config: OrgsGetHookResponseConfig
    • created_at: string
    • events: Array<string>
    • id: number
    • name: string
    • ping_url: string
    • updated_at: string
    • url: string

    OrgsGetHookResponseConfig

    OrgsGetHookResponseConfig: { content_type: string; url: string }

    Type declaration

    • content_type: string
    • url: string

    OrgsGetMembershipForAuthenticatedUserParams

    OrgsGetMembershipForAuthenticatedUserParams: { org: string }

    Type declaration

    • org: string

    OrgsGetMembershipForAuthenticatedUserResponse

    OrgsGetMembershipForAuthenticatedUserResponse: { organization: OrgsGetMembershipForAuthenticatedUserResponseOrganization; organization_url: string; role: string; state: string; url: string; user: OrgsGetMembershipForAuthenticatedUserResponseUser }

    Type declaration

    OrgsGetMembershipForAuthenticatedUserResponseOrganization

    OrgsGetMembershipForAuthenticatedUserResponseOrganization: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

    Type declaration

    • avatar_url: string
    • description: string
    • events_url: string
    • hooks_url: string
    • id: number
    • issues_url: string
    • login: string
    • members_url: string
    • node_id: string
    • public_members_url: string
    • repos_url: string
    • url: string

    OrgsGetMembershipForAuthenticatedUserResponseUser

    OrgsGetMembershipForAuthenticatedUserResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    OrgsGetMembershipParams

    OrgsGetMembershipParams: { org: string; username: string }

    Type declaration

    • org: string
    • username: string

    OrgsGetMembershipResponse

    OrgsGetMembershipResponse: { organization: OrgsGetMembershipResponseOrganization; organization_url: string; role: string; state: string; url: string; user: OrgsGetMembershipResponseUser }

    Type declaration

    OrgsGetMembershipResponseOrganization

    OrgsGetMembershipResponseOrganization: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

    Type declaration

    • avatar_url: string
    • description: string
    • events_url: string
    • hooks_url: string
    • id: number
    • issues_url: string
    • login: string
    • members_url: string
    • node_id: string
    • public_members_url: string
    • repos_url: string
    • url: string

    OrgsGetMembershipResponseUser

    OrgsGetMembershipResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    OrgsGetParams

    OrgsGetParams: { org: string }

    Type declaration

    • org: string

    OrgsGetResponse

    OrgsGetResponse: { avatar_url: string; billing_email?: undefined | string; blog: string; collaborators?: undefined | number; company: string; created_at: string; default_repository_permission?: undefined | string; description: string; disk_usage?: undefined | number; email: string; events_url: string; followers: number; following: number; has_organization_projects: boolean; has_repository_projects: boolean; hooks_url: string; html_url: string; id: number; is_verified: boolean; issues_url: string; location: string; login: string; members_allowed_repository_creation_type?: undefined | string; members_can_create_internal_repositories?: undefined | false | true; members_can_create_private_repositories?: undefined | false | true; members_can_create_public_repositories?: undefined | false | true; members_can_create_repositories?: undefined | false | true; members_url: string; name: string; node_id: string; owned_private_repos?: undefined | number; plan: OrgsGetResponsePlan; private_gists?: undefined | number; public_gists: number; public_members_url: string; public_repos: number; repos_url: string; total_private_repos?: undefined | number; two_factor_requirement_enabled?: undefined | false | true; type: string; url: string }

    Type declaration

    • avatar_url: string
    • Optional billing_email?: undefined | string
    • blog: string
    • Optional collaborators?: undefined | number
    • company: string
    • created_at: string
    • Optional default_repository_permission?: undefined | string
    • description: string
    • Optional disk_usage?: undefined | number
    • email: string
    • events_url: string
    • followers: number
    • following: number
    • has_organization_projects: boolean
    • has_repository_projects: boolean
    • hooks_url: string
    • html_url: string
    • id: number
    • is_verified: boolean
    • issues_url: string
    • location: string
    • login: string
    • Optional members_allowed_repository_creation_type?: undefined | string
    • Optional members_can_create_internal_repositories?: undefined | false | true
    • Optional members_can_create_private_repositories?: undefined | false | true
    • Optional members_can_create_public_repositories?: undefined | false | true
    • Optional members_can_create_repositories?: undefined | false | true
    • members_url: string
    • name: string
    • node_id: string
    • Optional owned_private_repos?: undefined | number
    • plan: OrgsGetResponsePlan
    • Optional private_gists?: undefined | number
    • public_gists: number
    • public_members_url: string
    • public_repos: number
    • repos_url: string
    • Optional total_private_repos?: undefined | number
    • Optional two_factor_requirement_enabled?: undefined | false | true
    • type: string
    • url: string

    OrgsGetResponsePlan

    OrgsGetResponsePlan: { filled_seats?: undefined | number; name: string; private_repos: number; seats?: undefined | number; space: number }

    Type declaration

    • Optional filled_seats?: undefined | number
    • name: string
    • private_repos: number
    • Optional seats?: undefined | number
    • space: number

    OrgsListBlockedUsersParams

    OrgsListBlockedUsersParams: { org: string }

    Type declaration

    • org: string

    OrgsListBlockedUsersResponse

    OrgsListBlockedUsersResponse: Array<OrgsListBlockedUsersResponseItem>

    OrgsListBlockedUsersResponseItem

    OrgsListBlockedUsersResponseItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    OrgsListForAuthenticatedUserParams

    OrgsListForAuthenticatedUserParams: { page?: undefined | number; per_page?: undefined | number }

    Type declaration

    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    OrgsListForAuthenticatedUserResponse

    OrgsListForAuthenticatedUserResponse: Array<OrgsListForAuthenticatedUserResponseItem>

    OrgsListForAuthenticatedUserResponseItem

    OrgsListForAuthenticatedUserResponseItem: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

    Type declaration

    • avatar_url: string
    • description: string
    • events_url: string
    • hooks_url: string
    • id: number
    • issues_url: string
    • login: string
    • members_url: string
    • node_id: string
    • public_members_url: string
    • repos_url: string
    • url: string

    OrgsListForUserParams

    OrgsListForUserParams: { page?: undefined | number; per_page?: undefined | number; username: string }

    Type declaration

    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • username: string

    OrgsListForUserResponse

    OrgsListForUserResponse: Array<OrgsListForUserResponseItem>

    OrgsListForUserResponseItem

    OrgsListForUserResponseItem: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

    Type declaration

    • avatar_url: string
    • description: string
    • events_url: string
    • hooks_url: string
    • id: number
    • issues_url: string
    • login: string
    • members_url: string
    • node_id: string
    • public_members_url: string
    • repos_url: string
    • url: string

    OrgsListHooksParams

    OrgsListHooksParams: { org: string; page?: undefined | number; per_page?: undefined | number }

    Type declaration

    • org: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    OrgsListHooksResponse

    OrgsListHooksResponse: Array<OrgsListHooksResponseItem>

    OrgsListHooksResponseItem

    OrgsListHooksResponseItem: { active: boolean; config: OrgsListHooksResponseItemConfig; created_at: string; events: Array<string>; id: number; name: string; ping_url: string; updated_at: string; url: string }

    Type declaration

    • active: boolean
    • config: OrgsListHooksResponseItemConfig
    • created_at: string
    • events: Array<string>
    • id: number
    • name: string
    • ping_url: string
    • updated_at: string
    • url: string

    OrgsListHooksResponseItemConfig

    OrgsListHooksResponseItemConfig: { content_type: string; url: string }

    Type declaration

    • content_type: string
    • url: string

    OrgsListInstallationsParams

    OrgsListInstallationsParams: { org: string; page?: undefined | number; per_page?: undefined | number }

    Type declaration

    • org: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    OrgsListInstallationsResponse

    OrgsListInstallationsResponse: { installations: Array<OrgsListInstallationsResponseInstallationsItem>; total_count: number }

    Type declaration

    OrgsListInstallationsResponseInstallationsItem

    OrgsListInstallationsResponseInstallationsItem: { access_tokens_url: string; account: OrgsListInstallationsResponseInstallationsItemAccount; app_id: number; created_at: string; events: Array<string>; html_url: string; id: number; permissions: OrgsListInstallationsResponseInstallationsItemPermissions; repositories_url: string; repository_selection: string; single_file_name: null; target_id: number; target_type: string; updated_at: string }

    Type declaration

    OrgsListInstallationsResponseInstallationsItemAccount

    OrgsListInstallationsResponseInstallationsItemAccount: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    OrgsListInstallationsResponseInstallationsItemPermissions

    OrgsListInstallationsResponseInstallationsItemPermissions: { deployments: string; metadata: string; pull_requests: string; statuses: string }

    Type declaration

    • deployments: string
    • metadata: string
    • pull_requests: string
    • statuses: string

    OrgsListInvitationTeamsParams

    OrgsListInvitationTeamsParams: { invitation_id: number; org: string; page?: undefined | number; per_page?: undefined | number }

    Type declaration

    • invitation_id: number
    • org: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    OrgsListInvitationTeamsResponse

    OrgsListInvitationTeamsResponse: Array<OrgsListInvitationTeamsResponseItem>

    OrgsListInvitationTeamsResponseItem

    OrgsListInvitationTeamsResponseItem: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: null; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

    Type declaration

    • description: string
    • html_url: string
    • id: number
    • members_url: string
    • name: string
    • node_id: string
    • parent: null
    • permission: string
    • privacy: string
    • repositories_url: string
    • slug: string
    • url: string

    OrgsListMembersParams

    OrgsListMembersParams: { filter?: "2fa_disabled" | "all"; org: string; page?: undefined | number; per_page?: undefined | number; role?: "all" | "admin" | "member" }

    Type declaration

    • Optional filter?: "2fa_disabled" | "all"

      Filter members returned in the list. Can be one of: * 2fa_disabled - Members without two-factor authentication enabled. Available for organization owners. * all - All members the authenticated user can see.

    • org: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • Optional role?: "all" | "admin" | "member"

      Filter members returned by their role. Can be one of: * all - All members of the organization, regardless of role. * admin - Organization owners. * member - Non-owner organization members.

    OrgsListMembersResponse

    OrgsListMembersResponse: Array<OrgsListMembersResponseItem>

    OrgsListMembersResponseItem

    OrgsListMembersResponseItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    OrgsListMembershipsParams

    OrgsListMembershipsParams: { page?: undefined | number; per_page?: undefined | number; state?: "active" | "pending" }

    Type declaration

    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • Optional state?: "active" | "pending"

      Indicates the state of the memberships to return. Can be either active or pending. If not specified, the API returns both active and pending memberships.

    OrgsListMembershipsResponse

    OrgsListMembershipsResponse: Array<OrgsListMembershipsResponseItem>

    OrgsListMembershipsResponseItem

    OrgsListMembershipsResponseItem: { organization: OrgsListMembershipsResponseItemOrganization; organization_url: string; role: string; state: string; url: string; user: OrgsListMembershipsResponseItemUser }

    Type declaration

    OrgsListMembershipsResponseItemOrganization

    OrgsListMembershipsResponseItemOrganization: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

    Type declaration

    • avatar_url: string
    • description: string
    • events_url: string
    • hooks_url: string
    • id: number
    • issues_url: string
    • login: string
    • members_url: string
    • node_id: string
    • public_members_url: string
    • repos_url: string
    • url: string

    OrgsListMembershipsResponseItemUser

    OrgsListMembershipsResponseItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    OrgsListOutsideCollaboratorsParams

    OrgsListOutsideCollaboratorsParams: { filter?: "2fa_disabled" | "all"; org: string; page?: undefined | number; per_page?: undefined | number }

    Type declaration

    • Optional filter?: "2fa_disabled" | "all"

      Filter the list of outside collaborators. Can be one of: * 2fa_disabled: Outside collaborators without two-factor authentication enabled. * all: All outside collaborators.

    • org: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    OrgsListOutsideCollaboratorsResponse

    OrgsListOutsideCollaboratorsResponse: Array<OrgsListOutsideCollaboratorsResponseItem>

    OrgsListOutsideCollaboratorsResponseItem

    OrgsListOutsideCollaboratorsResponseItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    OrgsListParams

    OrgsListParams: { page?: undefined | number; per_page?: undefined | number; since?: undefined | number }

    Type declaration

    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • Optional since?: undefined | number

      The integer ID of the last organization that you've seen.

    OrgsListPendingInvitationsParams

    OrgsListPendingInvitationsParams: { org: string; page?: undefined | number; per_page?: undefined | number }

    Type declaration

    • org: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    OrgsListPendingInvitationsResponse

    OrgsListPendingInvitationsResponse: Array<OrgsListPendingInvitationsResponseItem>

    OrgsListPendingInvitationsResponseItem

    OrgsListPendingInvitationsResponseItem: { created_at: string; email: string; id: number; invitation_team_url: string; inviter: OrgsListPendingInvitationsResponseItemInviter; login: string; role: string; team_count: number }

    Type declaration

    OrgsListPendingInvitationsResponseItemInviter

    OrgsListPendingInvitationsResponseItemInviter: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    OrgsListPublicMembersParams

    OrgsListPublicMembersParams: { org: string; page?: undefined | number; per_page?: undefined | number }

    Type declaration

    • org: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    OrgsListPublicMembersResponse

    OrgsListPublicMembersResponse: Array<OrgsListPublicMembersResponseItem>

    OrgsListPublicMembersResponseItem

    OrgsListPublicMembersResponseItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    OrgsListResponse

    OrgsListResponse: Array<OrgsListResponseItem>

    OrgsListResponseItem

    OrgsListResponseItem: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

    Type declaration

    • avatar_url: string
    • description: string
    • events_url: string
    • hooks_url: string
    • id: number
    • issues_url: string
    • login: string
    • members_url: string
    • node_id: string
    • public_members_url: string
    • repos_url: string
    • url: string

    OrgsPingHookParams

    OrgsPingHookParams: { hook_id: number; org: string }

    Type declaration

    • hook_id: number
    • org: string

    OrgsPublicizeMembershipParams

    OrgsPublicizeMembershipParams: { org: string; username: string }

    Type declaration

    • org: string
    • username: string

    OrgsRemoveMemberParams

    OrgsRemoveMemberParams: { org: string; username: string }

    Type declaration

    • org: string
    • username: string

    OrgsRemoveMembershipParams

    OrgsRemoveMembershipParams: { org: string; username: string }

    Type declaration

    • org: string
    • username: string

    OrgsRemoveOutsideCollaboratorParams

    OrgsRemoveOutsideCollaboratorParams: { org: string; username: string }

    Type declaration

    • org: string
    • username: string

    OrgsRemoveOutsideCollaboratorResponse

    OrgsRemoveOutsideCollaboratorResponse: { documentation_url: string; message: string }

    Type declaration

    • documentation_url: string
    • message: string

    OrgsUnblockUserParams

    OrgsUnblockUserParams: { org: string; username: string }

    Type declaration

    • org: string
    • username: string

    OrgsUpdateHookParams

    OrgsUpdateHookParams: { active?: undefined | false | true; config?: OrgsUpdateHookParamsConfig; events?: string[]; hook_id: number; org: string }

    Type declaration

    • Optional active?: undefined | false | true

      Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    • Optional config?: OrgsUpdateHookParamsConfig

      Key/value pairs to provide settings for this webhook. These are defined below.

    • Optional events?: string[]

      Determines what events the hook is triggered for.

    • hook_id: number
    • org: string

    OrgsUpdateHookParamsConfig

    OrgsUpdateHookParamsConfig: { content_type?: undefined | string; insecure_ssl?: undefined | string; secret?: undefined | string; url: string }

    Type declaration

    • Optional content_type?: undefined | string
    • Optional insecure_ssl?: undefined | string
    • Optional secret?: undefined | string
    • url: string

    OrgsUpdateHookResponse

    OrgsUpdateHookResponse: { active: boolean; config: OrgsUpdateHookResponseConfig; created_at: string; events: Array<string>; id: number; name: string; ping_url: string; updated_at: string; url: string }

    Type declaration

    • active: boolean
    • config: OrgsUpdateHookResponseConfig
    • created_at: string
    • events: Array<string>
    • id: number
    • name: string
    • ping_url: string
    • updated_at: string
    • url: string

    OrgsUpdateHookResponseConfig

    OrgsUpdateHookResponseConfig: { content_type: string; url: string }

    Type declaration

    • content_type: string
    • url: string

    OrgsUpdateMembershipParams

    OrgsUpdateMembershipParams: { org: string; state: "active" }

    Type declaration

    • org: string
    • state: "active"

      The state that the membership should be in. Only "active" will be accepted.

    OrgsUpdateMembershipResponse

    OrgsUpdateMembershipResponse: { organization: OrgsUpdateMembershipResponseOrganization; organization_url: string; role: string; state: string; url: string; user: OrgsUpdateMembershipResponseUser }

    Type declaration

    OrgsUpdateMembershipResponseOrganization

    OrgsUpdateMembershipResponseOrganization: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

    Type declaration

    • avatar_url: string
    • description: string
    • events_url: string
    • hooks_url: string
    • id: number
    • issues_url: string
    • login: string
    • members_url: string
    • node_id: string
    • public_members_url: string
    • repos_url: string
    • url: string

    OrgsUpdateMembershipResponseUser

    OrgsUpdateMembershipResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    OrgsUpdateParams

    OrgsUpdateParams: { billing_email?: undefined | string; company?: undefined | string; default_repository_permission?: "read" | "write" | "admin" | "none"; description?: undefined | string; email?: undefined | string; has_organization_projects?: undefined | false | true; has_repository_projects?: undefined | false | true; location?: undefined | string; members_can_create_internal_repositories?: undefined | false | true; members_can_create_private_repositories?: undefined | false | true; members_can_create_public_repositories?: undefined | false | true; members_can_create_repositories?: undefined | false | true; name?: undefined | string; org: string }

    Type declaration

    • Optional billing_email?: undefined | string

      Billing email address. This address is not publicized.

    • Optional company?: undefined | string

      The company name.

    • Optional default_repository_permission?: "read" | "write" | "admin" | "none"

      Default permission level members have for organization repositories: * read - can pull, but not push to or administer this repository. * write - can pull and push, but not administer this repository. * admin - can pull, push, and administer this repository. * none - no permissions granted by default.

    • Optional description?: undefined | string

      The description of the company.

    • Optional email?: undefined | string

      The publicly visible email address.

    • Optional has_organization_projects?: undefined | false | true

      Toggles whether an organization can use organization projects.

    • Optional has_repository_projects?: undefined | false | true

      Toggles whether repositories that belong to the organization can use repository projects.

    • Optional location?: undefined | string

      The location.

    • Optional members_can_create_internal_repositories?: undefined | false | true

      Toggles whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud. Can be one of: * true - all organization members can create internal repositories. * false - only organization owners can create internal repositories. Default: true. For more information, see "Restricting repository creation in your organization" in the GitHub Help documentation.

    • Optional members_can_create_private_repositories?: undefined | false | true

      Toggles whether organization members can create private repositories, which are visible to organization members with permission. Can be one of: * true - all organization members can create private repositories. * false - only organization owners can create private repositories. Default: true. For more information, see "Restricting repository creation in your organization" in the GitHub Help documentation.

    • Optional members_can_create_public_repositories?: undefined | false | true

      Toggles whether organization members can create public repositories, which are visible to anyone. Can be one of: * true - all organization members can create public repositories. * false - only organization owners can create public repositories. Default: true. For more information, see "Restricting repository creation in your organization" in the GitHub Help documentation.

    • Optional members_can_create_repositories?: undefined | false | true

      Toggles the ability of non-admin organization members to create repositories. Can be one of: * true - all organization members can create repositories. * false - only organization owners can create repositories. Default: true Note: A parameter can override this parameter. See members_allowed_repository_creation_type in this table for details. Note: A parameter can override this parameter. See members_allowed_repository_creation_type in this table for details.

    • Optional name?: undefined | string

      The shorthand name of the company.

    • org: string

    OrgsUpdateParamsDeprecatedMembersAllowedRepositoryCreationType

    OrgsUpdateParamsDeprecatedMembersAllowedRepositoryCreationType: { billing_email?: undefined | string; company?: undefined | string; default_repository_permission?: "read" | "write" | "admin" | "none"; description?: undefined | string; email?: undefined | string; has_organization_projects?: undefined | false | true; has_repository_projects?: undefined | false | true; location?: undefined | string; members_allowed_repository_creation_type?: undefined | string; members_can_create_internal_repositories?: undefined | false | true; members_can_create_private_repositories?: undefined | false | true; members_can_create_public_repositories?: undefined | false | true; members_can_create_repositories?: undefined | false | true; name?: undefined | string; org: string }

    Type declaration

    • Optional billing_email?: undefined | string

      Billing email address. This address is not publicized.

    • Optional company?: undefined | string

      The company name.

    • Optional default_repository_permission?: "read" | "write" | "admin" | "none"

      Default permission level members have for organization repositories: * read - can pull, but not push to or administer this repository. * write - can pull and push, but not administer this repository. * admin - can pull, push, and administer this repository. * none - no permissions granted by default.

    • Optional description?: undefined | string

      The description of the company.

    • Optional email?: undefined | string

      The publicly visible email address.

    • Optional has_organization_projects?: undefined | false | true

      Toggles whether an organization can use organization projects.

    • Optional has_repository_projects?: undefined | false | true

      Toggles whether repositories that belong to the organization can use repository projects.

    • Optional location?: undefined | string

      The location.

    • Optional members_allowed_repository_creation_type?: undefined | string

      Specifies which types of repositories non-admin organization members can create. Can be one of: * all - all organization members can create public and private repositories. * private - members can create private repositories. This option is only available to repositories that are part of an organization on GitHub Enterprise Cloud. * none - only admin members can create repositories. Note: This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in members_can_create_repositories. See this note for details.

      deprecated

      "members_allowed_repository_creation_type" parameter has been deprecated and will be removed in future

    • Optional members_can_create_internal_repositories?: undefined | false | true

      Toggles whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud. Can be one of: * true - all organization members can create internal repositories. * false - only organization owners can create internal repositories. Default: true. For more information, see "Restricting repository creation in your organization" in the GitHub Help documentation.

    • Optional members_can_create_private_repositories?: undefined | false | true

      Toggles whether organization members can create private repositories, which are visible to organization members with permission. Can be one of: * true - all organization members can create private repositories. * false - only organization owners can create private repositories. Default: true. For more information, see "Restricting repository creation in your organization" in the GitHub Help documentation.

    • Optional members_can_create_public_repositories?: undefined | false | true

      Toggles whether organization members can create public repositories, which are visible to anyone. Can be one of: * true - all organization members can create public repositories. * false - only organization owners can create public repositories. Default: true. For more information, see "Restricting repository creation in your organization" in the GitHub Help documentation.

    • Optional members_can_create_repositories?: undefined | false | true

      Toggles the ability of non-admin organization members to create repositories. Can be one of: * true - all organization members can create repositories. * false - only organization owners can create repositories. Default: true Note: A parameter can override this parameter. See members_allowed_repository_creation_type in this table for details. Note: A parameter can override this parameter. See members_allowed_repository_creation_type in this table for details.

    • Optional name?: undefined | string

      The shorthand name of the company.

    • org: string

    OrgsUpdateResponse

    OrgsUpdateResponse: { avatar_url: string; billing_email: string; blog: string; collaborators: number; company: string; created_at: string; default_repository_permission: string; description: string; disk_usage: number; email: string; events_url: string; followers: number; following: number; has_organization_projects: boolean; has_repository_projects: boolean; hooks_url: string; html_url: string; id: number; is_verified: boolean; issues_url: string; location: string; login: string; members_allowed_repository_creation_type: string; members_can_create_internal_repositories: boolean; members_can_create_private_repositories: boolean; members_can_create_public_repositories: boolean; members_can_create_repositories: boolean; members_url: string; name: string; node_id: string; owned_private_repos: number; plan: OrgsUpdateResponsePlan; private_gists: number; public_gists: number; public_members_url: string; public_repos: number; repos_url: string; total_private_repos: number; two_factor_requirement_enabled: boolean; type: string; url: string }

    Type declaration

    • avatar_url: string
    • billing_email: string
    • blog: string
    • collaborators: number
    • company: string
    • created_at: string
    • default_repository_permission: string
    • description: string
    • disk_usage: number
    • email: string
    • events_url: string
    • followers: number
    • following: number
    • has_organization_projects: boolean
    • has_repository_projects: boolean
    • hooks_url: string
    • html_url: string
    • id: number
    • is_verified: boolean
    • issues_url: string
    • location: string
    • login: string
    • members_allowed_repository_creation_type: string
    • members_can_create_internal_repositories: boolean
    • members_can_create_private_repositories: boolean
    • members_can_create_public_repositories: boolean
    • members_can_create_repositories: boolean
    • members_url: string
    • name: string
    • node_id: string
    • owned_private_repos: number
    • plan: OrgsUpdateResponsePlan
    • private_gists: number
    • public_gists: number
    • public_members_url: string
    • public_repos: number
    • repos_url: string
    • total_private_repos: number
    • two_factor_requirement_enabled: boolean
    • type: string
    • url: string

    OrgsUpdateResponsePlan

    OrgsUpdateResponsePlan: { name: string; private_repos: number; space: number }

    Type declaration

    • name: string
    • private_repos: number
    • space: number

    Plugin

    Plugin: (octokit: Octokit, options: Options) => void

    Type declaration

      • (octokit: Octokit, options: Options): void

      • Parameters

        • octokit: Octokit
        • options: Options

        Returns void

    ProjectsAddCollaboratorParams

    ProjectsAddCollaboratorParams: { permission?: "read" | "write" | "admin"; project_id: number; username: string }

    Type declaration

    • Optional permission?: "read" | "write" | "admin"

      The permission to grant the collaborator. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs." Can be one of: * read - can read, but not write to or administer this project. * write - can read and write, but not administer this project. * admin - can read, write and administer this project.

    • project_id: number
    • username: string

    ProjectsCreateCardParams

    ProjectsCreateCardParams: { column_id: number; content_id?: undefined | number; content_type?: undefined | string; note?: undefined | string }

    Type declaration

    • column_id: number
    • Optional content_id?: undefined | number

      The issue or pull request id you want to associate with this card. You can use the List issues for a repository and List pull requests endpoints to find this id. Note: Depending on whether you use the issue id or pull request id, you will need to specify Issue or PullRequest as the content_type.

    • Optional content_type?: undefined | string

      Required if you provide content_id. The type of content you want to associate with this card. Use Issue when content_id is an issue id and use PullRequest when content_id is a pull request id.

    • Optional note?: undefined | string

      The card's note content. Only valid for cards without another type of content, so you must omit when specifying content_id and content_type.

    ProjectsCreateCardResponse

    ProjectsCreateCardResponse: { archived: boolean; column_url: string; content_url: string; created_at: string; creator: ProjectsCreateCardResponseCreator; id: number; node_id: string; note: string; project_url: string; updated_at: string; url: string }

    Type declaration

    • archived: boolean
    • column_url: string
    • content_url: string
    • created_at: string
    • creator: ProjectsCreateCardResponseCreator
    • id: number
    • node_id: string
    • note: string
    • project_url: string
    • updated_at: string
    • url: string

    ProjectsCreateCardResponseCreator

    ProjectsCreateCardResponseCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ProjectsCreateColumnParams

    ProjectsCreateColumnParams: { name: string; project_id: number }

    Type declaration

    • name: string

      The name of the column.

    • project_id: number

    ProjectsCreateColumnResponse

    ProjectsCreateColumnResponse: { cards_url: string; created_at: string; id: number; name: string; node_id: string; project_url: string; updated_at: string; url: string }

    Type declaration

    • cards_url: string
    • created_at: string
    • id: number
    • name: string
    • node_id: string
    • project_url: string
    • updated_at: string
    • url: string

    ProjectsCreateForAuthenticatedUserParams

    ProjectsCreateForAuthenticatedUserParams: { body?: undefined | string; name: string }

    Type declaration

    • Optional body?: undefined | string

      The description of the project.

    • name: string

      The name of the project.

    ProjectsCreateForAuthenticatedUserResponse

    ProjectsCreateForAuthenticatedUserResponse: { body: string; columns_url: string; created_at: string; creator: ProjectsCreateForAuthenticatedUserResponseCreator; html_url: string; id: number; name: string; node_id: string; number: number; owner_url: string; state: string; updated_at: string; url: string }

    Type declaration

    • body: string
    • columns_url: string
    • created_at: string
    • creator: ProjectsCreateForAuthenticatedUserResponseCreator
    • html_url: string
    • id: number
    • name: string
    • node_id: string
    • number: number
    • owner_url: string
    • state: string
    • updated_at: string
    • url: string

    ProjectsCreateForAuthenticatedUserResponseCreator

    ProjectsCreateForAuthenticatedUserResponseCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ProjectsCreateForOrgParams

    ProjectsCreateForOrgParams: { body?: undefined | string; name: string; org: string }

    Type declaration

    • Optional body?: undefined | string

      The description of the project.

    • name: string

      The name of the project.

    • org: string

    ProjectsCreateForOrgResponse

    ProjectsCreateForOrgResponse: { body: string; columns_url: string; created_at: string; creator: ProjectsCreateForOrgResponseCreator; html_url: string; id: number; name: string; node_id: string; number: number; owner_url: string; state: string; updated_at: string; url: string }

    Type declaration

    • body: string
    • columns_url: string
    • created_at: string
    • creator: ProjectsCreateForOrgResponseCreator
    • html_url: string
    • id: number
    • name: string
    • node_id: string
    • number: number
    • owner_url: string
    • state: string
    • updated_at: string
    • url: string

    ProjectsCreateForOrgResponseCreator

    ProjectsCreateForOrgResponseCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ProjectsCreateForRepoParams

    ProjectsCreateForRepoParams: { body?: undefined | string; name: string; owner: string; repo: string }

    Type declaration

    • Optional body?: undefined | string

      The description of the project.

    • name: string

      The name of the project.

    • owner: string
    • repo: string

    ProjectsCreateForRepoResponse

    ProjectsCreateForRepoResponse: { body: string; columns_url: string; created_at: string; creator: ProjectsCreateForRepoResponseCreator; html_url: string; id: number; name: string; node_id: string; number: number; owner_url: string; state: string; updated_at: string; url: string }

    Type declaration

    • body: string
    • columns_url: string
    • created_at: string
    • creator: ProjectsCreateForRepoResponseCreator
    • html_url: string
    • id: number
    • name: string
    • node_id: string
    • number: number
    • owner_url: string
    • state: string
    • updated_at: string
    • url: string

    ProjectsCreateForRepoResponseCreator

    ProjectsCreateForRepoResponseCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ProjectsDeleteCardParams

    ProjectsDeleteCardParams: { card_id: number }

    Type declaration

    • card_id: number

    ProjectsDeleteColumnParams

    ProjectsDeleteColumnParams: { column_id: number }

    Type declaration

    • column_id: number

    ProjectsDeleteParams

    ProjectsDeleteParams: { project_id: number }

    Type declaration

    • project_id: number

    ProjectsGetCardParams

    ProjectsGetCardParams: { card_id: number }

    Type declaration

    • card_id: number

    ProjectsGetCardResponse

    ProjectsGetCardResponse: { archived: boolean; column_url: string; content_url: string; created_at: string; creator: ProjectsGetCardResponseCreator; id: number; node_id: string; note: string; project_url: string; updated_at: string; url: string }

    Type declaration

    • archived: boolean
    • column_url: string
    • content_url: string
    • created_at: string
    • creator: ProjectsGetCardResponseCreator
    • id: number
    • node_id: string
    • note: string
    • project_url: string
    • updated_at: string
    • url: string

    ProjectsGetCardResponseCreator

    ProjectsGetCardResponseCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ProjectsGetColumnParams

    ProjectsGetColumnParams: { column_id: number }

    Type declaration

    • column_id: number

    ProjectsGetColumnResponse

    ProjectsGetColumnResponse: { cards_url: string; created_at: string; id: number; name: string; node_id: string; project_url: string; updated_at: string; url: string }

    Type declaration

    • cards_url: string
    • created_at: string
    • id: number
    • name: string
    • node_id: string
    • project_url: string
    • updated_at: string
    • url: string

    ProjectsGetParams

    ProjectsGetParams: { project_id: number }

    Type declaration

    • project_id: number

    ProjectsGetResponse

    ProjectsGetResponse: { body: string; columns_url: string; created_at: string; creator: ProjectsGetResponseCreator; html_url: string; id: number; name: string; node_id: string; number: number; owner_url: string; state: string; updated_at: string; url: string }

    Type declaration

    • body: string
    • columns_url: string
    • created_at: string
    • creator: ProjectsGetResponseCreator
    • html_url: string
    • id: number
    • name: string
    • node_id: string
    • number: number
    • owner_url: string
    • state: string
    • updated_at: string
    • url: string

    ProjectsGetResponseCreator

    ProjectsGetResponseCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ProjectsListCardsParams

    ProjectsListCardsParams: { archived_state?: "all" | "archived" | "not_archived"; column_id: number; page?: undefined | number; per_page?: undefined | number }

    Type declaration

    • Optional archived_state?: "all" | "archived" | "not_archived"

      Filters the project cards that are returned by the card's state. Can be one of all,archived, or not_archived.

    • column_id: number
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    ProjectsListCardsResponse

    ProjectsListCardsResponse: Array<ProjectsListCardsResponseItem>

    ProjectsListCardsResponseItem

    ProjectsListCardsResponseItem: { archived: boolean; column_url: string; content_url: string; created_at: string; creator: ProjectsListCardsResponseItemCreator; id: number; node_id: string; note: string; project_url: string; updated_at: string; url: string }

    Type declaration

    • archived: boolean
    • column_url: string
    • content_url: string
    • created_at: string
    • creator: ProjectsListCardsResponseItemCreator
    • id: number
    • node_id: string
    • note: string
    • project_url: string
    • updated_at: string
    • url: string

    ProjectsListCardsResponseItemCreator

    ProjectsListCardsResponseItemCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ProjectsListCollaboratorsParams

    ProjectsListCollaboratorsParams: { affiliation?: "outside" | "direct" | "all"; page?: undefined | number; per_page?: undefined | number; project_id: number }

    Type declaration

    • Optional affiliation?: "outside" | "direct" | "all"

      Filters the collaborators by their affiliation. Can be one of: * outside: Outside collaborators of a project that are not a member of the project's organization. * direct: Collaborators with permissions to a project, regardless of organization membership status. * all: All collaborators the authenticated user can see.

    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • project_id: number

    ProjectsListCollaboratorsResponse

    ProjectsListCollaboratorsResponse: Array<ProjectsListCollaboratorsResponseItem>

    ProjectsListCollaboratorsResponseItem

    ProjectsListCollaboratorsResponseItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ProjectsListColumnsParams

    ProjectsListColumnsParams: { page?: undefined | number; per_page?: undefined | number; project_id: number }

    Type declaration

    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • project_id: number

    ProjectsListColumnsResponse

    ProjectsListColumnsResponse: Array<ProjectsListColumnsResponseItem>

    ProjectsListColumnsResponseItem

    ProjectsListColumnsResponseItem: { cards_url: string; created_at: string; id: number; name: string; node_id: string; project_url: string; updated_at: string; url: string }

    Type declaration

    • cards_url: string
    • created_at: string
    • id: number
    • name: string
    • node_id: string
    • project_url: string
    • updated_at: string
    • url: string

    ProjectsListForOrgParams

    ProjectsListForOrgParams: { org: string; page?: undefined | number; per_page?: undefined | number; state?: "open" | "closed" | "all" }

    Type declaration

    • org: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • Optional state?: "open" | "closed" | "all"

      Indicates the state of the projects to return. Can be either open, closed, or all.

    ProjectsListForOrgResponse

    ProjectsListForOrgResponse: Array<ProjectsListForOrgResponseItem>

    ProjectsListForOrgResponseItem

    ProjectsListForOrgResponseItem: { body: string; columns_url: string; created_at: string; creator: ProjectsListForOrgResponseItemCreator; html_url: string; id: number; name: string; node_id: string; number: number; owner_url: string; state: string; updated_at: string; url: string }

    Type declaration

    • body: string
    • columns_url: string
    • created_at: string
    • creator: ProjectsListForOrgResponseItemCreator
    • html_url: string
    • id: number
    • name: string
    • node_id: string
    • number: number
    • owner_url: string
    • state: string
    • updated_at: string
    • url: string

    ProjectsListForOrgResponseItemCreator

    ProjectsListForOrgResponseItemCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ProjectsListForRepoParams

    ProjectsListForRepoParams: { owner: string; page?: undefined | number; per_page?: undefined | number; repo: string; state?: "open" | "closed" | "all" }

    Type declaration

    • owner: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • repo: string
    • Optional state?: "open" | "closed" | "all"

      Indicates the state of the projects to return. Can be either open, closed, or all.

    ProjectsListForRepoResponse

    ProjectsListForRepoResponse: Array<ProjectsListForRepoResponseItem>

    ProjectsListForRepoResponseItem

    ProjectsListForRepoResponseItem: { body: string; columns_url: string; created_at: string; creator: ProjectsListForRepoResponseItemCreator; html_url: string; id: number; name: string; node_id: string; number: number; owner_url: string; state: string; updated_at: string; url: string }

    Type declaration

    • body: string
    • columns_url: string
    • created_at: string
    • creator: ProjectsListForRepoResponseItemCreator
    • html_url: string
    • id: number
    • name: string
    • node_id: string
    • number: number
    • owner_url: string
    • state: string
    • updated_at: string
    • url: string

    ProjectsListForRepoResponseItemCreator

    ProjectsListForRepoResponseItemCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ProjectsListForUserParams

    ProjectsListForUserParams: { page?: undefined | number; per_page?: undefined | number; state?: "open" | "closed" | "all"; username: string }

    Type declaration

    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • Optional state?: "open" | "closed" | "all"

      Indicates the state of the projects to return. Can be either open, closed, or all.

    • username: string

    ProjectsListForUserResponse

    ProjectsListForUserResponse: Array<ProjectsListForUserResponseItem>

    ProjectsListForUserResponseItem

    ProjectsListForUserResponseItem: { body: string; columns_url: string; created_at: string; creator: ProjectsListForUserResponseItemCreator; html_url: string; id: number; name: string; node_id: string; number: number; owner_url: string; state: string; updated_at: string; url: string }

    Type declaration

    • body: string
    • columns_url: string
    • created_at: string
    • creator: ProjectsListForUserResponseItemCreator
    • html_url: string
    • id: number
    • name: string
    • node_id: string
    • number: number
    • owner_url: string
    • state: string
    • updated_at: string
    • url: string

    ProjectsListForUserResponseItemCreator

    ProjectsListForUserResponseItemCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ProjectsMoveCardParams

    ProjectsMoveCardParams: { card_id: number; column_id?: undefined | number; position: string }

    Type declaration

    • card_id: number
    • Optional column_id?: undefined | number

      The id value of a column in the same project.

    • position: string

      Can be one of top, bottom, or after:<card_id>, where <card_id> is the id value of a card in the same column, or in the new column specified by column_id.

    ProjectsMoveColumnParams

    ProjectsMoveColumnParams: { column_id: number; position: string }

    Type declaration

    • column_id: number
    • position: string

      Can be one of first, last, or after:<column_id>, where <column_id> is the id value of a column in the same project.

    ProjectsRemoveCollaboratorParams

    ProjectsRemoveCollaboratorParams: { project_id: number; username: string }

    Type declaration

    • project_id: number
    • username: string

    ProjectsReviewUserPermissionLevelParams

    ProjectsReviewUserPermissionLevelParams: { project_id: number; username: string }

    Type declaration

    • project_id: number
    • username: string

    ProjectsReviewUserPermissionLevelResponse

    ProjectsReviewUserPermissionLevelResponse: { permission: string; user: ProjectsReviewUserPermissionLevelResponseUser }

    Type declaration

    ProjectsReviewUserPermissionLevelResponseUser

    ProjectsReviewUserPermissionLevelResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ProjectsUpdateCardParams

    ProjectsUpdateCardParams: { archived?: undefined | false | true; card_id: number; note?: undefined | string }

    Type declaration

    • Optional archived?: undefined | false | true

      Use true to archive a project card. Specify false if you need to restore a previously archived project card.

    • card_id: number
    • Optional note?: undefined | string

      The card's note content. Only valid for cards without another type of content, so this cannot be specified if the card already has a content_id and content_type.

    ProjectsUpdateCardResponse

    ProjectsUpdateCardResponse: { archived: boolean; column_url: string; content_url: string; created_at: string; creator: ProjectsUpdateCardResponseCreator; id: number; node_id: string; note: string; project_url: string; updated_at: string; url: string }

    Type declaration

    • archived: boolean
    • column_url: string
    • content_url: string
    • created_at: string
    • creator: ProjectsUpdateCardResponseCreator
    • id: number
    • node_id: string
    • note: string
    • project_url: string
    • updated_at: string
    • url: string

    ProjectsUpdateCardResponseCreator

    ProjectsUpdateCardResponseCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ProjectsUpdateColumnParams

    ProjectsUpdateColumnParams: { column_id: number; name: string }

    Type declaration

    • column_id: number
    • name: string

      The new name of the column.

    ProjectsUpdateColumnResponse

    ProjectsUpdateColumnResponse: { cards_url: string; created_at: string; id: number; name: string; node_id: string; project_url: string; updated_at: string; url: string }

    Type declaration

    • cards_url: string
    • created_at: string
    • id: number
    • name: string
    • node_id: string
    • project_url: string
    • updated_at: string
    • url: string

    ProjectsUpdateParams

    ProjectsUpdateParams: { body?: undefined | string; name?: undefined | string; organization_permission?: undefined | string; private?: undefined | false | true; project_id: number; state?: "open" | "closed" }

    Type declaration

    • Optional body?: undefined | string

      The description of the project.

    • Optional name?: undefined | string

      The name of the project.

    • Optional organization_permission?: undefined | string

      The permission level that determines whether all members of the project's organization can see and/or make changes to the project. Setting organization_permission is only available for organization projects. If an organization member belongs to a team with a higher level of access or is a collaborator with a higher level of access, their permission level is not lowered by organization_permission. For information on changing access for a team or collaborator, see Add or update team project or Add user as a collaborator.

      Note: Updating a project's organization_permission requires admin access to the project.

      Can be one of: * read - Organization members can read, but not write to or administer this project. * write - Organization members can read and write, but not administer this project. * admin - Organization members can read, write and administer this project. * none - Organization members can only see this project if it is public.

    • Optional private?: undefined | false | true

      Sets the visibility of a project board. Setting private is only available for organization and user projects. Note: Updating a project's visibility requires admin access to the project.

      Can be one of: * false - Anyone can see the project. * true - Only the user can view a project board created on a user account. Organization members with the appropriate organization_permission can see project boards in an organization account.

    • project_id: number
    • Optional state?: "open" | "closed"

      State of the project. Either open or closed.

    ProjectsUpdateResponse

    ProjectsUpdateResponse: { body: string; columns_url: string; created_at: string; creator: ProjectsUpdateResponseCreator; html_url: string; id: number; name: string; node_id: string; number: number; owner_url: string; state: string; updated_at: string; url: string }

    Type declaration

    • body: string
    • columns_url: string
    • created_at: string
    • creator: ProjectsUpdateResponseCreator
    • html_url: string
    • id: number
    • name: string
    • node_id: string
    • number: number
    • owner_url: string
    • state: string
    • updated_at: string
    • url: string

    ProjectsUpdateResponseCreator

    ProjectsUpdateResponseCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsCheckIfMergedParams

    PullsCheckIfMergedParams: { owner: string; pull_number: number; repo: string }

    Type declaration

    • owner: string
    • pull_number: number
    • repo: string

    PullsCheckIfMergedParamsDeprecatedNumber

    PullsCheckIfMergedParamsDeprecatedNumber: { number: number; owner: string; repo: string }

    Type declaration

    • number: number
      deprecated

      "number" parameter renamed to "pull_number"

    • owner: string
    • repo: string

    PullsCreateCommentParams

    PullsCreateCommentParams: { body: string; commit_id: string; line?: undefined | number; owner: string; path: string; position?: undefined | number; pull_number: number; repo: string; side?: "LEFT" | "RIGHT"; start_line?: undefined | number; start_side?: "LEFT" | "RIGHT" | "side" }

    Type declaration

    • body: string

      The text of the review comment.

    • commit_id: string

      The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the position.

    • Optional line?: undefined | number

      Required with comfort-fade preview. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

    • owner: string
    • path: string

      The relative path to the file that necessitates a comment.

    • Optional position?: undefined | number

      Required without comfort-fade preview. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

    • pull_number: number
    • repo: string
    • Optional side?: "LEFT" | "RIGHT"

      Required with comfort-fade preview. In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "Diff view options" in the GitHub Help documentation.

    • Optional start_line?: undefined | number

      Required when using multi-line comments. To create multi-line comments, you must use the comfort-fade preview header. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "Commenting on a pull request" in the GitHub Help documentation.

    • Optional start_side?: "LEFT" | "RIGHT" | "side"

      Required when using multi-line comments. To create multi-line comments, you must use the comfort-fade preview header. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see "Commenting on a pull request" in the GitHub Help documentation. See side in this table for additional context.

    PullsCreateCommentParamsDeprecatedInReplyTo

    PullsCreateCommentParamsDeprecatedInReplyTo: { body: string; commit_id: string; in_reply_to?: undefined | number; line?: undefined | number; owner: string; path: string; position?: undefined | number; pull_number: number; repo: string; side?: "LEFT" | "RIGHT"; start_line?: undefined | number; start_side?: "LEFT" | "RIGHT" | "side" }

    Type declaration

    • body: string

      The text of the review comment.

    • commit_id: string

      The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the position.

    • Optional in_reply_to?: undefined | number

      The comment ID to reply to. Note: This must be the ID of a top-level comment, not a reply to that comment. Replies to replies are not supported.

      deprecated

      "in_reply_to" parameter has been deprecated and will be removed in future

    • Optional line?: undefined | number

      Required with comfort-fade preview. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

    • owner: string
    • path: string

      The relative path to the file that necessitates a comment.

    • Optional position?: undefined | number

      Required without comfort-fade preview. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

    • pull_number: number
    • repo: string
    • Optional side?: "LEFT" | "RIGHT"

      Required with comfort-fade preview. In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "Diff view options" in the GitHub Help documentation.

    • Optional start_line?: undefined | number

      Required when using multi-line comments. To create multi-line comments, you must use the comfort-fade preview header. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "Commenting on a pull request" in the GitHub Help documentation.

    • Optional start_side?: "LEFT" | "RIGHT" | "side"

      Required when using multi-line comments. To create multi-line comments, you must use the comfort-fade preview header. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see "Commenting on a pull request" in the GitHub Help documentation. See side in this table for additional context.

    PullsCreateCommentParamsDeprecatedNumber

    PullsCreateCommentParamsDeprecatedNumber: { body: string; commit_id: string; line?: undefined | number; number: number; owner: string; path: string; position?: undefined | number; repo: string; side?: "LEFT" | "RIGHT"; start_line?: undefined | number; start_side?: "LEFT" | "RIGHT" | "side" }

    Type declaration

    • body: string

      The text of the review comment.

    • commit_id: string

      The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the position.

    • Optional line?: undefined | number

      Required with comfort-fade preview. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

    • number: number
      deprecated

      "number" parameter renamed to "pull_number"

    • owner: string
    • path: string

      The relative path to the file that necessitates a comment.

    • Optional position?: undefined | number

      Required without comfort-fade preview. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

    • repo: string
    • Optional side?: "LEFT" | "RIGHT"

      Required with comfort-fade preview. In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "Diff view options" in the GitHub Help documentation.

    • Optional start_line?: undefined | number

      Required when using multi-line comments. To create multi-line comments, you must use the comfort-fade preview header. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "Commenting on a pull request" in the GitHub Help documentation.

    • Optional start_side?: "LEFT" | "RIGHT" | "side"

      Required when using multi-line comments. To create multi-line comments, you must use the comfort-fade preview header. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see "Commenting on a pull request" in the GitHub Help documentation. See side in this table for additional context.

    PullsCreateCommentReplyParams

    PullsCreateCommentReplyParams: { body: string; commit_id: string; line?: undefined | number; owner: string; path: string; position?: undefined | number; pull_number: number; repo: string; side?: "LEFT" | "RIGHT"; start_line?: undefined | number; start_side?: "LEFT" | "RIGHT" | "side" }

    Type declaration

    • body: string

      The text of the review comment.

    • commit_id: string

      The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the position.

    • Optional line?: undefined | number

      Required with comfort-fade preview. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

    • owner: string
    • path: string

      The relative path to the file that necessitates a comment.

    • Optional position?: undefined | number

      Required without comfort-fade preview. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

    • pull_number: number
    • repo: string
    • Optional side?: "LEFT" | "RIGHT"

      Required with comfort-fade preview. In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "Diff view options" in the GitHub Help documentation.

    • Optional start_line?: undefined | number

      Required when using multi-line comments. To create multi-line comments, you must use the comfort-fade preview header. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "Commenting on a pull request" in the GitHub Help documentation.

    • Optional start_side?: "LEFT" | "RIGHT" | "side"

      Required when using multi-line comments. To create multi-line comments, you must use the comfort-fade preview header. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see "Commenting on a pull request" in the GitHub Help documentation. See side in this table for additional context.

    PullsCreateCommentReplyParamsDeprecatedInReplyTo

    PullsCreateCommentReplyParamsDeprecatedInReplyTo: { body: string; commit_id: string; in_reply_to?: undefined | number; line?: undefined | number; owner: string; path: string; position?: undefined | number; pull_number: number; repo: string; side?: "LEFT" | "RIGHT"; start_line?: undefined | number; start_side?: "LEFT" | "RIGHT" | "side" }

    Type declaration

    • body: string

      The text of the review comment.

    • commit_id: string

      The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the position.

    • Optional in_reply_to?: undefined | number

      The comment ID to reply to. Note: This must be the ID of a top-level comment, not a reply to that comment. Replies to replies are not supported.

      deprecated

      "in_reply_to" parameter has been deprecated and will be removed in future

    • Optional line?: undefined | number

      Required with comfort-fade preview. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

    • owner: string
    • path: string

      The relative path to the file that necessitates a comment.

    • Optional position?: undefined | number

      Required without comfort-fade preview. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

    • pull_number: number
    • repo: string
    • Optional side?: "LEFT" | "RIGHT"

      Required with comfort-fade preview. In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "Diff view options" in the GitHub Help documentation.

    • Optional start_line?: undefined | number

      Required when using multi-line comments. To create multi-line comments, you must use the comfort-fade preview header. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "Commenting on a pull request" in the GitHub Help documentation.

    • Optional start_side?: "LEFT" | "RIGHT" | "side"

      Required when using multi-line comments. To create multi-line comments, you must use the comfort-fade preview header. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see "Commenting on a pull request" in the GitHub Help documentation. See side in this table for additional context.

    PullsCreateCommentReplyParamsDeprecatedNumber

    PullsCreateCommentReplyParamsDeprecatedNumber: { body: string; commit_id: string; line?: undefined | number; number: number; owner: string; path: string; position?: undefined | number; repo: string; side?: "LEFT" | "RIGHT"; start_line?: undefined | number; start_side?: "LEFT" | "RIGHT" | "side" }

    Type declaration

    • body: string

      The text of the review comment.

    • commit_id: string

      The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the position.

    • Optional line?: undefined | number

      Required with comfort-fade preview. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

    • number: number
      deprecated

      "number" parameter renamed to "pull_number"

    • owner: string
    • path: string

      The relative path to the file that necessitates a comment.

    • Optional position?: undefined | number

      Required without comfort-fade preview. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

    • repo: string
    • Optional side?: "LEFT" | "RIGHT"

      Required with comfort-fade preview. In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "Diff view options" in the GitHub Help documentation.

    • Optional start_line?: undefined | number

      Required when using multi-line comments. To create multi-line comments, you must use the comfort-fade preview header. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "Commenting on a pull request" in the GitHub Help documentation.

    • Optional start_side?: "LEFT" | "RIGHT" | "side"

      Required when using multi-line comments. To create multi-line comments, you must use the comfort-fade preview header. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see "Commenting on a pull request" in the GitHub Help documentation. See side in this table for additional context.

    PullsCreateCommentReplyResponse

    PullsCreateCommentReplyResponse: { _links: PullsCreateCommentReplyResponseLinks; author_association: string; body: string; commit_id: string; created_at: string; diff_hunk: string; html_url: string; id: number; in_reply_to_id: number; line: number; node_id: string; original_commit_id: string; original_line: number; original_position: number; original_start_line: number; path: string; position: number; pull_request_review_id: number; pull_request_url: string; side: string; start_line: number; start_side: string; updated_at: string; url: string; user: PullsCreateCommentReplyResponseUser }

    Type declaration

    • _links: PullsCreateCommentReplyResponseLinks
    • author_association: string
    • body: string
    • commit_id: string
    • created_at: string
    • diff_hunk: string
    • html_url: string
    • id: number
    • in_reply_to_id: number
    • line: number
    • node_id: string
    • original_commit_id: string
    • original_line: number
    • original_position: number
    • original_start_line: number
    • path: string
    • position: number
    • pull_request_review_id: number
    • pull_request_url: string
    • side: string
    • start_line: number
    • start_side: string
    • updated_at: string
    • url: string
    • user: PullsCreateCommentReplyResponseUser

    PullsCreateCommentReplyResponseLinks

    PullsCreateCommentReplyResponseLinks: { html: PullsCreateCommentReplyResponseLinksHtml; pull_request: PullsCreateCommentReplyResponseLinksPullRequest; self: PullsCreateCommentReplyResponseLinksSelf }

    Type declaration

    PullsCreateCommentReplyResponseLinksHtml

    PullsCreateCommentReplyResponseLinksHtml: { href: string }

    Type declaration

    • href: string

    PullsCreateCommentReplyResponseLinksPullRequest

    PullsCreateCommentReplyResponseLinksPullRequest: { href: string }

    Type declaration

    • href: string

    PullsCreateCommentReplyResponseLinksSelf

    PullsCreateCommentReplyResponseLinksSelf: { href: string }

    Type declaration

    • href: string

    PullsCreateCommentReplyResponseUser

    PullsCreateCommentReplyResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsCreateCommentResponse

    PullsCreateCommentResponse: { _links: PullsCreateCommentResponseLinks; author_association: string; body: string; commit_id: string; created_at: string; diff_hunk: string; html_url: string; id: number; in_reply_to_id: number; line: number; node_id: string; original_commit_id: string; original_line: number; original_position: number; original_start_line: number; path: string; position: number; pull_request_review_id: number; pull_request_url: string; side: string; start_line: number; start_side: string; updated_at: string; url: string; user: PullsCreateCommentResponseUser }

    Type declaration

    • _links: PullsCreateCommentResponseLinks
    • author_association: string
    • body: string
    • commit_id: string
    • created_at: string
    • diff_hunk: string
    • html_url: string
    • id: number
    • in_reply_to_id: number
    • line: number
    • node_id: string
    • original_commit_id: string
    • original_line: number
    • original_position: number
    • original_start_line: number
    • path: string
    • position: number
    • pull_request_review_id: number
    • pull_request_url: string
    • side: string
    • start_line: number
    • start_side: string
    • updated_at: string
    • url: string
    • user: PullsCreateCommentResponseUser

    PullsCreateCommentResponseLinks

    PullsCreateCommentResponseLinks: { html: PullsCreateCommentResponseLinksHtml; pull_request: PullsCreateCommentResponseLinksPullRequest; self: PullsCreateCommentResponseLinksSelf }

    Type declaration

    PullsCreateCommentResponseLinksHtml

    PullsCreateCommentResponseLinksHtml: { href: string }

    Type declaration

    • href: string

    PullsCreateCommentResponseLinksPullRequest

    PullsCreateCommentResponseLinksPullRequest: { href: string }

    Type declaration

    • href: string

    PullsCreateCommentResponseLinksSelf

    PullsCreateCommentResponseLinksSelf: { href: string }

    Type declaration

    • href: string

    PullsCreateCommentResponseUser

    PullsCreateCommentResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsCreateFromIssueParams

    PullsCreateFromIssueParams: { base: string; draft?: undefined | false | true; head: string; issue: number; maintainer_can_modify?: undefined | false | true; owner: string; repo: string }

    Type declaration

    • base: string
    • Optional draft?: undefined | false | true
    • head: string
    • issue: number
    • Optional maintainer_can_modify?: undefined | false | true
    • owner: string
    • repo: string

    PullsCreateFromIssueResponse

    PullsCreateFromIssueResponse: { _links: PullsCreateFromIssueResponseLinks; active_lock_reason: string; additions: number; assignee: PullsCreateFromIssueResponseAssignee; assignees: Array<PullsCreateFromIssueResponseAssigneesItem>; author_association: string; base: PullsCreateFromIssueResponseBase; body: string; changed_files: number; closed_at: string; comments: number; comments_url: string; commits: number; commits_url: string; created_at: string; deletions: number; diff_url: string; draft: boolean; head: PullsCreateFromIssueResponseHead; html_url: string; id: number; issue_url: string; labels: Array<PullsCreateFromIssueResponseLabelsItem>; locked: boolean; maintainer_can_modify: boolean; merge_commit_sha: string; mergeable: boolean; mergeable_state: string; merged: boolean; merged_at: string; merged_by: PullsCreateFromIssueResponseMergedBy; milestone: PullsCreateFromIssueResponseMilestone; node_id: string; number: number; patch_url: string; rebaseable: boolean; requested_reviewers: Array<PullsCreateFromIssueResponseRequestedReviewersItem>; requested_teams: Array<PullsCreateFromIssueResponseRequestedTeamsItem>; review_comment_url: string; review_comments: number; review_comments_url: string; state: string; statuses_url: string; title: string; updated_at: string; url: string; user: PullsCreateFromIssueResponseUser }

    Type declaration

    PullsCreateFromIssueResponseAssignee

    PullsCreateFromIssueResponseAssignee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsCreateFromIssueResponseAssigneesItem

    PullsCreateFromIssueResponseAssigneesItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsCreateFromIssueResponseBase

    PullsCreateFromIssueResponseBase: { label: string; ref: string; repo: PullsCreateFromIssueResponseBaseRepo; sha: string; user: PullsCreateFromIssueResponseBaseUser }

    Type declaration

    PullsCreateFromIssueResponseBaseRepo

    PullsCreateFromIssueResponseBaseRepo: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: PullsCreateFromIssueResponseBaseRepoOwner; permissions: PullsCreateFromIssueResponseBaseRepoPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

    Type declaration

    • allow_merge_commit: boolean
    • allow_rebase_merge: boolean
    • allow_squash_merge: boolean
    • archive_url: string
    • archived: boolean
    • assignees_url: string
    • blobs_url: string
    • branches_url: string
    • clone_url: string
    • collaborators_url: string
    • comments_url: string
    • commits_url: string
    • compare_url: string
    • contents_url: string
    • contributors_url: string
    • created_at: string
    • default_branch: string
    • deployments_url: string
    • description: string
    • disabled: boolean
    • downloads_url: string
    • events_url: string
    • fork: boolean
    • forks_count: number
    • forks_url: string
    • full_name: string
    • git_commits_url: string
    • git_refs_url: string
    • git_tags_url: string
    • git_url: string
    • has_downloads: boolean
    • has_issues: boolean
    • has_pages: boolean
    • has_projects: boolean
    • has_wiki: boolean
    • homepage: string
    • hooks_url: string
    • html_url: string
    • id: number
    • is_template: boolean
    • issue_comment_url: string
    • issue_events_url: string
    • issues_url: string
    • keys_url: string
    • labels_url: string
    • language: null
    • languages_url: string
    • merges_url: string
    • milestones_url: string
    • mirror_url: string
    • name: string
    • network_count: number
    • node_id: string
    • notifications_url: string
    • open_issues_count: number
    • owner: PullsCreateFromIssueResponseBaseRepoOwner
    • permissions: PullsCreateFromIssueResponseBaseRepoPermissions
    • private: boolean
    • pulls_url: string
    • pushed_at: string
    • releases_url: string
    • size: number
    • ssh_url: string
    • stargazers_count: number
    • stargazers_url: string
    • statuses_url: string
    • subscribers_count: number
    • subscribers_url: string
    • subscription_url: string
    • svn_url: string
    • tags_url: string
    • teams_url: string
    • temp_clone_token: string
    • template_repository: null
    • topics: Array<string>
    • trees_url: string
    • updated_at: string
    • url: string
    • visibility: string
    • watchers_count: number

    PullsCreateFromIssueResponseBaseRepoOwner

    PullsCreateFromIssueResponseBaseRepoOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsCreateFromIssueResponseBaseRepoPermissions

    PullsCreateFromIssueResponseBaseRepoPermissions: { admin: boolean; pull: boolean; push: boolean }

    Type declaration

    • admin: boolean
    • pull: boolean
    • push: boolean

    PullsCreateFromIssueResponseBaseUser

    PullsCreateFromIssueResponseBaseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsCreateFromIssueResponseHead

    PullsCreateFromIssueResponseHead: { label: string; ref: string; repo: PullsCreateFromIssueResponseHeadRepo; sha: string; user: PullsCreateFromIssueResponseHeadUser }

    Type declaration

    PullsCreateFromIssueResponseHeadRepo

    PullsCreateFromIssueResponseHeadRepo: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: PullsCreateFromIssueResponseHeadRepoOwner; permissions: PullsCreateFromIssueResponseHeadRepoPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

    Type declaration

    • allow_merge_commit: boolean
    • allow_rebase_merge: boolean
    • allow_squash_merge: boolean
    • archive_url: string
    • archived: boolean
    • assignees_url: string
    • blobs_url: string
    • branches_url: string
    • clone_url: string
    • collaborators_url: string
    • comments_url: string
    • commits_url: string
    • compare_url: string
    • contents_url: string
    • contributors_url: string
    • created_at: string
    • default_branch: string
    • deployments_url: string
    • description: string
    • disabled: boolean
    • downloads_url: string
    • events_url: string
    • fork: boolean
    • forks_count: number
    • forks_url: string
    • full_name: string
    • git_commits_url: string
    • git_refs_url: string
    • git_tags_url: string
    • git_url: string
    • has_downloads: boolean
    • has_issues: boolean
    • has_pages: boolean
    • has_projects: boolean
    • has_wiki: boolean
    • homepage: string
    • hooks_url: string
    • html_url: string
    • id: number
    • is_template: boolean
    • issue_comment_url: string
    • issue_events_url: string
    • issues_url: string
    • keys_url: string
    • labels_url: string
    • language: null
    • languages_url: string
    • merges_url: string
    • milestones_url: string
    • mirror_url: string
    • name: string
    • network_count: number
    • node_id: string
    • notifications_url: string
    • open_issues_count: number
    • owner: PullsCreateFromIssueResponseHeadRepoOwner
    • permissions: PullsCreateFromIssueResponseHeadRepoPermissions
    • private: boolean
    • pulls_url: string
    • pushed_at: string
    • releases_url: string
    • size: number
    • ssh_url: string
    • stargazers_count: number
    • stargazers_url: string
    • statuses_url: string
    • subscribers_count: number
    • subscribers_url: string
    • subscription_url: string
    • svn_url: string
    • tags_url: string
    • teams_url: string
    • temp_clone_token: string
    • template_repository: null
    • topics: Array<string>
    • trees_url: string
    • updated_at: string
    • url: string
    • visibility: string
    • watchers_count: number

    PullsCreateFromIssueResponseHeadRepoOwner

    PullsCreateFromIssueResponseHeadRepoOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsCreateFromIssueResponseHeadRepoPermissions

    PullsCreateFromIssueResponseHeadRepoPermissions: { admin: boolean; pull: boolean; push: boolean }

    Type declaration

    • admin: boolean
    • pull: boolean
    • push: boolean

    PullsCreateFromIssueResponseHeadUser

    PullsCreateFromIssueResponseHeadUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsCreateFromIssueResponseLabelsItem

    PullsCreateFromIssueResponseLabelsItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

    Type declaration

    • color: string
    • default: boolean
    • description: string
    • id: number
    • name: string
    • node_id: string
    • url: string

    PullsCreateFromIssueResponseLinks

    PullsCreateFromIssueResponseLinks: { comments: PullsCreateFromIssueResponseLinksComments; commits: PullsCreateFromIssueResponseLinksCommits; html: PullsCreateFromIssueResponseLinksHtml; issue: PullsCreateFromIssueResponseLinksIssue; review_comment: PullsCreateFromIssueResponseLinksReviewComment; review_comments: PullsCreateFromIssueResponseLinksReviewComments; self: PullsCreateFromIssueResponseLinksSelf; statuses: PullsCreateFromIssueResponseLinksStatuses }

    Type declaration

    PullsCreateFromIssueResponseLinksComments

    PullsCreateFromIssueResponseLinksComments: { href: string }

    Type declaration

    • href: string

    PullsCreateFromIssueResponseLinksCommits

    PullsCreateFromIssueResponseLinksCommits: { href: string }

    Type declaration

    • href: string

    PullsCreateFromIssueResponseLinksHtml

    PullsCreateFromIssueResponseLinksHtml: { href: string }

    Type declaration

    • href: string

    PullsCreateFromIssueResponseLinksIssue

    PullsCreateFromIssueResponseLinksIssue: { href: string }

    Type declaration

    • href: string

    PullsCreateFromIssueResponseLinksReviewComment

    PullsCreateFromIssueResponseLinksReviewComment: { href: string }

    Type declaration

    • href: string

    PullsCreateFromIssueResponseLinksReviewComments

    PullsCreateFromIssueResponseLinksReviewComments: { href: string }

    Type declaration

    • href: string

    PullsCreateFromIssueResponseLinksSelf

    PullsCreateFromIssueResponseLinksSelf: { href: string }

    Type declaration

    • href: string

    PullsCreateFromIssueResponseLinksStatuses

    PullsCreateFromIssueResponseLinksStatuses: { href: string }

    Type declaration

    • href: string

    PullsCreateFromIssueResponseMergedBy

    PullsCreateFromIssueResponseMergedBy: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsCreateFromIssueResponseMilestone

    PullsCreateFromIssueResponseMilestone: { closed_at: string; closed_issues: number; created_at: string; creator: PullsCreateFromIssueResponseMilestoneCreator; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }

    Type declaration

    • closed_at: string
    • closed_issues: number
    • created_at: string
    • creator: PullsCreateFromIssueResponseMilestoneCreator
    • description: string
    • due_on: string
    • html_url: string
    • id: number
    • labels_url: string
    • node_id: string
    • number: number
    • open_issues: number
    • state: string
    • title: string
    • updated_at: string
    • url: string

    PullsCreateFromIssueResponseMilestoneCreator

    PullsCreateFromIssueResponseMilestoneCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsCreateFromIssueResponseRequestedReviewersItem

    PullsCreateFromIssueResponseRequestedReviewersItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsCreateFromIssueResponseRequestedTeamsItem

    PullsCreateFromIssueResponseRequestedTeamsItem: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: null; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

    Type declaration

    • description: string
    • html_url: string
    • id: number
    • members_url: string
    • name: string
    • node_id: string
    • parent: null
    • permission: string
    • privacy: string
    • repositories_url: string
    • slug: string
    • url: string

    PullsCreateFromIssueResponseUser

    PullsCreateFromIssueResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsCreateParams

    PullsCreateParams: { base: string; body?: undefined | string; draft?: undefined | false | true; head: string; maintainer_can_modify?: undefined | false | true; owner: string; repo: string; title: string }

    Type declaration

    • base: string

      The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.

    • Optional body?: undefined | string

      The contents of the pull request.

    • Optional draft?: undefined | false | true

      Indicates whether the pull request is a draft. See "Draft Pull Requests" in the GitHub Help documentation to learn more.

    • head: string

      The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username:branch.

    • Optional maintainer_can_modify?: undefined | false | true

      Indicates whether maintainers can modify the pull request.

    • owner: string
    • repo: string
    • title: string

      The title of the new pull request.

    PullsCreateResponse

    PullsCreateResponse: { _links: PullsCreateResponseLinks; active_lock_reason: string; additions: number; assignee: PullsCreateResponseAssignee; assignees: Array<PullsCreateResponseAssigneesItem>; author_association: string; base: PullsCreateResponseBase; body: string; changed_files: number; closed_at: string; comments: number; comments_url: string; commits: number; commits_url: string; created_at: string; deletions: number; diff_url: string; draft: boolean; head: PullsCreateResponseHead; html_url: string; id: number; issue_url: string; labels: Array<PullsCreateResponseLabelsItem>; locked: boolean; maintainer_can_modify: boolean; merge_commit_sha: string; mergeable: boolean; mergeable_state: string; merged: boolean; merged_at: string; merged_by: PullsCreateResponseMergedBy; milestone: PullsCreateResponseMilestone; node_id: string; number: number; patch_url: string; rebaseable: boolean; requested_reviewers: Array<PullsCreateResponseRequestedReviewersItem>; requested_teams: Array<PullsCreateResponseRequestedTeamsItem>; review_comment_url: string; review_comments: number; review_comments_url: string; state: string; statuses_url: string; title: string; updated_at: string; url: string; user: PullsCreateResponseUser }

    Type declaration

    PullsCreateResponseAssignee

    PullsCreateResponseAssignee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsCreateResponseAssigneesItem

    PullsCreateResponseAssigneesItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsCreateResponseBase

    PullsCreateResponseBase: { label: string; ref: string; repo: PullsCreateResponseBaseRepo; sha: string; user: PullsCreateResponseBaseUser }

    Type declaration

    PullsCreateResponseBaseRepo

    PullsCreateResponseBaseRepo: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: PullsCreateResponseBaseRepoOwner; permissions: PullsCreateResponseBaseRepoPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

    Type declaration

    • allow_merge_commit: boolean
    • allow_rebase_merge: boolean
    • allow_squash_merge: boolean
    • archive_url: string
    • archived: boolean
    • assignees_url: string
    • blobs_url: string
    • branches_url: string
    • clone_url: string
    • collaborators_url: string
    • comments_url: string
    • commits_url: string
    • compare_url: string
    • contents_url: string
    • contributors_url: string
    • created_at: string
    • default_branch: string
    • deployments_url: string
    • description: string
    • disabled: boolean
    • downloads_url: string
    • events_url: string
    • fork: boolean
    • forks_count: number
    • forks_url: string
    • full_name: string
    • git_commits_url: string
    • git_refs_url: string
    • git_tags_url: string
    • git_url: string
    • has_downloads: boolean
    • has_issues: boolean
    • has_pages: boolean
    • has_projects: boolean
    • has_wiki: boolean
    • homepage: string
    • hooks_url: string
    • html_url: string
    • id: number
    • is_template: boolean
    • issue_comment_url: string
    • issue_events_url: string
    • issues_url: string
    • keys_url: string
    • labels_url: string
    • language: null
    • languages_url: string
    • merges_url: string
    • milestones_url: string
    • mirror_url: string
    • name: string
    • network_count: number
    • node_id: string
    • notifications_url: string
    • open_issues_count: number
    • owner: PullsCreateResponseBaseRepoOwner
    • permissions: PullsCreateResponseBaseRepoPermissions
    • private: boolean
    • pulls_url: string
    • pushed_at: string
    • releases_url: string
    • size: number
    • ssh_url: string
    • stargazers_count: number
    • stargazers_url: string
    • statuses_url: string
    • subscribers_count: number
    • subscribers_url: string
    • subscription_url: string
    • svn_url: string
    • tags_url: string
    • teams_url: string
    • temp_clone_token: string
    • template_repository: null
    • topics: Array<string>
    • trees_url: string
    • updated_at: string
    • url: string
    • visibility: string
    • watchers_count: number

    PullsCreateResponseBaseRepoOwner

    PullsCreateResponseBaseRepoOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsCreateResponseBaseRepoPermissions

    PullsCreateResponseBaseRepoPermissions: { admin: boolean; pull: boolean; push: boolean }

    Type declaration

    • admin: boolean
    • pull: boolean
    • push: boolean

    PullsCreateResponseBaseUser

    PullsCreateResponseBaseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsCreateResponseHead

    PullsCreateResponseHead: { label: string; ref: string; repo: PullsCreateResponseHeadRepo; sha: string; user: PullsCreateResponseHeadUser }

    Type declaration

    PullsCreateResponseHeadRepo

    PullsCreateResponseHeadRepo: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: PullsCreateResponseHeadRepoOwner; permissions: PullsCreateResponseHeadRepoPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

    Type declaration

    • allow_merge_commit: boolean
    • allow_rebase_merge: boolean
    • allow_squash_merge: boolean
    • archive_url: string
    • archived: boolean
    • assignees_url: string
    • blobs_url: string
    • branches_url: string
    • clone_url: string
    • collaborators_url: string
    • comments_url: string
    • commits_url: string
    • compare_url: string
    • contents_url: string
    • contributors_url: string
    • created_at: string
    • default_branch: string
    • deployments_url: string
    • description: string
    • disabled: boolean
    • downloads_url: string
    • events_url: string
    • fork: boolean
    • forks_count: number
    • forks_url: string
    • full_name: string
    • git_commits_url: string
    • git_refs_url: string
    • git_tags_url: string
    • git_url: string
    • has_downloads: boolean
    • has_issues: boolean
    • has_pages: boolean
    • has_projects: boolean
    • has_wiki: boolean
    • homepage: string
    • hooks_url: string
    • html_url: string
    • id: number
    • is_template: boolean
    • issue_comment_url: string
    • issue_events_url: string
    • issues_url: string
    • keys_url: string
    • labels_url: string
    • language: null
    • languages_url: string
    • merges_url: string
    • milestones_url: string
    • mirror_url: string
    • name: string
    • network_count: number
    • node_id: string
    • notifications_url: string
    • open_issues_count: number
    • owner: PullsCreateResponseHeadRepoOwner
    • permissions: PullsCreateResponseHeadRepoPermissions
    • private: boolean
    • pulls_url: string
    • pushed_at: string
    • releases_url: string
    • size: number
    • ssh_url: string
    • stargazers_count: number
    • stargazers_url: string
    • statuses_url: string
    • subscribers_count: number
    • subscribers_url: string
    • subscription_url: string
    • svn_url: string
    • tags_url: string
    • teams_url: string
    • temp_clone_token: string
    • template_repository: null
    • topics: Array<string>
    • trees_url: string
    • updated_at: string
    • url: string
    • visibility: string
    • watchers_count: number

    PullsCreateResponseHeadRepoOwner

    PullsCreateResponseHeadRepoOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsCreateResponseHeadRepoPermissions

    PullsCreateResponseHeadRepoPermissions: { admin: boolean; pull: boolean; push: boolean }

    Type declaration

    • admin: boolean
    • pull: boolean
    • push: boolean

    PullsCreateResponseHeadUser

    PullsCreateResponseHeadUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsCreateResponseLabelsItem

    PullsCreateResponseLabelsItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

    Type declaration

    • color: string
    • default: boolean
    • description: string
    • id: number
    • name: string
    • node_id: string
    • url: string

    PullsCreateResponseLinks

    PullsCreateResponseLinks: { comments: PullsCreateResponseLinksComments; commits: PullsCreateResponseLinksCommits; html: PullsCreateResponseLinksHtml; issue: PullsCreateResponseLinksIssue; review_comment: PullsCreateResponseLinksReviewComment; review_comments: PullsCreateResponseLinksReviewComments; self: PullsCreateResponseLinksSelf; statuses: PullsCreateResponseLinksStatuses }

    Type declaration

    PullsCreateResponseLinksComments

    PullsCreateResponseLinksComments: { href: string }

    Type declaration

    • href: string

    PullsCreateResponseLinksCommits

    PullsCreateResponseLinksCommits: { href: string }

    Type declaration

    • href: string

    PullsCreateResponseLinksHtml

    PullsCreateResponseLinksHtml: { href: string }

    Type declaration

    • href: string

    PullsCreateResponseLinksIssue

    PullsCreateResponseLinksIssue: { href: string }

    Type declaration

    • href: string

    PullsCreateResponseLinksReviewComment

    PullsCreateResponseLinksReviewComment: { href: string }

    Type declaration

    • href: string

    PullsCreateResponseLinksReviewComments

    PullsCreateResponseLinksReviewComments: { href: string }

    Type declaration

    • href: string

    PullsCreateResponseLinksSelf

    PullsCreateResponseLinksSelf: { href: string }

    Type declaration

    • href: string

    PullsCreateResponseLinksStatuses

    PullsCreateResponseLinksStatuses: { href: string }

    Type declaration

    • href: string

    PullsCreateResponseMergedBy

    PullsCreateResponseMergedBy: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsCreateResponseMilestone

    PullsCreateResponseMilestone: { closed_at: string; closed_issues: number; created_at: string; creator: PullsCreateResponseMilestoneCreator; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }

    Type declaration

    • closed_at: string
    • closed_issues: number
    • created_at: string
    • creator: PullsCreateResponseMilestoneCreator
    • description: string
    • due_on: string
    • html_url: string
    • id: number
    • labels_url: string
    • node_id: string
    • number: number
    • open_issues: number
    • state: string
    • title: string
    • updated_at: string
    • url: string

    PullsCreateResponseMilestoneCreator

    PullsCreateResponseMilestoneCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsCreateResponseRequestedReviewersItem

    PullsCreateResponseRequestedReviewersItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsCreateResponseRequestedTeamsItem

    PullsCreateResponseRequestedTeamsItem: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: null; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

    Type declaration

    • description: string
    • html_url: string
    • id: number
    • members_url: string
    • name: string
    • node_id: string
    • parent: null
    • permission: string
    • privacy: string
    • repositories_url: string
    • slug: string
    • url: string

    PullsCreateResponseUser

    PullsCreateResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsCreateReviewCommentReplyParams

    PullsCreateReviewCommentReplyParams: { body: string; comment_id: number; owner: string; pull_number: number; repo: string }

    Type declaration

    • body: string

      The text of the review comment.

    • comment_id: number
    • owner: string
    • pull_number: number
    • repo: string

    PullsCreateReviewCommentReplyResponse

    PullsCreateReviewCommentReplyResponse: { _links: PullsCreateReviewCommentReplyResponseLinks; author_association: string; body: string; commit_id: string; created_at: string; diff_hunk: string; html_url: string; id: number; node_id: string; original_commit_id: string; original_position: number; path: string; position: number; pull_request_review_id: number; pull_request_url: string; updated_at: string; url: string; user: PullsCreateReviewCommentReplyResponseUser }

    Type declaration

    PullsCreateReviewCommentReplyResponseLinks

    PullsCreateReviewCommentReplyResponseLinks: { html: PullsCreateReviewCommentReplyResponseLinksHtml; pull_request: PullsCreateReviewCommentReplyResponseLinksPullRequest; self: PullsCreateReviewCommentReplyResponseLinksSelf }

    Type declaration

    PullsCreateReviewCommentReplyResponseLinksHtml

    PullsCreateReviewCommentReplyResponseLinksHtml: { href: string }

    Type declaration

    • href: string

    PullsCreateReviewCommentReplyResponseLinksPullRequest

    PullsCreateReviewCommentReplyResponseLinksPullRequest: { href: string }

    Type declaration

    • href: string

    PullsCreateReviewCommentReplyResponseLinksSelf

    PullsCreateReviewCommentReplyResponseLinksSelf: { href: string }

    Type declaration

    • href: string

    PullsCreateReviewCommentReplyResponseUser

    PullsCreateReviewCommentReplyResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsCreateReviewParams

    PullsCreateReviewParams: { body?: undefined | string; comments?: PullsCreateReviewParamsComments[]; commit_id?: undefined | string; event?: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; owner: string; pull_number: number; repo: string }

    Type declaration

    • Optional body?: undefined | string

      Required when using REQUEST_CHANGES or COMMENT for the event parameter. The body text of the pull request review.

    • Optional comments?: PullsCreateReviewParamsComments[]

      Use the following table to specify the location, destination, and contents of the draft review comment.

    • Optional commit_id?: undefined | string

      The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the position. Defaults to the most recent commit in the pull request when you do not specify a value.

    • Optional event?: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"

      The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. By leaving this blank, you set the review action state to PENDING, which means you will need to submit the pull request review when you are ready.

    • owner: string
    • pull_number: number
    • repo: string

    PullsCreateReviewParamsComments

    PullsCreateReviewParamsComments: { body: string; path: string; position: number }

    Type declaration

    • body: string
    • path: string
    • position: number

    PullsCreateReviewParamsDeprecatedNumber

    PullsCreateReviewParamsDeprecatedNumber: { body?: undefined | string; comments?: PullsCreateReviewParamsComments[]; commit_id?: undefined | string; event?: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; number: number; owner: string; repo: string }

    Type declaration

    • Optional body?: undefined | string

      Required when using REQUEST_CHANGES or COMMENT for the event parameter. The body text of the pull request review.

    • Optional comments?: PullsCreateReviewParamsComments[]

      Use the following table to specify the location, destination, and contents of the draft review comment.

    • Optional commit_id?: undefined | string

      The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the position. Defaults to the most recent commit in the pull request when you do not specify a value.

    • Optional event?: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"

      The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. By leaving this blank, you set the review action state to PENDING, which means you will need to submit the pull request review when you are ready.

    • number: number
      deprecated

      "number" parameter renamed to "pull_number"

    • owner: string
    • repo: string

    PullsCreateReviewRequestParams

    PullsCreateReviewRequestParams: { owner: string; pull_number: number; repo: string; reviewers?: string[]; team_reviewers?: string[] }

    Type declaration

    • owner: string
    • pull_number: number
    • repo: string
    • Optional reviewers?: string[]

      An array of user logins that will be requested.

    • Optional team_reviewers?: string[]

      An array of team slugs that will be requested.

    PullsCreateReviewRequestParamsDeprecatedNumber

    PullsCreateReviewRequestParamsDeprecatedNumber: { number: number; owner: string; repo: string; reviewers?: string[]; team_reviewers?: string[] }

    Type declaration

    • number: number
      deprecated

      "number" parameter renamed to "pull_number"

    • owner: string
    • repo: string
    • Optional reviewers?: string[]

      An array of user logins that will be requested.

    • Optional team_reviewers?: string[]

      An array of team slugs that will be requested.

    PullsCreateReviewRequestResponse

    PullsCreateReviewRequestResponse: { _links: PullsCreateReviewRequestResponseLinks; active_lock_reason: string; assignee: PullsCreateReviewRequestResponseAssignee; assignees: Array<PullsCreateReviewRequestResponseAssigneesItem>; author_association: string; base: PullsCreateReviewRequestResponseBase; body: string; closed_at: string; comments_url: string; commits_url: string; created_at: string; diff_url: string; draft: boolean; head: PullsCreateReviewRequestResponseHead; html_url: string; id: number; issue_url: string; labels: Array<PullsCreateReviewRequestResponseLabelsItem>; locked: boolean; merge_commit_sha: string; merged_at: string; milestone: PullsCreateReviewRequestResponseMilestone; node_id: string; number: number; patch_url: string; requested_reviewers: Array<PullsCreateReviewRequestResponseRequestedReviewersItem>; requested_teams: Array<PullsCreateReviewRequestResponseRequestedTeamsItem>; review_comment_url: string; review_comments_url: string; state: string; statuses_url: string; title: string; updated_at: string; url: string; user: PullsCreateReviewRequestResponseUser }

    Type declaration

    PullsCreateReviewRequestResponseAssignee

    PullsCreateReviewRequestResponseAssignee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsCreateReviewRequestResponseAssigneesItem

    PullsCreateReviewRequestResponseAssigneesItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsCreateReviewRequestResponseBase

    PullsCreateReviewRequestResponseBase: { label: string; ref: string; repo: PullsCreateReviewRequestResponseBaseRepo; sha: string; user: PullsCreateReviewRequestResponseBaseUser }

    Type declaration

    PullsCreateReviewRequestResponseBaseRepo

    PullsCreateReviewRequestResponseBaseRepo: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: PullsCreateReviewRequestResponseBaseRepoOwner; permissions: PullsCreateReviewRequestResponseBaseRepoPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

    Type declaration

    • allow_merge_commit: boolean
    • allow_rebase_merge: boolean
    • allow_squash_merge: boolean
    • archive_url: string
    • archived: boolean
    • assignees_url: string
    • blobs_url: string
    • branches_url: string
    • clone_url: string
    • collaborators_url: string
    • comments_url: string
    • commits_url: string
    • compare_url: string
    • contents_url: string
    • contributors_url: string
    • created_at: string
    • default_branch: string
    • deployments_url: string
    • description: string
    • disabled: boolean
    • downloads_url: string
    • events_url: string
    • fork: boolean
    • forks_count: number
    • forks_url: string
    • full_name: string
    • git_commits_url: string
    • git_refs_url: string
    • git_tags_url: string
    • git_url: string
    • has_downloads: boolean
    • has_issues: boolean
    • has_pages: boolean
    • has_projects: boolean
    • has_wiki: boolean
    • homepage: string
    • hooks_url: string
    • html_url: string
    • id: number
    • is_template: boolean
    • issue_comment_url: string
    • issue_events_url: string
    • issues_url: string
    • keys_url: string
    • labels_url: string
    • language: null
    • languages_url: string
    • merges_url: string
    • milestones_url: string
    • mirror_url: string
    • name: string
    • network_count: number
    • node_id: string
    • notifications_url: string
    • open_issues_count: number
    • owner: PullsCreateReviewRequestResponseBaseRepoOwner
    • permissions: PullsCreateReviewRequestResponseBaseRepoPermissions
    • private: boolean
    • pulls_url: string
    • pushed_at: string
    • releases_url: string
    • size: number
    • ssh_url: string
    • stargazers_count: number
    • stargazers_url: string
    • statuses_url: string
    • subscribers_count: number
    • subscribers_url: string
    • subscription_url: string
    • svn_url: string
    • tags_url: string
    • teams_url: string
    • temp_clone_token: string
    • template_repository: null
    • topics: Array<string>
    • trees_url: string
    • updated_at: string
    • url: string
    • visibility: string
    • watchers_count: number

    PullsCreateReviewRequestResponseBaseRepoOwner

    PullsCreateReviewRequestResponseBaseRepoOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsCreateReviewRequestResponseBaseRepoPermissions

    PullsCreateReviewRequestResponseBaseRepoPermissions: { admin: boolean; pull: boolean; push: boolean }

    Type declaration

    • admin: boolean
    • pull: boolean
    • push: boolean

    PullsCreateReviewRequestResponseBaseUser

    PullsCreateReviewRequestResponseBaseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsCreateReviewRequestResponseHead

    PullsCreateReviewRequestResponseHead: { label: string; ref: string; repo: PullsCreateReviewRequestResponseHeadRepo; sha: string; user: PullsCreateReviewRequestResponseHeadUser }

    Type declaration

    PullsCreateReviewRequestResponseHeadRepo

    PullsCreateReviewRequestResponseHeadRepo: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: PullsCreateReviewRequestResponseHeadRepoOwner; permissions: PullsCreateReviewRequestResponseHeadRepoPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

    Type declaration

    • allow_merge_commit: boolean
    • allow_rebase_merge: boolean
    • allow_squash_merge: boolean
    • archive_url: string
    • archived: boolean
    • assignees_url: string
    • blobs_url: string
    • branches_url: string
    • clone_url: string
    • collaborators_url: string
    • comments_url: string
    • commits_url: string
    • compare_url: string
    • contents_url: string
    • contributors_url: string
    • created_at: string
    • default_branch: string
    • deployments_url: string
    • description: string
    • disabled: boolean
    • downloads_url: string
    • events_url: string
    • fork: boolean
    • forks_count: number
    • forks_url: string
    • full_name: string
    • git_commits_url: string
    • git_refs_url: string
    • git_tags_url: string
    • git_url: string
    • has_downloads: boolean
    • has_issues: boolean
    • has_pages: boolean
    • has_projects: boolean
    • has_wiki: boolean
    • homepage: string
    • hooks_url: string
    • html_url: string
    • id: number
    • is_template: boolean
    • issue_comment_url: string
    • issue_events_url: string
    • issues_url: string
    • keys_url: string
    • labels_url: string
    • language: null
    • languages_url: string
    • merges_url: string
    • milestones_url: string
    • mirror_url: string
    • name: string
    • network_count: number
    • node_id: string
    • notifications_url: string
    • open_issues_count: number
    • owner: PullsCreateReviewRequestResponseHeadRepoOwner
    • permissions: PullsCreateReviewRequestResponseHeadRepoPermissions
    • private: boolean
    • pulls_url: string
    • pushed_at: string
    • releases_url: string
    • size: number
    • ssh_url: string
    • stargazers_count: number
    • stargazers_url: string
    • statuses_url: string
    • subscribers_count: number
    • subscribers_url: string
    • subscription_url: string
    • svn_url: string
    • tags_url: string
    • teams_url: string
    • temp_clone_token: string
    • template_repository: null
    • topics: Array<string>
    • trees_url: string
    • updated_at: string
    • url: string
    • visibility: string
    • watchers_count: number

    PullsCreateReviewRequestResponseHeadRepoOwner

    PullsCreateReviewRequestResponseHeadRepoOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsCreateReviewRequestResponseHeadRepoPermissions

    PullsCreateReviewRequestResponseHeadRepoPermissions: { admin: boolean; pull: boolean; push: boolean }

    Type declaration

    • admin: boolean
    • pull: boolean
    • push: boolean

    PullsCreateReviewRequestResponseHeadUser

    PullsCreateReviewRequestResponseHeadUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsCreateReviewRequestResponseLabelsItem

    PullsCreateReviewRequestResponseLabelsItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

    Type declaration

    • color: string
    • default: boolean
    • description: string
    • id: number
    • name: string
    • node_id: string
    • url: string

    PullsCreateReviewRequestResponseLinks

    PullsCreateReviewRequestResponseLinks: { comments: PullsCreateReviewRequestResponseLinksComments; commits: PullsCreateReviewRequestResponseLinksCommits; html: PullsCreateReviewRequestResponseLinksHtml; issue: PullsCreateReviewRequestResponseLinksIssue; review_comment: PullsCreateReviewRequestResponseLinksReviewComment; review_comments: PullsCreateReviewRequestResponseLinksReviewComments; self: PullsCreateReviewRequestResponseLinksSelf; statuses: PullsCreateReviewRequestResponseLinksStatuses }

    Type declaration

    PullsCreateReviewRequestResponseLinksComments

    PullsCreateReviewRequestResponseLinksComments: { href: string }

    Type declaration

    • href: string

    PullsCreateReviewRequestResponseLinksCommits

    PullsCreateReviewRequestResponseLinksCommits: { href: string }

    Type declaration

    • href: string

    PullsCreateReviewRequestResponseLinksHtml

    PullsCreateReviewRequestResponseLinksHtml: { href: string }

    Type declaration

    • href: string

    PullsCreateReviewRequestResponseLinksIssue

    PullsCreateReviewRequestResponseLinksIssue: { href: string }

    Type declaration

    • href: string

    PullsCreateReviewRequestResponseLinksReviewComment

    PullsCreateReviewRequestResponseLinksReviewComment: { href: string }

    Type declaration

    • href: string

    PullsCreateReviewRequestResponseLinksReviewComments

    PullsCreateReviewRequestResponseLinksReviewComments: { href: string }

    Type declaration

    • href: string

    PullsCreateReviewRequestResponseLinksSelf

    PullsCreateReviewRequestResponseLinksSelf: { href: string }

    Type declaration

    • href: string

    PullsCreateReviewRequestResponseLinksStatuses

    PullsCreateReviewRequestResponseLinksStatuses: { href: string }

    Type declaration

    • href: string

    PullsCreateReviewRequestResponseMilestone

    PullsCreateReviewRequestResponseMilestone: { closed_at: string; closed_issues: number; created_at: string; creator: PullsCreateReviewRequestResponseMilestoneCreator; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }

    Type declaration

    • closed_at: string
    • closed_issues: number
    • created_at: string
    • creator: PullsCreateReviewRequestResponseMilestoneCreator
    • description: string
    • due_on: string
    • html_url: string
    • id: number
    • labels_url: string
    • node_id: string
    • number: number
    • open_issues: number
    • state: string
    • title: string
    • updated_at: string
    • url: string

    PullsCreateReviewRequestResponseMilestoneCreator

    PullsCreateReviewRequestResponseMilestoneCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsCreateReviewRequestResponseRequestedReviewersItem

    PullsCreateReviewRequestResponseRequestedReviewersItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsCreateReviewRequestResponseRequestedTeamsItem

    PullsCreateReviewRequestResponseRequestedTeamsItem: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: null; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

    Type declaration

    • description: string
    • html_url: string
    • id: number
    • members_url: string
    • name: string
    • node_id: string
    • parent: null
    • permission: string
    • privacy: string
    • repositories_url: string
    • slug: string
    • url: string

    PullsCreateReviewRequestResponseUser

    PullsCreateReviewRequestResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsCreateReviewResponse

    PullsCreateReviewResponse: { _links: PullsCreateReviewResponseLinks; body: string; commit_id: string; html_url: string; id: number; node_id: string; pull_request_url: string; state: string; user: PullsCreateReviewResponseUser }

    Type declaration

    PullsCreateReviewResponseLinks

    PullsCreateReviewResponseLinks: { html: PullsCreateReviewResponseLinksHtml; pull_request: PullsCreateReviewResponseLinksPullRequest }

    Type declaration

    PullsCreateReviewResponseLinksHtml

    PullsCreateReviewResponseLinksHtml: { href: string }

    Type declaration

    • href: string

    PullsCreateReviewResponseLinksPullRequest

    PullsCreateReviewResponseLinksPullRequest: { href: string }

    Type declaration

    • href: string

    PullsCreateReviewResponseUser

    PullsCreateReviewResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsDeleteCommentParams

    PullsDeleteCommentParams: { comment_id: number; owner: string; repo: string }

    Type declaration

    • comment_id: number
    • owner: string
    • repo: string

    PullsDeletePendingReviewParams

    PullsDeletePendingReviewParams: { owner: string; pull_number: number; repo: string; review_id: number }

    Type declaration

    • owner: string
    • pull_number: number
    • repo: string
    • review_id: number

    PullsDeletePendingReviewParamsDeprecatedNumber

    PullsDeletePendingReviewParamsDeprecatedNumber: { number: number; owner: string; repo: string; review_id: number }

    Type declaration

    • number: number
      deprecated

      "number" parameter renamed to "pull_number"

    • owner: string
    • repo: string
    • review_id: number

    PullsDeletePendingReviewResponse

    PullsDeletePendingReviewResponse: { _links: PullsDeletePendingReviewResponseLinks; body: string; commit_id: string; html_url: string; id: number; node_id: string; pull_request_url: string; state: string; user: PullsDeletePendingReviewResponseUser }

    Type declaration

    PullsDeletePendingReviewResponseLinks

    PullsDeletePendingReviewResponseLinks: { html: PullsDeletePendingReviewResponseLinksHtml; pull_request: PullsDeletePendingReviewResponseLinksPullRequest }

    Type declaration

    PullsDeletePendingReviewResponseLinksHtml

    PullsDeletePendingReviewResponseLinksHtml: { href: string }

    Type declaration

    • href: string

    PullsDeletePendingReviewResponseLinksPullRequest

    PullsDeletePendingReviewResponseLinksPullRequest: { href: string }

    Type declaration

    • href: string

    PullsDeletePendingReviewResponseUser

    PullsDeletePendingReviewResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsDeleteReviewRequestParams

    PullsDeleteReviewRequestParams: { owner: string; pull_number: number; repo: string; reviewers?: string[]; team_reviewers?: string[] }

    Type declaration

    • owner: string
    • pull_number: number
    • repo: string
    • Optional reviewers?: string[]

      An array of user logins that will be removed.

    • Optional team_reviewers?: string[]

      An array of team slugs that will be removed.

    PullsDeleteReviewRequestParamsDeprecatedNumber

    PullsDeleteReviewRequestParamsDeprecatedNumber: { number: number; owner: string; repo: string; reviewers?: string[]; team_reviewers?: string[] }

    Type declaration

    • number: number
      deprecated

      "number" parameter renamed to "pull_number"

    • owner: string
    • repo: string
    • Optional reviewers?: string[]

      An array of user logins that will be removed.

    • Optional team_reviewers?: string[]

      An array of team slugs that will be removed.

    PullsDismissReviewParams

    PullsDismissReviewParams: { message: string; owner: string; pull_number: number; repo: string; review_id: number }

    Type declaration

    • message: string

      The message for the pull request review dismissal

    • owner: string
    • pull_number: number
    • repo: string
    • review_id: number

    PullsDismissReviewParamsDeprecatedNumber

    PullsDismissReviewParamsDeprecatedNumber: { message: string; number: number; owner: string; repo: string; review_id: number }

    Type declaration

    • message: string

      The message for the pull request review dismissal

    • number: number
      deprecated

      "number" parameter renamed to "pull_number"

    • owner: string
    • repo: string
    • review_id: number

    PullsDismissReviewResponse

    PullsDismissReviewResponse: { _links: PullsDismissReviewResponseLinks; body: string; commit_id: string; html_url: string; id: number; node_id: string; pull_request_url: string; state: string; user: PullsDismissReviewResponseUser }

    Type declaration

    PullsDismissReviewResponseLinks

    PullsDismissReviewResponseLinks: { html: PullsDismissReviewResponseLinksHtml; pull_request: PullsDismissReviewResponseLinksPullRequest }

    Type declaration

    PullsDismissReviewResponseLinksHtml

    PullsDismissReviewResponseLinksHtml: { href: string }

    Type declaration

    • href: string

    PullsDismissReviewResponseLinksPullRequest

    PullsDismissReviewResponseLinksPullRequest: { href: string }

    Type declaration

    • href: string

    PullsDismissReviewResponseUser

    PullsDismissReviewResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsGetCommentParams

    PullsGetCommentParams: { comment_id: number; owner: string; repo: string }

    Type declaration

    • comment_id: number
    • owner: string
    • repo: string

    PullsGetCommentResponse

    PullsGetCommentResponse: { _links: PullsGetCommentResponseLinks; author_association: string; body: string; commit_id: string; created_at: string; diff_hunk: string; html_url: string; id: number; in_reply_to_id: number; line: number; node_id: string; original_commit_id: string; original_line: number; original_position: number; original_start_line: number; path: string; position: number; pull_request_review_id: number; pull_request_url: string; side: string; start_line: number; start_side: string; updated_at: string; url: string; user: PullsGetCommentResponseUser }

    Type declaration

    • _links: PullsGetCommentResponseLinks
    • author_association: string
    • body: string
    • commit_id: string
    • created_at: string
    • diff_hunk: string
    • html_url: string
    • id: number
    • in_reply_to_id: number
    • line: number
    • node_id: string
    • original_commit_id: string
    • original_line: number
    • original_position: number
    • original_start_line: number
    • path: string
    • position: number
    • pull_request_review_id: number
    • pull_request_url: string
    • side: string
    • start_line: number
    • start_side: string
    • updated_at: string
    • url: string
    • user: PullsGetCommentResponseUser

    PullsGetCommentResponseLinks

    PullsGetCommentResponseLinks: { html: PullsGetCommentResponseLinksHtml; pull_request: PullsGetCommentResponseLinksPullRequest; self: PullsGetCommentResponseLinksSelf }

    Type declaration

    PullsGetCommentResponseLinksHtml

    PullsGetCommentResponseLinksHtml: { href: string }

    Type declaration

    • href: string

    PullsGetCommentResponseLinksPullRequest

    PullsGetCommentResponseLinksPullRequest: { href: string }

    Type declaration

    • href: string

    PullsGetCommentResponseLinksSelf

    PullsGetCommentResponseLinksSelf: { href: string }

    Type declaration

    • href: string

    PullsGetCommentResponseUser

    PullsGetCommentResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsGetCommentsForReviewParams

    PullsGetCommentsForReviewParams: { owner: string; page?: undefined | number; per_page?: undefined | number; pull_number: number; repo: string; review_id: number }

    Type declaration

    • owner: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • pull_number: number
    • repo: string
    • review_id: number

    PullsGetCommentsForReviewParamsDeprecatedNumber

    PullsGetCommentsForReviewParamsDeprecatedNumber: { number: number; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string; review_id: number }

    Type declaration

    • number: number
      deprecated

      "number" parameter renamed to "pull_number"

    • owner: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • repo: string
    • review_id: number

    PullsGetCommentsForReviewResponse

    PullsGetCommentsForReviewResponse: Array<PullsGetCommentsForReviewResponseItem>

    PullsGetCommentsForReviewResponseItem

    PullsGetCommentsForReviewResponseItem: { _links: PullsGetCommentsForReviewResponseItemLinks; author_association: string; body: string; commit_id: string; created_at: string; diff_hunk: string; html_url: string; id: number; in_reply_to_id: number; node_id: string; original_commit_id: string; original_position: number; path: string; position: number; pull_request_review_id: number; pull_request_url: string; updated_at: string; url: string; user: PullsGetCommentsForReviewResponseItemUser }

    Type declaration

    • _links: PullsGetCommentsForReviewResponseItemLinks
    • author_association: string
    • body: string
    • commit_id: string
    • created_at: string
    • diff_hunk: string
    • html_url: string
    • id: number
    • in_reply_to_id: number
    • node_id: string
    • original_commit_id: string
    • original_position: number
    • path: string
    • position: number
    • pull_request_review_id: number
    • pull_request_url: string
    • updated_at: string
    • url: string
    • user: PullsGetCommentsForReviewResponseItemUser

    PullsGetCommentsForReviewResponseItemLinks

    PullsGetCommentsForReviewResponseItemLinks: { html: PullsGetCommentsForReviewResponseItemLinksHtml; pull_request: PullsGetCommentsForReviewResponseItemLinksPullRequest; self: PullsGetCommentsForReviewResponseItemLinksSelf }

    Type declaration

    PullsGetCommentsForReviewResponseItemLinksHtml

    PullsGetCommentsForReviewResponseItemLinksHtml: { href: string }

    Type declaration

    • href: string

    PullsGetCommentsForReviewResponseItemLinksPullRequest

    PullsGetCommentsForReviewResponseItemLinksPullRequest: { href: string }

    Type declaration

    • href: string

    PullsGetCommentsForReviewResponseItemLinksSelf

    PullsGetCommentsForReviewResponseItemLinksSelf: { href: string }

    Type declaration

    • href: string

    PullsGetCommentsForReviewResponseItemUser

    PullsGetCommentsForReviewResponseItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsGetParams

    PullsGetParams: { owner: string; pull_number: number; repo: string }

    Type declaration

    • owner: string
    • pull_number: number
    • repo: string

    PullsGetParamsDeprecatedNumber

    PullsGetParamsDeprecatedNumber: { number: number; owner: string; repo: string }

    Type declaration

    • number: number
      deprecated

      "number" parameter renamed to "pull_number"

    • owner: string
    • repo: string

    PullsGetResponse

    PullsGetResponse: { _links: PullsGetResponseLinks; active_lock_reason: string; additions: number; assignee: PullsGetResponseAssignee; assignees: Array<PullsGetResponseAssigneesItem>; author_association: string; base: PullsGetResponseBase; body: string; changed_files: number; closed_at: string; comments: number; comments_url: string; commits: number; commits_url: string; created_at: string; deletions: number; diff_url: string; draft: boolean; head: PullsGetResponseHead; html_url: string; id: number; issue_url: string; labels: Array<PullsGetResponseLabelsItem>; locked: boolean; maintainer_can_modify: boolean; merge_commit_sha: string; mergeable: boolean; mergeable_state: string; merged: boolean; merged_at: string; merged_by: PullsGetResponseMergedBy; milestone: PullsGetResponseMilestone; node_id: string; number: number; patch_url: string; rebaseable: boolean; requested_reviewers: Array<PullsGetResponseRequestedReviewersItem>; requested_teams: Array<PullsGetResponseRequestedTeamsItem>; review_comment_url: string; review_comments: number; review_comments_url: string; state: string; statuses_url: string; title: string; updated_at: string; url: string; user: PullsGetResponseUser }

    Type declaration

    PullsGetResponseAssignee

    PullsGetResponseAssignee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsGetResponseAssigneesItem

    PullsGetResponseAssigneesItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsGetResponseBase

    PullsGetResponseBase: { label: string; ref: string; repo: PullsGetResponseBaseRepo; sha: string; user: PullsGetResponseBaseUser }

    Type declaration

    PullsGetResponseBaseRepo

    PullsGetResponseBaseRepo: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: PullsGetResponseBaseRepoOwner; permissions: PullsGetResponseBaseRepoPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

    Type declaration

    • allow_merge_commit: boolean
    • allow_rebase_merge: boolean
    • allow_squash_merge: boolean
    • archive_url: string
    • archived: boolean
    • assignees_url: string
    • blobs_url: string
    • branches_url: string
    • clone_url: string
    • collaborators_url: string
    • comments_url: string
    • commits_url: string
    • compare_url: string
    • contents_url: string
    • contributors_url: string
    • created_at: string
    • default_branch: string
    • deployments_url: string
    • description: string
    • disabled: boolean
    • downloads_url: string
    • events_url: string
    • fork: boolean
    • forks_count: number
    • forks_url: string
    • full_name: string
    • git_commits_url: string
    • git_refs_url: string
    • git_tags_url: string
    • git_url: string
    • has_downloads: boolean
    • has_issues: boolean
    • has_pages: boolean
    • has_projects: boolean
    • has_wiki: boolean
    • homepage: string
    • hooks_url: string
    • html_url: string
    • id: number
    • is_template: boolean
    • issue_comment_url: string
    • issue_events_url: string
    • issues_url: string
    • keys_url: string
    • labels_url: string
    • language: null
    • languages_url: string
    • merges_url: string
    • milestones_url: string
    • mirror_url: string
    • name: string
    • network_count: number
    • node_id: string
    • notifications_url: string
    • open_issues_count: number
    • owner: PullsGetResponseBaseRepoOwner
    • permissions: PullsGetResponseBaseRepoPermissions
    • private: boolean
    • pulls_url: string
    • pushed_at: string
    • releases_url: string
    • size: number
    • ssh_url: string
    • stargazers_count: number
    • stargazers_url: string
    • statuses_url: string
    • subscribers_count: number
    • subscribers_url: string
    • subscription_url: string
    • svn_url: string
    • tags_url: string
    • teams_url: string
    • temp_clone_token: string
    • template_repository: null
    • topics: Array<string>
    • trees_url: string
    • updated_at: string
    • url: string
    • visibility: string
    • watchers_count: number

    PullsGetResponseBaseRepoOwner

    PullsGetResponseBaseRepoOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsGetResponseBaseRepoPermissions

    PullsGetResponseBaseRepoPermissions: { admin: boolean; pull: boolean; push: boolean }

    Type declaration

    • admin: boolean
    • pull: boolean
    • push: boolean

    PullsGetResponseBaseUser

    PullsGetResponseBaseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsGetResponseHead

    PullsGetResponseHead: { label: string; ref: string; repo: PullsGetResponseHeadRepo; sha: string; user: PullsGetResponseHeadUser }

    Type declaration

    PullsGetResponseHeadRepo

    PullsGetResponseHeadRepo: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: PullsGetResponseHeadRepoOwner; permissions: PullsGetResponseHeadRepoPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

    Type declaration

    • allow_merge_commit: boolean
    • allow_rebase_merge: boolean
    • allow_squash_merge: boolean
    • archive_url: string
    • archived: boolean
    • assignees_url: string
    • blobs_url: string
    • branches_url: string
    • clone_url: string
    • collaborators_url: string
    • comments_url: string
    • commits_url: string
    • compare_url: string
    • contents_url: string
    • contributors_url: string
    • created_at: string
    • default_branch: string
    • deployments_url: string
    • description: string
    • disabled: boolean
    • downloads_url: string
    • events_url: string
    • fork: boolean
    • forks_count: number
    • forks_url: string
    • full_name: string
    • git_commits_url: string
    • git_refs_url: string
    • git_tags_url: string
    • git_url: string
    • has_downloads: boolean
    • has_issues: boolean
    • has_pages: boolean
    • has_projects: boolean
    • has_wiki: boolean
    • homepage: string
    • hooks_url: string
    • html_url: string
    • id: number
    • is_template: boolean
    • issue_comment_url: string
    • issue_events_url: string
    • issues_url: string
    • keys_url: string
    • labels_url: string
    • language: null
    • languages_url: string
    • merges_url: string
    • milestones_url: string
    • mirror_url: string
    • name: string
    • network_count: number
    • node_id: string
    • notifications_url: string
    • open_issues_count: number
    • owner: PullsGetResponseHeadRepoOwner
    • permissions: PullsGetResponseHeadRepoPermissions
    • private: boolean
    • pulls_url: string
    • pushed_at: string
    • releases_url: string
    • size: number
    • ssh_url: string
    • stargazers_count: number
    • stargazers_url: string
    • statuses_url: string
    • subscribers_count: number
    • subscribers_url: string
    • subscription_url: string
    • svn_url: string
    • tags_url: string
    • teams_url: string
    • temp_clone_token: string
    • template_repository: null
    • topics: Array<string>
    • trees_url: string
    • updated_at: string
    • url: string
    • visibility: string
    • watchers_count: number

    PullsGetResponseHeadRepoOwner

    PullsGetResponseHeadRepoOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsGetResponseHeadRepoPermissions

    PullsGetResponseHeadRepoPermissions: { admin: boolean; pull: boolean; push: boolean }

    Type declaration

    • admin: boolean
    • pull: boolean
    • push: boolean

    PullsGetResponseHeadUser

    PullsGetResponseHeadUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsGetResponseLabelsItem

    PullsGetResponseLabelsItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

    Type declaration

    • color: string
    • default: boolean
    • description: string
    • id: number
    • name: string
    • node_id: string
    • url: string

    PullsGetResponseLinks

    PullsGetResponseLinks: { comments: PullsGetResponseLinksComments; commits: PullsGetResponseLinksCommits; html: PullsGetResponseLinksHtml; issue: PullsGetResponseLinksIssue; review_comment: PullsGetResponseLinksReviewComment; review_comments: PullsGetResponseLinksReviewComments; self: PullsGetResponseLinksSelf; statuses: PullsGetResponseLinksStatuses }

    Type declaration

    PullsGetResponseLinksComments

    PullsGetResponseLinksComments: { href: string }

    Type declaration

    • href: string

    PullsGetResponseLinksCommits

    PullsGetResponseLinksCommits: { href: string }

    Type declaration

    • href: string

    PullsGetResponseLinksHtml

    PullsGetResponseLinksHtml: { href: string }

    Type declaration

    • href: string

    PullsGetResponseLinksIssue

    PullsGetResponseLinksIssue: { href: string }

    Type declaration

    • href: string

    PullsGetResponseLinksReviewComment

    PullsGetResponseLinksReviewComment: { href: string }

    Type declaration

    • href: string

    PullsGetResponseLinksReviewComments

    PullsGetResponseLinksReviewComments: { href: string }

    Type declaration

    • href: string

    PullsGetResponseLinksSelf

    PullsGetResponseLinksSelf: { href: string }

    Type declaration

    • href: string

    PullsGetResponseLinksStatuses

    PullsGetResponseLinksStatuses: { href: string }

    Type declaration

    • href: string

    PullsGetResponseMergedBy

    PullsGetResponseMergedBy: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsGetResponseMilestone

    PullsGetResponseMilestone: { closed_at: string; closed_issues: number; created_at: string; creator: PullsGetResponseMilestoneCreator; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }

    Type declaration

    • closed_at: string
    • closed_issues: number
    • created_at: string
    • creator: PullsGetResponseMilestoneCreator
    • description: string
    • due_on: string
    • html_url: string
    • id: number
    • labels_url: string
    • node_id: string
    • number: number
    • open_issues: number
    • state: string
    • title: string
    • updated_at: string
    • url: string

    PullsGetResponseMilestoneCreator

    PullsGetResponseMilestoneCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsGetResponseRequestedReviewersItem

    PullsGetResponseRequestedReviewersItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsGetResponseRequestedTeamsItem

    PullsGetResponseRequestedTeamsItem: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: null; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

    Type declaration

    • description: string
    • html_url: string
    • id: number
    • members_url: string
    • name: string
    • node_id: string
    • parent: null
    • permission: string
    • privacy: string
    • repositories_url: string
    • slug: string
    • url: string

    PullsGetResponseUser

    PullsGetResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsGetReviewParams

    PullsGetReviewParams: { owner: string; pull_number: number; repo: string; review_id: number }

    Type declaration

    • owner: string
    • pull_number: number
    • repo: string
    • review_id: number

    PullsGetReviewParamsDeprecatedNumber

    PullsGetReviewParamsDeprecatedNumber: { number: number; owner: string; repo: string; review_id: number }

    Type declaration

    • number: number
      deprecated

      "number" parameter renamed to "pull_number"

    • owner: string
    • repo: string
    • review_id: number

    PullsGetReviewResponse

    PullsGetReviewResponse: { _links: PullsGetReviewResponseLinks; body: string; commit_id: string; html_url: string; id: number; node_id: string; pull_request_url: string; state: string; submitted_at: string; user: PullsGetReviewResponseUser }

    Type declaration

    PullsGetReviewResponseLinks

    PullsGetReviewResponseLinks: { html: PullsGetReviewResponseLinksHtml; pull_request: PullsGetReviewResponseLinksPullRequest }

    Type declaration

    PullsGetReviewResponseLinksHtml

    PullsGetReviewResponseLinksHtml: { href: string }

    Type declaration

    • href: string

    PullsGetReviewResponseLinksPullRequest

    PullsGetReviewResponseLinksPullRequest: { href: string }

    Type declaration

    • href: string

    PullsGetReviewResponseUser

    PullsGetReviewResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsListCommentsForRepoParams

    PullsListCommentsForRepoParams: { direction?: "asc" | "desc"; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string; since?: undefined | string; sort?: "created" | "updated" }

    Type declaration

    • Optional direction?: "asc" | "desc"

      Can be either asc or desc. Ignored without sort parameter.

    • owner: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • repo: string
    • Optional since?: undefined | string

      This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only returns comments updated at or after this time.

    • Optional sort?: "created" | "updated"

      Can be either created or updated comments.

    PullsListCommentsForRepoResponse

    PullsListCommentsForRepoResponse: Array<PullsListCommentsForRepoResponseItem>

    PullsListCommentsForRepoResponseItem

    PullsListCommentsForRepoResponseItem: { _links: PullsListCommentsForRepoResponseItemLinks; author_association: string; body: string; commit_id: string; created_at: string; diff_hunk: string; html_url: string; id: number; in_reply_to_id: number; line: number; node_id: string; original_commit_id: string; original_line: number; original_position: number; original_start_line: number; path: string; position: number; pull_request_review_id: number; pull_request_url: string; side: string; start_line: number; start_side: string; updated_at: string; url: string; user: PullsListCommentsForRepoResponseItemUser }

    Type declaration

    • _links: PullsListCommentsForRepoResponseItemLinks
    • author_association: string
    • body: string
    • commit_id: string
    • created_at: string
    • diff_hunk: string
    • html_url: string
    • id: number
    • in_reply_to_id: number
    • line: number
    • node_id: string
    • original_commit_id: string
    • original_line: number
    • original_position: number
    • original_start_line: number
    • path: string
    • position: number
    • pull_request_review_id: number
    • pull_request_url: string
    • side: string
    • start_line: number
    • start_side: string
    • updated_at: string
    • url: string
    • user: PullsListCommentsForRepoResponseItemUser

    PullsListCommentsForRepoResponseItemLinks

    PullsListCommentsForRepoResponseItemLinks: { html: PullsListCommentsForRepoResponseItemLinksHtml; pull_request: PullsListCommentsForRepoResponseItemLinksPullRequest; self: PullsListCommentsForRepoResponseItemLinksSelf }

    Type declaration

    PullsListCommentsForRepoResponseItemLinksHtml

    PullsListCommentsForRepoResponseItemLinksHtml: { href: string }

    Type declaration

    • href: string

    PullsListCommentsForRepoResponseItemLinksPullRequest

    PullsListCommentsForRepoResponseItemLinksPullRequest: { href: string }

    Type declaration

    • href: string

    PullsListCommentsForRepoResponseItemLinksSelf

    PullsListCommentsForRepoResponseItemLinksSelf: { href: string }

    Type declaration

    • href: string

    PullsListCommentsForRepoResponseItemUser

    PullsListCommentsForRepoResponseItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsListCommentsParams

    PullsListCommentsParams: { direction?: "asc" | "desc"; owner: string; page?: undefined | number; per_page?: undefined | number; pull_number: number; repo: string; since?: undefined | string; sort?: "created" | "updated" }

    Type declaration

    • Optional direction?: "asc" | "desc"

      Can be either asc or desc. Ignored without sort parameter.

    • owner: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • pull_number: number
    • repo: string
    • Optional since?: undefined | string

      This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only returns comments updated at or after this time.

    • Optional sort?: "created" | "updated"

      Can be either created or updated comments.

    PullsListCommentsParamsDeprecatedNumber

    PullsListCommentsParamsDeprecatedNumber: { direction?: "asc" | "desc"; number: number; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string; since?: undefined | string; sort?: "created" | "updated" }

    Type declaration

    • Optional direction?: "asc" | "desc"

      Can be either asc or desc. Ignored without sort parameter.

    • number: number
      deprecated

      "number" parameter renamed to "pull_number"

    • owner: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • repo: string
    • Optional since?: undefined | string

      This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only returns comments updated at or after this time.

    • Optional sort?: "created" | "updated"

      Can be either created or updated comments.

    PullsListCommentsResponse

    PullsListCommentsResponse: Array<PullsListCommentsResponseItem>

    PullsListCommentsResponseItem

    PullsListCommentsResponseItem: { _links: PullsListCommentsResponseItemLinks; author_association: string; body: string; commit_id: string; created_at: string; diff_hunk: string; html_url: string; id: number; in_reply_to_id: number; line: number; node_id: string; original_commit_id: string; original_line: number; original_position: number; original_start_line: number; path: string; position: number; pull_request_review_id: number; pull_request_url: string; side: string; start_line: number; start_side: string; updated_at: string; url: string; user: PullsListCommentsResponseItemUser }

    Type declaration

    • _links: PullsListCommentsResponseItemLinks
    • author_association: string
    • body: string
    • commit_id: string
    • created_at: string
    • diff_hunk: string
    • html_url: string
    • id: number
    • in_reply_to_id: number
    • line: number
    • node_id: string
    • original_commit_id: string
    • original_line: number
    • original_position: number
    • original_start_line: number
    • path: string
    • position: number
    • pull_request_review_id: number
    • pull_request_url: string
    • side: string
    • start_line: number
    • start_side: string
    • updated_at: string
    • url: string
    • user: PullsListCommentsResponseItemUser

    PullsListCommentsResponseItemLinks

    PullsListCommentsResponseItemLinks: { html: PullsListCommentsResponseItemLinksHtml; pull_request: PullsListCommentsResponseItemLinksPullRequest; self: PullsListCommentsResponseItemLinksSelf }

    Type declaration

    PullsListCommentsResponseItemLinksHtml

    PullsListCommentsResponseItemLinksHtml: { href: string }

    Type declaration

    • href: string

    PullsListCommentsResponseItemLinksPullRequest

    PullsListCommentsResponseItemLinksPullRequest: { href: string }

    Type declaration

    • href: string

    PullsListCommentsResponseItemLinksSelf

    PullsListCommentsResponseItemLinksSelf: { href: string }

    Type declaration

    • href: string

    PullsListCommentsResponseItemUser

    PullsListCommentsResponseItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsListCommitsParams

    PullsListCommitsParams: { owner: string; page?: undefined | number; per_page?: undefined | number; pull_number: number; repo: string }

    Type declaration

    • owner: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • pull_number: number
    • repo: string

    PullsListCommitsParamsDeprecatedNumber

    PullsListCommitsParamsDeprecatedNumber: { number: number; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

    Type declaration

    • number: number
      deprecated

      "number" parameter renamed to "pull_number"

    • owner: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • repo: string

    PullsListCommitsResponse

    PullsListCommitsResponse: Array<PullsListCommitsResponseItem>

    PullsListCommitsResponseItem

    PullsListCommitsResponseItem: { author: PullsListCommitsResponseItemAuthor; comments_url: string; commit: PullsListCommitsResponseItemCommit; committer: PullsListCommitsResponseItemCommitter; html_url: string; node_id: string; parents: Array<PullsListCommitsResponseItemParentsItem>; sha: string; url: string }

    Type declaration

    PullsListCommitsResponseItemAuthor

    PullsListCommitsResponseItemAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsListCommitsResponseItemCommit

    PullsListCommitsResponseItemCommit: { author: PullsListCommitsResponseItemCommitAuthor; comment_count: number; committer: PullsListCommitsResponseItemCommitCommitter; message: string; tree: PullsListCommitsResponseItemCommitTree; url: string; verification: PullsListCommitsResponseItemCommitVerification }

    Type declaration

    PullsListCommitsResponseItemCommitAuthor

    PullsListCommitsResponseItemCommitAuthor: { date: string; email: string; name: string }

    Type declaration

    • date: string
    • email: string
    • name: string

    PullsListCommitsResponseItemCommitCommitter

    PullsListCommitsResponseItemCommitCommitter: { date: string; email: string; name: string }

    Type declaration

    • date: string
    • email: string
    • name: string

    PullsListCommitsResponseItemCommitTree

    PullsListCommitsResponseItemCommitTree: { sha: string; url: string }

    Type declaration

    • sha: string
    • url: string

    PullsListCommitsResponseItemCommitVerification

    PullsListCommitsResponseItemCommitVerification: { payload: null; reason: string; signature: null; verified: boolean }

    Type declaration

    • payload: null
    • reason: string
    • signature: null
    • verified: boolean

    PullsListCommitsResponseItemCommitter

    PullsListCommitsResponseItemCommitter: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsListCommitsResponseItemParentsItem

    PullsListCommitsResponseItemParentsItem: { sha: string; url: string }

    Type declaration

    • sha: string
    • url: string

    PullsListFilesParams

    PullsListFilesParams: { owner: string; page?: undefined | number; per_page?: undefined | number; pull_number: number; repo: string }

    Type declaration

    • owner: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • pull_number: number
    • repo: string

    PullsListFilesParamsDeprecatedNumber

    PullsListFilesParamsDeprecatedNumber: { number: number; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

    Type declaration

    • number: number
      deprecated

      "number" parameter renamed to "pull_number"

    • owner: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • repo: string

    PullsListFilesResponse

    PullsListFilesResponse: Array<PullsListFilesResponseItem>

    PullsListFilesResponseItem

    PullsListFilesResponseItem: { additions: number; blob_url: string; changes: number; contents_url: string; deletions: number; filename: string; patch: string; raw_url: string; sha: string; status: string }

    Type declaration

    • additions: number
    • blob_url: string
    • changes: number
    • contents_url: string
    • deletions: number
    • filename: string
    • patch: string
    • raw_url: string
    • sha: string
    • status: string

    PullsListParams

    PullsListParams: { base?: undefined | string; direction?: "asc" | "desc"; head?: undefined | string; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string; sort?: "created" | "updated" | "popularity" | "long-running"; state?: "open" | "closed" | "all" }

    Type declaration

    • Optional base?: undefined | string

      Filter pulls by base branch name. Example: gh-pages.

    • Optional direction?: "asc" | "desc"

      The direction of the sort. Can be either asc or desc. Default: desc when sort is created or sort is not specified, otherwise asc.

    • Optional head?: undefined | string

      Filter pulls by head user or head organization and branch name in the format of user:ref-name or organization:ref-name. For example: github:new-script-format or octocat:test-branch.

    • owner: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • repo: string
    • Optional sort?: "created" | "updated" | "popularity" | "long-running"

      What to sort results by. Can be either created, updated, popularity (comment count) or long-running (age, filtering by pulls updated in the last month).

    • Optional state?: "open" | "closed" | "all"

      Either open, closed, or all to filter by state.

    PullsListResponse

    PullsListResponse: Array<PullsListResponseItem>

    PullsListResponseItem

    PullsListResponseItem: { _links: PullsListResponseItemLinks; active_lock_reason: string; assignee: PullsListResponseItemAssignee; assignees: Array<PullsListResponseItemAssigneesItem>; author_association: string; base: PullsListResponseItemBase; body: string; closed_at: string; comments_url: string; commits_url: string; created_at: string; diff_url: string; draft: boolean; head: PullsListResponseItemHead; html_url: string; id: number; issue_url: string; labels: Array<PullsListResponseItemLabelsItem>; locked: boolean; merge_commit_sha: string; merged_at: string; milestone: PullsListResponseItemMilestone; node_id: string; number: number; patch_url: string; requested_reviewers: Array<PullsListResponseItemRequestedReviewersItem>; requested_teams: Array<PullsListResponseItemRequestedTeamsItem>; review_comment_url: string; review_comments_url: string; state: string; statuses_url: string; title: string; updated_at: string; url: string; user: PullsListResponseItemUser }

    Type declaration

    PullsListResponseItemAssignee

    PullsListResponseItemAssignee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsListResponseItemAssigneesItem

    PullsListResponseItemAssigneesItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsListResponseItemBase

    PullsListResponseItemBase: { label: string; ref: string; repo: PullsListResponseItemBaseRepo; sha: string; user: PullsListResponseItemBaseUser }

    Type declaration

    PullsListResponseItemBaseRepo

    PullsListResponseItemBaseRepo: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: PullsListResponseItemBaseRepoOwner; permissions: PullsListResponseItemBaseRepoPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

    Type declaration

    • allow_merge_commit: boolean
    • allow_rebase_merge: boolean
    • allow_squash_merge: boolean
    • archive_url: string
    • archived: boolean
    • assignees_url: string
    • blobs_url: string
    • branches_url: string
    • clone_url: string
    • collaborators_url: string
    • comments_url: string
    • commits_url: string
    • compare_url: string
    • contents_url: string
    • contributors_url: string
    • created_at: string
    • default_branch: string
    • deployments_url: string
    • description: string
    • disabled: boolean
    • downloads_url: string
    • events_url: string
    • fork: boolean
    • forks_count: number
    • forks_url: string
    • full_name: string
    • git_commits_url: string
    • git_refs_url: string
    • git_tags_url: string
    • git_url: string
    • has_downloads: boolean
    • has_issues: boolean
    • has_pages: boolean
    • has_projects: boolean
    • has_wiki: boolean
    • homepage: string
    • hooks_url: string
    • html_url: string
    • id: number
    • is_template: boolean
    • issue_comment_url: string
    • issue_events_url: string
    • issues_url: string
    • keys_url: string
    • labels_url: string
    • language: null
    • languages_url: string
    • merges_url: string
    • milestones_url: string
    • mirror_url: string
    • name: string
    • network_count: number
    • node_id: string
    • notifications_url: string
    • open_issues_count: number
    • owner: PullsListResponseItemBaseRepoOwner
    • permissions: PullsListResponseItemBaseRepoPermissions
    • private: boolean
    • pulls_url: string
    • pushed_at: string
    • releases_url: string
    • size: number
    • ssh_url: string
    • stargazers_count: number
    • stargazers_url: string
    • statuses_url: string
    • subscribers_count: number
    • subscribers_url: string
    • subscription_url: string
    • svn_url: string
    • tags_url: string
    • teams_url: string
    • temp_clone_token: string
    • template_repository: null
    • topics: Array<string>
    • trees_url: string
    • updated_at: string
    • url: string
    • visibility: string
    • watchers_count: number

    PullsListResponseItemBaseRepoOwner

    PullsListResponseItemBaseRepoOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsListResponseItemBaseRepoPermissions

    PullsListResponseItemBaseRepoPermissions: { admin: boolean; pull: boolean; push: boolean }

    Type declaration

    • admin: boolean
    • pull: boolean
    • push: boolean

    PullsListResponseItemBaseUser

    PullsListResponseItemBaseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsListResponseItemHead

    PullsListResponseItemHead: { label: string; ref: string; repo: PullsListResponseItemHeadRepo; sha: string; user: PullsListResponseItemHeadUser }

    Type declaration

    PullsListResponseItemHeadRepo

    PullsListResponseItemHeadRepo: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: PullsListResponseItemHeadRepoOwner; permissions: PullsListResponseItemHeadRepoPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

    Type declaration

    • allow_merge_commit: boolean
    • allow_rebase_merge: boolean
    • allow_squash_merge: boolean
    • archive_url: string
    • archived: boolean
    • assignees_url: string
    • blobs_url: string
    • branches_url: string
    • clone_url: string
    • collaborators_url: string
    • comments_url: string
    • commits_url: string
    • compare_url: string
    • contents_url: string
    • contributors_url: string
    • created_at: string
    • default_branch: string
    • deployments_url: string
    • description: string
    • disabled: boolean
    • downloads_url: string
    • events_url: string
    • fork: boolean
    • forks_count: number
    • forks_url: string
    • full_name: string
    • git_commits_url: string
    • git_refs_url: string
    • git_tags_url: string
    • git_url: string
    • has_downloads: boolean
    • has_issues: boolean
    • has_pages: boolean
    • has_projects: boolean
    • has_wiki: boolean
    • homepage: string
    • hooks_url: string
    • html_url: string
    • id: number
    • is_template: boolean
    • issue_comment_url: string
    • issue_events_url: string
    • issues_url: string
    • keys_url: string
    • labels_url: string
    • language: null
    • languages_url: string
    • merges_url: string
    • milestones_url: string
    • mirror_url: string
    • name: string
    • network_count: number
    • node_id: string
    • notifications_url: string
    • open_issues_count: number
    • owner: PullsListResponseItemHeadRepoOwner
    • permissions: PullsListResponseItemHeadRepoPermissions
    • private: boolean
    • pulls_url: string
    • pushed_at: string
    • releases_url: string
    • size: number
    • ssh_url: string
    • stargazers_count: number
    • stargazers_url: string
    • statuses_url: string
    • subscribers_count: number
    • subscribers_url: string
    • subscription_url: string
    • svn_url: string
    • tags_url: string
    • teams_url: string
    • temp_clone_token: string
    • template_repository: null
    • topics: Array<string>
    • trees_url: string
    • updated_at: string
    • url: string
    • visibility: string
    • watchers_count: number

    PullsListResponseItemHeadRepoOwner

    PullsListResponseItemHeadRepoOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsListResponseItemHeadRepoPermissions

    PullsListResponseItemHeadRepoPermissions: { admin: boolean; pull: boolean; push: boolean }

    Type declaration

    • admin: boolean
    • pull: boolean
    • push: boolean

    PullsListResponseItemHeadUser

    PullsListResponseItemHeadUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsListResponseItemLabelsItem

    PullsListResponseItemLabelsItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

    Type declaration

    • color: string
    • default: boolean
    • description: string
    • id: number
    • name: string
    • node_id: string
    • url: string

    PullsListResponseItemLinks

    PullsListResponseItemLinks: { comments: PullsListResponseItemLinksComments; commits: PullsListResponseItemLinksCommits; html: PullsListResponseItemLinksHtml; issue: PullsListResponseItemLinksIssue; review_comment: PullsListResponseItemLinksReviewComment; review_comments: PullsListResponseItemLinksReviewComments; self: PullsListResponseItemLinksSelf; statuses: PullsListResponseItemLinksStatuses }

    Type declaration

    PullsListResponseItemLinksComments

    PullsListResponseItemLinksComments: { href: string }

    Type declaration

    • href: string

    PullsListResponseItemLinksCommits

    PullsListResponseItemLinksCommits: { href: string }

    Type declaration

    • href: string

    PullsListResponseItemLinksHtml

    PullsListResponseItemLinksHtml: { href: string }

    Type declaration

    • href: string

    PullsListResponseItemLinksIssue

    PullsListResponseItemLinksIssue: { href: string }

    Type declaration

    • href: string

    PullsListResponseItemLinksReviewComment

    PullsListResponseItemLinksReviewComment: { href: string }

    Type declaration

    • href: string

    PullsListResponseItemLinksReviewComments

    PullsListResponseItemLinksReviewComments: { href: string }

    Type declaration

    • href: string

    PullsListResponseItemLinksSelf

    PullsListResponseItemLinksSelf: { href: string }

    Type declaration

    • href: string

    PullsListResponseItemLinksStatuses

    PullsListResponseItemLinksStatuses: { href: string }

    Type declaration

    • href: string

    PullsListResponseItemMilestone

    PullsListResponseItemMilestone: { closed_at: string; closed_issues: number; created_at: string; creator: PullsListResponseItemMilestoneCreator; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }

    Type declaration

    • closed_at: string
    • closed_issues: number
    • created_at: string
    • creator: PullsListResponseItemMilestoneCreator
    • description: string
    • due_on: string
    • html_url: string
    • id: number
    • labels_url: string
    • node_id: string
    • number: number
    • open_issues: number
    • state: string
    • title: string
    • updated_at: string
    • url: string

    PullsListResponseItemMilestoneCreator

    PullsListResponseItemMilestoneCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsListResponseItemRequestedReviewersItem

    PullsListResponseItemRequestedReviewersItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsListResponseItemRequestedTeamsItem

    PullsListResponseItemRequestedTeamsItem: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: null; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

    Type declaration

    • description: string
    • html_url: string
    • id: number
    • members_url: string
    • name: string
    • node_id: string
    • parent: null
    • permission: string
    • privacy: string
    • repositories_url: string
    • slug: string
    • url: string

    PullsListResponseItemUser

    PullsListResponseItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsListReviewRequestsParams

    PullsListReviewRequestsParams: { owner: string; page?: undefined | number; per_page?: undefined | number; pull_number: number; repo: string }

    Type declaration

    • owner: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • pull_number: number
    • repo: string

    PullsListReviewRequestsParamsDeprecatedNumber

    PullsListReviewRequestsParamsDeprecatedNumber: { number: number; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

    Type declaration

    • number: number
      deprecated

      "number" parameter renamed to "pull_number"

    • owner: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • repo: string

    PullsListReviewRequestsResponse

    PullsListReviewRequestsResponse: { teams: Array<PullsListReviewRequestsResponseTeamsItem>; users: Array<PullsListReviewRequestsResponseUsersItem> }

    Type declaration

    PullsListReviewRequestsResponseTeamsItem

    PullsListReviewRequestsResponseTeamsItem: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: null; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

    Type declaration

    • description: string
    • html_url: string
    • id: number
    • members_url: string
    • name: string
    • node_id: string
    • parent: null
    • permission: string
    • privacy: string
    • repositories_url: string
    • slug: string
    • url: string

    PullsListReviewRequestsResponseUsersItem

    PullsListReviewRequestsResponseUsersItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsListReviewsParams

    PullsListReviewsParams: { owner: string; page?: undefined | number; per_page?: undefined | number; pull_number: number; repo: string }

    Type declaration

    • owner: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • pull_number: number
    • repo: string

    PullsListReviewsParamsDeprecatedNumber

    PullsListReviewsParamsDeprecatedNumber: { number: number; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

    Type declaration

    • number: number
      deprecated

      "number" parameter renamed to "pull_number"

    • owner: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • repo: string

    PullsListReviewsResponse

    PullsListReviewsResponse: Array<PullsListReviewsResponseItem>

    PullsListReviewsResponseItem

    PullsListReviewsResponseItem: { _links: PullsListReviewsResponseItemLinks; body: string; commit_id: string; html_url: string; id: number; node_id: string; pull_request_url: string; state: string; submitted_at: string; user: PullsListReviewsResponseItemUser }

    Type declaration

    PullsListReviewsResponseItemLinks

    PullsListReviewsResponseItemLinks: { html: PullsListReviewsResponseItemLinksHtml; pull_request: PullsListReviewsResponseItemLinksPullRequest }

    Type declaration

    PullsListReviewsResponseItemLinksHtml

    PullsListReviewsResponseItemLinksHtml: { href: string }

    Type declaration

    • href: string

    PullsListReviewsResponseItemLinksPullRequest

    PullsListReviewsResponseItemLinksPullRequest: { href: string }

    Type declaration

    • href: string

    PullsListReviewsResponseItemUser

    PullsListReviewsResponseItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsMergeParams

    PullsMergeParams: { commit_message?: undefined | string; commit_title?: undefined | string; merge_method?: "merge" | "squash" | "rebase"; owner: string; pull_number: number; repo: string; sha?: undefined | string }

    Type declaration

    • Optional commit_message?: undefined | string

      Extra detail to append to automatic commit message.

    • Optional commit_title?: undefined | string

      Title for the automatic commit message.

    • Optional merge_method?: "merge" | "squash" | "rebase"

      Merge method to use. Possible values are merge, squash or rebase. Default is merge.

    • owner: string
    • pull_number: number
    • repo: string
    • Optional sha?: undefined | string

      SHA that pull request head must match to allow merge.

    PullsMergeParamsDeprecatedNumber

    PullsMergeParamsDeprecatedNumber: { commit_message?: undefined | string; commit_title?: undefined | string; merge_method?: "merge" | "squash" | "rebase"; number: number; owner: string; repo: string; sha?: undefined | string }

    Type declaration

    • Optional commit_message?: undefined | string

      Extra detail to append to automatic commit message.

    • Optional commit_title?: undefined | string

      Title for the automatic commit message.

    • Optional merge_method?: "merge" | "squash" | "rebase"

      Merge method to use. Possible values are merge, squash or rebase. Default is merge.

    • number: number
      deprecated

      "number" parameter renamed to "pull_number"

    • owner: string
    • repo: string
    • Optional sha?: undefined | string

      SHA that pull request head must match to allow merge.

    PullsMergeResponse

    PullsMergeResponse: { merged: boolean; message: string; sha: string }

    Type declaration

    • merged: boolean
    • message: string
    • sha: string

    PullsSubmitReviewParams

    PullsSubmitReviewParams: { body?: undefined | string; event: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; owner: string; pull_number: number; repo: string; review_id: number }

    Type declaration

    • Optional body?: undefined | string

      The body text of the pull request review

    • event: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"

      The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. When you leave this blank, the API returns HTTP 422 (Unrecognizable entity) and sets the review action state to PENDING, which means you will need to re-submit the pull request review using a review action.

    • owner: string
    • pull_number: number
    • repo: string
    • review_id: number

    PullsSubmitReviewParamsDeprecatedNumber

    PullsSubmitReviewParamsDeprecatedNumber: { body?: undefined | string; event: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; number: number; owner: string; repo: string; review_id: number }

    Type declaration

    • Optional body?: undefined | string

      The body text of the pull request review

    • event: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"

      The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. When you leave this blank, the API returns HTTP 422 (Unrecognizable entity) and sets the review action state to PENDING, which means you will need to re-submit the pull request review using a review action.

    • number: number
      deprecated

      "number" parameter renamed to "pull_number"

    • owner: string
    • repo: string
    • review_id: number

    PullsSubmitReviewResponse

    PullsSubmitReviewResponse: { _links: PullsSubmitReviewResponseLinks; body: string; commit_id: string; html_url: string; id: number; node_id: string; pull_request_url: string; state: string; submitted_at: string; user: PullsSubmitReviewResponseUser }

    Type declaration

    PullsSubmitReviewResponseLinks

    PullsSubmitReviewResponseLinks: { html: PullsSubmitReviewResponseLinksHtml; pull_request: PullsSubmitReviewResponseLinksPullRequest }

    Type declaration

    PullsSubmitReviewResponseLinksHtml

    PullsSubmitReviewResponseLinksHtml: { href: string }

    Type declaration

    • href: string

    PullsSubmitReviewResponseLinksPullRequest

    PullsSubmitReviewResponseLinksPullRequest: { href: string }

    Type declaration

    • href: string

    PullsSubmitReviewResponseUser

    PullsSubmitReviewResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsUpdateBranchParams

    PullsUpdateBranchParams: { expected_head_sha?: undefined | string; owner: string; pull_number: number; repo: string }

    Type declaration

    • Optional expected_head_sha?: undefined | string

      The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a 422 Unprocessable Entity status. You can use the "List commits on a repository" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.

    • owner: string
    • pull_number: number
    • repo: string

    PullsUpdateBranchResponse

    PullsUpdateBranchResponse: { message: string; url: string }

    Type declaration

    • message: string
    • url: string

    PullsUpdateCommentParams

    PullsUpdateCommentParams: { body: string; comment_id: number; owner: string; repo: string }

    Type declaration

    • body: string

      The text of the reply to the review comment.

    • comment_id: number
    • owner: string
    • repo: string

    PullsUpdateCommentResponse

    PullsUpdateCommentResponse: { _links: PullsUpdateCommentResponseLinks; author_association: string; body: string; commit_id: string; created_at: string; diff_hunk: string; html_url: string; id: number; in_reply_to_id: number; line: number; node_id: string; original_commit_id: string; original_line: number; original_position: number; original_start_line: number; path: string; position: number; pull_request_review_id: number; pull_request_url: string; side: string; start_line: number; start_side: string; updated_at: string; url: string; user: PullsUpdateCommentResponseUser }

    Type declaration

    • _links: PullsUpdateCommentResponseLinks
    • author_association: string
    • body: string
    • commit_id: string
    • created_at: string
    • diff_hunk: string
    • html_url: string
    • id: number
    • in_reply_to_id: number
    • line: number
    • node_id: string
    • original_commit_id: string
    • original_line: number
    • original_position: number
    • original_start_line: number
    • path: string
    • position: number
    • pull_request_review_id: number
    • pull_request_url: string
    • side: string
    • start_line: number
    • start_side: string
    • updated_at: string
    • url: string
    • user: PullsUpdateCommentResponseUser

    PullsUpdateCommentResponseLinks

    PullsUpdateCommentResponseLinks: { html: PullsUpdateCommentResponseLinksHtml; pull_request: PullsUpdateCommentResponseLinksPullRequest; self: PullsUpdateCommentResponseLinksSelf }

    Type declaration

    PullsUpdateCommentResponseLinksHtml

    PullsUpdateCommentResponseLinksHtml: { href: string }

    Type declaration

    • href: string

    PullsUpdateCommentResponseLinksPullRequest

    PullsUpdateCommentResponseLinksPullRequest: { href: string }

    Type declaration

    • href: string

    PullsUpdateCommentResponseLinksSelf

    PullsUpdateCommentResponseLinksSelf: { href: string }

    Type declaration

    • href: string

    PullsUpdateCommentResponseUser

    PullsUpdateCommentResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsUpdateParams

    PullsUpdateParams: { base?: undefined | string; body?: undefined | string; maintainer_can_modify?: undefined | false | true; owner: string; pull_number: number; repo: string; state?: "open" | "closed"; title?: undefined | string }

    Type declaration

    • Optional base?: undefined | string

      The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.

    • Optional body?: undefined | string

      The contents of the pull request.

    • Optional maintainer_can_modify?: undefined | false | true

      Indicates whether maintainers can modify the pull request.

    • owner: string
    • pull_number: number
    • repo: string
    • Optional state?: "open" | "closed"

      State of this Pull Request. Either open or closed.

    • Optional title?: undefined | string

      The title of the pull request.

    PullsUpdateParamsDeprecatedNumber

    PullsUpdateParamsDeprecatedNumber: { base?: undefined | string; body?: undefined | string; maintainer_can_modify?: undefined | false | true; number: number; owner: string; repo: string; state?: "open" | "closed"; title?: undefined | string }

    Type declaration

    • Optional base?: undefined | string

      The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.

    • Optional body?: undefined | string

      The contents of the pull request.

    • Optional maintainer_can_modify?: undefined | false | true

      Indicates whether maintainers can modify the pull request.

    • number: number
      deprecated

      "number" parameter renamed to "pull_number"

    • owner: string
    • repo: string
    • Optional state?: "open" | "closed"

      State of this Pull Request. Either open or closed.

    • Optional title?: undefined | string

      The title of the pull request.

    PullsUpdateResponse

    PullsUpdateResponse: { _links: PullsUpdateResponseLinks; active_lock_reason: string; additions: number; assignee: PullsUpdateResponseAssignee; assignees: Array<PullsUpdateResponseAssigneesItem>; author_association: string; base: PullsUpdateResponseBase; body: string; changed_files: number; closed_at: string; comments: number; comments_url: string; commits: number; commits_url: string; created_at: string; deletions: number; diff_url: string; draft: boolean; head: PullsUpdateResponseHead; html_url: string; id: number; issue_url: string; labels: Array<PullsUpdateResponseLabelsItem>; locked: boolean; maintainer_can_modify: boolean; merge_commit_sha: string; mergeable: boolean; mergeable_state: string; merged: boolean; merged_at: string; merged_by: PullsUpdateResponseMergedBy; milestone: PullsUpdateResponseMilestone; node_id: string; number: number; patch_url: string; rebaseable: boolean; requested_reviewers: Array<PullsUpdateResponseRequestedReviewersItem>; requested_teams: Array<PullsUpdateResponseRequestedTeamsItem>; review_comment_url: string; review_comments: number; review_comments_url: string; state: string; statuses_url: string; title: string; updated_at: string; url: string; user: PullsUpdateResponseUser }

    Type declaration

    PullsUpdateResponseAssignee

    PullsUpdateResponseAssignee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsUpdateResponseAssigneesItem

    PullsUpdateResponseAssigneesItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsUpdateResponseBase

    PullsUpdateResponseBase: { label: string; ref: string; repo: PullsUpdateResponseBaseRepo; sha: string; user: PullsUpdateResponseBaseUser }

    Type declaration

    PullsUpdateResponseBaseRepo

    PullsUpdateResponseBaseRepo: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: PullsUpdateResponseBaseRepoOwner; permissions: PullsUpdateResponseBaseRepoPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

    Type declaration

    • allow_merge_commit: boolean
    • allow_rebase_merge: boolean
    • allow_squash_merge: boolean
    • archive_url: string
    • archived: boolean
    • assignees_url: string
    • blobs_url: string
    • branches_url: string
    • clone_url: string
    • collaborators_url: string
    • comments_url: string
    • commits_url: string
    • compare_url: string
    • contents_url: string
    • contributors_url: string
    • created_at: string
    • default_branch: string
    • deployments_url: string
    • description: string
    • disabled: boolean
    • downloads_url: string
    • events_url: string
    • fork: boolean
    • forks_count: number
    • forks_url: string
    • full_name: string
    • git_commits_url: string
    • git_refs_url: string
    • git_tags_url: string
    • git_url: string
    • has_downloads: boolean
    • has_issues: boolean
    • has_pages: boolean
    • has_projects: boolean
    • has_wiki: boolean
    • homepage: string
    • hooks_url: string
    • html_url: string
    • id: number
    • is_template: boolean
    • issue_comment_url: string
    • issue_events_url: string
    • issues_url: string
    • keys_url: string
    • labels_url: string
    • language: null
    • languages_url: string
    • merges_url: string
    • milestones_url: string
    • mirror_url: string
    • name: string
    • network_count: number
    • node_id: string
    • notifications_url: string
    • open_issues_count: number
    • owner: PullsUpdateResponseBaseRepoOwner
    • permissions: PullsUpdateResponseBaseRepoPermissions
    • private: boolean
    • pulls_url: string
    • pushed_at: string
    • releases_url: string
    • size: number
    • ssh_url: string
    • stargazers_count: number
    • stargazers_url: string
    • statuses_url: string
    • subscribers_count: number
    • subscribers_url: string
    • subscription_url: string
    • svn_url: string
    • tags_url: string
    • teams_url: string
    • temp_clone_token: string
    • template_repository: null
    • topics: Array<string>
    • trees_url: string
    • updated_at: string
    • url: string
    • visibility: string
    • watchers_count: number

    PullsUpdateResponseBaseRepoOwner

    PullsUpdateResponseBaseRepoOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsUpdateResponseBaseRepoPermissions

    PullsUpdateResponseBaseRepoPermissions: { admin: boolean; pull: boolean; push: boolean }

    Type declaration

    • admin: boolean
    • pull: boolean
    • push: boolean

    PullsUpdateResponseBaseUser

    PullsUpdateResponseBaseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsUpdateResponseHead

    PullsUpdateResponseHead: { label: string; ref: string; repo: PullsUpdateResponseHeadRepo; sha: string; user: PullsUpdateResponseHeadUser }

    Type declaration

    PullsUpdateResponseHeadRepo

    PullsUpdateResponseHeadRepo: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: PullsUpdateResponseHeadRepoOwner; permissions: PullsUpdateResponseHeadRepoPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

    Type declaration

    • allow_merge_commit: boolean
    • allow_rebase_merge: boolean
    • allow_squash_merge: boolean
    • archive_url: string
    • archived: boolean
    • assignees_url: string
    • blobs_url: string
    • branches_url: string
    • clone_url: string
    • collaborators_url: string
    • comments_url: string
    • commits_url: string
    • compare_url: string
    • contents_url: string
    • contributors_url: string
    • created_at: string
    • default_branch: string
    • deployments_url: string
    • description: string
    • disabled: boolean
    • downloads_url: string
    • events_url: string
    • fork: boolean
    • forks_count: number
    • forks_url: string
    • full_name: string
    • git_commits_url: string
    • git_refs_url: string
    • git_tags_url: string
    • git_url: string
    • has_downloads: boolean
    • has_issues: boolean
    • has_pages: boolean
    • has_projects: boolean
    • has_wiki: boolean
    • homepage: string
    • hooks_url: string
    • html_url: string
    • id: number
    • is_template: boolean
    • issue_comment_url: string
    • issue_events_url: string
    • issues_url: string
    • keys_url: string
    • labels_url: string
    • language: null
    • languages_url: string
    • merges_url: string
    • milestones_url: string
    • mirror_url: string
    • name: string
    • network_count: number
    • node_id: string
    • notifications_url: string
    • open_issues_count: number
    • owner: PullsUpdateResponseHeadRepoOwner
    • permissions: PullsUpdateResponseHeadRepoPermissions
    • private: boolean
    • pulls_url: string
    • pushed_at: string
    • releases_url: string
    • size: number
    • ssh_url: string
    • stargazers_count: number
    • stargazers_url: string
    • statuses_url: string
    • subscribers_count: number
    • subscribers_url: string
    • subscription_url: string
    • svn_url: string
    • tags_url: string
    • teams_url: string
    • temp_clone_token: string
    • template_repository: null
    • topics: Array<string>
    • trees_url: string
    • updated_at: string
    • url: string
    • visibility: string
    • watchers_count: number

    PullsUpdateResponseHeadRepoOwner

    PullsUpdateResponseHeadRepoOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsUpdateResponseHeadRepoPermissions

    PullsUpdateResponseHeadRepoPermissions: { admin: boolean; pull: boolean; push: boolean }

    Type declaration

    • admin: boolean
    • pull: boolean
    • push: boolean

    PullsUpdateResponseHeadUser

    PullsUpdateResponseHeadUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsUpdateResponseLabelsItem

    PullsUpdateResponseLabelsItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

    Type declaration

    • color: string
    • default: boolean
    • description: string
    • id: number
    • name: string
    • node_id: string
    • url: string

    PullsUpdateResponseLinks

    PullsUpdateResponseLinks: { comments: PullsUpdateResponseLinksComments; commits: PullsUpdateResponseLinksCommits; html: PullsUpdateResponseLinksHtml; issue: PullsUpdateResponseLinksIssue; review_comment: PullsUpdateResponseLinksReviewComment; review_comments: PullsUpdateResponseLinksReviewComments; self: PullsUpdateResponseLinksSelf; statuses: PullsUpdateResponseLinksStatuses }

    Type declaration

    PullsUpdateResponseLinksComments

    PullsUpdateResponseLinksComments: { href: string }

    Type declaration

    • href: string

    PullsUpdateResponseLinksCommits

    PullsUpdateResponseLinksCommits: { href: string }

    Type declaration

    • href: string

    PullsUpdateResponseLinksHtml

    PullsUpdateResponseLinksHtml: { href: string }

    Type declaration

    • href: string

    PullsUpdateResponseLinksIssue

    PullsUpdateResponseLinksIssue: { href: string }

    Type declaration

    • href: string

    PullsUpdateResponseLinksReviewComment

    PullsUpdateResponseLinksReviewComment: { href: string }

    Type declaration

    • href: string

    PullsUpdateResponseLinksReviewComments

    PullsUpdateResponseLinksReviewComments: { href: string }

    Type declaration

    • href: string

    PullsUpdateResponseLinksSelf

    PullsUpdateResponseLinksSelf: { href: string }

    Type declaration

    • href: string

    PullsUpdateResponseLinksStatuses

    PullsUpdateResponseLinksStatuses: { href: string }

    Type declaration

    • href: string

    PullsUpdateResponseMergedBy

    PullsUpdateResponseMergedBy: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsUpdateResponseMilestone

    PullsUpdateResponseMilestone: { closed_at: string; closed_issues: number; created_at: string; creator: PullsUpdateResponseMilestoneCreator; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }

    Type declaration

    • closed_at: string
    • closed_issues: number
    • created_at: string
    • creator: PullsUpdateResponseMilestoneCreator
    • description: string
    • due_on: string
    • html_url: string
    • id: number
    • labels_url: string
    • node_id: string
    • number: number
    • open_issues: number
    • state: string
    • title: string
    • updated_at: string
    • url: string

    PullsUpdateResponseMilestoneCreator

    PullsUpdateResponseMilestoneCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsUpdateResponseRequestedReviewersItem

    PullsUpdateResponseRequestedReviewersItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsUpdateResponseRequestedTeamsItem

    PullsUpdateResponseRequestedTeamsItem: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: null; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

    Type declaration

    • description: string
    • html_url: string
    • id: number
    • members_url: string
    • name: string
    • node_id: string
    • parent: null
    • permission: string
    • privacy: string
    • repositories_url: string
    • slug: string
    • url: string

    PullsUpdateResponseUser

    PullsUpdateResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    PullsUpdateReviewParams

    PullsUpdateReviewParams: { body: string; owner: string; pull_number: number; repo: string; review_id: number }

    Type declaration

    • body: string

      The body text of the pull request review.

    • owner: string
    • pull_number: number
    • repo: string
    • review_id: number

    PullsUpdateReviewParamsDeprecatedNumber

    PullsUpdateReviewParamsDeprecatedNumber: { body: string; number: number; owner: string; repo: string; review_id: number }

    Type declaration

    • body: string

      The body text of the pull request review.

    • number: number
      deprecated

      "number" parameter renamed to "pull_number"

    • owner: string
    • repo: string
    • review_id: number

    PullsUpdateReviewResponse

    PullsUpdateReviewResponse: { _links: PullsUpdateReviewResponseLinks; body: string; commit_id: string; html_url: string; id: number; node_id: string; pull_request_url: string; state: string; user: PullsUpdateReviewResponseUser }

    Type declaration

    PullsUpdateReviewResponseLinks

    PullsUpdateReviewResponseLinks: { html: PullsUpdateReviewResponseLinksHtml; pull_request: PullsUpdateReviewResponseLinksPullRequest }

    Type declaration

    PullsUpdateReviewResponseLinksHtml

    PullsUpdateReviewResponseLinksHtml: { href: string }

    Type declaration

    • href: string

    PullsUpdateReviewResponseLinksPullRequest

    PullsUpdateReviewResponseLinksPullRequest: { href: string }

    Type declaration

    • href: string

    PullsUpdateReviewResponseUser

    PullsUpdateReviewResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    RateLimitGetResponse

    RateLimitGetResponse: { rate: RateLimitGetResponseRate; resources: RateLimitGetResponseResources }

    Type declaration

    RateLimitGetResponseRate

    RateLimitGetResponseRate: { limit: number; remaining: number; reset: number }

    Type declaration

    • limit: number
    • remaining: number
    • reset: number

    RateLimitGetResponseResources

    RateLimitGetResponseResources: { core: RateLimitGetResponseResourcesCore; graphql: RateLimitGetResponseResourcesGraphql; integration_manifest: RateLimitGetResponseResourcesIntegrationManifest; search: RateLimitGetResponseResourcesSearch }

    Type declaration

    RateLimitGetResponseResourcesCore

    RateLimitGetResponseResourcesCore: { limit: number; remaining: number; reset: number }

    Type declaration

    • limit: number
    • remaining: number
    • reset: number

    RateLimitGetResponseResourcesGraphql

    RateLimitGetResponseResourcesGraphql: { limit: number; remaining: number; reset: number }

    Type declaration

    • limit: number
    • remaining: number
    • reset: number

    RateLimitGetResponseResourcesIntegrationManifest

    RateLimitGetResponseResourcesIntegrationManifest: { limit: number; remaining: number; reset: number }

    Type declaration

    • limit: number
    • remaining: number
    • reset: number

    RateLimitGetResponseResourcesSearch

    RateLimitGetResponseResourcesSearch: { limit: number; remaining: number; reset: number }

    Type declaration

    • limit: number
    • remaining: number
    • reset: number

    ReactionsCreateForCommitCommentParams

    ReactionsCreateForCommitCommentParams: { comment_id: number; content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; owner: string; repo: string }

    Type declaration

    • comment_id: number
    • content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

      The reaction type to add to the commit comment.

    • owner: string
    • repo: string

    ReactionsCreateForCommitCommentResponse

    ReactionsCreateForCommitCommentResponse: { content: string; created_at: string; id: number; node_id: string; user: ReactionsCreateForCommitCommentResponseUser }

    Type declaration

    ReactionsCreateForCommitCommentResponseUser

    ReactionsCreateForCommitCommentResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ReactionsCreateForIssueCommentParams

    ReactionsCreateForIssueCommentParams: { comment_id: number; content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; owner: string; repo: string }

    Type declaration

    • comment_id: number
    • content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

      The reaction type to add to the issue comment.

    • owner: string
    • repo: string

    ReactionsCreateForIssueCommentResponse

    ReactionsCreateForIssueCommentResponse: { content: string; created_at: string; id: number; node_id: string; user: ReactionsCreateForIssueCommentResponseUser }

    Type declaration

    ReactionsCreateForIssueCommentResponseUser

    ReactionsCreateForIssueCommentResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ReactionsCreateForIssueParams

    ReactionsCreateForIssueParams: { content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; issue_number: number; owner: string; repo: string }

    Type declaration

    • content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

      The reaction type to add to the issue.

    • issue_number: number
    • owner: string
    • repo: string

    ReactionsCreateForIssueParamsDeprecatedNumber

    ReactionsCreateForIssueParamsDeprecatedNumber: { content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; number: number; owner: string; repo: string }

    Type declaration

    • content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

      The reaction type to add to the issue.

    • number: number
      deprecated

      "number" parameter renamed to "issue_number"

    • owner: string
    • repo: string

    ReactionsCreateForIssueResponse

    ReactionsCreateForIssueResponse: { content: string; created_at: string; id: number; node_id: string; user: ReactionsCreateForIssueResponseUser }

    Type declaration

    ReactionsCreateForIssueResponseUser

    ReactionsCreateForIssueResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ReactionsCreateForPullRequestReviewCommentParams

    ReactionsCreateForPullRequestReviewCommentParams: { comment_id: number; content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; owner: string; repo: string }

    Type declaration

    • comment_id: number
    • content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

      The reaction type to add to the pull request review comment.

    • owner: string
    • repo: string

    ReactionsCreateForPullRequestReviewCommentResponse

    ReactionsCreateForPullRequestReviewCommentResponse: { content: string; created_at: string; id: number; node_id: string; user: ReactionsCreateForPullRequestReviewCommentResponseUser }

    Type declaration

    ReactionsCreateForPullRequestReviewCommentResponseUser

    ReactionsCreateForPullRequestReviewCommentResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ReactionsCreateForTeamDiscussionCommentInOrgParams

    ReactionsCreateForTeamDiscussionCommentInOrgParams: { comment_number: number; content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; discussion_number: number; org: string; team_slug: string }

    Type declaration

    • comment_number: number
    • content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

      The reaction type to add to the team discussion comment.

    • discussion_number: number
    • org: string
    • team_slug: string

    ReactionsCreateForTeamDiscussionCommentInOrgResponse

    ReactionsCreateForTeamDiscussionCommentInOrgResponse: { content: string; created_at: string; id: number; node_id: string; user: ReactionsCreateForTeamDiscussionCommentInOrgResponseUser }

    Type declaration

    ReactionsCreateForTeamDiscussionCommentInOrgResponseUser

    ReactionsCreateForTeamDiscussionCommentInOrgResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ReactionsCreateForTeamDiscussionCommentLegacyParams

    ReactionsCreateForTeamDiscussionCommentLegacyParams: { comment_number: number; content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; discussion_number: number; team_id: number }

    Type declaration

    • comment_number: number
    • content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

      The reaction type to add to the team discussion comment.

    • discussion_number: number
    • team_id: number

    ReactionsCreateForTeamDiscussionCommentLegacyResponse

    ReactionsCreateForTeamDiscussionCommentLegacyResponse: { content: string; created_at: string; id: number; node_id: string; user: ReactionsCreateForTeamDiscussionCommentLegacyResponseUser }

    Type declaration

    ReactionsCreateForTeamDiscussionCommentLegacyResponseUser

    ReactionsCreateForTeamDiscussionCommentLegacyResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ReactionsCreateForTeamDiscussionCommentParams

    ReactionsCreateForTeamDiscussionCommentParams: { comment_number: number; content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; discussion_number: number; team_id: number }

    Type declaration

    • comment_number: number
    • content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

      The reaction type to add to the team discussion comment.

    • discussion_number: number
    • team_id: number

    ReactionsCreateForTeamDiscussionCommentResponse

    ReactionsCreateForTeamDiscussionCommentResponse: { content: string; created_at: string; id: number; node_id: string; user: ReactionsCreateForTeamDiscussionCommentResponseUser }

    Type declaration

    ReactionsCreateForTeamDiscussionCommentResponseUser

    ReactionsCreateForTeamDiscussionCommentResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ReactionsCreateForTeamDiscussionInOrgParams

    ReactionsCreateForTeamDiscussionInOrgParams: { content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; discussion_number: number; org: string; team_slug: string }

    Type declaration

    • content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

      The reaction type to add to the team discussion.

    • discussion_number: number
    • org: string
    • team_slug: string

    ReactionsCreateForTeamDiscussionInOrgResponse

    ReactionsCreateForTeamDiscussionInOrgResponse: { content: string; created_at: string; id: number; node_id: string; user: ReactionsCreateForTeamDiscussionInOrgResponseUser }

    Type declaration

    ReactionsCreateForTeamDiscussionInOrgResponseUser

    ReactionsCreateForTeamDiscussionInOrgResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ReactionsCreateForTeamDiscussionLegacyParams

    ReactionsCreateForTeamDiscussionLegacyParams: { content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; discussion_number: number; team_id: number }

    Type declaration

    • content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

      The reaction type to add to the team discussion.

    • discussion_number: number
    • team_id: number

    ReactionsCreateForTeamDiscussionLegacyResponse

    ReactionsCreateForTeamDiscussionLegacyResponse: { content: string; created_at: string; id: number; node_id: string; user: ReactionsCreateForTeamDiscussionLegacyResponseUser }

    Type declaration

    ReactionsCreateForTeamDiscussionLegacyResponseUser

    ReactionsCreateForTeamDiscussionLegacyResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ReactionsCreateForTeamDiscussionParams

    ReactionsCreateForTeamDiscussionParams: { content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; discussion_number: number; team_id: number }

    Type declaration

    • content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

      The reaction type to add to the team discussion.

    • discussion_number: number
    • team_id: number

    ReactionsCreateForTeamDiscussionResponse

    ReactionsCreateForTeamDiscussionResponse: { content: string; created_at: string; id: number; node_id: string; user: ReactionsCreateForTeamDiscussionResponseUser }

    Type declaration

    ReactionsCreateForTeamDiscussionResponseUser

    ReactionsCreateForTeamDiscussionResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ReactionsDeleteParams

    ReactionsDeleteParams: { reaction_id: number }

    Type declaration

    • reaction_id: number

    ReactionsListForCommitCommentParams

    ReactionsListForCommitCommentParams: { comment_id: number; content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

    Type declaration

    • comment_id: number
    • Optional content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

      Returns a single reaction type. Omit this parameter to list all reactions to a commit comment.

    • owner: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • repo: string

    ReactionsListForCommitCommentResponse

    ReactionsListForCommitCommentResponse: Array<ReactionsListForCommitCommentResponseItem>

    ReactionsListForCommitCommentResponseItem

    ReactionsListForCommitCommentResponseItem: { content: string; created_at: string; id: number; node_id: string; user: ReactionsListForCommitCommentResponseItemUser }

    Type declaration

    ReactionsListForCommitCommentResponseItemUser

    ReactionsListForCommitCommentResponseItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ReactionsListForIssueCommentParams

    ReactionsListForIssueCommentParams: { comment_id: number; content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

    Type declaration

    • comment_id: number
    • Optional content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

      Returns a single reaction type. Omit this parameter to list all reactions to an issue comment.

    • owner: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • repo: string

    ReactionsListForIssueCommentResponse

    ReactionsListForIssueCommentResponse: Array<ReactionsListForIssueCommentResponseItem>

    ReactionsListForIssueCommentResponseItem

    ReactionsListForIssueCommentResponseItem: { content: string; created_at: string; id: number; node_id: string; user: ReactionsListForIssueCommentResponseItemUser }

    Type declaration

    ReactionsListForIssueCommentResponseItemUser

    ReactionsListForIssueCommentResponseItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ReactionsListForIssueParams

    ReactionsListForIssueParams: { content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; issue_number: number; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

    Type declaration

    • Optional content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

      Returns a single reaction type. Omit this parameter to list all reactions to an issue.

    • issue_number: number
    • owner: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • repo: string

    ReactionsListForIssueParamsDeprecatedNumber

    ReactionsListForIssueParamsDeprecatedNumber: { content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; number: number; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

    Type declaration

    • Optional content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

      Returns a single reaction type. Omit this parameter to list all reactions to an issue.

    • number: number
      deprecated

      "number" parameter renamed to "issue_number"

    • owner: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • repo: string

    ReactionsListForIssueResponse

    ReactionsListForIssueResponse: Array<ReactionsListForIssueResponseItem>

    ReactionsListForIssueResponseItem

    ReactionsListForIssueResponseItem: { content: string; created_at: string; id: number; node_id: string; user: ReactionsListForIssueResponseItemUser }

    Type declaration

    ReactionsListForIssueResponseItemUser

    ReactionsListForIssueResponseItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ReactionsListForPullRequestReviewCommentParams

    ReactionsListForPullRequestReviewCommentParams: { comment_id: number; content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

    Type declaration

    • comment_id: number
    • Optional content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

      Returns a single reaction type. Omit this parameter to list all reactions to a pull request review comment.

    • owner: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • repo: string

    ReactionsListForPullRequestReviewCommentResponse

    ReactionsListForPullRequestReviewCommentResponse: Array<ReactionsListForPullRequestReviewCommentResponseItem>

    ReactionsListForPullRequestReviewCommentResponseItem

    ReactionsListForPullRequestReviewCommentResponseItem: { content: string; created_at: string; id: number; node_id: string; user: ReactionsListForPullRequestReviewCommentResponseItemUser }

    Type declaration

    ReactionsListForPullRequestReviewCommentResponseItemUser

    ReactionsListForPullRequestReviewCommentResponseItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ReactionsListForTeamDiscussionCommentInOrgParams

    ReactionsListForTeamDiscussionCommentInOrgParams: { comment_number: number; content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; discussion_number: number; org: string; page?: undefined | number; per_page?: undefined | number; team_slug: string }

    Type declaration

    • comment_number: number
    • Optional content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

      Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.

    • discussion_number: number
    • org: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • team_slug: string

    ReactionsListForTeamDiscussionCommentInOrgResponse

    ReactionsListForTeamDiscussionCommentInOrgResponse: Array<ReactionsListForTeamDiscussionCommentInOrgResponseItem>

    ReactionsListForTeamDiscussionCommentInOrgResponseItem

    ReactionsListForTeamDiscussionCommentInOrgResponseItem: { content: string; created_at: string; id: number; node_id: string; user: ReactionsListForTeamDiscussionCommentInOrgResponseItemUser }

    Type declaration

    ReactionsListForTeamDiscussionCommentInOrgResponseItemUser

    ReactionsListForTeamDiscussionCommentInOrgResponseItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ReactionsListForTeamDiscussionCommentLegacyParams

    ReactionsListForTeamDiscussionCommentLegacyParams: { comment_number: number; content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; discussion_number: number; page?: undefined | number; per_page?: undefined | number; team_id: number }

    Type declaration

    • comment_number: number
    • Optional content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

      Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.

    • discussion_number: number
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • team_id: number

    ReactionsListForTeamDiscussionCommentLegacyResponse

    ReactionsListForTeamDiscussionCommentLegacyResponse: Array<ReactionsListForTeamDiscussionCommentLegacyResponseItem>

    ReactionsListForTeamDiscussionCommentLegacyResponseItem

    ReactionsListForTeamDiscussionCommentLegacyResponseItem: { content: string; created_at: string; id: number; node_id: string; user: ReactionsListForTeamDiscussionCommentLegacyResponseItemUser }

    Type declaration

    ReactionsListForTeamDiscussionCommentLegacyResponseItemUser

    ReactionsListForTeamDiscussionCommentLegacyResponseItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ReactionsListForTeamDiscussionCommentParams

    ReactionsListForTeamDiscussionCommentParams: { comment_number: number; content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; discussion_number: number; page?: undefined | number; per_page?: undefined | number; team_id: number }

    Type declaration

    • comment_number: number
    • Optional content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

      Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.

    • discussion_number: number
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • team_id: number

    ReactionsListForTeamDiscussionCommentResponse

    ReactionsListForTeamDiscussionCommentResponse: Array<ReactionsListForTeamDiscussionCommentResponseItem>

    ReactionsListForTeamDiscussionCommentResponseItem

    ReactionsListForTeamDiscussionCommentResponseItem: { content: string; created_at: string; id: number; node_id: string; user: ReactionsListForTeamDiscussionCommentResponseItemUser }

    Type declaration

    ReactionsListForTeamDiscussionCommentResponseItemUser

    ReactionsListForTeamDiscussionCommentResponseItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ReactionsListForTeamDiscussionInOrgParams

    ReactionsListForTeamDiscussionInOrgParams: { content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; discussion_number: number; org: string; page?: undefined | number; per_page?: undefined | number; team_slug: string }

    Type declaration

    • Optional content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

      Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.

    • discussion_number: number
    • org: string
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • team_slug: string

    ReactionsListForTeamDiscussionInOrgResponse

    ReactionsListForTeamDiscussionInOrgResponse: Array<ReactionsListForTeamDiscussionInOrgResponseItem>

    ReactionsListForTeamDiscussionInOrgResponseItem

    ReactionsListForTeamDiscussionInOrgResponseItem: { content: string; created_at: string; id: number; node_id: string; user: ReactionsListForTeamDiscussionInOrgResponseItemUser }

    Type declaration

    ReactionsListForTeamDiscussionInOrgResponseItemUser

    ReactionsListForTeamDiscussionInOrgResponseItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ReactionsListForTeamDiscussionLegacyParams

    ReactionsListForTeamDiscussionLegacyParams: { content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; discussion_number: number; page?: undefined | number; per_page?: undefined | number; team_id: number }

    Type declaration

    • Optional content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

      Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.

    • discussion_number: number
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • team_id: number

    ReactionsListForTeamDiscussionLegacyResponse

    ReactionsListForTeamDiscussionLegacyResponse: Array<ReactionsListForTeamDiscussionLegacyResponseItem>

    ReactionsListForTeamDiscussionLegacyResponseItem

    ReactionsListForTeamDiscussionLegacyResponseItem: { content: string; created_at: string; id: number; node_id: string; user: ReactionsListForTeamDiscussionLegacyResponseItemUser }

    Type declaration

    ReactionsListForTeamDiscussionLegacyResponseItemUser

    ReactionsListForTeamDiscussionLegacyResponseItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ReactionsListForTeamDiscussionParams

    ReactionsListForTeamDiscussionParams: { content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; discussion_number: number; page?: undefined | number; per_page?: undefined | number; team_id: number }

    Type declaration

    • Optional content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

      Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.

    • discussion_number: number
    • Optional page?: undefined | number

      Page number of the results to fetch.

    • Optional per_page?: undefined | number

      Results per page (max 100)

    • team_id: number

    ReactionsListForTeamDiscussionResponse

    ReactionsListForTeamDiscussionResponse: Array<ReactionsListForTeamDiscussionResponseItem>

    ReactionsListForTeamDiscussionResponseItem

    ReactionsListForTeamDiscussionResponseItem: { content: string; created_at: string; id: number; node_id: string; user: ReactionsListForTeamDiscussionResponseItemUser }

    Type declaration

    ReactionsListForTeamDiscussionResponseItemUser

    ReactionsListForTeamDiscussionResponseItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ReposAcceptInvitationParams

    ReposAcceptInvitationParams: { invitation_id: number }

    Type declaration

    • invitation_id: number

    ReposAddCollaboratorParams

    ReposAddCollaboratorParams: { owner: string; permission?: "pull" | "push" | "admin"; repo: string; username: string }

    Type declaration

    • owner: string
    • Optional permission?: "pull" | "push" | "admin"

      The permission to grant the collaborator. Only valid on organization-owned repositories. Can be one of: * pull - can pull, but not push to or administer this repository. * push - can pull and push, but not administer this repository. * admin - can pull, push and administer this repository.

    • repo: string
    • username: string

    ReposAddCollaboratorResponse

    ReposAddCollaboratorResponse: { created_at: string; html_url: string; id: number; invitee: ReposAddCollaboratorResponseInvitee; inviter: ReposAddCollaboratorResponseInviter; permissions: string; repository: ReposAddCollaboratorResponseRepository; url: string }

    Type declaration

    ReposAddCollaboratorResponseInvitee

    ReposAddCollaboratorResponseInvitee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ReposAddCollaboratorResponseInviter

    ReposAddCollaboratorResponseInviter: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ReposAddCollaboratorResponseRepository

    ReposAddCollaboratorResponseRepository: { archive_url: string; assignees_url: string; blobs_url: string; branches_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; deployments_url: string; description: string; downloads_url: string; events_url: string; fork: boolean; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; html_url: string; id: number; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; languages_url: string; merges_url: string; milestones_url: string; name: string; node_id: string; notifications_url: string; owner: ReposAddCollaboratorResponseRepositoryOwner; private: boolean; pulls_url: string; releases_url: string; ssh_url: string; stargazers_url: string; statuses_url: string; subscribers_url: string; subscription_url: string; tags_url: string; teams_url: string; trees_url: string; url: string }

    Type declaration

    • archive_url: string
    • assignees_url: string
    • blobs_url: string
    • branches_url: string
    • collaborators_url: string
    • comments_url: string
    • commits_url: string
    • compare_url: string
    • contents_url: string
    • contributors_url: string
    • deployments_url: string
    • description: string
    • downloads_url: string
    • events_url: string
    • fork: boolean
    • forks_url: string
    • full_name: string
    • git_commits_url: string
    • git_refs_url: string
    • git_tags_url: string
    • git_url: string
    • html_url: string
    • id: number
    • issue_comment_url: string
    • issue_events_url: string
    • issues_url: string
    • keys_url: string
    • labels_url: string
    • languages_url: string
    • merges_url: string
    • milestones_url: string
    • name: string
    • node_id: string
    • notifications_url: string
    • owner: ReposAddCollaboratorResponseRepositoryOwner
    • private: boolean
    • pulls_url: string
    • releases_url: string
    • ssh_url: string
    • stargazers_url: string
    • statuses_url: string
    • subscribers_url: string
    • subscription_url: string
    • tags_url: string
    • teams_url: string
    • trees_url: string
    • url: string

    ReposAddCollaboratorResponseRepositoryOwner

    ReposAddCollaboratorResponseRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ReposAddDeployKeyParams

    ReposAddDeployKeyParams: { key: string; owner: string; read_only?: undefined | false | true; repo: string; title?: undefined | string }

    Type declaration

    • key: string

      The contents of the key.

    • owner: string
    • Optional read_only?: undefined | false | true

      If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.

      Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "Repository permission levels for an organization" and "Permission levels for a user account repository."

    • repo: string
    • Optional title?: undefined | string

      A name for the key.

    ReposAddDeployKeyResponse

    ReposAddDeployKeyResponse: { created_at: string; id: number; key: string; read_only: boolean; title: string; url: string; verified: boolean }

    Type declaration

    • created_at: string
    • id: number
    • key: string
    • read_only: boolean
    • title: string
    • url: string
    • verified: boolean

    ReposAddProtectedBranchAdminEnforcementParams

    ReposAddProtectedBranchAdminEnforcementParams: { branch: string; owner: string; repo: string }

    Type declaration

    • branch: string
    • owner: string
    • repo: string

    ReposAddProtectedBranchAdminEnforcementResponse

    ReposAddProtectedBranchAdminEnforcementResponse: { enabled: boolean; url: string }

    Type declaration

    • enabled: boolean
    • url: string

    ReposAddProtectedBranchAppRestrictionsParams

    ReposAddProtectedBranchAppRestrictionsParams: { apps: string[]; branch: string; owner: string; repo: string }

    Type declaration

    • apps: string[]
    • branch: string
    • owner: string
    • repo: string

    ReposAddProtectedBranchAppRestrictionsResponse

    ReposAddProtectedBranchAppRestrictionsResponse: Array<ReposAddProtectedBranchAppRestrictionsResponseItem>

    ReposAddProtectedBranchAppRestrictionsResponseItem

    ReposAddProtectedBranchAppRestrictionsResponseItem: { created_at: string; description: string; events: Array<string>; external_url: string; html_url: string; id: number; name: string; node_id: string; owner: ReposAddProtectedBranchAppRestrictionsResponseItemOwner; permissions: ReposAddProtectedBranchAppRestrictionsResponseItemPermissions; slug: string; updated_at: string }

    Type declaration

    ReposAddProtectedBranchAppRestrictionsResponseItemOwner

    ReposAddProtectedBranchAppRestrictionsResponseItemOwner: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

    Type declaration

    • avatar_url: string
    • description: string
    • events_url: string
    • hooks_url: string
    • id: number
    • issues_url: string
    • login: string
    • members_url: string
    • node_id: string
    • public_members_url: string
    • repos_url: string
    • url: string

    ReposAddProtectedBranchAppRestrictionsResponseItemPermissions

    ReposAddProtectedBranchAppRestrictionsResponseItemPermissions: { contents: string; issues: string; metadata: string; single_file: string }

    Type declaration

    • contents: string
    • issues: string
    • metadata: string
    • single_file: string

    ReposAddProtectedBranchRequiredSignaturesParams

    ReposAddProtectedBranchRequiredSignaturesParams: { branch: string; owner: string; repo: string }

    Type declaration

    • branch: string
    • owner: string
    • repo: string

    ReposAddProtectedBranchRequiredSignaturesResponse

    ReposAddProtectedBranchRequiredSignaturesResponse: { enabled: boolean; url: string }

    Type declaration

    • enabled: boolean
    • url: string

    ReposAddProtectedBranchRequiredStatusChecksContextsParams

    ReposAddProtectedBranchRequiredStatusChecksContextsParams: { branch: string; contexts: string[]; owner: string; repo: string }

    Type declaration

    • branch: string
    • contexts: string[]
    • owner: string
    • repo: string

    ReposAddProtectedBranchRequiredStatusChecksContextsResponse

    ReposAddProtectedBranchRequiredStatusChecksContextsResponse: Array<string>

    ReposAddProtectedBranchTeamRestrictionsParams

    ReposAddProtectedBranchTeamRestrictionsParams: { branch: string; owner: string; repo: string; teams: string[] }

    Type declaration

    • branch: string
    • owner: string
    • repo: string
    • teams: string[]

    ReposAddProtectedBranchTeamRestrictionsResponse

    ReposAddProtectedBranchTeamRestrictionsResponse: Array<ReposAddProtectedBranchTeamRestrictionsResponseItem>

    ReposAddProtectedBranchTeamRestrictionsResponseItem

    ReposAddProtectedBranchTeamRestrictionsResponseItem: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: null; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

    Type declaration

    • description: string
    • html_url: string
    • id: number
    • members_url: string
    • name: string
    • node_id: string
    • parent: null
    • permission: string
    • privacy: string
    • repositories_url: string
    • slug: string
    • url: string

    ReposAddProtectedBranchUserRestrictionsParams

    ReposAddProtectedBranchUserRestrictionsParams: { branch: string; owner: string; repo: string; users: string[] }

    Type declaration

    • branch: string
    • owner: string
    • repo: string
    • users: string[]

    ReposAddProtectedBranchUserRestrictionsResponse

    ReposAddProtectedBranchUserRestrictionsResponse: Array<ReposAddProtectedBranchUserRestrictionsResponseItem>

    ReposAddProtectedBranchUserRestrictionsResponseItem

    ReposAddProtectedBranchUserRestrictionsResponseItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ReposCheckCollaboratorParams

    ReposCheckCollaboratorParams: { owner: string; repo: string; username: string }

    Type declaration

    • owner: string
    • repo: string
    • username: string

    ReposCheckVulnerabilityAlertsParams

    ReposCheckVulnerabilityAlertsParams: { owner: string; repo: string }

    Type declaration

    • owner: string
    • repo: string

    ReposCompareCommitsParams

    ReposCompareCommitsParams: { base: string; head: string; owner: string; repo: string }

    Type declaration

    • base: string
    • head: string
    • owner: string
    • repo: string

    ReposCompareCommitsResponse

    ReposCompareCommitsResponse: { ahead_by: number; base_commit: ReposCompareCommitsResponseBaseCommit; behind_by: number; commits: Array<ReposCompareCommitsResponseCommitsItem>; diff_url: string; files: Array<ReposCompareCommitsResponseFilesItem>; html_url: string; merge_base_commit: ReposCompareCommitsResponseMergeBaseCommit; patch_url: string; permalink_url: string; status: string; total_commits: number; url: string }

    Type declaration

    ReposCompareCommitsResponseBaseCommit

    ReposCompareCommitsResponseBaseCommit: { author: ReposCompareCommitsResponseBaseCommitAuthor; comments_url: string; commit: ReposCompareCommitsResponseBaseCommitCommit; committer: ReposCompareCommitsResponseBaseCommitCommitter; html_url: string; node_id: string; parents: Array<ReposCompareCommitsResponseBaseCommitParentsItem>; sha: string; url: string }

    Type declaration

    ReposCompareCommitsResponseBaseCommitAuthor

    ReposCompareCommitsResponseBaseCommitAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ReposCompareCommitsResponseBaseCommitCommit

    ReposCompareCommitsResponseBaseCommitCommit: { author: ReposCompareCommitsResponseBaseCommitCommitAuthor; comment_count: number; committer: ReposCompareCommitsResponseBaseCommitCommitCommitter; message: string; tree: ReposCompareCommitsResponseBaseCommitCommitTree; url: string; verification: ReposCompareCommitsResponseBaseCommitCommitVerification }

    Type declaration

    ReposCompareCommitsResponseBaseCommitCommitAuthor

    ReposCompareCommitsResponseBaseCommitCommitAuthor: { date: string; email: string; name: string }

    Type declaration

    • date: string
    • email: string
    • name: string

    ReposCompareCommitsResponseBaseCommitCommitCommitter

    ReposCompareCommitsResponseBaseCommitCommitCommitter: { date: string; email: string; name: string }

    Type declaration

    • date: string
    • email: string
    • name: string

    ReposCompareCommitsResponseBaseCommitCommitTree

    ReposCompareCommitsResponseBaseCommitCommitTree: { sha: string; url: string }

    Type declaration

    • sha: string
    • url: string

    ReposCompareCommitsResponseBaseCommitCommitVerification

    ReposCompareCommitsResponseBaseCommitCommitVerification: { payload: null; reason: string; signature: null; verified: boolean }

    Type declaration

    • payload: null
    • reason: string
    • signature: null
    • verified: boolean

    ReposCompareCommitsResponseBaseCommitCommitter

    ReposCompareCommitsResponseBaseCommitCommitter: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ReposCompareCommitsResponseBaseCommitParentsItem

    ReposCompareCommitsResponseBaseCommitParentsItem: { sha: string; url: string }

    Type declaration

    • sha: string
    • url: string

    ReposCompareCommitsResponseCommitsItem

    ReposCompareCommitsResponseCommitsItem: { author: ReposCompareCommitsResponseCommitsItemAuthor; comments_url: string; commit: ReposCompareCommitsResponseCommitsItemCommit; committer: ReposCompareCommitsResponseCommitsItemCommitter; html_url: string; node_id: string; parents: Array<ReposCompareCommitsResponseCommitsItemParentsItem>; sha: string; url: string }

    Type declaration

    ReposCompareCommitsResponseCommitsItemAuthor

    ReposCompareCommitsResponseCommitsItemAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ReposCompareCommitsResponseCommitsItemCommit

    ReposCompareCommitsResponseCommitsItemCommit: { author: ReposCompareCommitsResponseCommitsItemCommitAuthor; comment_count: number; committer: ReposCompareCommitsResponseCommitsItemCommitCommitter; message: string; tree: ReposCompareCommitsResponseCommitsItemCommitTree; url: string; verification: ReposCompareCommitsResponseCommitsItemCommitVerification }

    Type declaration

    ReposCompareCommitsResponseCommitsItemCommitAuthor

    ReposCompareCommitsResponseCommitsItemCommitAuthor: { date: string; email: string; name: string }

    Type declaration

    • date: string
    • email: string
    • name: string

    ReposCompareCommitsResponseCommitsItemCommitCommitter

    ReposCompareCommitsResponseCommitsItemCommitCommitter: { date: string; email: string; name: string }

    Type declaration

    • date: string
    • email: string
    • name: string

    ReposCompareCommitsResponseCommitsItemCommitTree

    ReposCompareCommitsResponseCommitsItemCommitTree: { sha: string; url: string }

    Type declaration

    • sha: string
    • url: string

    ReposCompareCommitsResponseCommitsItemCommitVerification

    ReposCompareCommitsResponseCommitsItemCommitVerification: { payload: null; reason: string; signature: null; verified: boolean }

    Type declaration

    • payload: null
    • reason: string
    • signature: null
    • verified: boolean

    ReposCompareCommitsResponseCommitsItemCommitter

    ReposCompareCommitsResponseCommitsItemCommitter: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ReposCompareCommitsResponseCommitsItemParentsItem

    ReposCompareCommitsResponseCommitsItemParentsItem: { sha: string; url: string }

    Type declaration

    • sha: string
    • url: string

    ReposCompareCommitsResponseFilesItem

    ReposCompareCommitsResponseFilesItem: { additions: number; blob_url: string; changes: number; contents_url: string; deletions: number; filename: string; patch: string; raw_url: string; sha: string; status: string }

    Type declaration

    • additions: number
    • blob_url: string
    • changes: number
    • contents_url: string
    • deletions: number
    • filename: string
    • patch: string
    • raw_url: string
    • sha: string
    • status: string

    ReposCompareCommitsResponseMergeBaseCommit

    ReposCompareCommitsResponseMergeBaseCommit: { author: ReposCompareCommitsResponseMergeBaseCommitAuthor; comments_url: string; commit: ReposCompareCommitsResponseMergeBaseCommitCommit; committer: ReposCompareCommitsResponseMergeBaseCommitCommitter; html_url: string; node_id: string; parents: Array<ReposCompareCommitsResponseMergeBaseCommitParentsItem>; sha: string; url: string }

    Type declaration

    ReposCompareCommitsResponseMergeBaseCommitAuthor

    ReposCompareCommitsResponseMergeBaseCommitAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ReposCompareCommitsResponseMergeBaseCommitCommit

    ReposCompareCommitsResponseMergeBaseCommitCommit: { author: ReposCompareCommitsResponseMergeBaseCommitCommitAuthor; comment_count: number; committer: ReposCompareCommitsResponseMergeBaseCommitCommitCommitter; message: string; tree: ReposCompareCommitsResponseMergeBaseCommitCommitTree; url: string; verification: ReposCompareCommitsResponseMergeBaseCommitCommitVerification }

    Type declaration

    ReposCompareCommitsResponseMergeBaseCommitCommitAuthor

    ReposCompareCommitsResponseMergeBaseCommitCommitAuthor: { date: string; email: string; name: string }

    Type declaration

    • date: string
    • email: string
    • name: string

    ReposCompareCommitsResponseMergeBaseCommitCommitCommitter

    ReposCompareCommitsResponseMergeBaseCommitCommitCommitter: { date: string; email: string; name: string }

    Type declaration

    • date: string
    • email: string
    • name: string

    ReposCompareCommitsResponseMergeBaseCommitCommitTree

    ReposCompareCommitsResponseMergeBaseCommitCommitTree: { sha: string; url: string }

    Type declaration

    • sha: string
    • url: string

    ReposCompareCommitsResponseMergeBaseCommitCommitVerification

    ReposCompareCommitsResponseMergeBaseCommitCommitVerification: { payload: null; reason: string; signature: null; verified: boolean }

    Type declaration

    • payload: null
    • reason: string
    • signature: null
    • verified: boolean

    ReposCompareCommitsResponseMergeBaseCommitCommitter

    ReposCompareCommitsResponseMergeBaseCommitCommitter: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ReposCompareCommitsResponseMergeBaseCommitParentsItem

    ReposCompareCommitsResponseMergeBaseCommitParentsItem: { sha: string; url: string }

    Type declaration

    • sha: string
    • url: string

    ReposCreateCommitCommentParams

    ReposCreateCommitCommentParams: { body: string; commit_sha: string; owner: string; path?: undefined | string; position?: undefined | number; repo: string }

    Type declaration

    • body: string

      The contents of the comment.

    • commit_sha: string
    • owner: string
    • Optional path?: undefined | string

      Relative path of the file to comment on.

    • Optional position?: undefined | number

      Line index in the diff to comment on.

    • repo: string

    ReposCreateCommitCommentParamsDeprecatedLine

    ReposCreateCommitCommentParamsDeprecatedLine: { body: string; commit_sha: string; line?: undefined | number; owner: string; path?: undefined | string; position?: undefined | number; repo: string }

    Type declaration

    • body: string

      The contents of the comment.

    • commit_sha: string
    • Optional line?: undefined | number

      Deprecated. Use position parameter instead. Line number in the file to comment on.

      deprecated

      "line" parameter has been deprecated and will be removed in future

    • owner: string
    • Optional path?: undefined | string

      Relative path of the file to comment on.

    • Optional position?: undefined | number

      Line index in the diff to comment on.

    • repo: string

    ReposCreateCommitCommentParamsDeprecatedSha

    ReposCreateCommitCommentParamsDeprecatedSha: { body: string; owner: string; path?: undefined | string; position?: undefined | number; repo: string; sha: string }

    Type declaration

    • body: string

      The contents of the comment.

    • owner: string
    • Optional path?: undefined | string

      Relative path of the file to comment on.

    • Optional position?: undefined | number

      Line index in the diff to comment on.

    • repo: string
    • sha: string
      deprecated

      "sha" parameter renamed to "commit_sha"

    ReposCreateCommitCommentResponse

    ReposCreateCommitCommentResponse: { body: string; commit_id: string; created_at: string; html_url: string; id: number; line: number; node_id: string; path: string; position: number; updated_at: string; url: string; user: ReposCreateCommitCommentResponseUser }

    Type declaration

    • body: string
    • commit_id: string
    • created_at: string
    • html_url: string
    • id: number
    • line: number
    • node_id: string
    • path: string
    • position: number
    • updated_at: string
    • url: string
    • user: ReposCreateCommitCommentResponseUser

    ReposCreateCommitCommentResponseUser

    ReposCreateCommitCommentResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ReposCreateDeploymentParams

    ReposCreateDeploymentParams: { auto_merge?: undefined | false | true; description?: undefined | string; environment?: undefined | string; owner: string; payload?: undefined | string; production_environment?: undefined | false | true; ref: string; repo: string; required_contexts?: string[]; task?: undefined | string; transient_environment?: undefined | false | true }

    Type declaration

    • Optional auto_merge?: undefined | false | true

      Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.

    • Optional description?: undefined | string

      Short description of the deployment.

    • Optional environment?: undefined | string

      Name for the target deployment environment (e.g., production, staging, qa).

    • owner: string
    • Optional payload?: undefined | string

      JSON payload with extra information about the deployment.

    • Optional production_environment?: undefined | false | true

      Specifies if the given environment is one that end-users directly interact with. Default: true when environment is production and false otherwise. Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

    • ref: string

      The ref to deploy. This can be a branch, tag, or SHA.

    • repo: string
    • Optional required_contexts?: string[]

      The status contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.

    • Optional task?: undefined | string

      Specifies a task to execute (e.g., deploy or deploy:migrations).

    • Optional transient_environment?: undefined | false | true

      Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: false Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type. Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

    ReposCreateDeploymentResponse

    ReposCreateDeploymentResponse: { created_at: string; creator: ReposCreateDeploymentResponseCreator; description: string; environment: string; id: number; node_id: string; original_environment: string; payload: ReposCreateDeploymentResponsePayload; production_environment: boolean; ref: string; repository_url: string; sha: string; statuses_url: string; task: string; transient_environment: boolean; updated_at: string; url: string }

    Type declaration

    • created_at: string
    • creator: ReposCreateDeploymentResponseCreator
    • description: string
    • environment: string
    • id: number
    • node_id: string
    • original_environment: string
    • payload: ReposCreateDeploymentResponsePayload
    • production_environment: boolean
    • ref: string
    • repository_url: string
    • sha: string
    • statuses_url: string
    • task: string
    • transient_environment: boolean
    • updated_at: string
    • url: string

    ReposCreateDeploymentResponseCreator

    ReposCreateDeploymentResponseCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ReposCreateDeploymentResponsePayload

    ReposCreateDeploymentResponsePayload: { deploy: string }

    Type declaration

    • deploy: string

    ReposCreateDeploymentStatusParams

    ReposCreateDeploymentStatusParams: { auto_inactive?: undefined | false | true; deployment_id: number; description?: undefined | string; environment?: "production" | "staging" | "qa"; environment_url?: undefined | string; log_url?: undefined | string; owner: string; repo: string; state: "error" | "failure" | "inactive" | "in_progress" | "queued" | "pending" | "success"; target_url?: undefined | string }

    Type declaration

    • Optional auto_inactive?: undefined | false | true

      Adds a new inactive status to all prior non-transient, non-production environment deployments with the same repository and environment name as the created status's deployment. An inactive status is only added to deployments that had a success state. Default: true Note: To add an inactive status to production environments, you must use the application/vnd.github.flash-preview+json custom media type. Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

    • deployment_id: number
    • Optional description?: undefined | string

      A short description of the status. The maximum description length is 140 characters.

    • Optional environment?: "production" | "staging" | "qa"

      Name for the target deployment environment, which can be changed when setting a deploy status. For example, production, staging, or qa. Note: This parameter requires you to use the application/vnd.github.flash-preview+json custom media type.

    • Optional environment_url?: undefined | string

      Sets the URL for accessing your environment. Default: "" Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type. Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

    • Optional log_url?: undefined | string

      The full URL of the deployment's output. This parameter replaces target_url. We will continue to accept target_url to support legacy uses, but we recommend replacing target_url with log_url. Setting log_url will automatically set target_url to the same value. Default: "" Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type. Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

    • owner: string
    • repo: string
    • state: "error" | "failure" | "inactive" | "in_progress" | "queued" | "pending" | "success"

      The state of the status. Can be one of error, failure, inactive, in_progress, queued pending, or success. Note: To use the inactive state, you must provide the application/vnd.github.ant-man-preview+json custom media type. To use the in_progress and queued states, you must provide the application/vnd.github.flash-preview+json custom media type.

    • Optional target_url?: undefined | string

      The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. Note: It's recommended to use the log_url parameter, which replaces target_url.

    ReposCreateDeploymentStatusResponse

    ReposCreateDeploymentStatusResponse: { created_at: string; creator: ReposCreateDeploymentStatusResponseCreator; deployment_url: string; description: string; environment: string; environment_url: string; id: number; log_url: string; node_id: string; repository_url: string; state: string; target_url: string; updated_at: string; url: string }

    Type declaration

    • created_at: string
    • creator: ReposCreateDeploymentStatusResponseCreator
    • deployment_url: string
    • description: string
    • environment: string
    • environment_url: string
    • id: number
    • log_url: string
    • node_id: string
    • repository_url: string
    • state: string
    • target_url: string
    • updated_at: string
    • url: string

    ReposCreateDeploymentStatusResponseCreator

    ReposCreateDeploymentStatusResponseCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

    Type declaration

    • avatar_url: string
    • events_url: string
    • followers_url: string
    • following_url: string
    • gists_url: string
    • gravatar_id: string
    • html_url: string
    • id: number
    • login: string
    • node_id: string
    • organizations_url: string
    • received_events_url: string
    • repos_url: string
    • site_admin: boolean
    • starred_url: string
    • subscriptions_url: string
    • type: string
    • url: string

    ReposCreateDispatchEventParams

    ReposCreateDispatchEventParams: { client_payload?: ReposCreateDispatchEventParamsClientPayload; event_type?: undefined | string; owner: string; repo: string }

    Type declaration

    • Optional client_payload?: ReposCreateDispatchEventParamsClientPayload

      JSON payload with extra information about the webhook event that your action or worklow may use.

    • Optional event_type?: undefined | string

      Required: A custom webhook event name.

    • owner: string
    • repo: string

    ReposCreateDispatchEventParamsClientPayload

    ReposCreateDispatchEventParamsClientPayload: {}

    Type declaration

      ReposCreateFileParams

      ReposCreateFileParams: { author?: ReposCreateFileParamsAuthor; branch?: undefined | string; committer?: ReposCreateFileParamsCommitter; content: string; message: string; owner: string; path: string; repo: string; sha?: undefined | string }

      Type declaration

      • Optional author?: ReposCreateFileParamsAuthor

        The author of the file. Default: The committer or the authenticated user if you omit committer.

      • Optional branch?: undefined | string

        The branch name. Default: the repository’s default branch (usually master)

      • Optional committer?: ReposCreateFileParamsCommitter

        The person that committed the file. Default: the authenticated user.

      • content: string

        The new file content, using Base64 encoding.

      • message: string

        The commit message.

      • owner: string
      • path: string
      • repo: string
      • Optional sha?: undefined | string

        Required if you are updating a file. The blob SHA of the file being replaced.

      ReposCreateFileParamsAuthor

      ReposCreateFileParamsAuthor: { email: string; name: string }

      Type declaration

      • email: string
      • name: string

      ReposCreateFileParamsCommitter

      ReposCreateFileParamsCommitter: { email: string; name: string }

      Type declaration

      • email: string
      • name: string

      ReposCreateFileResponse

      ReposCreateFileResponse: { commit: ReposCreateFileResponseCommit; content: ReposCreateFileResponseContent }

      Type declaration

      ReposCreateFileResponseCommit

      ReposCreateFileResponseCommit: { author: ReposCreateFileResponseCommitAuthor; committer: ReposCreateFileResponseCommitCommitter; html_url: string; message: string; node_id: string; parents: Array<ReposCreateFileResponseCommitParentsItem>; sha: string; tree: ReposCreateFileResponseCommitTree; url: string; verification: ReposCreateFileResponseCommitVerification }

      Type declaration

      ReposCreateFileResponseCommitAuthor

      ReposCreateFileResponseCommitAuthor: { date: string; email: string; name: string }

      Type declaration

      • date: string
      • email: string
      • name: string

      ReposCreateFileResponseCommitCommitter

      ReposCreateFileResponseCommitCommitter: { date: string; email: string; name: string }

      Type declaration

      • date: string
      • email: string
      • name: string

      ReposCreateFileResponseCommitParentsItem

      ReposCreateFileResponseCommitParentsItem: { html_url: string; sha: string; url: string }

      Type declaration

      • html_url: string
      • sha: string
      • url: string

      ReposCreateFileResponseCommitTree

      ReposCreateFileResponseCommitTree: { sha: string; url: string }

      Type declaration

      • sha: string
      • url: string

      ReposCreateFileResponseCommitVerification

      ReposCreateFileResponseCommitVerification: { payload: null; reason: string; signature: null; verified: boolean }

      Type declaration

      • payload: null
      • reason: string
      • signature: null
      • verified: boolean

      ReposCreateFileResponseContent

      ReposCreateFileResponseContent: { _links: ReposCreateFileResponseContentLinks; download_url: string; git_url: string; html_url: string; name: string; path: string; sha: string; size: number; type: string; url: string }

      Type declaration

      • _links: ReposCreateFileResponseContentLinks
      • download_url: string
      • git_url: string
      • html_url: string
      • name: string
      • path: string
      • sha: string
      • size: number
      • type: string
      • url: string

      ReposCreateFileResponseContentLinks

      ReposCreateFileResponseContentLinks: { git: string; html: string; self: string }

      Type declaration

      • git: string
      • html: string
      • self: string

      ReposCreateForAuthenticatedUserParams

      ReposCreateForAuthenticatedUserParams: { allow_merge_commit?: undefined | false | true; allow_rebase_merge?: undefined | false | true; allow_squash_merge?: undefined | false | true; auto_init?: undefined | false | true; delete_branch_on_merge?: undefined | false | true; description?: undefined | string; gitignore_template?: undefined | string; has_issues?: undefined | false | true; has_projects?: undefined | false | true; has_wiki?: undefined | false | true; homepage?: undefined | string; is_template?: undefined | false | true; license_template?: undefined | string; name: string; private?: undefined | false | true; team_id?: undefined | number; visibility?: "public" | "private" | "visibility" | "internal" }

      Type declaration

      • Optional allow_merge_commit?: undefined | false | true

        Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

      • Optional allow_rebase_merge?: undefined | false | true

        Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

      • Optional allow_squash_merge?: undefined | false | true

        Either true to allow squash-merging pull requests, or false to prevent squash-merging.

      • Optional auto_init?: undefined | false | true

        Pass true to create an initial commit with empty README.

      • Optional delete_branch_on_merge?: undefined | false | true

        Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

      • Optional description?: undefined | string

        A short description of the repository.

      • Optional gitignore_template?: undefined | string

        Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, "Haskell".

      • Optional has_issues?: undefined | false | true

        Either true to enable issues for this repository or false to disable them.

      • Optional has_projects?: undefined | false | true

        Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

      • Optional has_wiki?: undefined | false | true

        Either true to enable the wiki for this repository or false to disable it.

      • Optional homepage?: undefined | string

        A URL with more information about the repository.

      • Optional is_template?: undefined | false | true

        Either true to make this repo available as a template repository or false to prevent it.

      • Optional license_template?: undefined | string

        Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, "mit" or "mpl-2.0".

      • name: string

        The name of the repository.

      • Optional private?: undefined | false | true

        Either true to create a private repository or false to create a public one. Creating private repositories requires a paid GitHub account.

      • Optional team_id?: undefined | number

        The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

      • Optional visibility?: "public" | "private" | "visibility" | "internal"

        Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud, visibility can also be internal. For more information, see "Creating an internal repository" in the GitHub Help documentation. The visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.

      ReposCreateForAuthenticatedUserResponse

      ReposCreateForAuthenticatedUserResponse: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: ReposCreateForAuthenticatedUserResponseOwner; permissions: ReposCreateForAuthenticatedUserResponsePermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

      Type declaration

      • allow_merge_commit: boolean
      • allow_rebase_merge: boolean
      • allow_squash_merge: boolean
      • archive_url: string
      • archived: boolean
      • assignees_url: string
      • blobs_url: string
      • branches_url: string
      • clone_url: string
      • collaborators_url: string
      • comments_url: string
      • commits_url: string
      • compare_url: string
      • contents_url: string
      • contributors_url: string
      • created_at: string
      • default_branch: string
      • deployments_url: string
      • description: string
      • disabled: boolean
      • downloads_url: string
      • events_url: string
      • fork: boolean
      • forks_count: number
      • forks_url: string
      • full_name: string
      • git_commits_url: string
      • git_refs_url: string
      • git_tags_url: string
      • git_url: string
      • has_downloads: boolean
      • has_issues: boolean
      • has_pages: boolean
      • has_projects: boolean
      • has_wiki: boolean
      • homepage: string
      • hooks_url: string
      • html_url: string
      • id: number
      • is_template: boolean
      • issue_comment_url: string
      • issue_events_url: string
      • issues_url: string
      • keys_url: string
      • labels_url: string
      • language: null
      • languages_url: string
      • merges_url: string
      • milestones_url: string
      • mirror_url: string
      • name: string
      • network_count: number
      • node_id: string
      • notifications_url: string
      • open_issues_count: number
      • owner: ReposCreateForAuthenticatedUserResponseOwner
      • permissions: ReposCreateForAuthenticatedUserResponsePermissions
      • private: boolean
      • pulls_url: string
      • pushed_at: string
      • releases_url: string
      • size: number
      • ssh_url: string
      • stargazers_count: number
      • stargazers_url: string
      • statuses_url: string
      • subscribers_count: number
      • subscribers_url: string
      • subscription_url: string
      • svn_url: string
      • tags_url: string
      • teams_url: string
      • temp_clone_token: string
      • template_repository: null
      • topics: Array<string>
      • trees_url: string
      • updated_at: string
      • url: string
      • visibility: string
      • watchers_count: number

      ReposCreateForAuthenticatedUserResponseOwner

      ReposCreateForAuthenticatedUserResponseOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposCreateForAuthenticatedUserResponsePermissions

      ReposCreateForAuthenticatedUserResponsePermissions: { admin: boolean; pull: boolean; push: boolean }

      Type declaration

      • admin: boolean
      • pull: boolean
      • push: boolean

      ReposCreateForkParams

      ReposCreateForkParams: { organization?: undefined | string; owner: string; repo: string }

      Type declaration

      • Optional organization?: undefined | string

        Optional parameter to specify the organization name if forking into an organization.

      • owner: string
      • repo: string

      ReposCreateForkResponse

      ReposCreateForkResponse: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: ReposCreateForkResponseOwner; permissions: ReposCreateForkResponsePermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

      Type declaration

      • allow_merge_commit: boolean
      • allow_rebase_merge: boolean
      • allow_squash_merge: boolean
      • archive_url: string
      • archived: boolean
      • assignees_url: string
      • blobs_url: string
      • branches_url: string
      • clone_url: string
      • collaborators_url: string
      • comments_url: string
      • commits_url: string
      • compare_url: string
      • contents_url: string
      • contributors_url: string
      • created_at: string
      • default_branch: string
      • deployments_url: string
      • description: string
      • disabled: boolean
      • downloads_url: string
      • events_url: string
      • fork: boolean
      • forks_count: number
      • forks_url: string
      • full_name: string
      • git_commits_url: string
      • git_refs_url: string
      • git_tags_url: string
      • git_url: string
      • has_downloads: boolean
      • has_issues: boolean
      • has_pages: boolean
      • has_projects: boolean
      • has_wiki: boolean
      • homepage: string
      • hooks_url: string
      • html_url: string
      • id: number
      • is_template: boolean
      • issue_comment_url: string
      • issue_events_url: string
      • issues_url: string
      • keys_url: string
      • labels_url: string
      • language: null
      • languages_url: string
      • merges_url: string
      • milestones_url: string
      • mirror_url: string
      • name: string
      • network_count: number
      • node_id: string
      • notifications_url: string
      • open_issues_count: number
      • owner: ReposCreateForkResponseOwner
      • permissions: ReposCreateForkResponsePermissions
      • private: boolean
      • pulls_url: string
      • pushed_at: string
      • releases_url: string
      • size: number
      • ssh_url: string
      • stargazers_count: number
      • stargazers_url: string
      • statuses_url: string
      • subscribers_count: number
      • subscribers_url: string
      • subscription_url: string
      • svn_url: string
      • tags_url: string
      • teams_url: string
      • temp_clone_token: string
      • template_repository: null
      • topics: Array<string>
      • trees_url: string
      • updated_at: string
      • url: string
      • visibility: string
      • watchers_count: number

      ReposCreateForkResponseOwner

      ReposCreateForkResponseOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposCreateForkResponsePermissions

      ReposCreateForkResponsePermissions: { admin: boolean; pull: boolean; push: boolean }

      Type declaration

      • admin: boolean
      • pull: boolean
      • push: boolean

      ReposCreateHookParams

      ReposCreateHookParams: { active?: undefined | false | true; config: ReposCreateHookParamsConfig; events?: string[]; name?: undefined | string; owner: string; repo: string }

      Type declaration

      • Optional active?: undefined | false | true

        Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

      • config: ReposCreateHookParamsConfig

        Key/value pairs to provide settings for this webhook. These are defined below.

      • Optional events?: string[]

        Determines what events the hook is triggered for.

      • Optional name?: undefined | string

        Use web to create a webhook. Default: web. This parameter only accepts the value web.

      • owner: string
      • repo: string

      ReposCreateHookParamsConfig

      ReposCreateHookParamsConfig: { content_type?: undefined | string; insecure_ssl?: undefined | string; secret?: undefined | string; url: string }

      Type declaration

      • Optional content_type?: undefined | string
      • Optional insecure_ssl?: undefined | string
      • Optional secret?: undefined | string
      • url: string

      ReposCreateHookResponse

      ReposCreateHookResponse: { active: boolean; config: ReposCreateHookResponseConfig; created_at: string; events: Array<string>; id: number; last_response: ReposCreateHookResponseLastResponse; name: string; ping_url: string; test_url: string; type: string; updated_at: string; url: string }

      Type declaration

      ReposCreateHookResponseConfig

      ReposCreateHookResponseConfig: { content_type: string; insecure_ssl: string; url: string }

      Type declaration

      • content_type: string
      • insecure_ssl: string
      • url: string

      ReposCreateHookResponseLastResponse

      ReposCreateHookResponseLastResponse: { code: null; message: null; status: string }

      Type declaration

      • code: null
      • message: null
      • status: string

      ReposCreateInOrgParams

      ReposCreateInOrgParams: { allow_merge_commit?: undefined | false | true; allow_rebase_merge?: undefined | false | true; allow_squash_merge?: undefined | false | true; auto_init?: undefined | false | true; delete_branch_on_merge?: undefined | false | true; description?: undefined | string; gitignore_template?: undefined | string; has_issues?: undefined | false | true; has_projects?: undefined | false | true; has_wiki?: undefined | false | true; homepage?: undefined | string; is_template?: undefined | false | true; license_template?: undefined | string; name: string; org: string; private?: undefined | false | true; team_id?: undefined | number; visibility?: "public" | "private" | "visibility" | "internal" }

      Type declaration

      • Optional allow_merge_commit?: undefined | false | true

        Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

      • Optional allow_rebase_merge?: undefined | false | true

        Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

      • Optional allow_squash_merge?: undefined | false | true

        Either true to allow squash-merging pull requests, or false to prevent squash-merging.

      • Optional auto_init?: undefined | false | true

        Pass true to create an initial commit with empty README.

      • Optional delete_branch_on_merge?: undefined | false | true

        Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

      • Optional description?: undefined | string

        A short description of the repository.

      • Optional gitignore_template?: undefined | string

        Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, "Haskell".

      • Optional has_issues?: undefined | false | true

        Either true to enable issues for this repository or false to disable them.

      • Optional has_projects?: undefined | false | true

        Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

      • Optional has_wiki?: undefined | false | true

        Either true to enable the wiki for this repository or false to disable it.

      • Optional homepage?: undefined | string

        A URL with more information about the repository.

      • Optional is_template?: undefined | false | true

        Either true to make this repo available as a template repository or false to prevent it.

      • Optional license_template?: undefined | string

        Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, "mit" or "mpl-2.0".

      • name: string

        The name of the repository.

      • org: string
      • Optional private?: undefined | false | true

        Either true to create a private repository or false to create a public one. Creating private repositories requires a paid GitHub account.

      • Optional team_id?: undefined | number

        The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

      • Optional visibility?: "public" | "private" | "visibility" | "internal"

        Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud, visibility can also be internal. For more information, see "Creating an internal repository" in the GitHub Help documentation. The visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.

      ReposCreateInOrgResponse

      ReposCreateInOrgResponse: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: ReposCreateInOrgResponseOwner; permissions: ReposCreateInOrgResponsePermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

      Type declaration

      • allow_merge_commit: boolean
      • allow_rebase_merge: boolean
      • allow_squash_merge: boolean
      • archive_url: string
      • archived: boolean
      • assignees_url: string
      • blobs_url: string
      • branches_url: string
      • clone_url: string
      • collaborators_url: string
      • comments_url: string
      • commits_url: string
      • compare_url: string
      • contents_url: string
      • contributors_url: string
      • created_at: string
      • default_branch: string
      • deployments_url: string
      • description: string
      • disabled: boolean
      • downloads_url: string
      • events_url: string
      • fork: boolean
      • forks_count: number
      • forks_url: string
      • full_name: string
      • git_commits_url: string
      • git_refs_url: string
      • git_tags_url: string
      • git_url: string
      • has_downloads: boolean
      • has_issues: boolean
      • has_pages: boolean
      • has_projects: boolean
      • has_wiki: boolean
      • homepage: string
      • hooks_url: string
      • html_url: string
      • id: number
      • is_template: boolean
      • issue_comment_url: string
      • issue_events_url: string
      • issues_url: string
      • keys_url: string
      • labels_url: string
      • language: null
      • languages_url: string
      • merges_url: string
      • milestones_url: string
      • mirror_url: string
      • name: string
      • network_count: number
      • node_id: string
      • notifications_url: string
      • open_issues_count: number
      • owner: ReposCreateInOrgResponseOwner
      • permissions: ReposCreateInOrgResponsePermissions
      • private: boolean
      • pulls_url: string
      • pushed_at: string
      • releases_url: string
      • size: number
      • ssh_url: string
      • stargazers_count: number
      • stargazers_url: string
      • statuses_url: string
      • subscribers_count: number
      • subscribers_url: string
      • subscription_url: string
      • svn_url: string
      • tags_url: string
      • teams_url: string
      • temp_clone_token: string
      • template_repository: null
      • topics: Array<string>
      • trees_url: string
      • updated_at: string
      • url: string
      • visibility: string
      • watchers_count: number

      ReposCreateInOrgResponseOwner

      ReposCreateInOrgResponseOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposCreateInOrgResponsePermissions

      ReposCreateInOrgResponsePermissions: { admin: boolean; pull: boolean; push: boolean }

      Type declaration

      • admin: boolean
      • pull: boolean
      • push: boolean

      ReposCreateOrUpdateFileParams

      ReposCreateOrUpdateFileParams: { author?: ReposCreateOrUpdateFileParamsAuthor; branch?: undefined | string; committer?: ReposCreateOrUpdateFileParamsCommitter; content: string; message: string; owner: string; path: string; repo: string; sha?: undefined | string }

      Type declaration

      • Optional author?: ReposCreateOrUpdateFileParamsAuthor

        The author of the file. Default: The committer or the authenticated user if you omit committer.

      • Optional branch?: undefined | string

        The branch name. Default: the repository’s default branch (usually master)

      • Optional committer?: ReposCreateOrUpdateFileParamsCommitter

        The person that committed the file. Default: the authenticated user.

      • content: string

        The new file content, using Base64 encoding.

      • message: string

        The commit message.

      • owner: string
      • path: string
      • repo: string
      • Optional sha?: undefined | string

        Required if you are updating a file. The blob SHA of the file being replaced.

      ReposCreateOrUpdateFileParamsAuthor

      ReposCreateOrUpdateFileParamsAuthor: { email: string; name: string }

      Type declaration

      • email: string
      • name: string

      ReposCreateOrUpdateFileParamsCommitter

      ReposCreateOrUpdateFileParamsCommitter: { email: string; name: string }

      Type declaration

      • email: string
      • name: string

      ReposCreateOrUpdateFileResponse

      ReposCreateOrUpdateFileResponse: { commit: ReposCreateOrUpdateFileResponseCommit; content: ReposCreateOrUpdateFileResponseContent }

      Type declaration

      ReposCreateOrUpdateFileResponseCommit

      ReposCreateOrUpdateFileResponseCommit: { author: ReposCreateOrUpdateFileResponseCommitAuthor; committer: ReposCreateOrUpdateFileResponseCommitCommitter; html_url: string; message: string; node_id: string; parents: Array<ReposCreateOrUpdateFileResponseCommitParentsItem>; sha: string; tree: ReposCreateOrUpdateFileResponseCommitTree; url: string; verification: ReposCreateOrUpdateFileResponseCommitVerification }

      Type declaration

      ReposCreateOrUpdateFileResponseCommitAuthor

      ReposCreateOrUpdateFileResponseCommitAuthor: { date: string; email: string; name: string }

      Type declaration

      • date: string
      • email: string
      • name: string

      ReposCreateOrUpdateFileResponseCommitCommitter

      ReposCreateOrUpdateFileResponseCommitCommitter: { date: string; email: string; name: string }

      Type declaration

      • date: string
      • email: string
      • name: string

      ReposCreateOrUpdateFileResponseCommitParentsItem

      ReposCreateOrUpdateFileResponseCommitParentsItem: { html_url: string; sha: string; url: string }

      Type declaration

      • html_url: string
      • sha: string
      • url: string

      ReposCreateOrUpdateFileResponseCommitTree

      ReposCreateOrUpdateFileResponseCommitTree: { sha: string; url: string }

      Type declaration

      • sha: string
      • url: string

      ReposCreateOrUpdateFileResponseCommitVerification

      ReposCreateOrUpdateFileResponseCommitVerification: { payload: null; reason: string; signature: null; verified: boolean }

      Type declaration

      • payload: null
      • reason: string
      • signature: null
      • verified: boolean

      ReposCreateOrUpdateFileResponseContent

      ReposCreateOrUpdateFileResponseContent: { _links: ReposCreateOrUpdateFileResponseContentLinks; download_url: string; git_url: string; html_url: string; name: string; path: string; sha: string; size: number; type: string; url: string }

      Type declaration

      ReposCreateOrUpdateFileResponseContentLinks

      ReposCreateOrUpdateFileResponseContentLinks: { git: string; html: string; self: string }

      Type declaration

      • git: string
      • html: string
      • self: string

      ReposCreateReleaseParams

      ReposCreateReleaseParams: { body?: undefined | string; draft?: undefined | false | true; name?: undefined | string; owner: string; prerelease?: undefined | false | true; repo: string; tag_name: string; target_commitish?: undefined | string }

      Type declaration

      • Optional body?: undefined | string

        Text describing the contents of the tag.

      • Optional draft?: undefined | false | true

        true to create a draft (unpublished) release, false to create a published one.

      • Optional name?: undefined | string

        The name of the release.

      • owner: string
      • Optional prerelease?: undefined | false | true

        true to identify the release as a prerelease. false to identify the release as a full release.

      • repo: string
      • tag_name: string

        The name of the tag.

      • Optional target_commitish?: undefined | string

        Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

      ReposCreateReleaseResponse

      ReposCreateReleaseResponse: { assets: Array<any>; assets_url: string; author: ReposCreateReleaseResponseAuthor; body: string; created_at: string; draft: boolean; html_url: string; id: number; name: string; node_id: string; prerelease: boolean; published_at: string; tag_name: string; tarball_url: string; target_commitish: string; upload_url: string; url: string; zipball_url: string }

      Type declaration

      • assets: Array<any>
      • assets_url: string
      • author: ReposCreateReleaseResponseAuthor
      • body: string
      • created_at: string
      • draft: boolean
      • html_url: string
      • id: number
      • name: string
      • node_id: string
      • prerelease: boolean
      • published_at: string
      • tag_name: string
      • tarball_url: string
      • target_commitish: string
      • upload_url: string
      • url: string
      • zipball_url: string

      ReposCreateReleaseResponseAuthor

      ReposCreateReleaseResponseAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposCreateStatusParams

      ReposCreateStatusParams: { context?: undefined | string; description?: undefined | string; owner: string; repo: string; sha: string; state: "error" | "failure" | "pending" | "success"; target_url?: undefined | string }

      Type declaration

      • Optional context?: undefined | string

        A string label to differentiate this status from the status of other systems.

      • Optional description?: undefined | string

        A short description of the status.

      • owner: string
      • repo: string
      • sha: string
      • state: "error" | "failure" | "pending" | "success"

        The state of the status. Can be one of error, failure, pending, or success.

      • Optional target_url?: undefined | string

        The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: http://ci.example.com/user/repo/build/sha

      ReposCreateStatusResponse

      ReposCreateStatusResponse: { avatar_url: string; context: string; created_at: string; creator: ReposCreateStatusResponseCreator; description: string; id: number; node_id: string; state: string; target_url: string; updated_at: string; url: string }

      Type declaration

      • avatar_url: string
      • context: string
      • created_at: string
      • creator: ReposCreateStatusResponseCreator
      • description: string
      • id: number
      • node_id: string
      • state: string
      • target_url: string
      • updated_at: string
      • url: string

      ReposCreateStatusResponseCreator

      ReposCreateStatusResponseCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposCreateUsingTemplateParams

      ReposCreateUsingTemplateParams: { description?: undefined | string; name: string; owner?: undefined | string; private?: undefined | false | true; template_owner: string; template_repo: string }

      Type declaration

      • Optional description?: undefined | string

        A short description of the new repository.

      • name: string

        The name of the new repository.

      • Optional owner?: undefined | string

        The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.

      • Optional private?: undefined | false | true

        Either true to create a new private repository or false to create a new public one.

      • template_owner: string
      • template_repo: string

      ReposCreateUsingTemplateResponse

      ReposCreateUsingTemplateResponse: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: ReposCreateUsingTemplateResponseOwner; permissions: ReposCreateUsingTemplateResponsePermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: ReposCreateUsingTemplateResponseTemplateRepository; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

      Type declaration

      • allow_merge_commit: boolean
      • allow_rebase_merge: boolean
      • allow_squash_merge: boolean
      • archive_url: string
      • archived: boolean
      • assignees_url: string
      • blobs_url: string
      • branches_url: string
      • clone_url: string
      • collaborators_url: string
      • comments_url: string
      • commits_url: string
      • compare_url: string
      • contents_url: string
      • contributors_url: string
      • created_at: string
      • default_branch: string
      • deployments_url: string
      • description: string
      • disabled: boolean
      • downloads_url: string
      • events_url: string
      • fork: boolean
      • forks_count: number
      • forks_url: string
      • full_name: string
      • git_commits_url: string
      • git_refs_url: string
      • git_tags_url: string
      • git_url: string
      • has_downloads: boolean
      • has_issues: boolean
      • has_pages: boolean
      • has_projects: boolean
      • has_wiki: boolean
      • homepage: string
      • hooks_url: string
      • html_url: string
      • id: number
      • is_template: boolean
      • issue_comment_url: string
      • issue_events_url: string
      • issues_url: string
      • keys_url: string
      • labels_url: string
      • language: null
      • languages_url: string
      • merges_url: string
      • milestones_url: string
      • mirror_url: string
      • name: string
      • network_count: number
      • node_id: string
      • notifications_url: string
      • open_issues_count: number
      • owner: ReposCreateUsingTemplateResponseOwner
      • permissions: ReposCreateUsingTemplateResponsePermissions
      • private: boolean
      • pulls_url: string
      • pushed_at: string
      • releases_url: string
      • size: number
      • ssh_url: string
      • stargazers_count: number
      • stargazers_url: string
      • statuses_url: string
      • subscribers_count: number
      • subscribers_url: string
      • subscription_url: string
      • svn_url: string
      • tags_url: string
      • teams_url: string
      • temp_clone_token: string
      • template_repository: ReposCreateUsingTemplateResponseTemplateRepository
      • topics: Array<string>
      • trees_url: string
      • updated_at: string
      • url: string
      • visibility: string
      • watchers_count: number

      ReposCreateUsingTemplateResponseOwner

      ReposCreateUsingTemplateResponseOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposCreateUsingTemplateResponsePermissions

      ReposCreateUsingTemplateResponsePermissions: { admin: boolean; pull: boolean; push: boolean }

      Type declaration

      • admin: boolean
      • pull: boolean
      • push: boolean

      ReposCreateUsingTemplateResponseTemplateRepository

      ReposCreateUsingTemplateResponseTemplateRepository: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: ReposCreateUsingTemplateResponseTemplateRepositoryOwner; permissions: ReposCreateUsingTemplateResponseTemplateRepositoryPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

      Type declaration

      • allow_merge_commit: boolean
      • allow_rebase_merge: boolean
      • allow_squash_merge: boolean
      • archive_url: string
      • archived: boolean
      • assignees_url: string
      • blobs_url: string
      • branches_url: string
      • clone_url: string
      • collaborators_url: string
      • comments_url: string
      • commits_url: string
      • compare_url: string
      • contents_url: string
      • contributors_url: string
      • created_at: string
      • default_branch: string
      • deployments_url: string
      • description: string
      • disabled: boolean
      • downloads_url: string
      • events_url: string
      • fork: boolean
      • forks_count: number
      • forks_url: string
      • full_name: string
      • git_commits_url: string
      • git_refs_url: string
      • git_tags_url: string
      • git_url: string
      • has_downloads: boolean
      • has_issues: boolean
      • has_pages: boolean
      • has_projects: boolean
      • has_wiki: boolean
      • homepage: string
      • hooks_url: string
      • html_url: string
      • id: number
      • is_template: boolean
      • issue_comment_url: string
      • issue_events_url: string
      • issues_url: string
      • keys_url: string
      • labels_url: string
      • language: null
      • languages_url: string
      • merges_url: string
      • milestones_url: string
      • mirror_url: string
      • name: string
      • network_count: number
      • node_id: string
      • notifications_url: string
      • open_issues_count: number
      • owner: ReposCreateUsingTemplateResponseTemplateRepositoryOwner
      • permissions: ReposCreateUsingTemplateResponseTemplateRepositoryPermissions
      • private: boolean
      • pulls_url: string
      • pushed_at: string
      • releases_url: string
      • size: number
      • ssh_url: string
      • stargazers_count: number
      • stargazers_url: string
      • statuses_url: string
      • subscribers_count: number
      • subscribers_url: string
      • subscription_url: string
      • svn_url: string
      • tags_url: string
      • teams_url: string
      • temp_clone_token: string
      • template_repository: null
      • topics: Array<string>
      • trees_url: string
      • updated_at: string
      • url: string
      • visibility: string
      • watchers_count: number

      ReposCreateUsingTemplateResponseTemplateRepositoryOwner

      ReposCreateUsingTemplateResponseTemplateRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposCreateUsingTemplateResponseTemplateRepositoryPermissions

      ReposCreateUsingTemplateResponseTemplateRepositoryPermissions: { admin: boolean; pull: boolean; push: boolean }

      Type declaration

      • admin: boolean
      • pull: boolean
      • push: boolean

      ReposDeclineInvitationParams

      ReposDeclineInvitationParams: { invitation_id: number }

      Type declaration

      • invitation_id: number

      ReposDeleteCommitCommentParams

      ReposDeleteCommitCommentParams: { comment_id: number; owner: string; repo: string }

      Type declaration

      • comment_id: number
      • owner: string
      • repo: string

      ReposDeleteDownloadParams

      ReposDeleteDownloadParams: { download_id: number; owner: string; repo: string }

      Type declaration

      • download_id: number
      • owner: string
      • repo: string

      ReposDeleteFileParams

      ReposDeleteFileParams: { author?: ReposDeleteFileParamsAuthor; branch?: undefined | string; committer?: ReposDeleteFileParamsCommitter; message: string; owner: string; path: string; repo: string; sha: string }

      Type declaration

      • Optional author?: ReposDeleteFileParamsAuthor

        object containing information about the author.

      • Optional branch?: undefined | string

        The branch name. Default: the repository’s default branch (usually master)

      • Optional committer?: ReposDeleteFileParamsCommitter

        object containing information about the committer.

      • message: string

        The commit message.

      • owner: string
      • path: string
      • repo: string
      • sha: string

        The blob SHA of the file being replaced.

      ReposDeleteFileParamsAuthor

      ReposDeleteFileParamsAuthor: { email?: undefined | string; name?: undefined | string }

      Type declaration

      • Optional email?: undefined | string
      • Optional name?: undefined | string

      ReposDeleteFileParamsCommitter

      ReposDeleteFileParamsCommitter: { email?: undefined | string; name?: undefined | string }

      Type declaration

      • Optional email?: undefined | string
      • Optional name?: undefined | string

      ReposDeleteFileResponse

      ReposDeleteFileResponse: { commit: ReposDeleteFileResponseCommit; content: null }

      Type declaration

      ReposDeleteFileResponseCommit

      ReposDeleteFileResponseCommit: { author: ReposDeleteFileResponseCommitAuthor; committer: ReposDeleteFileResponseCommitCommitter; html_url: string; message: string; node_id: string; parents: Array<ReposDeleteFileResponseCommitParentsItem>; sha: string; tree: ReposDeleteFileResponseCommitTree; url: string; verification: ReposDeleteFileResponseCommitVerification }

      Type declaration

      ReposDeleteFileResponseCommitAuthor

      ReposDeleteFileResponseCommitAuthor: { date: string; email: string; name: string }

      Type declaration

      • date: string
      • email: string
      • name: string

      ReposDeleteFileResponseCommitCommitter

      ReposDeleteFileResponseCommitCommitter: { date: string; email: string; name: string }

      Type declaration

      • date: string
      • email: string
      • name: string

      ReposDeleteFileResponseCommitParentsItem

      ReposDeleteFileResponseCommitParentsItem: { html_url: string; sha: string; url: string }

      Type declaration

      • html_url: string
      • sha: string
      • url: string

      ReposDeleteFileResponseCommitTree

      ReposDeleteFileResponseCommitTree: { sha: string; url: string }

      Type declaration

      • sha: string
      • url: string

      ReposDeleteFileResponseCommitVerification

      ReposDeleteFileResponseCommitVerification: { payload: null; reason: string; signature: null; verified: boolean }

      Type declaration

      • payload: null
      • reason: string
      • signature: null
      • verified: boolean

      ReposDeleteHookParams

      ReposDeleteHookParams: { hook_id: number; owner: string; repo: string }

      Type declaration

      • hook_id: number
      • owner: string
      • repo: string

      ReposDeleteInvitationParams

      ReposDeleteInvitationParams: { invitation_id: number; owner: string; repo: string }

      Type declaration

      • invitation_id: number
      • owner: string
      • repo: string

      ReposDeleteParams

      ReposDeleteParams: { owner: string; repo: string }

      Type declaration

      • owner: string
      • repo: string

      ReposDeleteReleaseAssetParams

      ReposDeleteReleaseAssetParams: { asset_id: number; owner: string; repo: string }

      Type declaration

      • asset_id: number
      • owner: string
      • repo: string

      ReposDeleteReleaseParams

      ReposDeleteReleaseParams: { owner: string; release_id: number; repo: string }

      Type declaration

      • owner: string
      • release_id: number
      • repo: string

      ReposDeleteResponse

      ReposDeleteResponse: { documentation_url: string; message: string }

      Type declaration

      • documentation_url: string
      • message: string

      ReposDisableAutomatedSecurityFixesParams

      ReposDisableAutomatedSecurityFixesParams: { owner: string; repo: string }

      Type declaration

      • owner: string
      • repo: string

      ReposDisablePagesSiteParams

      ReposDisablePagesSiteParams: { owner: string; repo: string }

      Type declaration

      • owner: string
      • repo: string

      ReposDisableVulnerabilityAlertsParams

      ReposDisableVulnerabilityAlertsParams: { owner: string; repo: string }

      Type declaration

      • owner: string
      • repo: string

      ReposEnableAutomatedSecurityFixesParams

      ReposEnableAutomatedSecurityFixesParams: { owner: string; repo: string }

      Type declaration

      • owner: string
      • repo: string

      ReposEnablePagesSiteParams

      ReposEnablePagesSiteParams: { owner: string; repo: string; source?: ReposEnablePagesSiteParamsSource }

      Type declaration

      ReposEnablePagesSiteParamsSource

      ReposEnablePagesSiteParamsSource: { branch?: "master" | "gh-pages"; path?: undefined | string }

      Type declaration

      • Optional branch?: "master" | "gh-pages"
      • Optional path?: undefined | string

      ReposEnablePagesSiteResponse

      ReposEnablePagesSiteResponse: { cname: string; custom_404: boolean; html_url: string; source: ReposEnablePagesSiteResponseSource; status: string; url: string }

      Type declaration

      ReposEnablePagesSiteResponseSource

      ReposEnablePagesSiteResponseSource: { branch: string; directory: string }

      Type declaration

      • branch: string
      • directory: string

      ReposEnableVulnerabilityAlertsParams

      ReposEnableVulnerabilityAlertsParams: { owner: string; repo: string }

      Type declaration

      • owner: string
      • repo: string

      ReposGetAppsWithAccessToProtectedBranchParams

      ReposGetAppsWithAccessToProtectedBranchParams: { branch: string; owner: string; repo: string }

      Type declaration

      • branch: string
      • owner: string
      • repo: string

      ReposGetAppsWithAccessToProtectedBranchResponse

      ReposGetAppsWithAccessToProtectedBranchResponse: Array<ReposGetAppsWithAccessToProtectedBranchResponseItem>

      ReposGetAppsWithAccessToProtectedBranchResponseItem

      ReposGetAppsWithAccessToProtectedBranchResponseItem: { created_at: string; description: string; events: Array<string>; external_url: string; html_url: string; id: number; name: string; node_id: string; owner: ReposGetAppsWithAccessToProtectedBranchResponseItemOwner; permissions: ReposGetAppsWithAccessToProtectedBranchResponseItemPermissions; slug: string; updated_at: string }

      Type declaration

      ReposGetAppsWithAccessToProtectedBranchResponseItemOwner

      ReposGetAppsWithAccessToProtectedBranchResponseItemOwner: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

      Type declaration

      • avatar_url: string
      • description: string
      • events_url: string
      • hooks_url: string
      • id: number
      • issues_url: string
      • login: string
      • members_url: string
      • node_id: string
      • public_members_url: string
      • repos_url: string
      • url: string

      ReposGetAppsWithAccessToProtectedBranchResponseItemPermissions

      ReposGetAppsWithAccessToProtectedBranchResponseItemPermissions: { contents: string; issues: string; metadata: string; single_file: string }

      Type declaration

      • contents: string
      • issues: string
      • metadata: string
      • single_file: string

      ReposGetArchiveLinkParams

      ReposGetArchiveLinkParams: { archive_format: string; owner: string; ref: string; repo: string }

      Type declaration

      • archive_format: string
      • owner: string
      • ref: string
      • repo: string

      ReposGetBranchParams

      ReposGetBranchParams: { branch: string; owner: string; repo: string }

      Type declaration

      • branch: string
      • owner: string
      • repo: string

      ReposGetBranchProtectionParams

      ReposGetBranchProtectionParams: { branch: string; owner: string; repo: string }

      Type declaration

      • branch: string
      • owner: string
      • repo: string

      ReposGetBranchProtectionResponse

      ReposGetBranchProtectionResponse: { allow_deletions: ReposGetBranchProtectionResponseAllowDeletions; allow_force_pushes: ReposGetBranchProtectionResponseAllowForcePushes; enforce_admins: ReposGetBranchProtectionResponseEnforceAdmins; required_linear_history: ReposGetBranchProtectionResponseRequiredLinearHistory; required_pull_request_reviews: ReposGetBranchProtectionResponseRequiredPullRequestReviews; required_status_checks: ReposGetBranchProtectionResponseRequiredStatusChecks; restrictions: ReposGetBranchProtectionResponseRestrictions; url: string }

      Type declaration

      ReposGetBranchProtectionResponseAllowDeletions

      ReposGetBranchProtectionResponseAllowDeletions: { enabled: boolean }

      Type declaration

      • enabled: boolean

      ReposGetBranchProtectionResponseAllowForcePushes

      ReposGetBranchProtectionResponseAllowForcePushes: { enabled: boolean }

      Type declaration

      • enabled: boolean

      ReposGetBranchProtectionResponseEnforceAdmins

      ReposGetBranchProtectionResponseEnforceAdmins: { enabled: boolean; url: string }

      Type declaration

      • enabled: boolean
      • url: string

      ReposGetBranchProtectionResponseRequiredLinearHistory

      ReposGetBranchProtectionResponseRequiredLinearHistory: { enabled: boolean }

      Type declaration

      • enabled: boolean

      ReposGetBranchProtectionResponseRequiredPullRequestReviews

      ReposGetBranchProtectionResponseRequiredPullRequestReviews: { dismiss_stale_reviews: boolean; dismissal_restrictions: ReposGetBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictions; require_code_owner_reviews: boolean; required_approving_review_count: number; url: string }

      Type declaration

      ReposGetBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictions

      ReposGetBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictions: { teams: Array<ReposGetBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictionsTeamsItem>; teams_url: string; url: string; users: Array<ReposGetBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictionsUsersItem>; users_url: string }

      Type declaration

      ReposGetBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictionsTeamsItem

      ReposGetBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictionsTeamsItem: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: null; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

      Type declaration

      • description: string
      • html_url: string
      • id: number
      • members_url: string
      • name: string
      • node_id: string
      • parent: null
      • permission: string
      • privacy: string
      • repositories_url: string
      • slug: string
      • url: string

      ReposGetBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictionsUsersItem

      ReposGetBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictionsUsersItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposGetBranchProtectionResponseRequiredStatusChecks

      ReposGetBranchProtectionResponseRequiredStatusChecks: { contexts: Array<string>; contexts_url: string; strict: boolean; url: string }

      Type declaration

      • contexts: Array<string>
      • contexts_url: string
      • strict: boolean
      • url: string

      ReposGetBranchProtectionResponseRestrictions

      ReposGetBranchProtectionResponseRestrictions: { apps: Array<ReposGetBranchProtectionResponseRestrictionsAppsItem>; apps_url: string; teams: Array<ReposGetBranchProtectionResponseRestrictionsTeamsItem>; teams_url: string; url: string; users: Array<ReposGetBranchProtectionResponseRestrictionsUsersItem>; users_url: string }

      Type declaration

      ReposGetBranchProtectionResponseRestrictionsAppsItem

      ReposGetBranchProtectionResponseRestrictionsAppsItem: { created_at: string; description: string; events: Array<string>; external_url: string; html_url: string; id: number; name: string; node_id: string; owner: ReposGetBranchProtectionResponseRestrictionsAppsItemOwner; permissions: ReposGetBranchProtectionResponseRestrictionsAppsItemPermissions; slug: string; updated_at: string }

      Type declaration

      ReposGetBranchProtectionResponseRestrictionsAppsItemOwner

      ReposGetBranchProtectionResponseRestrictionsAppsItemOwner: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

      Type declaration

      • avatar_url: string
      • description: string
      • events_url: string
      • hooks_url: string
      • id: number
      • issues_url: string
      • login: string
      • members_url: string
      • node_id: string
      • public_members_url: string
      • repos_url: string
      • url: string

      ReposGetBranchProtectionResponseRestrictionsAppsItemPermissions

      ReposGetBranchProtectionResponseRestrictionsAppsItemPermissions: { contents: string; issues: string; metadata: string; single_file: string }

      Type declaration

      • contents: string
      • issues: string
      • metadata: string
      • single_file: string

      ReposGetBranchProtectionResponseRestrictionsTeamsItem

      ReposGetBranchProtectionResponseRestrictionsTeamsItem: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: null; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

      Type declaration

      • description: string
      • html_url: string
      • id: number
      • members_url: string
      • name: string
      • node_id: string
      • parent: null
      • permission: string
      • privacy: string
      • repositories_url: string
      • slug: string
      • url: string

      ReposGetBranchProtectionResponseRestrictionsUsersItem

      ReposGetBranchProtectionResponseRestrictionsUsersItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposGetBranchResponse

      ReposGetBranchResponse: { _links: ReposGetBranchResponseLinks; commit: ReposGetBranchResponseCommit; name: string; protected: boolean; protection: ReposGetBranchResponseProtection; protection_url: string }

      Type declaration

      ReposGetBranchResponseCommit

      ReposGetBranchResponseCommit: { author: ReposGetBranchResponseCommitAuthor; commit: ReposGetBranchResponseCommitCommit; committer: ReposGetBranchResponseCommitCommitter; node_id: string; parents: Array<ReposGetBranchResponseCommitParentsItem>; sha: string; url: string }

      Type declaration

      ReposGetBranchResponseCommitAuthor

      ReposGetBranchResponseCommitAuthor: { avatar_url: string; gravatar_id: string; id: number; login: string; url: string }

      Type declaration

      • avatar_url: string
      • gravatar_id: string
      • id: number
      • login: string
      • url: string

      ReposGetBranchResponseCommitCommit

      ReposGetBranchResponseCommitCommit: { author: ReposGetBranchResponseCommitCommitAuthor; committer: ReposGetBranchResponseCommitCommitCommitter; message: string; tree: ReposGetBranchResponseCommitCommitTree; url: string; verification: ReposGetBranchResponseCommitCommitVerification }

      Type declaration

      ReposGetBranchResponseCommitCommitAuthor

      ReposGetBranchResponseCommitCommitAuthor: { date: string; email: string; name: string }

      Type declaration

      • date: string
      • email: string
      • name: string

      ReposGetBranchResponseCommitCommitCommitter

      ReposGetBranchResponseCommitCommitCommitter: { date: string; email: string; name: string }

      Type declaration

      • date: string
      • email: string
      • name: string

      ReposGetBranchResponseCommitCommitTree

      ReposGetBranchResponseCommitCommitTree: { sha: string; url: string }

      Type declaration

      • sha: string
      • url: string

      ReposGetBranchResponseCommitCommitVerification

      ReposGetBranchResponseCommitCommitVerification: { payload: null; reason: string; signature: null; verified: boolean }

      Type declaration

      • payload: null
      • reason: string
      • signature: null
      • verified: boolean

      ReposGetBranchResponseCommitCommitter

      ReposGetBranchResponseCommitCommitter: { avatar_url: string; gravatar_id: string; id: number; login: string; url: string }

      Type declaration

      • avatar_url: string
      • gravatar_id: string
      • id: number
      • login: string
      • url: string

      ReposGetBranchResponseCommitParentsItem

      ReposGetBranchResponseCommitParentsItem: { sha: string; url: string }

      Type declaration

      • sha: string
      • url: string

      ReposGetBranchResponseLinks

      ReposGetBranchResponseLinks: { html: string; self: string }

      Type declaration

      • html: string
      • self: string

      ReposGetBranchResponseProtection

      ReposGetBranchResponseProtection: { enabled: boolean; required_status_checks: ReposGetBranchResponseProtectionRequiredStatusChecks }

      Type declaration

      ReposGetBranchResponseProtectionRequiredStatusChecks

      ReposGetBranchResponseProtectionRequiredStatusChecks: { contexts: Array<string>; enforcement_level: string }

      Type declaration

      • contexts: Array<string>
      • enforcement_level: string

      ReposGetClonesParams

      ReposGetClonesParams: { owner: string; per?: "day" | "week"; repo: string }

      Type declaration

      • owner: string
      • Optional per?: "day" | "week"

        Must be one of: day, week.

      • repo: string

      ReposGetClonesResponse

      ReposGetClonesResponse: { clones: Array<ReposGetClonesResponseClonesItem>; count: number; uniques: number }

      Type declaration

      ReposGetClonesResponseClonesItem

      ReposGetClonesResponseClonesItem: { count: number; timestamp: string; uniques: number }

      Type declaration

      • count: number
      • timestamp: string
      • uniques: number

      ReposGetCodeFrequencyStatsParams

      ReposGetCodeFrequencyStatsParams: { owner: string; repo: string }

      Type declaration

      • owner: string
      • repo: string

      ReposGetCodeFrequencyStatsResponse

      ReposGetCodeFrequencyStatsResponse: Array<Array<number>>

      ReposGetCollaboratorPermissionLevelParams

      ReposGetCollaboratorPermissionLevelParams: { owner: string; repo: string; username: string }

      Type declaration

      • owner: string
      • repo: string
      • username: string

      ReposGetCollaboratorPermissionLevelResponse

      ReposGetCollaboratorPermissionLevelResponse: { permission: string; user: ReposGetCollaboratorPermissionLevelResponseUser }

      Type declaration

      ReposGetCollaboratorPermissionLevelResponseUser

      ReposGetCollaboratorPermissionLevelResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposGetCombinedStatusForRefParams

      ReposGetCombinedStatusForRefParams: { owner: string; ref: string; repo: string }

      Type declaration

      • owner: string
      • ref: string
      • repo: string

      ReposGetCombinedStatusForRefResponse

      ReposGetCombinedStatusForRefResponse: { commit_url: string; repository: ReposGetCombinedStatusForRefResponseRepository; sha: string; state: string; statuses: Array<ReposGetCombinedStatusForRefResponseStatusesItem>; total_count: number; url: string }

      Type declaration

      ReposGetCombinedStatusForRefResponseRepository

      ReposGetCombinedStatusForRefResponseRepository: { archive_url: string; assignees_url: string; blobs_url: string; branches_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; deployments_url: string; description: string; downloads_url: string; events_url: string; fork: boolean; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; html_url: string; id: number; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; languages_url: string; merges_url: string; milestones_url: string; name: string; node_id: string; notifications_url: string; owner: ReposGetCombinedStatusForRefResponseRepositoryOwner; private: boolean; pulls_url: string; releases_url: string; ssh_url: string; stargazers_url: string; statuses_url: string; subscribers_url: string; subscription_url: string; tags_url: string; teams_url: string; trees_url: string; url: string }

      Type declaration

      • archive_url: string
      • assignees_url: string
      • blobs_url: string
      • branches_url: string
      • collaborators_url: string
      • comments_url: string
      • commits_url: string
      • compare_url: string
      • contents_url: string
      • contributors_url: string
      • deployments_url: string
      • description: string
      • downloads_url: string
      • events_url: string
      • fork: boolean
      • forks_url: string
      • full_name: string
      • git_commits_url: string
      • git_refs_url: string
      • git_tags_url: string
      • git_url: string
      • html_url: string
      • id: number
      • issue_comment_url: string
      • issue_events_url: string
      • issues_url: string
      • keys_url: string
      • labels_url: string
      • languages_url: string
      • merges_url: string
      • milestones_url: string
      • name: string
      • node_id: string
      • notifications_url: string
      • owner: ReposGetCombinedStatusForRefResponseRepositoryOwner
      • private: boolean
      • pulls_url: string
      • releases_url: string
      • ssh_url: string
      • stargazers_url: string
      • statuses_url: string
      • subscribers_url: string
      • subscription_url: string
      • tags_url: string
      • teams_url: string
      • trees_url: string
      • url: string

      ReposGetCombinedStatusForRefResponseRepositoryOwner

      ReposGetCombinedStatusForRefResponseRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposGetCombinedStatusForRefResponseStatusesItem

      ReposGetCombinedStatusForRefResponseStatusesItem: { avatar_url: string; context: string; created_at: string; description: string; id: number; node_id: string; state: string; target_url: string; updated_at: string; url: string }

      Type declaration

      • avatar_url: string
      • context: string
      • created_at: string
      • description: string
      • id: number
      • node_id: string
      • state: string
      • target_url: string
      • updated_at: string
      • url: string

      ReposGetCommitActivityStatsParams

      ReposGetCommitActivityStatsParams: { owner: string; repo: string }

      Type declaration

      • owner: string
      • repo: string

      ReposGetCommitActivityStatsResponse

      ReposGetCommitActivityStatsResponse: Array<ReposGetCommitActivityStatsResponseItem>

      ReposGetCommitActivityStatsResponseItem

      ReposGetCommitActivityStatsResponseItem: { days: Array<number>; total: number; week: number }

      Type declaration

      • days: Array<number>
      • total: number
      • week: number

      ReposGetCommitCommentParams

      ReposGetCommitCommentParams: { comment_id: number; owner: string; repo: string }

      Type declaration

      • comment_id: number
      • owner: string
      • repo: string

      ReposGetCommitCommentResponse

      ReposGetCommitCommentResponse: { body: string; commit_id: string; created_at: string; html_url: string; id: number; line: number; node_id: string; path: string; position: number; updated_at: string; url: string; user: ReposGetCommitCommentResponseUser }

      Type declaration

      • body: string
      • commit_id: string
      • created_at: string
      • html_url: string
      • id: number
      • line: number
      • node_id: string
      • path: string
      • position: number
      • updated_at: string
      • url: string
      • user: ReposGetCommitCommentResponseUser

      ReposGetCommitCommentResponseUser

      ReposGetCommitCommentResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposGetCommitParams

      ReposGetCommitParams: { owner: string; ref: string; repo: string }

      Type declaration

      • owner: string
      • ref: string
      • repo: string

      ReposGetCommitParamsDeprecatedCommitSha

      ReposGetCommitParamsDeprecatedCommitSha: { commit_sha: string; owner: string; repo: string }

      Type declaration

      • commit_sha: string
        deprecated

        "commit_sha" parameter renamed to "ref"

      • owner: string
      • repo: string

      ReposGetCommitParamsDeprecatedSha

      ReposGetCommitParamsDeprecatedSha: { owner: string; repo: string; sha: string }

      Type declaration

      • owner: string
      • repo: string
      • sha: string
        deprecated

        "sha" parameter renamed to "ref"

      ReposGetCommitRefShaParams

      ReposGetCommitRefShaParams: { owner: string; ref: string; repo: string }

      Type declaration

      • owner: string
      • ref: string
      • repo: string

      ReposGetCommitResponse

      ReposGetCommitResponse: { author: ReposGetCommitResponseAuthor; comments_url: string; commit: ReposGetCommitResponseCommit; committer: ReposGetCommitResponseCommitter; files: Array<ReposGetCommitResponseFilesItem>; html_url: string; node_id: string; parents: Array<ReposGetCommitResponseParentsItem>; sha: string; stats: ReposGetCommitResponseStats; url: string }

      Type declaration

      ReposGetCommitResponseAuthor

      ReposGetCommitResponseAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposGetCommitResponseCommit

      ReposGetCommitResponseCommit: { author: ReposGetCommitResponseCommitAuthor; comment_count: number; committer: ReposGetCommitResponseCommitCommitter; message: string; tree: ReposGetCommitResponseCommitTree; url: string; verification: ReposGetCommitResponseCommitVerification }

      Type declaration

      ReposGetCommitResponseCommitAuthor

      ReposGetCommitResponseCommitAuthor: { date: string; email: string; name: string }

      Type declaration

      • date: string
      • email: string
      • name: string

      ReposGetCommitResponseCommitCommitter

      ReposGetCommitResponseCommitCommitter: { date: string; email: string; name: string }

      Type declaration

      • date: string
      • email: string
      • name: string

      ReposGetCommitResponseCommitTree

      ReposGetCommitResponseCommitTree: { sha: string; url: string }

      Type declaration

      • sha: string
      • url: string

      ReposGetCommitResponseCommitVerification

      ReposGetCommitResponseCommitVerification: { payload: null; reason: string; signature: null; verified: boolean }

      Type declaration

      • payload: null
      • reason: string
      • signature: null
      • verified: boolean

      ReposGetCommitResponseCommitter

      ReposGetCommitResponseCommitter: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposGetCommitResponseFilesItem

      ReposGetCommitResponseFilesItem: { additions: number; blob_url: string; changes: number; deletions: number; filename: string; patch: string; raw_url: string; status: string }

      Type declaration

      • additions: number
      • blob_url: string
      • changes: number
      • deletions: number
      • filename: string
      • patch: string
      • raw_url: string
      • status: string

      ReposGetCommitResponseParentsItem

      ReposGetCommitResponseParentsItem: { sha: string; url: string }

      Type declaration

      • sha: string
      • url: string

      ReposGetCommitResponseStats

      ReposGetCommitResponseStats: { additions: number; deletions: number; total: number }

      Type declaration

      • additions: number
      • deletions: number
      • total: number

      ReposGetContentsParams

      ReposGetContentsParams: { owner: string; path: string; ref?: undefined | string; repo: string }

      Type declaration

      • owner: string
      • path: string
      • Optional ref?: undefined | string

        The name of the commit/branch/tag. Default: the repository’s default branch (usually master)

      • repo: string

      ReposGetContentsResponse

      ReposGetContentsResponse: { _links: ReposGetContentsResponseLinks; content?: undefined | string; download_url: string | null; encoding?: undefined | string; git_url: string; html_url: string; name: string; path: string; sha: string; size: number; submodule_git_url?: undefined | string; target?: undefined | string; type: string; url: string } | Array<ReposGetContentsResponseItem>

      ReposGetContentsResponseItem

      ReposGetContentsResponseItem: { _links: ReposGetContentsResponseItemLinks; download_url: string | null; git_url: string; html_url: string; name: string; path: string; sha: string; size: number; type: string; url: string }

      Type declaration

      • _links: ReposGetContentsResponseItemLinks
      • download_url: string | null
      • git_url: string
      • html_url: string
      • name: string
      • path: string
      • sha: string
      • size: number
      • type: string
      • url: string

      ReposGetContentsResponseItemLinks

      ReposGetContentsResponseItemLinks: { git: string; html: string; self: string }

      Type declaration

      • git: string
      • html: string
      • self: string

      ReposGetContentsResponseLinks

      ReposGetContentsResponseLinks: { git: string; html: string; self: string }

      Type declaration

      • git: string
      • html: string
      • self: string

      ReposGetContributorsStatsParams

      ReposGetContributorsStatsParams: { owner: string; repo: string }

      Type declaration

      • owner: string
      • repo: string

      ReposGetContributorsStatsResponse

      ReposGetContributorsStatsResponse: Array<ReposGetContributorsStatsResponseItem>

      ReposGetContributorsStatsResponseItem

      ReposGetContributorsStatsResponseItem: { author: ReposGetContributorsStatsResponseItemAuthor; total: number; weeks: Array<ReposGetContributorsStatsResponseItemWeeksItem> }

      Type declaration

      ReposGetContributorsStatsResponseItemAuthor

      ReposGetContributorsStatsResponseItemAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposGetContributorsStatsResponseItemWeeksItem

      ReposGetContributorsStatsResponseItemWeeksItem: { a: number; c: number; d: number; w: string }

      Type declaration

      • a: number
      • c: number
      • d: number
      • w: string

      ReposGetDeployKeyParams

      ReposGetDeployKeyParams: { key_id: number; owner: string; repo: string }

      Type declaration

      • key_id: number
      • owner: string
      • repo: string

      ReposGetDeployKeyResponse

      ReposGetDeployKeyResponse: { created_at: string; id: number; key: string; read_only: boolean; title: string; url: string; verified: boolean }

      Type declaration

      • created_at: string
      • id: number
      • key: string
      • read_only: boolean
      • title: string
      • url: string
      • verified: boolean

      ReposGetDeploymentParams

      ReposGetDeploymentParams: { deployment_id: number; owner: string; repo: string }

      Type declaration

      • deployment_id: number
      • owner: string
      • repo: string

      ReposGetDeploymentResponse

      ReposGetDeploymentResponse: { created_at: string; creator: ReposGetDeploymentResponseCreator; description: string; environment: string; id: number; node_id: string; original_environment: string; payload: ReposGetDeploymentResponsePayload; production_environment: boolean; ref: string; repository_url: string; sha: string; statuses_url: string; task: string; transient_environment: boolean; updated_at: string; url: string }

      Type declaration

      • created_at: string
      • creator: ReposGetDeploymentResponseCreator
      • description: string
      • environment: string
      • id: number
      • node_id: string
      • original_environment: string
      • payload: ReposGetDeploymentResponsePayload
      • production_environment: boolean
      • ref: string
      • repository_url: string
      • sha: string
      • statuses_url: string
      • task: string
      • transient_environment: boolean
      • updated_at: string
      • url: string

      ReposGetDeploymentResponseCreator

      ReposGetDeploymentResponseCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposGetDeploymentResponsePayload

      ReposGetDeploymentResponsePayload: { deploy: string }

      Type declaration

      • deploy: string

      ReposGetDeploymentStatusParams

      ReposGetDeploymentStatusParams: { deployment_id: number; owner: string; repo: string; status_id: number }

      Type declaration

      • deployment_id: number
      • owner: string
      • repo: string
      • status_id: number

      ReposGetDeploymentStatusResponse

      ReposGetDeploymentStatusResponse: { created_at: string; creator: ReposGetDeploymentStatusResponseCreator; deployment_url: string; description: string; environment: string; environment_url: string; id: number; log_url: string; node_id: string; repository_url: string; state: string; target_url: string; updated_at: string; url: string }

      Type declaration

      • created_at: string
      • creator: ReposGetDeploymentStatusResponseCreator
      • deployment_url: string
      • description: string
      • environment: string
      • environment_url: string
      • id: number
      • log_url: string
      • node_id: string
      • repository_url: string
      • state: string
      • target_url: string
      • updated_at: string
      • url: string

      ReposGetDeploymentStatusResponseCreator

      ReposGetDeploymentStatusResponseCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposGetDownloadParams

      ReposGetDownloadParams: { download_id: number; owner: string; repo: string }

      Type declaration

      • download_id: number
      • owner: string
      • repo: string

      ReposGetDownloadResponse

      ReposGetDownloadResponse: { content_type: string; description: string; download_count: number; html_url: string; id: number; name: string; size: number; url: string }

      Type declaration

      • content_type: string
      • description: string
      • download_count: number
      • html_url: string
      • id: number
      • name: string
      • size: number
      • url: string

      ReposGetHookParams

      ReposGetHookParams: { hook_id: number; owner: string; repo: string }

      Type declaration

      • hook_id: number
      • owner: string
      • repo: string

      ReposGetHookResponse

      ReposGetHookResponse: { active: boolean; config: ReposGetHookResponseConfig; created_at: string; events: Array<string>; id: number; last_response: ReposGetHookResponseLastResponse; name: string; ping_url: string; test_url: string; type: string; updated_at: string; url: string }

      Type declaration

      ReposGetHookResponseConfig

      ReposGetHookResponseConfig: { content_type: string; insecure_ssl: string; url: string }

      Type declaration

      • content_type: string
      • insecure_ssl: string
      • url: string

      ReposGetHookResponseLastResponse

      ReposGetHookResponseLastResponse: { code: null; message: null; status: string }

      Type declaration

      • code: null
      • message: null
      • status: string

      ReposGetLatestPagesBuildParams

      ReposGetLatestPagesBuildParams: { owner: string; repo: string }

      Type declaration

      • owner: string
      • repo: string

      ReposGetLatestPagesBuildResponse

      ReposGetLatestPagesBuildResponse: { commit: string; created_at: string; duration: number; error: ReposGetLatestPagesBuildResponseError; pusher: ReposGetLatestPagesBuildResponsePusher; status: string; updated_at: string; url: string }

      Type declaration

      ReposGetLatestPagesBuildResponseError

      ReposGetLatestPagesBuildResponseError: { message: null }

      Type declaration

      • message: null

      ReposGetLatestPagesBuildResponsePusher

      ReposGetLatestPagesBuildResponsePusher: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposGetLatestReleaseParams

      ReposGetLatestReleaseParams: { owner: string; repo: string }

      Type declaration

      • owner: string
      • repo: string

      ReposGetLatestReleaseResponse

      ReposGetLatestReleaseResponse: { assets: Array<ReposGetLatestReleaseResponseAssetsItem>; assets_url: string; author: ReposGetLatestReleaseResponseAuthor; body: string; created_at: string; draft: boolean; html_url: string; id: number; name: string; node_id: string; prerelease: boolean; published_at: string; tag_name: string; tarball_url: string; target_commitish: string; upload_url: string; url: string; zipball_url: string }

      Type declaration

      • assets: Array<ReposGetLatestReleaseResponseAssetsItem>
      • assets_url: string
      • author: ReposGetLatestReleaseResponseAuthor
      • body: string
      • created_at: string
      • draft: boolean
      • html_url: string
      • id: number
      • name: string
      • node_id: string
      • prerelease: boolean
      • published_at: string
      • tag_name: string
      • tarball_url: string
      • target_commitish: string
      • upload_url: string
      • url: string
      • zipball_url: string

      ReposGetLatestReleaseResponseAssetsItem

      ReposGetLatestReleaseResponseAssetsItem: { browser_download_url: string; content_type: string; created_at: string; download_count: number; id: number; label: string; name: string; node_id: string; size: number; state: string; updated_at: string; uploader: ReposGetLatestReleaseResponseAssetsItemUploader; url: string }

      Type declaration

      • browser_download_url: string
      • content_type: string
      • created_at: string
      • download_count: number
      • id: number
      • label: string
      • name: string
      • node_id: string
      • size: number
      • state: string
      • updated_at: string
      • uploader: ReposGetLatestReleaseResponseAssetsItemUploader
      • url: string

      ReposGetLatestReleaseResponseAssetsItemUploader

      ReposGetLatestReleaseResponseAssetsItemUploader: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposGetLatestReleaseResponseAuthor

      ReposGetLatestReleaseResponseAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposGetPagesBuildParams

      ReposGetPagesBuildParams: { build_id: number; owner: string; repo: string }

      Type declaration

      • build_id: number
      • owner: string
      • repo: string

      ReposGetPagesBuildResponse

      ReposGetPagesBuildResponse: { commit: string; created_at: string; duration: number; error: ReposGetPagesBuildResponseError; pusher: ReposGetPagesBuildResponsePusher; status: string; updated_at: string; url: string }

      Type declaration

      ReposGetPagesBuildResponseError

      ReposGetPagesBuildResponseError: { message: null }

      Type declaration

      • message: null

      ReposGetPagesBuildResponsePusher

      ReposGetPagesBuildResponsePusher: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposGetPagesParams

      ReposGetPagesParams: { owner: string; repo: string }

      Type declaration

      • owner: string
      • repo: string

      ReposGetPagesResponse

      ReposGetPagesResponse: { cname: string; custom_404: boolean; html_url: string; source: ReposGetPagesResponseSource; status: string; url: string }

      Type declaration

      ReposGetPagesResponseSource

      ReposGetPagesResponseSource: { branch: string; directory: string }

      Type declaration

      • branch: string
      • directory: string

      ReposGetParams

      ReposGetParams: { owner: string; repo: string }

      Type declaration

      • owner: string
      • repo: string

      ReposGetParticipationStatsParams

      ReposGetParticipationStatsParams: { owner: string; repo: string }

      Type declaration

      • owner: string
      • repo: string

      ReposGetParticipationStatsResponse

      ReposGetParticipationStatsResponse: { all: Array<number>; owner: Array<number> }

      Type declaration

      • all: Array<number>
      • owner: Array<number>

      ReposGetProtectedBranchAdminEnforcementParams

      ReposGetProtectedBranchAdminEnforcementParams: { branch: string; owner: string; repo: string }

      Type declaration

      • branch: string
      • owner: string
      • repo: string

      ReposGetProtectedBranchAdminEnforcementResponse

      ReposGetProtectedBranchAdminEnforcementResponse: { enabled: boolean; url: string }

      Type declaration

      • enabled: boolean
      • url: string

      ReposGetProtectedBranchPullRequestReviewEnforcementParams

      ReposGetProtectedBranchPullRequestReviewEnforcementParams: { branch: string; owner: string; repo: string }

      Type declaration

      • branch: string
      • owner: string
      • repo: string

      ReposGetProtectedBranchPullRequestReviewEnforcementResponse

      ReposGetProtectedBranchPullRequestReviewEnforcementResponse: { dismiss_stale_reviews: boolean; dismissal_restrictions: ReposGetProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictions; require_code_owner_reviews: boolean; required_approving_review_count: number; url: string }

      Type declaration

      ReposGetProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictions

      ReposGetProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictions: { teams: Array<ReposGetProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictionsTeamsItem>; teams_url: string; url: string; users: Array<ReposGetProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictionsUsersItem>; users_url: string }

      Type declaration

      ReposGetProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictionsTeamsItem

      ReposGetProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictionsTeamsItem: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: null; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

      Type declaration

      • description: string
      • html_url: string
      • id: number
      • members_url: string
      • name: string
      • node_id: string
      • parent: null
      • permission: string
      • privacy: string
      • repositories_url: string
      • slug: string
      • url: string

      ReposGetProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictionsUsersItem

      ReposGetProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictionsUsersItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposGetProtectedBranchRequiredSignaturesParams

      ReposGetProtectedBranchRequiredSignaturesParams: { branch: string; owner: string; repo: string }

      Type declaration

      • branch: string
      • owner: string
      • repo: string

      ReposGetProtectedBranchRequiredSignaturesResponse

      ReposGetProtectedBranchRequiredSignaturesResponse: { enabled: boolean; url: string }

      Type declaration

      • enabled: boolean
      • url: string

      ReposGetProtectedBranchRequiredStatusChecksParams

      ReposGetProtectedBranchRequiredStatusChecksParams: { branch: string; owner: string; repo: string }

      Type declaration

      • branch: string
      • owner: string
      • repo: string

      ReposGetProtectedBranchRequiredStatusChecksResponse

      ReposGetProtectedBranchRequiredStatusChecksResponse: { contexts: Array<string>; contexts_url: string; strict: boolean; url: string }

      Type declaration

      • contexts: Array<string>
      • contexts_url: string
      • strict: boolean
      • url: string

      ReposGetProtectedBranchRestrictionsParams

      ReposGetProtectedBranchRestrictionsParams: { branch: string; owner: string; repo: string }

      Type declaration

      • branch: string
      • owner: string
      • repo: string

      ReposGetProtectedBranchRestrictionsResponse

      ReposGetProtectedBranchRestrictionsResponse: { apps: Array<ReposGetProtectedBranchRestrictionsResponseAppsItem>; apps_url: string; teams: Array<ReposGetProtectedBranchRestrictionsResponseTeamsItem>; teams_url: string; url: string; users: Array<ReposGetProtectedBranchRestrictionsResponseUsersItem>; users_url: string }

      Type declaration

      ReposGetProtectedBranchRestrictionsResponseAppsItem

      ReposGetProtectedBranchRestrictionsResponseAppsItem: { created_at: string; description: string; events: Array<string>; external_url: string; html_url: string; id: number; name: string; node_id: string; owner: ReposGetProtectedBranchRestrictionsResponseAppsItemOwner; permissions: ReposGetProtectedBranchRestrictionsResponseAppsItemPermissions; slug: string; updated_at: string }

      Type declaration

      ReposGetProtectedBranchRestrictionsResponseAppsItemOwner

      ReposGetProtectedBranchRestrictionsResponseAppsItemOwner: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

      Type declaration

      • avatar_url: string
      • description: string
      • events_url: string
      • hooks_url: string
      • id: number
      • issues_url: string
      • login: string
      • members_url: string
      • node_id: string
      • public_members_url: string
      • repos_url: string
      • url: string

      ReposGetProtectedBranchRestrictionsResponseAppsItemPermissions

      ReposGetProtectedBranchRestrictionsResponseAppsItemPermissions: { contents: string; issues: string; metadata: string; single_file: string }

      Type declaration

      • contents: string
      • issues: string
      • metadata: string
      • single_file: string

      ReposGetProtectedBranchRestrictionsResponseTeamsItem

      ReposGetProtectedBranchRestrictionsResponseTeamsItem: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: null; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

      Type declaration

      • description: string
      • html_url: string
      • id: number
      • members_url: string
      • name: string
      • node_id: string
      • parent: null
      • permission: string
      • privacy: string
      • repositories_url: string
      • slug: string
      • url: string

      ReposGetProtectedBranchRestrictionsResponseUsersItem

      ReposGetProtectedBranchRestrictionsResponseUsersItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposGetPunchCardStatsParams

      ReposGetPunchCardStatsParams: { owner: string; repo: string }

      Type declaration

      • owner: string
      • repo: string

      ReposGetPunchCardStatsResponse

      ReposGetPunchCardStatsResponse: Array<Array<number>>

      ReposGetReadmeParams

      ReposGetReadmeParams: { owner: string; ref?: undefined | string; repo: string }

      Type declaration

      • owner: string
      • Optional ref?: undefined | string

        The name of the commit/branch/tag. Default: the repository’s default branch (usually master)

      • repo: string

      ReposGetReadmeResponse

      ReposGetReadmeResponse: { _links: ReposGetReadmeResponseLinks; content: string; download_url: string; encoding: string; git_url: string; html_url: string; name: string; path: string; sha: string; size: number; type: string; url: string }

      Type declaration

      • _links: ReposGetReadmeResponseLinks
      • content: string
      • download_url: string
      • encoding: string
      • git_url: string
      • html_url: string
      • name: string
      • path: string
      • sha: string
      • size: number
      • type: string
      • url: string

      ReposGetReadmeResponseLinks

      ReposGetReadmeResponseLinks: { git: string; html: string; self: string }

      Type declaration

      • git: string
      • html: string
      • self: string

      ReposGetReleaseAssetParams

      ReposGetReleaseAssetParams: { asset_id: number; owner: string; repo: string }

      Type declaration

      • asset_id: number
      • owner: string
      • repo: string

      ReposGetReleaseAssetResponse

      ReposGetReleaseAssetResponse: { browser_download_url: string; content_type: string; created_at: string; download_count: number; id: number; label: string; name: string; node_id: string; size: number; state: string; updated_at: string; uploader: ReposGetReleaseAssetResponseUploader; url: string }

      Type declaration

      • browser_download_url: string
      • content_type: string
      • created_at: string
      • download_count: number
      • id: number
      • label: string
      • name: string
      • node_id: string
      • size: number
      • state: string
      • updated_at: string
      • uploader: ReposGetReleaseAssetResponseUploader
      • url: string

      ReposGetReleaseAssetResponseUploader

      ReposGetReleaseAssetResponseUploader: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposGetReleaseByTagParams

      ReposGetReleaseByTagParams: { owner: string; repo: string; tag: string }

      Type declaration

      • owner: string
      • repo: string
      • tag: string

      ReposGetReleaseByTagResponse

      ReposGetReleaseByTagResponse: { assets: Array<ReposGetReleaseByTagResponseAssetsItem>; assets_url: string; author: ReposGetReleaseByTagResponseAuthor; body: string; created_at: string; draft: boolean; html_url: string; id: number; name: string; node_id: string; prerelease: boolean; published_at: string; tag_name: string; tarball_url: string; target_commitish: string; upload_url: string; url: string; zipball_url: string }

      Type declaration

      • assets: Array<ReposGetReleaseByTagResponseAssetsItem>
      • assets_url: string
      • author: ReposGetReleaseByTagResponseAuthor
      • body: string
      • created_at: string
      • draft: boolean
      • html_url: string
      • id: number
      • name: string
      • node_id: string
      • prerelease: boolean
      • published_at: string
      • tag_name: string
      • tarball_url: string
      • target_commitish: string
      • upload_url: string
      • url: string
      • zipball_url: string

      ReposGetReleaseByTagResponseAssetsItem

      ReposGetReleaseByTagResponseAssetsItem: { browser_download_url: string; content_type: string; created_at: string; download_count: number; id: number; label: string; name: string; node_id: string; size: number; state: string; updated_at: string; uploader: ReposGetReleaseByTagResponseAssetsItemUploader; url: string }

      Type declaration

      • browser_download_url: string
      • content_type: string
      • created_at: string
      • download_count: number
      • id: number
      • label: string
      • name: string
      • node_id: string
      • size: number
      • state: string
      • updated_at: string
      • uploader: ReposGetReleaseByTagResponseAssetsItemUploader
      • url: string

      ReposGetReleaseByTagResponseAssetsItemUploader

      ReposGetReleaseByTagResponseAssetsItemUploader: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposGetReleaseByTagResponseAuthor

      ReposGetReleaseByTagResponseAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposGetReleaseParams

      ReposGetReleaseParams: { owner: string; release_id: number; repo: string }

      Type declaration

      • owner: string
      • release_id: number
      • repo: string

      ReposGetReleaseResponse

      ReposGetReleaseResponse: { assets: Array<ReposGetReleaseResponseAssetsItem>; assets_url: string; author: ReposGetReleaseResponseAuthor; body: string; created_at: string; draft: boolean; html_url: string; id: number; name: string; node_id: string; prerelease: boolean; published_at: string; tag_name: string; tarball_url: string; target_commitish: string; upload_url: string; url: string; zipball_url: string }

      Type declaration

      • assets: Array<ReposGetReleaseResponseAssetsItem>
      • assets_url: string
      • author: ReposGetReleaseResponseAuthor
      • body: string
      • created_at: string
      • draft: boolean
      • html_url: string
      • id: number
      • name: string
      • node_id: string
      • prerelease: boolean
      • published_at: string
      • tag_name: string
      • tarball_url: string
      • target_commitish: string
      • upload_url: string
      • url: string
      • zipball_url: string

      ReposGetReleaseResponseAssetsItem

      ReposGetReleaseResponseAssetsItem: { browser_download_url: string; content_type: string; created_at: string; download_count: number; id: number; label: string; name: string; node_id: string; size: number; state: string; updated_at: string; uploader: ReposGetReleaseResponseAssetsItemUploader; url: string }

      Type declaration

      • browser_download_url: string
      • content_type: string
      • created_at: string
      • download_count: number
      • id: number
      • label: string
      • name: string
      • node_id: string
      • size: number
      • state: string
      • updated_at: string
      • uploader: ReposGetReleaseResponseAssetsItemUploader
      • url: string

      ReposGetReleaseResponseAssetsItemUploader

      ReposGetReleaseResponseAssetsItemUploader: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposGetReleaseResponseAuthor

      ReposGetReleaseResponseAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposGetResponse

      ReposGetResponse: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; license: ReposGetResponseLicense; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; organization: ReposGetResponseOrganization; owner: ReposGetResponseOwner; parent: ReposGetResponseParent; permissions: ReposGetResponsePermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; source: ReposGetResponseSource; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

      Type declaration

      • allow_merge_commit: boolean
      • allow_rebase_merge: boolean
      • allow_squash_merge: boolean
      • archive_url: string
      • archived: boolean
      • assignees_url: string
      • blobs_url: string
      • branches_url: string
      • clone_url: string
      • collaborators_url: string
      • comments_url: string
      • commits_url: string
      • compare_url: string
      • contents_url: string
      • contributors_url: string
      • created_at: string
      • default_branch: string
      • deployments_url: string
      • description: string
      • disabled: boolean
      • downloads_url: string
      • events_url: string
      • fork: boolean
      • forks_count: number
      • forks_url: string
      • full_name: string
      • git_commits_url: string
      • git_refs_url: string
      • git_tags_url: string
      • git_url: string
      • has_downloads: boolean
      • has_issues: boolean
      • has_pages: boolean
      • has_projects: boolean
      • has_wiki: boolean
      • homepage: string
      • hooks_url: string
      • html_url: string
      • id: number
      • is_template: boolean
      • issue_comment_url: string
      • issue_events_url: string
      • issues_url: string
      • keys_url: string
      • labels_url: string
      • language: null
      • languages_url: string
      • license: ReposGetResponseLicense
      • merges_url: string
      • milestones_url: string
      • mirror_url: string
      • name: string
      • network_count: number
      • node_id: string
      • notifications_url: string
      • open_issues_count: number
      • organization: ReposGetResponseOrganization
      • owner: ReposGetResponseOwner
      • parent: ReposGetResponseParent
      • permissions: ReposGetResponsePermissions
      • private: boolean
      • pulls_url: string
      • pushed_at: string
      • releases_url: string
      • size: number
      • source: ReposGetResponseSource
      • ssh_url: string
      • stargazers_count: number
      • stargazers_url: string
      • statuses_url: string
      • subscribers_count: number
      • subscribers_url: string
      • subscription_url: string
      • svn_url: string
      • tags_url: string
      • teams_url: string
      • temp_clone_token: string
      • template_repository: null
      • topics: Array<string>
      • trees_url: string
      • updated_at: string
      • url: string
      • visibility: string
      • watchers_count: number

      ReposGetResponseLicense

      ReposGetResponseLicense: { key: string; name: string; node_id: string; spdx_id: string; url: string }

      Type declaration

      • key: string
      • name: string
      • node_id: string
      • spdx_id: string
      • url: string

      ReposGetResponseOrganization

      ReposGetResponseOrganization: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposGetResponseOwner

      ReposGetResponseOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposGetResponseParent

      ReposGetResponseParent: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: ReposGetResponseParentOwner; permissions: ReposGetResponseParentPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

      Type declaration

      • allow_merge_commit: boolean
      • allow_rebase_merge: boolean
      • allow_squash_merge: boolean
      • archive_url: string
      • archived: boolean
      • assignees_url: string
      • blobs_url: string
      • branches_url: string
      • clone_url: string
      • collaborators_url: string
      • comments_url: string
      • commits_url: string
      • compare_url: string
      • contents_url: string
      • contributors_url: string
      • created_at: string
      • default_branch: string
      • deployments_url: string
      • description: string
      • disabled: boolean
      • downloads_url: string
      • events_url: string
      • fork: boolean
      • forks_count: number
      • forks_url: string
      • full_name: string
      • git_commits_url: string
      • git_refs_url: string
      • git_tags_url: string
      • git_url: string
      • has_downloads: boolean
      • has_issues: boolean
      • has_pages: boolean
      • has_projects: boolean
      • has_wiki: boolean
      • homepage: string
      • hooks_url: string
      • html_url: string
      • id: number
      • is_template: boolean
      • issue_comment_url: string
      • issue_events_url: string
      • issues_url: string
      • keys_url: string
      • labels_url: string
      • language: null
      • languages_url: string
      • merges_url: string
      • milestones_url: string
      • mirror_url: string
      • name: string
      • network_count: number
      • node_id: string
      • notifications_url: string
      • open_issues_count: number
      • owner: ReposGetResponseParentOwner
      • permissions: ReposGetResponseParentPermissions
      • private: boolean
      • pulls_url: string
      • pushed_at: string
      • releases_url: string
      • size: number
      • ssh_url: string
      • stargazers_count: number
      • stargazers_url: string
      • statuses_url: string
      • subscribers_count: number
      • subscribers_url: string
      • subscription_url: string
      • svn_url: string
      • tags_url: string
      • teams_url: string
      • temp_clone_token: string
      • template_repository: null
      • topics: Array<string>
      • trees_url: string
      • updated_at: string
      • url: string
      • visibility: string
      • watchers_count: number

      ReposGetResponseParentOwner

      ReposGetResponseParentOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposGetResponseParentPermissions

      ReposGetResponseParentPermissions: { admin: boolean; pull: boolean; push: boolean }

      Type declaration

      • admin: boolean
      • pull: boolean
      • push: boolean

      ReposGetResponsePermissions

      ReposGetResponsePermissions: { admin: boolean; pull: boolean; push: boolean }

      Type declaration

      • admin: boolean
      • pull: boolean
      • push: boolean

      ReposGetResponseSource

      ReposGetResponseSource: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: ReposGetResponseSourceOwner; permissions: ReposGetResponseSourcePermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

      Type declaration

      • allow_merge_commit: boolean
      • allow_rebase_merge: boolean
      • allow_squash_merge: boolean
      • archive_url: string
      • archived: boolean
      • assignees_url: string
      • blobs_url: string
      • branches_url: string
      • clone_url: string
      • collaborators_url: string
      • comments_url: string
      • commits_url: string
      • compare_url: string
      • contents_url: string
      • contributors_url: string
      • created_at: string
      • default_branch: string
      • deployments_url: string
      • description: string
      • disabled: boolean
      • downloads_url: string
      • events_url: string
      • fork: boolean
      • forks_count: number
      • forks_url: string
      • full_name: string
      • git_commits_url: string
      • git_refs_url: string
      • git_tags_url: string
      • git_url: string
      • has_downloads: boolean
      • has_issues: boolean
      • has_pages: boolean
      • has_projects: boolean
      • has_wiki: boolean
      • homepage: string
      • hooks_url: string
      • html_url: string
      • id: number
      • is_template: boolean
      • issue_comment_url: string
      • issue_events_url: string
      • issues_url: string
      • keys_url: string
      • labels_url: string
      • language: null
      • languages_url: string
      • merges_url: string
      • milestones_url: string
      • mirror_url: string
      • name: string
      • network_count: number
      • node_id: string
      • notifications_url: string
      • open_issues_count: number
      • owner: ReposGetResponseSourceOwner
      • permissions: ReposGetResponseSourcePermissions
      • private: boolean
      • pulls_url: string
      • pushed_at: string
      • releases_url: string
      • size: number
      • ssh_url: string
      • stargazers_count: number
      • stargazers_url: string
      • statuses_url: string
      • subscribers_count: number
      • subscribers_url: string
      • subscription_url: string
      • svn_url: string
      • tags_url: string
      • teams_url: string
      • temp_clone_token: string
      • template_repository: null
      • topics: Array<string>
      • trees_url: string
      • updated_at: string
      • url: string
      • visibility: string
      • watchers_count: number

      ReposGetResponseSourceOwner

      ReposGetResponseSourceOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposGetResponseSourcePermissions

      ReposGetResponseSourcePermissions: { admin: boolean; pull: boolean; push: boolean }

      Type declaration

      • admin: boolean
      • pull: boolean
      • push: boolean

      ReposGetTeamsWithAccessToProtectedBranchParams

      ReposGetTeamsWithAccessToProtectedBranchParams: { branch: string; owner: string; repo: string }

      Type declaration

      • branch: string
      • owner: string
      • repo: string

      ReposGetTeamsWithAccessToProtectedBranchResponse

      ReposGetTeamsWithAccessToProtectedBranchResponse: Array<ReposGetTeamsWithAccessToProtectedBranchResponseItem>

      ReposGetTeamsWithAccessToProtectedBranchResponseItem

      ReposGetTeamsWithAccessToProtectedBranchResponseItem: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: null; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

      Type declaration

      • description: string
      • html_url: string
      • id: number
      • members_url: string
      • name: string
      • node_id: string
      • parent: null
      • permission: string
      • privacy: string
      • repositories_url: string
      • slug: string
      • url: string

      ReposGetTopPathsParams

      ReposGetTopPathsParams: { owner: string; repo: string }

      Type declaration

      • owner: string
      • repo: string

      ReposGetTopPathsResponse

      ReposGetTopPathsResponse: Array<ReposGetTopPathsResponseItem>

      ReposGetTopPathsResponseItem

      ReposGetTopPathsResponseItem: { count: number; path: string; title: string; uniques: number }

      Type declaration

      • count: number
      • path: string
      • title: string
      • uniques: number

      ReposGetTopReferrersParams

      ReposGetTopReferrersParams: { owner: string; repo: string }

      Type declaration

      • owner: string
      • repo: string

      ReposGetTopReferrersResponse

      ReposGetTopReferrersResponse: Array<ReposGetTopReferrersResponseItem>

      ReposGetTopReferrersResponseItem

      ReposGetTopReferrersResponseItem: { count: number; referrer: string; uniques: number }

      Type declaration

      • count: number
      • referrer: string
      • uniques: number

      ReposGetUsersWithAccessToProtectedBranchParams

      ReposGetUsersWithAccessToProtectedBranchParams: { branch: string; owner: string; repo: string }

      Type declaration

      • branch: string
      • owner: string
      • repo: string

      ReposGetUsersWithAccessToProtectedBranchResponse

      ReposGetUsersWithAccessToProtectedBranchResponse: Array<ReposGetUsersWithAccessToProtectedBranchResponseItem>

      ReposGetUsersWithAccessToProtectedBranchResponseItem

      ReposGetUsersWithAccessToProtectedBranchResponseItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposGetViewsParams

      ReposGetViewsParams: { owner: string; per?: "day" | "week"; repo: string }

      Type declaration

      • owner: string
      • Optional per?: "day" | "week"

        Must be one of: day, week.

      • repo: string

      ReposGetViewsResponse

      ReposGetViewsResponse: { count: number; uniques: number; views: Array<ReposGetViewsResponseViewsItem> }

      Type declaration

      ReposGetViewsResponseViewsItem

      ReposGetViewsResponseViewsItem: { count: number; timestamp: string; uniques: number }

      Type declaration

      • count: number
      • timestamp: string
      • uniques: number

      ReposListAppsWithAccessToProtectedBranchParams

      ReposListAppsWithAccessToProtectedBranchParams: { branch: string; owner: string; repo: string }

      Type declaration

      • branch: string
      • owner: string
      • repo: string

      ReposListAppsWithAccessToProtectedBranchResponse

      ReposListAppsWithAccessToProtectedBranchResponse: Array<ReposListAppsWithAccessToProtectedBranchResponseItem>

      ReposListAppsWithAccessToProtectedBranchResponseItem

      ReposListAppsWithAccessToProtectedBranchResponseItem: { created_at: string; description: string; events: Array<string>; external_url: string; html_url: string; id: number; name: string; node_id: string; owner: ReposListAppsWithAccessToProtectedBranchResponseItemOwner; permissions: ReposListAppsWithAccessToProtectedBranchResponseItemPermissions; slug: string; updated_at: string }

      Type declaration

      ReposListAppsWithAccessToProtectedBranchResponseItemOwner

      ReposListAppsWithAccessToProtectedBranchResponseItemOwner: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

      Type declaration

      • avatar_url: string
      • description: string
      • events_url: string
      • hooks_url: string
      • id: number
      • issues_url: string
      • login: string
      • members_url: string
      • node_id: string
      • public_members_url: string
      • repos_url: string
      • url: string

      ReposListAppsWithAccessToProtectedBranchResponseItemPermissions

      ReposListAppsWithAccessToProtectedBranchResponseItemPermissions: { contents: string; issues: string; metadata: string; single_file: string }

      Type declaration

      • contents: string
      • issues: string
      • metadata: string
      • single_file: string

      ReposListAssetsForReleaseParams

      ReposListAssetsForReleaseParams: { owner: string; page?: undefined | number; per_page?: undefined | number; release_id: number; repo: string }

      Type declaration

      • owner: string
      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • release_id: number
      • repo: string

      ReposListAssetsForReleaseResponse

      ReposListAssetsForReleaseResponse: Array<ReposListAssetsForReleaseResponseItem>

      ReposListAssetsForReleaseResponseItem

      ReposListAssetsForReleaseResponseItem: { browser_download_url: string; content_type: string; created_at: string; download_count: number; id: number; label: string; name: string; node_id: string; size: number; state: string; updated_at: string; uploader: ReposListAssetsForReleaseResponseItemUploader; url: string }

      Type declaration

      • browser_download_url: string
      • content_type: string
      • created_at: string
      • download_count: number
      • id: number
      • label: string
      • name: string
      • node_id: string
      • size: number
      • state: string
      • updated_at: string
      • uploader: ReposListAssetsForReleaseResponseItemUploader
      • url: string

      ReposListAssetsForReleaseResponseItemUploader

      ReposListAssetsForReleaseResponseItemUploader: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposListBranchesForHeadCommitParams

      ReposListBranchesForHeadCommitParams: { commit_sha: string; owner: string; repo: string }

      Type declaration

      • commit_sha: string
      • owner: string
      • repo: string

      ReposListBranchesForHeadCommitResponse

      ReposListBranchesForHeadCommitResponse: Array<ReposListBranchesForHeadCommitResponseItem>

      ReposListBranchesForHeadCommitResponseItem

      ReposListBranchesForHeadCommitResponseItem: { commit: ReposListBranchesForHeadCommitResponseItemCommit; name: string; protected: string }

      Type declaration

      ReposListBranchesForHeadCommitResponseItemCommit

      ReposListBranchesForHeadCommitResponseItemCommit: { sha: string; url: string }

      Type declaration

      • sha: string
      • url: string

      ReposListBranchesParams

      ReposListBranchesParams: { owner: string; page?: undefined | number; per_page?: undefined | number; protected?: undefined | false | true; repo: string }

      Type declaration

      • owner: string
      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • Optional protected?: undefined | false | true

        Setting to true returns only protected branches. When set to false, only unprotected branches are returned. Omitting this parameter returns all branches.

      • repo: string

      ReposListBranchesResponse

      ReposListBranchesResponse: Array<ReposListBranchesResponseItem>

      ReposListBranchesResponseItem

      ReposListBranchesResponseItem: { commit: ReposListBranchesResponseItemCommit; name: string; protected: boolean; protection: ReposListBranchesResponseItemProtection; protection_url: string }

      Type declaration

      ReposListBranchesResponseItemCommit

      ReposListBranchesResponseItemCommit: { sha: string; url: string }

      Type declaration

      • sha: string
      • url: string

      ReposListBranchesResponseItemProtection

      ReposListBranchesResponseItemProtection: { enabled: boolean; required_status_checks: ReposListBranchesResponseItemProtectionRequiredStatusChecks }

      Type declaration

      ReposListBranchesResponseItemProtectionRequiredStatusChecks

      ReposListBranchesResponseItemProtectionRequiredStatusChecks: { contexts: Array<string>; enforcement_level: string }

      Type declaration

      • contexts: Array<string>
      • enforcement_level: string

      ReposListCollaboratorsParams

      ReposListCollaboratorsParams: { affiliation?: "outside" | "direct" | "all"; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

      Type declaration

      • Optional affiliation?: "outside" | "direct" | "all"

        Filter collaborators returned by their affiliation. Can be one of: * outside: All outside collaborators of an organization-owned repository. * direct: All collaborators with permissions to an organization-owned repository, regardless of organization membership status. * all: All collaborators the authenticated user can see.

      • owner: string
      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • repo: string

      ReposListCollaboratorsResponse

      ReposListCollaboratorsResponse: Array<ReposListCollaboratorsResponseItem>

      ReposListCollaboratorsResponseItem

      ReposListCollaboratorsResponseItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; permissions: ReposListCollaboratorsResponseItemPermissions; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • permissions: ReposListCollaboratorsResponseItemPermissions
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposListCollaboratorsResponseItemPermissions

      ReposListCollaboratorsResponseItemPermissions: { admin: boolean; pull: boolean; push: boolean }

      Type declaration

      • admin: boolean
      • pull: boolean
      • push: boolean

      ReposListCommentsForCommitParams

      ReposListCommentsForCommitParams: { commit_sha: string; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

      Type declaration

      • commit_sha: string
      • owner: string
      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • repo: string

      ReposListCommentsForCommitParamsDeprecatedRef

      ReposListCommentsForCommitParamsDeprecatedRef: { owner: string; page?: undefined | number; per_page?: undefined | number; ref: string; repo: string }

      Type declaration

      • owner: string
      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • ref: string
        deprecated

        "ref" parameter renamed to "commit_sha"

      • repo: string

      ReposListCommentsForCommitResponse

      ReposListCommentsForCommitResponse: Array<ReposListCommentsForCommitResponseItem>

      ReposListCommentsForCommitResponseItem

      ReposListCommentsForCommitResponseItem: { body: string; commit_id: string; created_at: string; html_url: string; id: number; line: number; node_id: string; path: string; position: number; updated_at: string; url: string; user: ReposListCommentsForCommitResponseItemUser }

      Type declaration

      • body: string
      • commit_id: string
      • created_at: string
      • html_url: string
      • id: number
      • line: number
      • node_id: string
      • path: string
      • position: number
      • updated_at: string
      • url: string
      • user: ReposListCommentsForCommitResponseItemUser

      ReposListCommentsForCommitResponseItemUser

      ReposListCommentsForCommitResponseItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposListCommitCommentsParams

      ReposListCommitCommentsParams: { owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

      Type declaration

      • owner: string
      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • repo: string

      ReposListCommitCommentsResponse

      ReposListCommitCommentsResponse: Array<ReposListCommitCommentsResponseItem>

      ReposListCommitCommentsResponseItem

      ReposListCommitCommentsResponseItem: { body: string; commit_id: string; created_at: string; html_url: string; id: number; line: number; node_id: string; path: string; position: number; updated_at: string; url: string; user: ReposListCommitCommentsResponseItemUser }

      Type declaration

      • body: string
      • commit_id: string
      • created_at: string
      • html_url: string
      • id: number
      • line: number
      • node_id: string
      • path: string
      • position: number
      • updated_at: string
      • url: string
      • user: ReposListCommitCommentsResponseItemUser

      ReposListCommitCommentsResponseItemUser

      ReposListCommitCommentsResponseItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposListCommitsParams

      ReposListCommitsParams: { author?: undefined | string; owner: string; page?: undefined | number; path?: undefined | string; per_page?: undefined | number; repo: string; sha?: undefined | string; since?: undefined | string; until?: undefined | string }

      Type declaration

      • Optional author?: undefined | string

        GitHub login or email address by which to filter by commit author.

      • owner: string
      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional path?: undefined | string

        Only commits containing this file path will be returned.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • repo: string
      • Optional sha?: undefined | string

        SHA or branch to start listing commits from. Default: the repository’s default branch (usually master).

      • Optional since?: undefined | string

        Only commits after this date will be returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

      • Optional until?: undefined | string

        Only commits before this date will be returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

      ReposListCommitsResponse

      ReposListCommitsResponse: Array<ReposListCommitsResponseItem>

      ReposListCommitsResponseItem

      ReposListCommitsResponseItem: { author: ReposListCommitsResponseItemAuthor; comments_url: string; commit: ReposListCommitsResponseItemCommit; committer: ReposListCommitsResponseItemCommitter; html_url: string; node_id: string; parents: Array<ReposListCommitsResponseItemParentsItem>; sha: string; url: string }

      Type declaration

      ReposListCommitsResponseItemAuthor

      ReposListCommitsResponseItemAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposListCommitsResponseItemCommit

      ReposListCommitsResponseItemCommit: { author: ReposListCommitsResponseItemCommitAuthor; comment_count: number; committer: ReposListCommitsResponseItemCommitCommitter; message: string; tree: ReposListCommitsResponseItemCommitTree; url: string; verification: ReposListCommitsResponseItemCommitVerification }

      Type declaration

      ReposListCommitsResponseItemCommitAuthor

      ReposListCommitsResponseItemCommitAuthor: { date: string; email: string; name: string }

      Type declaration

      • date: string
      • email: string
      • name: string

      ReposListCommitsResponseItemCommitCommitter

      ReposListCommitsResponseItemCommitCommitter: { date: string; email: string; name: string }

      Type declaration

      • date: string
      • email: string
      • name: string

      ReposListCommitsResponseItemCommitTree

      ReposListCommitsResponseItemCommitTree: { sha: string; url: string }

      Type declaration

      • sha: string
      • url: string

      ReposListCommitsResponseItemCommitVerification

      ReposListCommitsResponseItemCommitVerification: { payload: null; reason: string; signature: null; verified: boolean }

      Type declaration

      • payload: null
      • reason: string
      • signature: null
      • verified: boolean

      ReposListCommitsResponseItemCommitter

      ReposListCommitsResponseItemCommitter: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposListCommitsResponseItemParentsItem

      ReposListCommitsResponseItemParentsItem: { sha: string; url: string }

      Type declaration

      • sha: string
      • url: string

      ReposListContributorsParams

      ReposListContributorsParams: { anon?: undefined | string; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

      Type declaration

      • Optional anon?: undefined | string

        Set to 1 or true to include anonymous contributors in results.

      • owner: string
      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • repo: string

      ReposListContributorsResponse

      ReposListContributorsResponse: Array<ReposListContributorsResponseItem>

      ReposListContributorsResponseItem

      ReposListContributorsResponseItem: { avatar_url: string; contributions: number; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • contributions: number
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposListDeployKeysParams

      ReposListDeployKeysParams: { owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

      Type declaration

      • owner: string
      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • repo: string

      ReposListDeployKeysResponse

      ReposListDeployKeysResponse: Array<ReposListDeployKeysResponseItem>

      ReposListDeployKeysResponseItem

      ReposListDeployKeysResponseItem: { created_at: string; id: number; key: string; read_only: boolean; title: string; url: string; verified: boolean }

      Type declaration

      • created_at: string
      • id: number
      • key: string
      • read_only: boolean
      • title: string
      • url: string
      • verified: boolean

      ReposListDeploymentStatusesParams

      ReposListDeploymentStatusesParams: { deployment_id: number; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

      Type declaration

      • deployment_id: number
      • owner: string
      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • repo: string

      ReposListDeploymentStatusesResponse

      ReposListDeploymentStatusesResponse: Array<ReposListDeploymentStatusesResponseItem>

      ReposListDeploymentStatusesResponseItem

      ReposListDeploymentStatusesResponseItem: { created_at: string; creator: ReposListDeploymentStatusesResponseItemCreator; deployment_url: string; description: string; environment: string; environment_url: string; id: number; log_url: string; node_id: string; repository_url: string; state: string; target_url: string; updated_at: string; url: string }

      Type declaration

      • created_at: string
      • creator: ReposListDeploymentStatusesResponseItemCreator
      • deployment_url: string
      • description: string
      • environment: string
      • environment_url: string
      • id: number
      • log_url: string
      • node_id: string
      • repository_url: string
      • state: string
      • target_url: string
      • updated_at: string
      • url: string

      ReposListDeploymentStatusesResponseItemCreator

      ReposListDeploymentStatusesResponseItemCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposListDeploymentsParams

      ReposListDeploymentsParams: { environment?: undefined | string; owner: string; page?: undefined | number; per_page?: undefined | number; ref?: undefined | string; repo: string; sha?: undefined | string; task?: undefined | string }

      Type declaration

      • Optional environment?: undefined | string

        The name of the environment that was deployed to (e.g., staging or production).

      • owner: string
      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • Optional ref?: undefined | string

        The name of the ref. This can be a branch, tag, or SHA.

      • repo: string
      • Optional sha?: undefined | string

        The SHA recorded at creation time.

      • Optional task?: undefined | string

        The name of the task for the deployment (e.g., deploy or deploy:migrations).

      ReposListDeploymentsResponse

      ReposListDeploymentsResponse: Array<ReposListDeploymentsResponseItem>

      ReposListDeploymentsResponseItem

      ReposListDeploymentsResponseItem: { created_at: string; creator: ReposListDeploymentsResponseItemCreator; description: string; environment: string; id: number; node_id: string; original_environment: string; payload: ReposListDeploymentsResponseItemPayload; production_environment: boolean; ref: string; repository_url: string; sha: string; statuses_url: string; task: string; transient_environment: boolean; updated_at: string; url: string }

      Type declaration

      ReposListDeploymentsResponseItemCreator

      ReposListDeploymentsResponseItemCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposListDeploymentsResponseItemPayload

      ReposListDeploymentsResponseItemPayload: { deploy: string }

      Type declaration

      • deploy: string

      ReposListDownloadsParams

      ReposListDownloadsParams: { owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

      Type declaration

      • owner: string
      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • repo: string

      ReposListDownloadsResponse

      ReposListDownloadsResponse: Array<ReposListDownloadsResponseItem>

      ReposListDownloadsResponseItem

      ReposListDownloadsResponseItem: { content_type: string; description: string; download_count: number; html_url: string; id: number; name: string; size: number; url: string }

      Type declaration

      • content_type: string
      • description: string
      • download_count: number
      • html_url: string
      • id: number
      • name: string
      • size: number
      • url: string

      ReposListForOrgParams

      ReposListForOrgParams: { direction?: "asc" | "desc"; org: string; page?: undefined | number; per_page?: undefined | number; sort?: "created" | "updated" | "pushed" | "full_name"; type?: "all" | "public" | "private" | "forks" | "sources" | "member" | "internal" }

      Type declaration

      • Optional direction?: "asc" | "desc"

        Can be one of asc or desc. Default: when using full_name: asc, otherwise desc

      • org: string
      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • Optional sort?: "created" | "updated" | "pushed" | "full_name"

        Can be one of created, updated, pushed, full_name.

      • Optional type?: "all" | "public" | "private" | "forks" | "sources" | "member" | "internal"

        Specifies the types of repositories you want returned. Can be one of all, public, private, forks, sources, member, internal. Default: all. If your organization is associated with an enterprise account using GitHub Enterprise Cloud, type can also be internal.

      ReposListForOrgResponse

      ReposListForOrgResponse: Array<ReposListForOrgResponseItem>

      ReposListForOrgResponseItem

      ReposListForOrgResponseItem: { archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; license: ReposListForOrgResponseItemLicense; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: ReposListForOrgResponseItemOwner; permissions: ReposListForOrgResponseItemPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

      Type declaration

      • archive_url: string
      • archived: boolean
      • assignees_url: string
      • blobs_url: string
      • branches_url: string
      • clone_url: string
      • collaborators_url: string
      • comments_url: string
      • commits_url: string
      • compare_url: string
      • contents_url: string
      • contributors_url: string
      • created_at: string
      • default_branch: string
      • deployments_url: string
      • description: string
      • disabled: boolean
      • downloads_url: string
      • events_url: string
      • fork: boolean
      • forks_count: number
      • forks_url: string
      • full_name: string
      • git_commits_url: string
      • git_refs_url: string
      • git_tags_url: string
      • git_url: string
      • has_downloads: boolean
      • has_issues: boolean
      • has_pages: boolean
      • has_projects: boolean
      • has_wiki: boolean
      • homepage: string
      • hooks_url: string
      • html_url: string
      • id: number
      • is_template: boolean
      • issue_comment_url: string
      • issue_events_url: string
      • issues_url: string
      • keys_url: string
      • labels_url: string
      • language: null
      • languages_url: string
      • license: ReposListForOrgResponseItemLicense
      • merges_url: string
      • milestones_url: string
      • mirror_url: string
      • name: string
      • network_count: number
      • node_id: string
      • notifications_url: string
      • open_issues_count: number
      • owner: ReposListForOrgResponseItemOwner
      • permissions: ReposListForOrgResponseItemPermissions
      • private: boolean
      • pulls_url: string
      • pushed_at: string
      • releases_url: string
      • size: number
      • ssh_url: string
      • stargazers_count: number
      • stargazers_url: string
      • statuses_url: string
      • subscribers_count: number
      • subscribers_url: string
      • subscription_url: string
      • svn_url: string
      • tags_url: string
      • teams_url: string
      • temp_clone_token: string
      • template_repository: null
      • topics: Array<string>
      • trees_url: string
      • updated_at: string
      • url: string
      • visibility: string
      • watchers_count: number

      ReposListForOrgResponseItemLicense

      ReposListForOrgResponseItemLicense: { key: string; name: string; node_id: string; spdx_id: string; url: string }

      Type declaration

      • key: string
      • name: string
      • node_id: string
      • spdx_id: string
      • url: string

      ReposListForOrgResponseItemOwner

      ReposListForOrgResponseItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposListForOrgResponseItemPermissions

      ReposListForOrgResponseItemPermissions: { admin: boolean; pull: boolean; push: boolean }

      Type declaration

      • admin: boolean
      • pull: boolean
      • push: boolean

      ReposListForUserParams

      ReposListForUserParams: { direction?: "asc" | "desc"; page?: undefined | number; per_page?: undefined | number; sort?: "created" | "updated" | "pushed" | "full_name"; type?: "all" | "owner" | "member"; username: string }

      Type declaration

      • Optional direction?: "asc" | "desc"

        Can be one of asc or desc. Default: asc when using full_name, otherwise desc

      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • Optional sort?: "created" | "updated" | "pushed" | "full_name"

        Can be one of created, updated, pushed, full_name.

      • Optional type?: "all" | "owner" | "member"

        Can be one of all, owner, member.

      • username: string

      ReposListForksParams

      ReposListForksParams: { owner: string; page?: undefined | number; per_page?: undefined | number; repo: string; sort?: "newest" | "oldest" | "stargazers" }

      Type declaration

      • owner: string
      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • repo: string
      • Optional sort?: "newest" | "oldest" | "stargazers"

        The sort order. Can be either newest, oldest, or stargazers.

      ReposListForksResponse

      ReposListForksResponse: Array<ReposListForksResponseItem>

      ReposListForksResponseItem

      ReposListForksResponseItem: { archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; license: ReposListForksResponseItemLicense; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: ReposListForksResponseItemOwner; permissions: ReposListForksResponseItemPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

      Type declaration

      • archive_url: string
      • archived: boolean
      • assignees_url: string
      • blobs_url: string
      • branches_url: string
      • clone_url: string
      • collaborators_url: string
      • comments_url: string
      • commits_url: string
      • compare_url: string
      • contents_url: string
      • contributors_url: string
      • created_at: string
      • default_branch: string
      • deployments_url: string
      • description: string
      • disabled: boolean
      • downloads_url: string
      • events_url: string
      • fork: boolean
      • forks_count: number
      • forks_url: string
      • full_name: string
      • git_commits_url: string
      • git_refs_url: string
      • git_tags_url: string
      • git_url: string
      • has_downloads: boolean
      • has_issues: boolean
      • has_pages: boolean
      • has_projects: boolean
      • has_wiki: boolean
      • homepage: string
      • hooks_url: string
      • html_url: string
      • id: number
      • is_template: boolean
      • issue_comment_url: string
      • issue_events_url: string
      • issues_url: string
      • keys_url: string
      • labels_url: string
      • language: null
      • languages_url: string
      • license: ReposListForksResponseItemLicense
      • merges_url: string
      • milestones_url: string
      • mirror_url: string
      • name: string
      • network_count: number
      • node_id: string
      • notifications_url: string
      • open_issues_count: number
      • owner: ReposListForksResponseItemOwner
      • permissions: ReposListForksResponseItemPermissions
      • private: boolean
      • pulls_url: string
      • pushed_at: string
      • releases_url: string
      • size: number
      • ssh_url: string
      • stargazers_count: number
      • stargazers_url: string
      • statuses_url: string
      • subscribers_count: number
      • subscribers_url: string
      • subscription_url: string
      • svn_url: string
      • tags_url: string
      • teams_url: string
      • temp_clone_token: string
      • template_repository: null
      • topics: Array<string>
      • trees_url: string
      • updated_at: string
      • url: string
      • visibility: string
      • watchers_count: number

      ReposListForksResponseItemLicense

      ReposListForksResponseItemLicense: { key: string; name: string; node_id: string; spdx_id: string; url: string }

      Type declaration

      • key: string
      • name: string
      • node_id: string
      • spdx_id: string
      • url: string

      ReposListForksResponseItemOwner

      ReposListForksResponseItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposListForksResponseItemPermissions

      ReposListForksResponseItemPermissions: { admin: boolean; pull: boolean; push: boolean }

      Type declaration

      • admin: boolean
      • pull: boolean
      • push: boolean

      ReposListHooksParams

      ReposListHooksParams: { owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

      Type declaration

      • owner: string
      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • repo: string

      ReposListHooksResponse

      ReposListHooksResponse: Array<ReposListHooksResponseItem>

      ReposListHooksResponseItem

      ReposListHooksResponseItem: { active: boolean; config: ReposListHooksResponseItemConfig; created_at: string; events: Array<string>; id: number; last_response: ReposListHooksResponseItemLastResponse; name: string; ping_url: string; test_url: string; type: string; updated_at: string; url: string }

      Type declaration

      ReposListHooksResponseItemConfig

      ReposListHooksResponseItemConfig: { content_type: string; insecure_ssl: string; url: string }

      Type declaration

      • content_type: string
      • insecure_ssl: string
      • url: string

      ReposListHooksResponseItemLastResponse

      ReposListHooksResponseItemLastResponse: { code: null; message: null; status: string }

      Type declaration

      • code: null
      • message: null
      • status: string

      ReposListInvitationsForAuthenticatedUserParams

      ReposListInvitationsForAuthenticatedUserParams: { page?: undefined | number; per_page?: undefined | number }

      Type declaration

      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      ReposListInvitationsForAuthenticatedUserResponse

      ReposListInvitationsForAuthenticatedUserResponse: Array<ReposListInvitationsForAuthenticatedUserResponseItem>

      ReposListInvitationsForAuthenticatedUserResponseItem

      ReposListInvitationsForAuthenticatedUserResponseItem: { created_at: string; html_url: string; id: number; invitee: ReposListInvitationsForAuthenticatedUserResponseItemInvitee; inviter: ReposListInvitationsForAuthenticatedUserResponseItemInviter; permissions: string; repository: ReposListInvitationsForAuthenticatedUserResponseItemRepository; url: string }

      Type declaration

      ReposListInvitationsForAuthenticatedUserResponseItemInvitee

      ReposListInvitationsForAuthenticatedUserResponseItemInvitee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposListInvitationsForAuthenticatedUserResponseItemInviter

      ReposListInvitationsForAuthenticatedUserResponseItemInviter: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposListInvitationsForAuthenticatedUserResponseItemRepository

      ReposListInvitationsForAuthenticatedUserResponseItemRepository: { archive_url: string; assignees_url: string; blobs_url: string; branches_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; deployments_url: string; description: string; downloads_url: string; events_url: string; fork: boolean; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; html_url: string; id: number; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; languages_url: string; merges_url: string; milestones_url: string; name: string; node_id: string; notifications_url: string; owner: ReposListInvitationsForAuthenticatedUserResponseItemRepositoryOwner; private: boolean; pulls_url: string; releases_url: string; ssh_url: string; stargazers_url: string; statuses_url: string; subscribers_url: string; subscription_url: string; tags_url: string; teams_url: string; trees_url: string; url: string }

      Type declaration

      • archive_url: string
      • assignees_url: string
      • blobs_url: string
      • branches_url: string
      • collaborators_url: string
      • comments_url: string
      • commits_url: string
      • compare_url: string
      • contents_url: string
      • contributors_url: string
      • deployments_url: string
      • description: string
      • downloads_url: string
      • events_url: string
      • fork: boolean
      • forks_url: string
      • full_name: string
      • git_commits_url: string
      • git_refs_url: string
      • git_tags_url: string
      • git_url: string
      • html_url: string
      • id: number
      • issue_comment_url: string
      • issue_events_url: string
      • issues_url: string
      • keys_url: string
      • labels_url: string
      • languages_url: string
      • merges_url: string
      • milestones_url: string
      • name: string
      • node_id: string
      • notifications_url: string
      • owner: ReposListInvitationsForAuthenticatedUserResponseItemRepositoryOwner
      • private: boolean
      • pulls_url: string
      • releases_url: string
      • ssh_url: string
      • stargazers_url: string
      • statuses_url: string
      • subscribers_url: string
      • subscription_url: string
      • tags_url: string
      • teams_url: string
      • trees_url: string
      • url: string

      ReposListInvitationsForAuthenticatedUserResponseItemRepositoryOwner

      ReposListInvitationsForAuthenticatedUserResponseItemRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposListInvitationsParams

      ReposListInvitationsParams: { owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

      Type declaration

      • owner: string
      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • repo: string

      ReposListInvitationsResponse

      ReposListInvitationsResponse: Array<ReposListInvitationsResponseItem>

      ReposListInvitationsResponseItem

      ReposListInvitationsResponseItem: { created_at: string; html_url: string; id: number; invitee: ReposListInvitationsResponseItemInvitee; inviter: ReposListInvitationsResponseItemInviter; permissions: string; repository: ReposListInvitationsResponseItemRepository; url: string }

      Type declaration

      ReposListInvitationsResponseItemInvitee

      ReposListInvitationsResponseItemInvitee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposListInvitationsResponseItemInviter

      ReposListInvitationsResponseItemInviter: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposListInvitationsResponseItemRepository

      ReposListInvitationsResponseItemRepository: { archive_url: string; assignees_url: string; blobs_url: string; branches_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; deployments_url: string; description: string; downloads_url: string; events_url: string; fork: boolean; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; html_url: string; id: number; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; languages_url: string; merges_url: string; milestones_url: string; name: string; node_id: string; notifications_url: string; owner: ReposListInvitationsResponseItemRepositoryOwner; private: boolean; pulls_url: string; releases_url: string; ssh_url: string; stargazers_url: string; statuses_url: string; subscribers_url: string; subscription_url: string; tags_url: string; teams_url: string; trees_url: string; url: string }

      Type declaration

      • archive_url: string
      • assignees_url: string
      • blobs_url: string
      • branches_url: string
      • collaborators_url: string
      • comments_url: string
      • commits_url: string
      • compare_url: string
      • contents_url: string
      • contributors_url: string
      • deployments_url: string
      • description: string
      • downloads_url: string
      • events_url: string
      • fork: boolean
      • forks_url: string
      • full_name: string
      • git_commits_url: string
      • git_refs_url: string
      • git_tags_url: string
      • git_url: string
      • html_url: string
      • id: number
      • issue_comment_url: string
      • issue_events_url: string
      • issues_url: string
      • keys_url: string
      • labels_url: string
      • languages_url: string
      • merges_url: string
      • milestones_url: string
      • name: string
      • node_id: string
      • notifications_url: string
      • owner: ReposListInvitationsResponseItemRepositoryOwner
      • private: boolean
      • pulls_url: string
      • releases_url: string
      • ssh_url: string
      • stargazers_url: string
      • statuses_url: string
      • subscribers_url: string
      • subscription_url: string
      • tags_url: string
      • teams_url: string
      • trees_url: string
      • url: string

      ReposListInvitationsResponseItemRepositoryOwner

      ReposListInvitationsResponseItemRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposListLanguagesParams

      ReposListLanguagesParams: { owner: string; repo: string }

      Type declaration

      • owner: string
      • repo: string

      ReposListLanguagesResponse

      ReposListLanguagesResponse: { C: number; Python: number }

      Type declaration

      • C: number
      • Python: number

      ReposListPagesBuildsParams

      ReposListPagesBuildsParams: { owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

      Type declaration

      • owner: string
      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • repo: string

      ReposListPagesBuildsResponse

      ReposListPagesBuildsResponse: Array<ReposListPagesBuildsResponseItem>

      ReposListPagesBuildsResponseItem

      ReposListPagesBuildsResponseItem: { commit: string; created_at: string; duration: number; error: ReposListPagesBuildsResponseItemError; pusher: ReposListPagesBuildsResponseItemPusher; status: string; updated_at: string; url: string }

      Type declaration

      ReposListPagesBuildsResponseItemError

      ReposListPagesBuildsResponseItemError: { message: null }

      Type declaration

      • message: null

      ReposListPagesBuildsResponseItemPusher

      ReposListPagesBuildsResponseItemPusher: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposListParams

      ReposListParams: { affiliation?: undefined | string; direction?: "asc" | "desc"; page?: undefined | number; per_page?: undefined | number; sort?: "created" | "updated" | "pushed" | "full_name"; type?: "all" | "owner" | "public" | "private" | "member"; visibility?: "all" | "public" | "private" }

      Type declaration

      • Optional affiliation?: undefined | string

        Comma-separated list of values. Can include: * owner: Repositories that are owned by the authenticated user. * collaborator: Repositories that the user has been added to as a collaborator. * organization_member: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.

      • Optional direction?: "asc" | "desc"

        Can be one of asc or desc. Default: asc when using full_name, otherwise desc

      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • Optional sort?: "created" | "updated" | "pushed" | "full_name"

        Can be one of created, updated, pushed, full_name.

      • Optional type?: "all" | "owner" | "public" | "private" | "member"

        Can be one of all, owner, public, private, member. Default: all

        Will cause a 422 error if used in the same request as visibility or affiliation. Will cause a 422 error if used in the same request as visibility or affiliation.

      • Optional visibility?: "all" | "public" | "private"

        Can be one of all, public, or private.

      ReposListProtectedBranchRequiredStatusChecksContextsParams

      ReposListProtectedBranchRequiredStatusChecksContextsParams: { branch: string; owner: string; repo: string }

      Type declaration

      • branch: string
      • owner: string
      • repo: string

      ReposListProtectedBranchRequiredStatusChecksContextsResponse

      ReposListProtectedBranchRequiredStatusChecksContextsResponse: Array<string>

      ReposListProtectedBranchTeamRestrictionsParams

      ReposListProtectedBranchTeamRestrictionsParams: { branch: string; owner: string; repo: string }

      Type declaration

      • branch: string
      • owner: string
      • repo: string

      ReposListProtectedBranchTeamRestrictionsResponse

      ReposListProtectedBranchTeamRestrictionsResponse: Array<ReposListProtectedBranchTeamRestrictionsResponseItem>

      ReposListProtectedBranchTeamRestrictionsResponseItem

      ReposListProtectedBranchTeamRestrictionsResponseItem: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: null; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

      Type declaration

      • description: string
      • html_url: string
      • id: number
      • members_url: string
      • name: string
      • node_id: string
      • parent: null
      • permission: string
      • privacy: string
      • repositories_url: string
      • slug: string
      • url: string

      ReposListProtectedBranchUserRestrictionsParams

      ReposListProtectedBranchUserRestrictionsParams: { branch: string; owner: string; repo: string }

      Type declaration

      • branch: string
      • owner: string
      • repo: string

      ReposListProtectedBranchUserRestrictionsResponse

      ReposListProtectedBranchUserRestrictionsResponse: Array<ReposListProtectedBranchUserRestrictionsResponseItem>

      ReposListProtectedBranchUserRestrictionsResponseItem

      ReposListProtectedBranchUserRestrictionsResponseItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposListPublicParams

      ReposListPublicParams: { page?: undefined | number; per_page?: undefined | number; since?: undefined | number }

      Type declaration

      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • Optional since?: undefined | number

        The integer ID of the last repository that you've seen.

      ReposListPublicResponse

      ReposListPublicResponse: Array<ReposListPublicResponseItem>

      ReposListPublicResponseItem

      ReposListPublicResponseItem: { archive_url: string; assignees_url: string; blobs_url: string; branches_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; deployments_url: string; description: string; downloads_url: string; events_url: string; fork: boolean; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; html_url: string; id: number; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; languages_url: string; merges_url: string; milestones_url: string; name: string; node_id: string; notifications_url: string; owner: ReposListPublicResponseItemOwner; private: boolean; pulls_url: string; releases_url: string; ssh_url: string; stargazers_url: string; statuses_url: string; subscribers_url: string; subscription_url: string; tags_url: string; teams_url: string; trees_url: string; url: string }

      Type declaration

      • archive_url: string
      • assignees_url: string
      • blobs_url: string
      • branches_url: string
      • collaborators_url: string
      • comments_url: string
      • commits_url: string
      • compare_url: string
      • contents_url: string
      • contributors_url: string
      • deployments_url: string
      • description: string
      • downloads_url: string
      • events_url: string
      • fork: boolean
      • forks_url: string
      • full_name: string
      • git_commits_url: string
      • git_refs_url: string
      • git_tags_url: string
      • git_url: string
      • html_url: string
      • id: number
      • issue_comment_url: string
      • issue_events_url: string
      • issues_url: string
      • keys_url: string
      • labels_url: string
      • languages_url: string
      • merges_url: string
      • milestones_url: string
      • name: string
      • node_id: string
      • notifications_url: string
      • owner: ReposListPublicResponseItemOwner
      • private: boolean
      • pulls_url: string
      • releases_url: string
      • ssh_url: string
      • stargazers_url: string
      • statuses_url: string
      • subscribers_url: string
      • subscription_url: string
      • tags_url: string
      • teams_url: string
      • trees_url: string
      • url: string

      ReposListPublicResponseItemOwner

      ReposListPublicResponseItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposListPullRequestsAssociatedWithCommitParams

      ReposListPullRequestsAssociatedWithCommitParams: { commit_sha: string; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

      Type declaration

      • commit_sha: string
      • owner: string
      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • repo: string

      ReposListPullRequestsAssociatedWithCommitResponse

      ReposListPullRequestsAssociatedWithCommitResponse: Array<ReposListPullRequestsAssociatedWithCommitResponseItem>

      ReposListPullRequestsAssociatedWithCommitResponseItem

      ReposListPullRequestsAssociatedWithCommitResponseItem: { _links: ReposListPullRequestsAssociatedWithCommitResponseItemLinks; active_lock_reason: string; assignee: ReposListPullRequestsAssociatedWithCommitResponseItemAssignee; assignees: Array<ReposListPullRequestsAssociatedWithCommitResponseItemAssigneesItem>; author_association: string; base: ReposListPullRequestsAssociatedWithCommitResponseItemBase; body: string; closed_at: string; comments_url: string; commits_url: string; created_at: string; diff_url: string; draft: boolean; head: ReposListPullRequestsAssociatedWithCommitResponseItemHead; html_url: string; id: number; issue_url: string; labels: Array<ReposListPullRequestsAssociatedWithCommitResponseItemLabelsItem>; locked: boolean; merge_commit_sha: string; merged_at: string; milestone: ReposListPullRequestsAssociatedWithCommitResponseItemMilestone; node_id: string; number: number; patch_url: string; requested_reviewers: Array<ReposListPullRequestsAssociatedWithCommitResponseItemRequestedReviewersItem>; requested_teams: Array<ReposListPullRequestsAssociatedWithCommitResponseItemRequestedTeamsItem>; review_comment_url: string; review_comments_url: string; state: string; statuses_url: string; title: string; updated_at: string; url: string; user: ReposListPullRequestsAssociatedWithCommitResponseItemUser }

      Type declaration

      ReposListPullRequestsAssociatedWithCommitResponseItemAssignee

      ReposListPullRequestsAssociatedWithCommitResponseItemAssignee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposListPullRequestsAssociatedWithCommitResponseItemAssigneesItem

      ReposListPullRequestsAssociatedWithCommitResponseItemAssigneesItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposListPullRequestsAssociatedWithCommitResponseItemBase

      ReposListPullRequestsAssociatedWithCommitResponseItemBase: { label: string; ref: string; repo: ReposListPullRequestsAssociatedWithCommitResponseItemBaseRepo; sha: string; user: ReposListPullRequestsAssociatedWithCommitResponseItemBaseUser }

      Type declaration

      ReposListPullRequestsAssociatedWithCommitResponseItemBaseRepo

      ReposListPullRequestsAssociatedWithCommitResponseItemBaseRepo: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: ReposListPullRequestsAssociatedWithCommitResponseItemBaseRepoOwner; permissions: ReposListPullRequestsAssociatedWithCommitResponseItemBaseRepoPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

      Type declaration

      • allow_merge_commit: boolean
      • allow_rebase_merge: boolean
      • allow_squash_merge: boolean
      • archive_url: string
      • archived: boolean
      • assignees_url: string
      • blobs_url: string
      • branches_url: string
      • clone_url: string
      • collaborators_url: string
      • comments_url: string
      • commits_url: string
      • compare_url: string
      • contents_url: string
      • contributors_url: string
      • created_at: string
      • default_branch: string
      • deployments_url: string
      • description: string
      • disabled: boolean
      • downloads_url: string
      • events_url: string
      • fork: boolean
      • forks_count: number
      • forks_url: string
      • full_name: string
      • git_commits_url: string
      • git_refs_url: string
      • git_tags_url: string
      • git_url: string
      • has_downloads: boolean
      • has_issues: boolean
      • has_pages: boolean
      • has_projects: boolean
      • has_wiki: boolean
      • homepage: string
      • hooks_url: string
      • html_url: string
      • id: number
      • is_template: boolean
      • issue_comment_url: string
      • issue_events_url: string
      • issues_url: string
      • keys_url: string
      • labels_url: string
      • language: null
      • languages_url: string
      • merges_url: string
      • milestones_url: string
      • mirror_url: string
      • name: string
      • network_count: number
      • node_id: string
      • notifications_url: string
      • open_issues_count: number
      • owner: ReposListPullRequestsAssociatedWithCommitResponseItemBaseRepoOwner
      • permissions: ReposListPullRequestsAssociatedWithCommitResponseItemBaseRepoPermissions
      • private: boolean
      • pulls_url: string
      • pushed_at: string
      • releases_url: string
      • size: number
      • ssh_url: string
      • stargazers_count: number
      • stargazers_url: string
      • statuses_url: string
      • subscribers_count: number
      • subscribers_url: string
      • subscription_url: string
      • svn_url: string
      • tags_url: string
      • teams_url: string
      • temp_clone_token: string
      • template_repository: null
      • topics: Array<string>
      • trees_url: string
      • updated_at: string
      • url: string
      • visibility: string
      • watchers_count: number

      ReposListPullRequestsAssociatedWithCommitResponseItemBaseRepoOwner

      ReposListPullRequestsAssociatedWithCommitResponseItemBaseRepoOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposListPullRequestsAssociatedWithCommitResponseItemBaseRepoPermissions

      ReposListPullRequestsAssociatedWithCommitResponseItemBaseRepoPermissions: { admin: boolean; pull: boolean; push: boolean }

      Type declaration

      • admin: boolean
      • pull: boolean
      • push: boolean

      ReposListPullRequestsAssociatedWithCommitResponseItemBaseUser

      ReposListPullRequestsAssociatedWithCommitResponseItemBaseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposListPullRequestsAssociatedWithCommitResponseItemHead

      ReposListPullRequestsAssociatedWithCommitResponseItemHead: { label: string; ref: string; repo: ReposListPullRequestsAssociatedWithCommitResponseItemHeadRepo; sha: string; user: ReposListPullRequestsAssociatedWithCommitResponseItemHeadUser }

      Type declaration

      ReposListPullRequestsAssociatedWithCommitResponseItemHeadRepo

      ReposListPullRequestsAssociatedWithCommitResponseItemHeadRepo: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: ReposListPullRequestsAssociatedWithCommitResponseItemHeadRepoOwner; permissions: ReposListPullRequestsAssociatedWithCommitResponseItemHeadRepoPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

      Type declaration

      • allow_merge_commit: boolean
      • allow_rebase_merge: boolean
      • allow_squash_merge: boolean
      • archive_url: string
      • archived: boolean
      • assignees_url: string
      • blobs_url: string
      • branches_url: string
      • clone_url: string
      • collaborators_url: string
      • comments_url: string
      • commits_url: string
      • compare_url: string
      • contents_url: string
      • contributors_url: string
      • created_at: string
      • default_branch: string
      • deployments_url: string
      • description: string
      • disabled: boolean
      • downloads_url: string
      • events_url: string
      • fork: boolean
      • forks_count: number
      • forks_url: string
      • full_name: string
      • git_commits_url: string
      • git_refs_url: string
      • git_tags_url: string
      • git_url: string
      • has_downloads: boolean
      • has_issues: boolean
      • has_pages: boolean
      • has_projects: boolean
      • has_wiki: boolean
      • homepage: string
      • hooks_url: string
      • html_url: string
      • id: number
      • is_template: boolean
      • issue_comment_url: string
      • issue_events_url: string
      • issues_url: string
      • keys_url: string
      • labels_url: string
      • language: null
      • languages_url: string
      • merges_url: string
      • milestones_url: string
      • mirror_url: string
      • name: string
      • network_count: number
      • node_id: string
      • notifications_url: string
      • open_issues_count: number
      • owner: ReposListPullRequestsAssociatedWithCommitResponseItemHeadRepoOwner
      • permissions: ReposListPullRequestsAssociatedWithCommitResponseItemHeadRepoPermissions
      • private: boolean
      • pulls_url: string
      • pushed_at: string
      • releases_url: string
      • size: number
      • ssh_url: string
      • stargazers_count: number
      • stargazers_url: string
      • statuses_url: string
      • subscribers_count: number
      • subscribers_url: string
      • subscription_url: string
      • svn_url: string
      • tags_url: string
      • teams_url: string
      • temp_clone_token: string
      • template_repository: null
      • topics: Array<string>
      • trees_url: string
      • updated_at: string
      • url: string
      • visibility: string
      • watchers_count: number

      ReposListPullRequestsAssociatedWithCommitResponseItemHeadRepoOwner

      ReposListPullRequestsAssociatedWithCommitResponseItemHeadRepoOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposListPullRequestsAssociatedWithCommitResponseItemHeadRepoPermissions

      ReposListPullRequestsAssociatedWithCommitResponseItemHeadRepoPermissions: { admin: boolean; pull: boolean; push: boolean }

      Type declaration

      • admin: boolean
      • pull: boolean
      • push: boolean

      ReposListPullRequestsAssociatedWithCommitResponseItemHeadUser

      ReposListPullRequestsAssociatedWithCommitResponseItemHeadUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposListPullRequestsAssociatedWithCommitResponseItemLabelsItem

      ReposListPullRequestsAssociatedWithCommitResponseItemLabelsItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }

      Type declaration

      • color: string
      • default: boolean
      • description: string
      • id: number
      • name: string
      • node_id: string
      • url: string

      ReposListPullRequestsAssociatedWithCommitResponseItemLinks

      ReposListPullRequestsAssociatedWithCommitResponseItemLinks: { comments: ReposListPullRequestsAssociatedWithCommitResponseItemLinksComments; commits: ReposListPullRequestsAssociatedWithCommitResponseItemLinksCommits; html: ReposListPullRequestsAssociatedWithCommitResponseItemLinksHtml; issue: ReposListPullRequestsAssociatedWithCommitResponseItemLinksIssue; review_comment: ReposListPullRequestsAssociatedWithCommitResponseItemLinksReviewComment; review_comments: ReposListPullRequestsAssociatedWithCommitResponseItemLinksReviewComments; self: ReposListPullRequestsAssociatedWithCommitResponseItemLinksSelf; statuses: ReposListPullRequestsAssociatedWithCommitResponseItemLinksStatuses }

      Type declaration

      ReposListPullRequestsAssociatedWithCommitResponseItemLinksComments

      ReposListPullRequestsAssociatedWithCommitResponseItemLinksComments: { href: string }

      Type declaration

      • href: string

      ReposListPullRequestsAssociatedWithCommitResponseItemLinksCommits

      ReposListPullRequestsAssociatedWithCommitResponseItemLinksCommits: { href: string }

      Type declaration

      • href: string

      ReposListPullRequestsAssociatedWithCommitResponseItemLinksHtml

      ReposListPullRequestsAssociatedWithCommitResponseItemLinksHtml: { href: string }

      Type declaration

      • href: string

      ReposListPullRequestsAssociatedWithCommitResponseItemLinksIssue

      ReposListPullRequestsAssociatedWithCommitResponseItemLinksIssue: { href: string }

      Type declaration

      • href: string

      ReposListPullRequestsAssociatedWithCommitResponseItemLinksReviewComment

      ReposListPullRequestsAssociatedWithCommitResponseItemLinksReviewComment: { href: string }

      Type declaration

      • href: string

      ReposListPullRequestsAssociatedWithCommitResponseItemLinksReviewComments

      ReposListPullRequestsAssociatedWithCommitResponseItemLinksReviewComments: { href: string }

      Type declaration

      • href: string

      ReposListPullRequestsAssociatedWithCommitResponseItemLinksSelf

      ReposListPullRequestsAssociatedWithCommitResponseItemLinksSelf: { href: string }

      Type declaration

      • href: string

      ReposListPullRequestsAssociatedWithCommitResponseItemLinksStatuses

      ReposListPullRequestsAssociatedWithCommitResponseItemLinksStatuses: { href: string }

      Type declaration

      • href: string

      ReposListPullRequestsAssociatedWithCommitResponseItemMilestone

      ReposListPullRequestsAssociatedWithCommitResponseItemMilestone: { closed_at: string; closed_issues: number; created_at: string; creator: ReposListPullRequestsAssociatedWithCommitResponseItemMilestoneCreator; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }

      Type declaration

      ReposListPullRequestsAssociatedWithCommitResponseItemMilestoneCreator

      ReposListPullRequestsAssociatedWithCommitResponseItemMilestoneCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposListPullRequestsAssociatedWithCommitResponseItemRequestedReviewersItem

      ReposListPullRequestsAssociatedWithCommitResponseItemRequestedReviewersItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposListPullRequestsAssociatedWithCommitResponseItemRequestedTeamsItem

      ReposListPullRequestsAssociatedWithCommitResponseItemRequestedTeamsItem: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: null; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

      Type declaration

      • description: string
      • html_url: string
      • id: number
      • members_url: string
      • name: string
      • node_id: string
      • parent: null
      • permission: string
      • privacy: string
      • repositories_url: string
      • slug: string
      • url: string

      ReposListPullRequestsAssociatedWithCommitResponseItemUser

      ReposListPullRequestsAssociatedWithCommitResponseItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposListReleasesParams

      ReposListReleasesParams: { owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

      Type declaration

      • owner: string
      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • repo: string

      ReposListReleasesResponse

      ReposListReleasesResponse: Array<ReposListReleasesResponseItem>

      ReposListReleasesResponseItem

      ReposListReleasesResponseItem: { assets: Array<ReposListReleasesResponseItemAssetsItem>; assets_url: string; author: ReposListReleasesResponseItemAuthor; body: string; created_at: string; draft: boolean; html_url: string; id: number; name: string; node_id: string; prerelease: boolean; published_at: string; tag_name: string; tarball_url: string; target_commitish: string; upload_url: string; url: string; zipball_url: string }

      Type declaration

      • assets: Array<ReposListReleasesResponseItemAssetsItem>
      • assets_url: string
      • author: ReposListReleasesResponseItemAuthor
      • body: string
      • created_at: string
      • draft: boolean
      • html_url: string
      • id: number
      • name: string
      • node_id: string
      • prerelease: boolean
      • published_at: string
      • tag_name: string
      • tarball_url: string
      • target_commitish: string
      • upload_url: string
      • url: string
      • zipball_url: string

      ReposListReleasesResponseItemAssetsItem

      ReposListReleasesResponseItemAssetsItem: { browser_download_url: string; content_type: string; created_at: string; download_count: number; id: number; label: string; name: string; node_id: string; size: number; state: string; updated_at: string; uploader: ReposListReleasesResponseItemAssetsItemUploader; url: string }

      Type declaration

      • browser_download_url: string
      • content_type: string
      • created_at: string
      • download_count: number
      • id: number
      • label: string
      • name: string
      • node_id: string
      • size: number
      • state: string
      • updated_at: string
      • uploader: ReposListReleasesResponseItemAssetsItemUploader
      • url: string

      ReposListReleasesResponseItemAssetsItemUploader

      ReposListReleasesResponseItemAssetsItemUploader: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposListReleasesResponseItemAuthor

      ReposListReleasesResponseItemAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposListStatusesForRefParams

      ReposListStatusesForRefParams: { owner: string; page?: undefined | number; per_page?: undefined | number; ref: string; repo: string }

      Type declaration

      • owner: string
      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • ref: string
      • repo: string

      ReposListStatusesForRefResponse

      ReposListStatusesForRefResponse: Array<ReposListStatusesForRefResponseItem>

      ReposListStatusesForRefResponseItem

      ReposListStatusesForRefResponseItem: { avatar_url: string; context: string; created_at: string; creator: ReposListStatusesForRefResponseItemCreator; description: string; id: number; node_id: string; state: string; target_url: string; updated_at: string; url: string }

      Type declaration

      • avatar_url: string
      • context: string
      • created_at: string
      • creator: ReposListStatusesForRefResponseItemCreator
      • description: string
      • id: number
      • node_id: string
      • state: string
      • target_url: string
      • updated_at: string
      • url: string

      ReposListStatusesForRefResponseItemCreator

      ReposListStatusesForRefResponseItemCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposListTagsParams

      ReposListTagsParams: { owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

      Type declaration

      • owner: string
      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • repo: string

      ReposListTagsResponse

      ReposListTagsResponse: Array<ReposListTagsResponseItem>

      ReposListTagsResponseItem

      ReposListTagsResponseItem: { commit: ReposListTagsResponseItemCommit; name: string; tarball_url: string; zipball_url: string }

      Type declaration

      ReposListTagsResponseItemCommit

      ReposListTagsResponseItemCommit: { sha: string; url: string }

      Type declaration

      • sha: string
      • url: string

      ReposListTeamsParams

      ReposListTeamsParams: { owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

      Type declaration

      • owner: string
      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • repo: string

      ReposListTeamsResponse

      ReposListTeamsResponse: Array<ReposListTeamsResponseItem>

      ReposListTeamsResponseItem

      ReposListTeamsResponseItem: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: null; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

      Type declaration

      • description: string
      • html_url: string
      • id: number
      • members_url: string
      • name: string
      • node_id: string
      • parent: null
      • permission: string
      • privacy: string
      • repositories_url: string
      • slug: string
      • url: string

      ReposListTeamsWithAccessToProtectedBranchParams

      ReposListTeamsWithAccessToProtectedBranchParams: { branch: string; owner: string; repo: string }

      Type declaration

      • branch: string
      • owner: string
      • repo: string

      ReposListTeamsWithAccessToProtectedBranchResponse

      ReposListTeamsWithAccessToProtectedBranchResponse: Array<ReposListTeamsWithAccessToProtectedBranchResponseItem>

      ReposListTeamsWithAccessToProtectedBranchResponseItem

      ReposListTeamsWithAccessToProtectedBranchResponseItem: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: null; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

      Type declaration

      • description: string
      • html_url: string
      • id: number
      • members_url: string
      • name: string
      • node_id: string
      • parent: null
      • permission: string
      • privacy: string
      • repositories_url: string
      • slug: string
      • url: string

      ReposListTopicsParams

      ReposListTopicsParams: { owner: string; repo: string }

      Type declaration

      • owner: string
      • repo: string

      ReposListTopicsResponse

      ReposListTopicsResponse: { names: Array<string> }

      Type declaration

      • names: Array<string>

      ReposListUsersWithAccessToProtectedBranchParams

      ReposListUsersWithAccessToProtectedBranchParams: { branch: string; owner: string; repo: string }

      Type declaration

      • branch: string
      • owner: string
      • repo: string

      ReposListUsersWithAccessToProtectedBranchResponse

      ReposListUsersWithAccessToProtectedBranchResponse: Array<ReposListUsersWithAccessToProtectedBranchResponseItem>

      ReposListUsersWithAccessToProtectedBranchResponseItem

      ReposListUsersWithAccessToProtectedBranchResponseItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposMergeParams

      ReposMergeParams: { base: string; commit_message?: undefined | string; head: string; owner: string; repo: string }

      Type declaration

      • base: string

        The name of the base branch that the head will be merged into.

      • Optional commit_message?: undefined | string

        Commit message to use for the merge commit. If omitted, a default message will be used.

      • head: string

        The head to merge. This can be a branch name or a commit SHA1.

      • owner: string
      • repo: string

      ReposMergeResponse

      ReposMergeResponse: { author: ReposMergeResponseAuthor; comments_url: string; commit: ReposMergeResponseCommit; committer: ReposMergeResponseCommitter; html_url: string; node_id: string; parents: Array<ReposMergeResponseParentsItem>; sha: string; url: string }

      Type declaration

      ReposMergeResponseAuthor

      ReposMergeResponseAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposMergeResponseCommit

      ReposMergeResponseCommit: { author: ReposMergeResponseCommitAuthor; comment_count: number; committer: ReposMergeResponseCommitCommitter; message: string; tree: ReposMergeResponseCommitTree; url: string; verification: ReposMergeResponseCommitVerification }

      Type declaration

      ReposMergeResponseCommitAuthor

      ReposMergeResponseCommitAuthor: { date: string; email: string; name: string }

      Type declaration

      • date: string
      • email: string
      • name: string

      ReposMergeResponseCommitCommitter

      ReposMergeResponseCommitCommitter: { date: string; email: string; name: string }

      Type declaration

      • date: string
      • email: string
      • name: string

      ReposMergeResponseCommitTree

      ReposMergeResponseCommitTree: { sha: string; url: string }

      Type declaration

      • sha: string
      • url: string

      ReposMergeResponseCommitVerification

      ReposMergeResponseCommitVerification: { payload: null; reason: string; signature: null; verified: boolean }

      Type declaration

      • payload: null
      • reason: string
      • signature: null
      • verified: boolean

      ReposMergeResponseCommitter

      ReposMergeResponseCommitter: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposMergeResponseParentsItem

      ReposMergeResponseParentsItem: { sha: string; url: string }

      Type declaration

      • sha: string
      • url: string

      ReposPingHookParams

      ReposPingHookParams: { hook_id: number; owner: string; repo: string }

      Type declaration

      • hook_id: number
      • owner: string
      • repo: string

      ReposRemoveBranchProtectionParams

      ReposRemoveBranchProtectionParams: { branch: string; owner: string; repo: string }

      Type declaration

      • branch: string
      • owner: string
      • repo: string

      ReposRemoveCollaboratorParams

      ReposRemoveCollaboratorParams: { owner: string; repo: string; username: string }

      Type declaration

      • owner: string
      • repo: string
      • username: string

      ReposRemoveDeployKeyParams

      ReposRemoveDeployKeyParams: { key_id: number; owner: string; repo: string }

      Type declaration

      • key_id: number
      • owner: string
      • repo: string

      ReposRemoveProtectedBranchAdminEnforcementParams

      ReposRemoveProtectedBranchAdminEnforcementParams: { branch: string; owner: string; repo: string }

      Type declaration

      • branch: string
      • owner: string
      • repo: string

      ReposRemoveProtectedBranchAppRestrictionsParams

      ReposRemoveProtectedBranchAppRestrictionsParams: { apps: string[]; branch: string; owner: string; repo: string }

      Type declaration

      • apps: string[]
      • branch: string
      • owner: string
      • repo: string

      ReposRemoveProtectedBranchAppRestrictionsResponse

      ReposRemoveProtectedBranchAppRestrictionsResponse: Array<ReposRemoveProtectedBranchAppRestrictionsResponseItem>

      ReposRemoveProtectedBranchAppRestrictionsResponseItem

      ReposRemoveProtectedBranchAppRestrictionsResponseItem: { created_at: string; description: string; events: Array<string>; external_url: string; html_url: string; id: number; name: string; node_id: string; owner: ReposRemoveProtectedBranchAppRestrictionsResponseItemOwner; permissions: ReposRemoveProtectedBranchAppRestrictionsResponseItemPermissions; slug: string; updated_at: string }

      Type declaration

      ReposRemoveProtectedBranchAppRestrictionsResponseItemOwner

      ReposRemoveProtectedBranchAppRestrictionsResponseItemOwner: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

      Type declaration

      • avatar_url: string
      • description: string
      • events_url: string
      • hooks_url: string
      • id: number
      • issues_url: string
      • login: string
      • members_url: string
      • node_id: string
      • public_members_url: string
      • repos_url: string
      • url: string

      ReposRemoveProtectedBranchAppRestrictionsResponseItemPermissions

      ReposRemoveProtectedBranchAppRestrictionsResponseItemPermissions: { contents: string; issues: string; metadata: string; single_file: string }

      Type declaration

      • contents: string
      • issues: string
      • metadata: string
      • single_file: string

      ReposRemoveProtectedBranchPullRequestReviewEnforcementParams

      ReposRemoveProtectedBranchPullRequestReviewEnforcementParams: { branch: string; owner: string; repo: string }

      Type declaration

      • branch: string
      • owner: string
      • repo: string

      ReposRemoveProtectedBranchRequiredSignaturesParams

      ReposRemoveProtectedBranchRequiredSignaturesParams: { branch: string; owner: string; repo: string }

      Type declaration

      • branch: string
      • owner: string
      • repo: string

      ReposRemoveProtectedBranchRequiredStatusChecksContextsParams

      ReposRemoveProtectedBranchRequiredStatusChecksContextsParams: { branch: string; contexts: string[]; owner: string; repo: string }

      Type declaration

      • branch: string
      • contexts: string[]
      • owner: string
      • repo: string

      ReposRemoveProtectedBranchRequiredStatusChecksContextsResponse

      ReposRemoveProtectedBranchRequiredStatusChecksContextsResponse: Array<string>

      ReposRemoveProtectedBranchRequiredStatusChecksParams

      ReposRemoveProtectedBranchRequiredStatusChecksParams: { branch: string; owner: string; repo: string }

      Type declaration

      • branch: string
      • owner: string
      • repo: string

      ReposRemoveProtectedBranchRestrictionsParams

      ReposRemoveProtectedBranchRestrictionsParams: { branch: string; owner: string; repo: string }

      Type declaration

      • branch: string
      • owner: string
      • repo: string

      ReposRemoveProtectedBranchTeamRestrictionsParams

      ReposRemoveProtectedBranchTeamRestrictionsParams: { branch: string; owner: string; repo: string; teams: string[] }

      Type declaration

      • branch: string
      • owner: string
      • repo: string
      • teams: string[]

      ReposRemoveProtectedBranchTeamRestrictionsResponse

      ReposRemoveProtectedBranchTeamRestrictionsResponse: Array<ReposRemoveProtectedBranchTeamRestrictionsResponseItem>

      ReposRemoveProtectedBranchTeamRestrictionsResponseItem

      ReposRemoveProtectedBranchTeamRestrictionsResponseItem: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: null; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

      Type declaration

      • description: string
      • html_url: string
      • id: number
      • members_url: string
      • name: string
      • node_id: string
      • parent: null
      • permission: string
      • privacy: string
      • repositories_url: string
      • slug: string
      • url: string

      ReposRemoveProtectedBranchUserRestrictionsParams

      ReposRemoveProtectedBranchUserRestrictionsParams: { branch: string; owner: string; repo: string; users: string[] }

      Type declaration

      • branch: string
      • owner: string
      • repo: string
      • users: string[]

      ReposRemoveProtectedBranchUserRestrictionsResponse

      ReposRemoveProtectedBranchUserRestrictionsResponse: Array<ReposRemoveProtectedBranchUserRestrictionsResponseItem>

      ReposRemoveProtectedBranchUserRestrictionsResponseItem

      ReposRemoveProtectedBranchUserRestrictionsResponseItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposReplaceProtectedBranchAppRestrictionsParams

      ReposReplaceProtectedBranchAppRestrictionsParams: { apps: string[]; branch: string; owner: string; repo: string }

      Type declaration

      • apps: string[]
      • branch: string
      • owner: string
      • repo: string

      ReposReplaceProtectedBranchAppRestrictionsResponse

      ReposReplaceProtectedBranchAppRestrictionsResponse: Array<ReposReplaceProtectedBranchAppRestrictionsResponseItem>

      ReposReplaceProtectedBranchAppRestrictionsResponseItem

      ReposReplaceProtectedBranchAppRestrictionsResponseItem: { created_at: string; description: string; events: Array<string>; external_url: string; html_url: string; id: number; name: string; node_id: string; owner: ReposReplaceProtectedBranchAppRestrictionsResponseItemOwner; permissions: ReposReplaceProtectedBranchAppRestrictionsResponseItemPermissions; slug: string; updated_at: string }

      Type declaration

      ReposReplaceProtectedBranchAppRestrictionsResponseItemOwner

      ReposReplaceProtectedBranchAppRestrictionsResponseItemOwner: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

      Type declaration

      • avatar_url: string
      • description: string
      • events_url: string
      • hooks_url: string
      • id: number
      • issues_url: string
      • login: string
      • members_url: string
      • node_id: string
      • public_members_url: string
      • repos_url: string
      • url: string

      ReposReplaceProtectedBranchAppRestrictionsResponseItemPermissions

      ReposReplaceProtectedBranchAppRestrictionsResponseItemPermissions: { contents: string; issues: string; metadata: string; single_file: string }

      Type declaration

      • contents: string
      • issues: string
      • metadata: string
      • single_file: string

      ReposReplaceProtectedBranchRequiredStatusChecksContextsParams

      ReposReplaceProtectedBranchRequiredStatusChecksContextsParams: { branch: string; contexts: string[]; owner: string; repo: string }

      Type declaration

      • branch: string
      • contexts: string[]
      • owner: string
      • repo: string

      ReposReplaceProtectedBranchRequiredStatusChecksContextsResponse

      ReposReplaceProtectedBranchRequiredStatusChecksContextsResponse: Array<string>

      ReposReplaceProtectedBranchTeamRestrictionsParams

      ReposReplaceProtectedBranchTeamRestrictionsParams: { branch: string; owner: string; repo: string; teams: string[] }

      Type declaration

      • branch: string
      • owner: string
      • repo: string
      • teams: string[]

      ReposReplaceProtectedBranchTeamRestrictionsResponse

      ReposReplaceProtectedBranchTeamRestrictionsResponse: Array<ReposReplaceProtectedBranchTeamRestrictionsResponseItem>

      ReposReplaceProtectedBranchTeamRestrictionsResponseItem

      ReposReplaceProtectedBranchTeamRestrictionsResponseItem: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: null; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

      Type declaration

      • description: string
      • html_url: string
      • id: number
      • members_url: string
      • name: string
      • node_id: string
      • parent: null
      • permission: string
      • privacy: string
      • repositories_url: string
      • slug: string
      • url: string

      ReposReplaceProtectedBranchUserRestrictionsParams

      ReposReplaceProtectedBranchUserRestrictionsParams: { branch: string; owner: string; repo: string; users: string[] }

      Type declaration

      • branch: string
      • owner: string
      • repo: string
      • users: string[]

      ReposReplaceProtectedBranchUserRestrictionsResponse

      ReposReplaceProtectedBranchUserRestrictionsResponse: Array<ReposReplaceProtectedBranchUserRestrictionsResponseItem>

      ReposReplaceProtectedBranchUserRestrictionsResponseItem

      ReposReplaceProtectedBranchUserRestrictionsResponseItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposReplaceTopicsParams

      ReposReplaceTopicsParams: { names: string[]; owner: string; repo: string }

      Type declaration

      • names: string[]

        An array of topics to add to the repository. Pass one or more topics to replace the set of existing topics. Send an empty array ([]) to clear all topics from the repository. Note: Topic names cannot contain uppercase letters.

      • owner: string
      • repo: string

      ReposReplaceTopicsResponse

      ReposReplaceTopicsResponse: { names: Array<string> }

      Type declaration

      • names: Array<string>

      ReposRequestPageBuildParams

      ReposRequestPageBuildParams: { owner: string; repo: string }

      Type declaration

      • owner: string
      • repo: string

      ReposRequestPageBuildResponse

      ReposRequestPageBuildResponse: { status: string; url: string }

      Type declaration

      • status: string
      • url: string

      ReposRetrieveCommunityProfileMetricsParams

      ReposRetrieveCommunityProfileMetricsParams: { owner: string; repo: string }

      Type declaration

      • owner: string
      • repo: string

      ReposRetrieveCommunityProfileMetricsResponse

      ReposRetrieveCommunityProfileMetricsResponse: { description: string; documentation: boolean; files: ReposRetrieveCommunityProfileMetricsResponseFiles; health_percentage: number; updated_at: string }

      Type declaration

      ReposRetrieveCommunityProfileMetricsResponseFiles

      ReposRetrieveCommunityProfileMetricsResponseFiles: { code_of_conduct: ReposRetrieveCommunityProfileMetricsResponseFilesCodeOfConduct; contributing: ReposRetrieveCommunityProfileMetricsResponseFilesContributing; issue_template: ReposRetrieveCommunityProfileMetricsResponseFilesIssueTemplate; license: ReposRetrieveCommunityProfileMetricsResponseFilesLicense; pull_request_template: ReposRetrieveCommunityProfileMetricsResponseFilesPullRequestTemplate; readme: ReposRetrieveCommunityProfileMetricsResponseFilesReadme }

      Type declaration

      ReposRetrieveCommunityProfileMetricsResponseFilesCodeOfConduct

      ReposRetrieveCommunityProfileMetricsResponseFilesCodeOfConduct: { html_url: string; key: string; name: string; url: string }

      Type declaration

      • html_url: string
      • key: string
      • name: string
      • url: string

      ReposRetrieveCommunityProfileMetricsResponseFilesContributing

      ReposRetrieveCommunityProfileMetricsResponseFilesContributing: { html_url: string; url: string }

      Type declaration

      • html_url: string
      • url: string

      ReposRetrieveCommunityProfileMetricsResponseFilesIssueTemplate

      ReposRetrieveCommunityProfileMetricsResponseFilesIssueTemplate: { html_url: string; url: string }

      Type declaration

      • html_url: string
      • url: string

      ReposRetrieveCommunityProfileMetricsResponseFilesLicense

      ReposRetrieveCommunityProfileMetricsResponseFilesLicense: { html_url: string; key: string; name: string; spdx_id: string; url: string }

      Type declaration

      • html_url: string
      • key: string
      • name: string
      • spdx_id: string
      • url: string

      ReposRetrieveCommunityProfileMetricsResponseFilesPullRequestTemplate

      ReposRetrieveCommunityProfileMetricsResponseFilesPullRequestTemplate: { html_url: string; url: string }

      Type declaration

      • html_url: string
      • url: string

      ReposRetrieveCommunityProfileMetricsResponseFilesReadme

      ReposRetrieveCommunityProfileMetricsResponseFilesReadme: { html_url: string; url: string }

      Type declaration

      • html_url: string
      • url: string

      ReposTestPushHookParams

      ReposTestPushHookParams: { hook_id: number; owner: string; repo: string }

      Type declaration

      • hook_id: number
      • owner: string
      • repo: string

      ReposTransferParams

      ReposTransferParams: { new_owner?: undefined | string; owner: string; repo: string; team_ids?: number[] }

      Type declaration

      • Optional new_owner?: undefined | string

        Required: The username or organization name the repository will be transferred to.

      • owner: string
      • repo: string
      • Optional team_ids?: number[]

        ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.

      ReposTransferResponse

      ReposTransferResponse: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: ReposTransferResponseOwner; permissions: ReposTransferResponsePermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

      Type declaration

      • allow_merge_commit: boolean
      • allow_rebase_merge: boolean
      • allow_squash_merge: boolean
      • archive_url: string
      • archived: boolean
      • assignees_url: string
      • blobs_url: string
      • branches_url: string
      • clone_url: string
      • collaborators_url: string
      • comments_url: string
      • commits_url: string
      • compare_url: string
      • contents_url: string
      • contributors_url: string
      • created_at: string
      • default_branch: string
      • deployments_url: string
      • description: string
      • disabled: boolean
      • downloads_url: string
      • events_url: string
      • fork: boolean
      • forks_count: number
      • forks_url: string
      • full_name: string
      • git_commits_url: string
      • git_refs_url: string
      • git_tags_url: string
      • git_url: string
      • has_downloads: boolean
      • has_issues: boolean
      • has_pages: boolean
      • has_projects: boolean
      • has_wiki: boolean
      • homepage: string
      • hooks_url: string
      • html_url: string
      • id: number
      • is_template: boolean
      • issue_comment_url: string
      • issue_events_url: string
      • issues_url: string
      • keys_url: string
      • labels_url: string
      • language: null
      • languages_url: string
      • merges_url: string
      • milestones_url: string
      • mirror_url: string
      • name: string
      • network_count: number
      • node_id: string
      • notifications_url: string
      • open_issues_count: number
      • owner: ReposTransferResponseOwner
      • permissions: ReposTransferResponsePermissions
      • private: boolean
      • pulls_url: string
      • pushed_at: string
      • releases_url: string
      • size: number
      • ssh_url: string
      • stargazers_count: number
      • stargazers_url: string
      • statuses_url: string
      • subscribers_count: number
      • subscribers_url: string
      • subscription_url: string
      • svn_url: string
      • tags_url: string
      • teams_url: string
      • temp_clone_token: string
      • template_repository: null
      • topics: Array<string>
      • trees_url: string
      • updated_at: string
      • url: string
      • visibility: string
      • watchers_count: number

      ReposTransferResponseOwner

      ReposTransferResponseOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposTransferResponsePermissions

      ReposTransferResponsePermissions: { admin: boolean; pull: boolean; push: boolean }

      Type declaration

      • admin: boolean
      • pull: boolean
      • push: boolean

      ReposUpdateBranchProtectionParams

      ReposUpdateBranchProtectionParams: { allow_deletions?: undefined | false | true; allow_force_pushes?: boolean | null; branch: string; enforce_admins: boolean | null; owner: string; repo: string; required_linear_history?: undefined | false | true; required_pull_request_reviews: ReposUpdateBranchProtectionParamsRequiredPullRequestReviews | null; required_status_checks: ReposUpdateBranchProtectionParamsRequiredStatusChecks | null; restrictions: ReposUpdateBranchProtectionParamsRestrictions | null }

      Type declaration

      • Optional allow_deletions?: undefined | false | true

        Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see "Enabling force pushes to a protected branch" in the GitHub Help documentation.

      • Optional allow_force_pushes?: boolean | null

        Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see "Enabling force pushes to a protected branch" in the GitHub Help documentation."

      • branch: string
      • enforce_admins: boolean | null

        Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

      • owner: string
      • repo: string
      • Optional required_linear_history?: undefined | false | true

        Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see "Requiring a linear commit history" in the GitHub Help documentation.

      • required_pull_request_reviews: ReposUpdateBranchProtectionParamsRequiredPullRequestReviews | null

        Require at least one approving review on a pull request, before merging. Set to null to disable.

      • required_status_checks: ReposUpdateBranchProtectionParamsRequiredStatusChecks | null

        Require status checks to pass before merging. Set to null to disable.

      • restrictions: ReposUpdateBranchProtectionParamsRestrictions | null

        Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

      ReposUpdateBranchProtectionParamsRequiredPullRequestReviews

      ReposUpdateBranchProtectionParamsRequiredPullRequestReviews: { dismiss_stale_reviews?: undefined | false | true; dismissal_restrictions?: ReposUpdateBranchProtectionParamsRequiredPullRequestReviewsDismissalRestrictions; require_code_owner_reviews?: undefined | false | true; required_approving_review_count?: undefined | number }

      Type declaration

      ReposUpdateBranchProtectionParamsRequiredPullRequestReviewsDismissalRestrictions

      ReposUpdateBranchProtectionParamsRequiredPullRequestReviewsDismissalRestrictions: { teams?: string[]; users?: string[] }

      Type declaration

      • Optional teams?: string[]
      • Optional users?: string[]

      ReposUpdateBranchProtectionParamsRequiredStatusChecks

      ReposUpdateBranchProtectionParamsRequiredStatusChecks: { contexts: string[]; strict: boolean }

      Type declaration

      • contexts: string[]
      • strict: boolean

      ReposUpdateBranchProtectionParamsRestrictions

      ReposUpdateBranchProtectionParamsRestrictions: { apps?: string[]; teams: string[]; users: string[] }

      Type declaration

      • Optional apps?: string[]
      • teams: string[]
      • users: string[]

      ReposUpdateBranchProtectionResponse

      ReposUpdateBranchProtectionResponse: { allow_deletions: ReposUpdateBranchProtectionResponseAllowDeletions; allow_force_pushes: ReposUpdateBranchProtectionResponseAllowForcePushes; enforce_admins: ReposUpdateBranchProtectionResponseEnforceAdmins; required_linear_history: ReposUpdateBranchProtectionResponseRequiredLinearHistory; required_pull_request_reviews: ReposUpdateBranchProtectionResponseRequiredPullRequestReviews; required_status_checks: ReposUpdateBranchProtectionResponseRequiredStatusChecks; restrictions: ReposUpdateBranchProtectionResponseRestrictions; url: string }

      Type declaration

      ReposUpdateBranchProtectionResponseAllowDeletions

      ReposUpdateBranchProtectionResponseAllowDeletions: { enabled: boolean }

      Type declaration

      • enabled: boolean

      ReposUpdateBranchProtectionResponseAllowForcePushes

      ReposUpdateBranchProtectionResponseAllowForcePushes: { enabled: boolean }

      Type declaration

      • enabled: boolean

      ReposUpdateBranchProtectionResponseEnforceAdmins

      ReposUpdateBranchProtectionResponseEnforceAdmins: { enabled: boolean; url: string }

      Type declaration

      • enabled: boolean
      • url: string

      ReposUpdateBranchProtectionResponseRequiredLinearHistory

      ReposUpdateBranchProtectionResponseRequiredLinearHistory: { enabled: boolean }

      Type declaration

      • enabled: boolean

      ReposUpdateBranchProtectionResponseRequiredPullRequestReviews

      ReposUpdateBranchProtectionResponseRequiredPullRequestReviews: { dismiss_stale_reviews: boolean; dismissal_restrictions: ReposUpdateBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictions; require_code_owner_reviews: boolean; required_approving_review_count: number; url: string }

      Type declaration

      ReposUpdateBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictions

      ReposUpdateBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictions: { teams: Array<ReposUpdateBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictionsTeamsItem>; teams_url: string; url: string; users: Array<ReposUpdateBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictionsUsersItem>; users_url: string }

      Type declaration

      ReposUpdateBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictionsTeamsItem

      ReposUpdateBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictionsTeamsItem: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: null; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

      Type declaration

      • description: string
      • html_url: string
      • id: number
      • members_url: string
      • name: string
      • node_id: string
      • parent: null
      • permission: string
      • privacy: string
      • repositories_url: string
      • slug: string
      • url: string

      ReposUpdateBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictionsUsersItem

      ReposUpdateBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictionsUsersItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposUpdateBranchProtectionResponseRequiredStatusChecks

      ReposUpdateBranchProtectionResponseRequiredStatusChecks: { contexts: Array<string>; contexts_url: string; strict: boolean; url: string }

      Type declaration

      • contexts: Array<string>
      • contexts_url: string
      • strict: boolean
      • url: string

      ReposUpdateBranchProtectionResponseRestrictions

      ReposUpdateBranchProtectionResponseRestrictions: { apps: Array<ReposUpdateBranchProtectionResponseRestrictionsAppsItem>; apps_url: string; teams: Array<ReposUpdateBranchProtectionResponseRestrictionsTeamsItem>; teams_url: string; url: string; users: Array<ReposUpdateBranchProtectionResponseRestrictionsUsersItem>; users_url: string }

      Type declaration

      ReposUpdateBranchProtectionResponseRestrictionsAppsItem

      ReposUpdateBranchProtectionResponseRestrictionsAppsItem: { created_at: string; description: string; events: Array<string>; external_url: string; html_url: string; id: number; name: string; node_id: string; owner: ReposUpdateBranchProtectionResponseRestrictionsAppsItemOwner; permissions: ReposUpdateBranchProtectionResponseRestrictionsAppsItemPermissions; slug: string; updated_at: string }

      Type declaration

      ReposUpdateBranchProtectionResponseRestrictionsAppsItemOwner

      ReposUpdateBranchProtectionResponseRestrictionsAppsItemOwner: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }

      Type declaration

      • avatar_url: string
      • description: string
      • events_url: string
      • hooks_url: string
      • id: number
      • issues_url: string
      • login: string
      • members_url: string
      • node_id: string
      • public_members_url: string
      • repos_url: string
      • url: string

      ReposUpdateBranchProtectionResponseRestrictionsAppsItemPermissions

      ReposUpdateBranchProtectionResponseRestrictionsAppsItemPermissions: { contents: string; issues: string; metadata: string; single_file: string }

      Type declaration

      • contents: string
      • issues: string
      • metadata: string
      • single_file: string

      ReposUpdateBranchProtectionResponseRestrictionsTeamsItem

      ReposUpdateBranchProtectionResponseRestrictionsTeamsItem: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: null; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

      Type declaration

      • description: string
      • html_url: string
      • id: number
      • members_url: string
      • name: string
      • node_id: string
      • parent: null
      • permission: string
      • privacy: string
      • repositories_url: string
      • slug: string
      • url: string

      ReposUpdateBranchProtectionResponseRestrictionsUsersItem

      ReposUpdateBranchProtectionResponseRestrictionsUsersItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposUpdateCommitCommentParams

      ReposUpdateCommitCommentParams: { body: string; comment_id: number; owner: string; repo: string }

      Type declaration

      • body: string

        The contents of the comment

      • comment_id: number
      • owner: string
      • repo: string

      ReposUpdateCommitCommentResponse

      ReposUpdateCommitCommentResponse: { body: string; commit_id: string; created_at: string; html_url: string; id: number; line: number; node_id: string; path: string; position: number; updated_at: string; url: string; user: ReposUpdateCommitCommentResponseUser }

      Type declaration

      • body: string
      • commit_id: string
      • created_at: string
      • html_url: string
      • id: number
      • line: number
      • node_id: string
      • path: string
      • position: number
      • updated_at: string
      • url: string
      • user: ReposUpdateCommitCommentResponseUser

      ReposUpdateCommitCommentResponseUser

      ReposUpdateCommitCommentResponseUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposUpdateFileParams

      ReposUpdateFileParams: { author?: ReposUpdateFileParamsAuthor; branch?: undefined | string; committer?: ReposUpdateFileParamsCommitter; content: string; message: string; owner: string; path: string; repo: string; sha?: undefined | string }

      Type declaration

      • Optional author?: ReposUpdateFileParamsAuthor

        The author of the file. Default: The committer or the authenticated user if you omit committer.

      • Optional branch?: undefined | string

        The branch name. Default: the repository’s default branch (usually master)

      • Optional committer?: ReposUpdateFileParamsCommitter

        The person that committed the file. Default: the authenticated user.

      • content: string

        The new file content, using Base64 encoding.

      • message: string

        The commit message.

      • owner: string
      • path: string
      • repo: string
      • Optional sha?: undefined | string

        Required if you are updating a file. The blob SHA of the file being replaced.

      ReposUpdateFileParamsAuthor

      ReposUpdateFileParamsAuthor: { email: string; name: string }

      Type declaration

      • email: string
      • name: string

      ReposUpdateFileParamsCommitter

      ReposUpdateFileParamsCommitter: { email: string; name: string }

      Type declaration

      • email: string
      • name: string

      ReposUpdateFileResponse

      ReposUpdateFileResponse: { commit: ReposUpdateFileResponseCommit; content: ReposUpdateFileResponseContent }

      Type declaration

      ReposUpdateFileResponseCommit

      ReposUpdateFileResponseCommit: { author: ReposUpdateFileResponseCommitAuthor; committer: ReposUpdateFileResponseCommitCommitter; html_url: string; message: string; node_id: string; parents: Array<ReposUpdateFileResponseCommitParentsItem>; sha: string; tree: ReposUpdateFileResponseCommitTree; url: string; verification: ReposUpdateFileResponseCommitVerification }

      Type declaration

      ReposUpdateFileResponseCommitAuthor

      ReposUpdateFileResponseCommitAuthor: { date: string; email: string; name: string }

      Type declaration

      • date: string
      • email: string
      • name: string

      ReposUpdateFileResponseCommitCommitter

      ReposUpdateFileResponseCommitCommitter: { date: string; email: string; name: string }

      Type declaration

      • date: string
      • email: string
      • name: string

      ReposUpdateFileResponseCommitParentsItem

      ReposUpdateFileResponseCommitParentsItem: { html_url: string; sha: string; url: string }

      Type declaration

      • html_url: string
      • sha: string
      • url: string

      ReposUpdateFileResponseCommitTree

      ReposUpdateFileResponseCommitTree: { sha: string; url: string }

      Type declaration

      • sha: string
      • url: string

      ReposUpdateFileResponseCommitVerification

      ReposUpdateFileResponseCommitVerification: { payload: null; reason: string; signature: null; verified: boolean }

      Type declaration

      • payload: null
      • reason: string
      • signature: null
      • verified: boolean

      ReposUpdateFileResponseContent

      ReposUpdateFileResponseContent: { _links: ReposUpdateFileResponseContentLinks; download_url: string; git_url: string; html_url: string; name: string; path: string; sha: string; size: number; type: string; url: string }

      Type declaration

      • _links: ReposUpdateFileResponseContentLinks
      • download_url: string
      • git_url: string
      • html_url: string
      • name: string
      • path: string
      • sha: string
      • size: number
      • type: string
      • url: string

      ReposUpdateFileResponseContentLinks

      ReposUpdateFileResponseContentLinks: { git: string; html: string; self: string }

      Type declaration

      • git: string
      • html: string
      • self: string

      ReposUpdateHookParams

      ReposUpdateHookParams: { active?: undefined | false | true; add_events?: string[]; config?: ReposUpdateHookParamsConfig; events?: string[]; hook_id: number; owner: string; remove_events?: string[]; repo: string }

      Type declaration

      • Optional active?: undefined | false | true

        Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

      • Optional add_events?: string[]

        Determines a list of events to be added to the list of events that the Hook triggers for.

      • Optional config?: ReposUpdateHookParamsConfig

        Key/value pairs to provide settings for this webhook. These are defined below.

      • Optional events?: string[]

        Determines what events the hook is triggered for. This replaces the entire array of events.

      • hook_id: number
      • owner: string
      • Optional remove_events?: string[]

        Determines a list of events to be removed from the list of events that the Hook triggers for.

      • repo: string

      ReposUpdateHookParamsConfig

      ReposUpdateHookParamsConfig: { content_type?: undefined | string; insecure_ssl?: undefined | string; secret?: undefined | string; url: string }

      Type declaration

      • Optional content_type?: undefined | string
      • Optional insecure_ssl?: undefined | string
      • Optional secret?: undefined | string
      • url: string

      ReposUpdateHookResponse

      ReposUpdateHookResponse: { active: boolean; config: ReposUpdateHookResponseConfig; created_at: string; events: Array<string>; id: number; last_response: ReposUpdateHookResponseLastResponse; name: string; ping_url: string; test_url: string; type: string; updated_at: string; url: string }

      Type declaration

      ReposUpdateHookResponseConfig

      ReposUpdateHookResponseConfig: { content_type: string; insecure_ssl: string; url: string }

      Type declaration

      • content_type: string
      • insecure_ssl: string
      • url: string

      ReposUpdateHookResponseLastResponse

      ReposUpdateHookResponseLastResponse: { code: null; message: null; status: string }

      Type declaration

      • code: null
      • message: null
      • status: string

      ReposUpdateInformationAboutPagesSiteParams

      ReposUpdateInformationAboutPagesSiteParams: { cname?: undefined | string; owner: string; repo: string; source?: ""gh-pages"" | ""master"" | ""master /docs"" }

      Type declaration

      • Optional cname?: undefined | string

        Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see "Using a custom domain with GitHub Pages."

      • owner: string
      • repo: string
      • Optional source?: ""gh-pages"" | ""master"" | ""master /docs""

        Update the source for the repository. Must include the branch name, and may optionally specify the subdirectory /docs. Possible values are "gh-pages", "master", and "master /docs".

      ReposUpdateInvitationParams

      ReposUpdateInvitationParams: { invitation_id: number; owner: string; permissions?: "read" | "write" | "admin"; repo: string }

      Type declaration

      • invitation_id: number
      • owner: string
      • Optional permissions?: "read" | "write" | "admin"

        The permissions that the associated user will have on the repository. Valid values are read, write, and admin.

      • repo: string

      ReposUpdateInvitationResponse

      ReposUpdateInvitationResponse: { created_at: string; html_url: string; id: number; invitee: ReposUpdateInvitationResponseInvitee; inviter: ReposUpdateInvitationResponseInviter; permissions: string; repository: ReposUpdateInvitationResponseRepository; url: string }

      Type declaration

      ReposUpdateInvitationResponseInvitee

      ReposUpdateInvitationResponseInvitee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposUpdateInvitationResponseInviter

      ReposUpdateInvitationResponseInviter: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposUpdateInvitationResponseRepository

      ReposUpdateInvitationResponseRepository: { archive_url: string; assignees_url: string; blobs_url: string; branches_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; deployments_url: string; description: string; downloads_url: string; events_url: string; fork: boolean; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; html_url: string; id: number; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; languages_url: string; merges_url: string; milestones_url: string; name: string; node_id: string; notifications_url: string; owner: ReposUpdateInvitationResponseRepositoryOwner; private: boolean; pulls_url: string; releases_url: string; ssh_url: string; stargazers_url: string; statuses_url: string; subscribers_url: string; subscription_url: string; tags_url: string; teams_url: string; trees_url: string; url: string }

      Type declaration

      • archive_url: string
      • assignees_url: string
      • blobs_url: string
      • branches_url: string
      • collaborators_url: string
      • comments_url: string
      • commits_url: string
      • compare_url: string
      • contents_url: string
      • contributors_url: string
      • deployments_url: string
      • description: string
      • downloads_url: string
      • events_url: string
      • fork: boolean
      • forks_url: string
      • full_name: string
      • git_commits_url: string
      • git_refs_url: string
      • git_tags_url: string
      • git_url: string
      • html_url: string
      • id: number
      • issue_comment_url: string
      • issue_events_url: string
      • issues_url: string
      • keys_url: string
      • labels_url: string
      • languages_url: string
      • merges_url: string
      • milestones_url: string
      • name: string
      • node_id: string
      • notifications_url: string
      • owner: ReposUpdateInvitationResponseRepositoryOwner
      • private: boolean
      • pulls_url: string
      • releases_url: string
      • ssh_url: string
      • stargazers_url: string
      • statuses_url: string
      • subscribers_url: string
      • subscription_url: string
      • tags_url: string
      • teams_url: string
      • trees_url: string
      • url: string

      ReposUpdateInvitationResponseRepositoryOwner

      ReposUpdateInvitationResponseRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposUpdateParams

      ReposUpdateParams: { allow_merge_commit?: undefined | false | true; allow_rebase_merge?: undefined | false | true; allow_squash_merge?: undefined | false | true; archived?: undefined | false | true; default_branch?: undefined | string; delete_branch_on_merge?: undefined | false | true; description?: undefined | string; has_issues?: undefined | false | true; has_projects?: undefined | false | true; has_wiki?: undefined | false | true; homepage?: undefined | string; is_template?: undefined | false | true; name?: undefined | string; owner: string; private?: undefined | false | true; repo: string; visibility?: "public" | "private" | "visibility" | "internal" }

      Type declaration

      • Optional allow_merge_commit?: undefined | false | true

        Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

      • Optional allow_rebase_merge?: undefined | false | true

        Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

      • Optional allow_squash_merge?: undefined | false | true

        Either true to allow squash-merging pull requests, or false to prevent squash-merging.

      • Optional archived?: undefined | false | true

        true to archive this repository. Note: You cannot unarchive repositories through the API.

      • Optional default_branch?: undefined | string

        Updates the default branch for this repository.

      • Optional delete_branch_on_merge?: undefined | false | true

        Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

      • Optional description?: undefined | string

        A short description of the repository.

      • Optional has_issues?: undefined | false | true

        Either true to enable issues for this repository or false to disable them.

      • Optional has_projects?: undefined | false | true

        Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

      • Optional has_wiki?: undefined | false | true

        Either true to enable the wiki for this repository or false to disable it.

      • Optional homepage?: undefined | string

        A URL with more information about the repository.

      • Optional is_template?: undefined | false | true

        Either true to make this repo available as a template repository or false to prevent it.

      • Optional name?: undefined | string

        The name of the repository.

      • owner: string
      • Optional private?: undefined | false | true

        Either true to make the repository private or false to make it public. Creating private repositories requires a paid GitHub account. Default: false. Note: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private. Note: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.

      • repo: string
      • Optional visibility?: "public" | "private" | "visibility" | "internal"

        Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud, visibility can also be internal. The visibility parameter overrides the private parameter when you use both along with the nebula-preview preview header.

      ReposUpdateProtectedBranchPullRequestReviewEnforcementParams

      ReposUpdateProtectedBranchPullRequestReviewEnforcementParams: { branch: string; dismiss_stale_reviews?: undefined | false | true; dismissal_restrictions?: ReposUpdateProtectedBranchPullRequestReviewEnforcementParamsDismissalRestrictions; owner: string; repo: string; require_code_owner_reviews?: undefined | false | true; required_approving_review_count?: undefined | number }

      Type declaration

      • branch: string
      • Optional dismiss_stale_reviews?: undefined | false | true

        Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

      • Optional dismissal_restrictions?: ReposUpdateProtectedBranchPullRequestReviewEnforcementParamsDismissalRestrictions

        Specify which users and teams can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

      • owner: string
      • repo: string
      • Optional require_code_owner_reviews?: undefined | false | true

        Blocks merging pull requests until code owners have reviewed.

      • Optional required_approving_review_count?: undefined | number

        Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6.

      ReposUpdateProtectedBranchPullRequestReviewEnforcementParamsDismissalRestrictions

      ReposUpdateProtectedBranchPullRequestReviewEnforcementParamsDismissalRestrictions: { teams?: string[]; users?: string[] }

      Type declaration

      • Optional teams?: string[]
      • Optional users?: string[]

      ReposUpdateProtectedBranchPullRequestReviewEnforcementResponse

      ReposUpdateProtectedBranchPullRequestReviewEnforcementResponse: { dismiss_stale_reviews: boolean; dismissal_restrictions: ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictions; require_code_owner_reviews: boolean; required_approving_review_count: number; url: string }

      Type declaration

      ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictions

      ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictions: { teams: Array<ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictionsTeamsItem>; teams_url: string; url: string; users: Array<ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictionsUsersItem>; users_url: string }

      Type declaration

      ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictionsTeamsItem

      ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictionsTeamsItem: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: null; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

      Type declaration

      • description: string
      • html_url: string
      • id: number
      • members_url: string
      • name: string
      • node_id: string
      • parent: null
      • permission: string
      • privacy: string
      • repositories_url: string
      • slug: string
      • url: string

      ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictionsUsersItem

      ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictionsUsersItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposUpdateProtectedBranchRequiredStatusChecksParams

      ReposUpdateProtectedBranchRequiredStatusChecksParams: { branch: string; contexts?: string[]; owner: string; repo: string; strict?: undefined | false | true }

      Type declaration

      • branch: string
      • Optional contexts?: string[]

        The list of status checks to require in order to merge into this branch

      • owner: string
      • repo: string
      • Optional strict?: undefined | false | true

        Require branches to be up to date before merging.

      ReposUpdateProtectedBranchRequiredStatusChecksResponse

      ReposUpdateProtectedBranchRequiredStatusChecksResponse: { contexts: Array<string>; contexts_url: string; strict: boolean; url: string }

      Type declaration

      • contexts: Array<string>
      • contexts_url: string
      • strict: boolean
      • url: string

      ReposUpdateReleaseAssetParams

      ReposUpdateReleaseAssetParams: { asset_id: number; label?: undefined | string; name?: undefined | string; owner: string; repo: string }

      Type declaration

      • asset_id: number
      • Optional label?: undefined | string

        An alternate short description of the asset. Used in place of the filename.

      • Optional name?: undefined | string

        The file name of the asset.

      • owner: string
      • repo: string

      ReposUpdateReleaseAssetResponse

      ReposUpdateReleaseAssetResponse: { browser_download_url: string; content_type: string; created_at: string; download_count: number; id: number; label: string; name: string; node_id: string; size: number; state: string; updated_at: string; uploader: ReposUpdateReleaseAssetResponseUploader; url: string }

      Type declaration

      • browser_download_url: string
      • content_type: string
      • created_at: string
      • download_count: number
      • id: number
      • label: string
      • name: string
      • node_id: string
      • size: number
      • state: string
      • updated_at: string
      • uploader: ReposUpdateReleaseAssetResponseUploader
      • url: string

      ReposUpdateReleaseAssetResponseUploader

      ReposUpdateReleaseAssetResponseUploader: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposUpdateReleaseParams

      ReposUpdateReleaseParams: { body?: undefined | string; draft?: undefined | false | true; name?: undefined | string; owner: string; prerelease?: undefined | false | true; release_id: number; repo: string; tag_name?: undefined | string; target_commitish?: undefined | string }

      Type declaration

      • Optional body?: undefined | string

        Text describing the contents of the tag.

      • Optional draft?: undefined | false | true

        true makes the release a draft, and false publishes the release.

      • Optional name?: undefined | string

        The name of the release.

      • owner: string
      • Optional prerelease?: undefined | false | true

        true to identify the release as a prerelease, false to identify the release as a full release.

      • release_id: number
      • repo: string
      • Optional tag_name?: undefined | string

        The name of the tag.

      • Optional target_commitish?: undefined | string

        Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

      ReposUpdateReleaseResponse

      ReposUpdateReleaseResponse: { assets: Array<ReposUpdateReleaseResponseAssetsItem>; assets_url: string; author: ReposUpdateReleaseResponseAuthor; body: string; created_at: string; draft: boolean; html_url: string; id: number; name: string; node_id: string; prerelease: boolean; published_at: string; tag_name: string; tarball_url: string; target_commitish: string; upload_url: string; url: string; zipball_url: string }

      Type declaration

      • assets: Array<ReposUpdateReleaseResponseAssetsItem>
      • assets_url: string
      • author: ReposUpdateReleaseResponseAuthor
      • body: string
      • created_at: string
      • draft: boolean
      • html_url: string
      • id: number
      • name: string
      • node_id: string
      • prerelease: boolean
      • published_at: string
      • tag_name: string
      • tarball_url: string
      • target_commitish: string
      • upload_url: string
      • url: string
      • zipball_url: string

      ReposUpdateReleaseResponseAssetsItem

      ReposUpdateReleaseResponseAssetsItem: { browser_download_url: string; content_type: string; created_at: string; download_count: number; id: number; label: string; name: string; node_id: string; size: number; state: string; updated_at: string; uploader: ReposUpdateReleaseResponseAssetsItemUploader; url: string }

      Type declaration

      • browser_download_url: string
      • content_type: string
      • created_at: string
      • download_count: number
      • id: number
      • label: string
      • name: string
      • node_id: string
      • size: number
      • state: string
      • updated_at: string
      • uploader: ReposUpdateReleaseResponseAssetsItemUploader
      • url: string

      ReposUpdateReleaseResponseAssetsItemUploader

      ReposUpdateReleaseResponseAssetsItemUploader: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposUpdateReleaseResponseAuthor

      ReposUpdateReleaseResponseAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposUpdateResponse

      ReposUpdateResponse: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; organization: ReposUpdateResponseOrganization; owner: ReposUpdateResponseOwner; parent: ReposUpdateResponseParent; permissions: ReposUpdateResponsePermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; source: ReposUpdateResponseSource; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

      Type declaration

      • allow_merge_commit: boolean
      • allow_rebase_merge: boolean
      • allow_squash_merge: boolean
      • archive_url: string
      • archived: boolean
      • assignees_url: string
      • blobs_url: string
      • branches_url: string
      • clone_url: string
      • collaborators_url: string
      • comments_url: string
      • commits_url: string
      • compare_url: string
      • contents_url: string
      • contributors_url: string
      • created_at: string
      • default_branch: string
      • deployments_url: string
      • description: string
      • disabled: boolean
      • downloads_url: string
      • events_url: string
      • fork: boolean
      • forks_count: number
      • forks_url: string
      • full_name: string
      • git_commits_url: string
      • git_refs_url: string
      • git_tags_url: string
      • git_url: string
      • has_downloads: boolean
      • has_issues: boolean
      • has_pages: boolean
      • has_projects: boolean
      • has_wiki: boolean
      • homepage: string
      • hooks_url: string
      • html_url: string
      • id: number
      • is_template: boolean
      • issue_comment_url: string
      • issue_events_url: string
      • issues_url: string
      • keys_url: string
      • labels_url: string
      • language: null
      • languages_url: string
      • merges_url: string
      • milestones_url: string
      • mirror_url: string
      • name: string
      • network_count: number
      • node_id: string
      • notifications_url: string
      • open_issues_count: number
      • organization: ReposUpdateResponseOrganization
      • owner: ReposUpdateResponseOwner
      • parent: ReposUpdateResponseParent
      • permissions: ReposUpdateResponsePermissions
      • private: boolean
      • pulls_url: string
      • pushed_at: string
      • releases_url: string
      • size: number
      • source: ReposUpdateResponseSource
      • ssh_url: string
      • stargazers_count: number
      • stargazers_url: string
      • statuses_url: string
      • subscribers_count: number
      • subscribers_url: string
      • subscription_url: string
      • svn_url: string
      • tags_url: string
      • teams_url: string
      • temp_clone_token: string
      • template_repository: null
      • topics: Array<string>
      • trees_url: string
      • updated_at: string
      • url: string
      • visibility: string
      • watchers_count: number

      ReposUpdateResponseOrganization

      ReposUpdateResponseOrganization: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposUpdateResponseOwner

      ReposUpdateResponseOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposUpdateResponseParent

      ReposUpdateResponseParent: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: ReposUpdateResponseParentOwner; permissions: ReposUpdateResponseParentPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

      Type declaration

      • allow_merge_commit: boolean
      • allow_rebase_merge: boolean
      • allow_squash_merge: boolean
      • archive_url: string
      • archived: boolean
      • assignees_url: string
      • blobs_url: string
      • branches_url: string
      • clone_url: string
      • collaborators_url: string
      • comments_url: string
      • commits_url: string
      • compare_url: string
      • contents_url: string
      • contributors_url: string
      • created_at: string
      • default_branch: string
      • deployments_url: string
      • description: string
      • disabled: boolean
      • downloads_url: string
      • events_url: string
      • fork: boolean
      • forks_count: number
      • forks_url: string
      • full_name: string
      • git_commits_url: string
      • git_refs_url: string
      • git_tags_url: string
      • git_url: string
      • has_downloads: boolean
      • has_issues: boolean
      • has_pages: boolean
      • has_projects: boolean
      • has_wiki: boolean
      • homepage: string
      • hooks_url: string
      • html_url: string
      • id: number
      • is_template: boolean
      • issue_comment_url: string
      • issue_events_url: string
      • issues_url: string
      • keys_url: string
      • labels_url: string
      • language: null
      • languages_url: string
      • merges_url: string
      • milestones_url: string
      • mirror_url: string
      • name: string
      • network_count: number
      • node_id: string
      • notifications_url: string
      • open_issues_count: number
      • owner: ReposUpdateResponseParentOwner
      • permissions: ReposUpdateResponseParentPermissions
      • private: boolean
      • pulls_url: string
      • pushed_at: string
      • releases_url: string
      • size: number
      • ssh_url: string
      • stargazers_count: number
      • stargazers_url: string
      • statuses_url: string
      • subscribers_count: number
      • subscribers_url: string
      • subscription_url: string
      • svn_url: string
      • tags_url: string
      • teams_url: string
      • temp_clone_token: string
      • template_repository: null
      • topics: Array<string>
      • trees_url: string
      • updated_at: string
      • url: string
      • visibility: string
      • watchers_count: number

      ReposUpdateResponseParentOwner

      ReposUpdateResponseParentOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposUpdateResponseParentPermissions

      ReposUpdateResponseParentPermissions: { admin: boolean; pull: boolean; push: boolean }

      Type declaration

      • admin: boolean
      • pull: boolean
      • push: boolean

      ReposUpdateResponsePermissions

      ReposUpdateResponsePermissions: { admin: boolean; pull: boolean; push: boolean }

      Type declaration

      • admin: boolean
      • pull: boolean
      • push: boolean

      ReposUpdateResponseSource

      ReposUpdateResponseSource: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: ReposUpdateResponseSourceOwner; permissions: ReposUpdateResponseSourcePermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

      Type declaration

      • allow_merge_commit: boolean
      • allow_rebase_merge: boolean
      • allow_squash_merge: boolean
      • archive_url: string
      • archived: boolean
      • assignees_url: string
      • blobs_url: string
      • branches_url: string
      • clone_url: string
      • collaborators_url: string
      • comments_url: string
      • commits_url: string
      • compare_url: string
      • contents_url: string
      • contributors_url: string
      • created_at: string
      • default_branch: string
      • deployments_url: string
      • description: string
      • disabled: boolean
      • downloads_url: string
      • events_url: string
      • fork: boolean
      • forks_count: number
      • forks_url: string
      • full_name: string
      • git_commits_url: string
      • git_refs_url: string
      • git_tags_url: string
      • git_url: string
      • has_downloads: boolean
      • has_issues: boolean
      • has_pages: boolean
      • has_projects: boolean
      • has_wiki: boolean
      • homepage: string
      • hooks_url: string
      • html_url: string
      • id: number
      • is_template: boolean
      • issue_comment_url: string
      • issue_events_url: string
      • issues_url: string
      • keys_url: string
      • labels_url: string
      • language: null
      • languages_url: string
      • merges_url: string
      • milestones_url: string
      • mirror_url: string
      • name: string
      • network_count: number
      • node_id: string
      • notifications_url: string
      • open_issues_count: number
      • owner: ReposUpdateResponseSourceOwner
      • permissions: ReposUpdateResponseSourcePermissions
      • private: boolean
      • pulls_url: string
      • pushed_at: string
      • releases_url: string
      • size: number
      • ssh_url: string
      • stargazers_count: number
      • stargazers_url: string
      • statuses_url: string
      • subscribers_count: number
      • subscribers_url: string
      • subscription_url: string
      • svn_url: string
      • tags_url: string
      • teams_url: string
      • temp_clone_token: string
      • template_repository: null
      • topics: Array<string>
      • trees_url: string
      • updated_at: string
      • url: string
      • visibility: string
      • watchers_count: number

      ReposUpdateResponseSourceOwner

      ReposUpdateResponseSourceOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      ReposUpdateResponseSourcePermissions

      ReposUpdateResponseSourcePermissions: { admin: boolean; pull: boolean; push: boolean }

      Type declaration

      • admin: boolean
      • pull: boolean
      • push: boolean

      ReposUploadReleaseAssetParams

      ReposUploadReleaseAssetParams: { data: string | object; headers: ReposUploadReleaseAssetParamsHeaders; label?: undefined | string; name: string; url: string }

      Type declaration

      • data: string | object
      • headers: ReposUploadReleaseAssetParamsHeaders
      • Optional label?: undefined | string

        An alternate short description of the asset. Used in place of the filename. This should be set in a URI query parameter.

      • name: string

        The file name of the asset. This should be set in a URI query parameter.

      • url: string

        The upload_url key returned from creating or getting a release

      ReposUploadReleaseAssetParamsDeprecatedFile

      ReposUploadReleaseAssetParamsDeprecatedFile: { file: string | object; headers: ReposUploadReleaseAssetParamsHeaders; label?: undefined | string; name: string; url: string }

      Type declaration

      • file: string | object
        deprecated

        "file" parameter renamed to "data"

      • headers: ReposUploadReleaseAssetParamsHeaders
      • Optional label?: undefined | string

        An alternate short description of the asset. Used in place of the filename. This should be set in a URI query parameter.

      • name: string

        The file name of the asset. This should be set in a URI query parameter.

      • url: string

        The upload_url key returned from creating or getting a release

      ReposUploadReleaseAssetParamsHeaders

      ReposUploadReleaseAssetParamsHeaders: { content-length: number; content-type: string }

      Type declaration

      • content-length: number
      • content-type: string

      ReposUploadReleaseAssetResponse

      ReposUploadReleaseAssetResponse: { value: ReposUploadReleaseAssetResponseValue }

      Type declaration

      ReposUploadReleaseAssetResponseValue

      ReposUploadReleaseAssetResponseValue: { browser_download_url: string; content_type: string; created_at: string; download_count: number; id: number; label: string; name: string; node_id: string; size: number; state: string; updated_at: string; uploader: ReposUploadReleaseAssetResponseValueUploader; url: string }

      Type declaration

      • browser_download_url: string
      • content_type: string
      • created_at: string
      • download_count: number
      • id: number
      • label: string
      • name: string
      • node_id: string
      • size: number
      • state: string
      • updated_at: string
      • uploader: ReposUploadReleaseAssetResponseValueUploader
      • url: string

      ReposUploadReleaseAssetResponseValueUploader

      ReposUploadReleaseAssetResponseValueUploader: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      RequestHeaders

      RequestHeaders: { accept?: undefined | string; authorization?: undefined | string; user-agent?: undefined | string }

      Type declaration

      • [header: string]: string | number | undefined
      • Optional accept?: undefined | string

        Avoid setting accept, use mediaFormat.{format|previews} instead.

      • Optional authorization?: undefined | string

        Use authorization to send authenticated request, remember token / bearer prefixes. Example: token 1234567890abcdef1234567890abcdef12345678

      • Optional user-agent?: undefined | string

        user-agent is set do a default and can be overwritten as needed.

      RequestMethod

      RequestMethod: "DELETE" | "GET" | "HEAD" | "PATCH" | "POST" | "PUT"

      SearchCodeParams

      SearchCodeParams: { order?: "desc" | "asc"; page?: undefined | number; per_page?: undefined | number; q: string; sort?: undefined | "indexed" }

      Type declaration

      • Optional order?: "desc" | "asc"

        Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.

      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • q: string

        The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see Constructing a search query. See "Searching code" for a detailed list of qualifiers.

      • Optional sort?: undefined | "indexed"

        Sorts the results of your query. Can only be indexed, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: best match

      SearchCodeResponse

      SearchCodeResponse: { incomplete_results: boolean; items: Array<SearchCodeResponseItemsItem>; total_count: number }

      Type declaration

      SearchCodeResponseItemsItem

      SearchCodeResponseItemsItem: { git_url: string; html_url: string; name: string; path: string; repository: SearchCodeResponseItemsItemRepository; score: number; sha: string; url: string }

      Type declaration

      SearchCodeResponseItemsItemRepository

      SearchCodeResponseItemsItemRepository: { archive_url: string; assignees_url: string; blobs_url: string; branches_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; description: string; downloads_url: string; events_url: string; fork: boolean; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; hooks_url: string; html_url: string; id: number; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; languages_url: string; merges_url: string; milestones_url: string; name: string; node_id: string; notifications_url: string; owner: SearchCodeResponseItemsItemRepositoryOwner; private: boolean; pulls_url: string; stargazers_url: string; statuses_url: string; subscribers_url: string; subscription_url: string; tags_url: string; teams_url: string; trees_url: string; url: string }

      Type declaration

      • archive_url: string
      • assignees_url: string
      • blobs_url: string
      • branches_url: string
      • collaborators_url: string
      • comments_url: string
      • commits_url: string
      • compare_url: string
      • contents_url: string
      • contributors_url: string
      • description: string
      • downloads_url: string
      • events_url: string
      • fork: boolean
      • forks_url: string
      • full_name: string
      • git_commits_url: string
      • git_refs_url: string
      • git_tags_url: string
      • hooks_url: string
      • html_url: string
      • id: number
      • issue_comment_url: string
      • issue_events_url: string
      • issues_url: string
      • keys_url: string
      • labels_url: string
      • languages_url: string
      • merges_url: string
      • milestones_url: string
      • name: string
      • node_id: string
      • notifications_url: string
      • owner: SearchCodeResponseItemsItemRepositoryOwner
      • private: boolean
      • pulls_url: string
      • stargazers_url: string
      • statuses_url: string
      • subscribers_url: string
      • subscription_url: string
      • tags_url: string
      • teams_url: string
      • trees_url: string
      • url: string

      SearchCodeResponseItemsItemRepositoryOwner

      SearchCodeResponseItemsItemRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      SearchCommitsParams

      SearchCommitsParams: { order?: "desc" | "asc"; page?: undefined | number; per_page?: undefined | number; q: string; sort?: "author-date" | "committer-date" }

      Type declaration

      • Optional order?: "desc" | "asc"

        Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.

      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • q: string

        The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see Constructing a search query. See "Searching commits" for a detailed list of qualifiers.

      • Optional sort?: "author-date" | "committer-date"

        Sorts the results of your query by author-date or committer-date. Default: best match

      SearchCommitsResponse

      SearchCommitsResponse: { incomplete_results: boolean; items: Array<SearchCommitsResponseItemsItem>; total_count: number }

      Type declaration

      SearchCommitsResponseItemsItem

      SearchCommitsResponseItemsItem: { author: SearchCommitsResponseItemsItemAuthor; comments_url: string; commit: SearchCommitsResponseItemsItemCommit; committer: SearchCommitsResponseItemsItemCommitter; html_url: string; parents: Array<SearchCommitsResponseItemsItemParentsItem>; repository: SearchCommitsResponseItemsItemRepository; score: number; sha: string; url: string }

      Type declaration

      SearchCommitsResponseItemsItemAuthor

      SearchCommitsResponseItemsItemAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      SearchCommitsResponseItemsItemCommit

      SearchCommitsResponseItemsItemCommit: { author: SearchCommitsResponseItemsItemCommitAuthor; comment_count: number; committer: SearchCommitsResponseItemsItemCommitCommitter; message: string; tree: SearchCommitsResponseItemsItemCommitTree; url: string }

      Type declaration

      SearchCommitsResponseItemsItemCommitAuthor

      SearchCommitsResponseItemsItemCommitAuthor: { date: string; email: string; name: string }

      Type declaration

      • date: string
      • email: string
      • name: string

      SearchCommitsResponseItemsItemCommitCommitter

      SearchCommitsResponseItemsItemCommitCommitter: { date: string; email: string; name: string }

      Type declaration

      • date: string
      • email: string
      • name: string

      SearchCommitsResponseItemsItemCommitTree

      SearchCommitsResponseItemsItemCommitTree: { sha: string; url: string }

      Type declaration

      • sha: string
      • url: string

      SearchCommitsResponseItemsItemCommitter

      SearchCommitsResponseItemsItemCommitter: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      SearchCommitsResponseItemsItemParentsItem

      SearchCommitsResponseItemsItemParentsItem: { html_url: string; sha: string; url: string }

      Type declaration

      • html_url: string
      • sha: string
      • url: string

      SearchCommitsResponseItemsItemRepository

      SearchCommitsResponseItemsItemRepository: { archive_url: string; assignees_url: string; blobs_url: string; branches_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; deployments_url: string; description: string; downloads_url: string; events_url: string; fork: boolean; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; hooks_url: string; html_url: string; id: number; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; languages_url: string; merges_url: string; milestones_url: string; name: string; node_id: string; notifications_url: string; owner: SearchCommitsResponseItemsItemRepositoryOwner; private: boolean; pulls_url: string; releases_url: string; stargazers_url: string; statuses_url: string; subscribers_url: string; subscription_url: string; tags_url: string; teams_url: string; trees_url: string; url: string }

      Type declaration

      • archive_url: string
      • assignees_url: string
      • blobs_url: string
      • branches_url: string
      • collaborators_url: string
      • comments_url: string
      • commits_url: string
      • compare_url: string
      • contents_url: string
      • contributors_url: string
      • deployments_url: string
      • description: string
      • downloads_url: string
      • events_url: string
      • fork: boolean
      • forks_url: string
      • full_name: string
      • git_commits_url: string
      • git_refs_url: string
      • git_tags_url: string
      • hooks_url: string
      • html_url: string
      • id: number
      • issue_comment_url: string
      • issue_events_url: string
      • issues_url: string
      • keys_url: string
      • labels_url: string
      • languages_url: string
      • merges_url: string
      • milestones_url: string
      • name: string
      • node_id: string
      • notifications_url: string
      • owner: SearchCommitsResponseItemsItemRepositoryOwner
      • private: boolean
      • pulls_url: string
      • releases_url: string
      • stargazers_url: string
      • statuses_url: string
      • subscribers_url: string
      • subscription_url: string
      • tags_url: string
      • teams_url: string
      • trees_url: string
      • url: string

      SearchCommitsResponseItemsItemRepositoryOwner

      SearchCommitsResponseItemsItemRepositoryOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      SearchEmailLegacyParams

      SearchEmailLegacyParams: { email: string }

      Type declaration

      • email: string

        The email address.

      SearchEmailLegacyResponse

      SearchEmailLegacyResponse: { user: SearchEmailLegacyResponseUser }

      Type declaration

      SearchEmailLegacyResponseUser

      SearchEmailLegacyResponseUser: { blog: string; company: string; created: string; created_at: string; email: string; followers_count: number; following_count: number; gravatar_id: string; id: number; location: string; login: string; name: string; public_gist_count: number; public_repo_count: number; type: string }

      Type declaration

      • blog: string
      • company: string
      • created: string
      • created_at: string
      • email: string
      • followers_count: number
      • following_count: number
      • gravatar_id: string
      • id: number
      • location: string
      • login: string
      • name: string
      • public_gist_count: number
      • public_repo_count: number
      • type: string

      SearchIssuesAndPullRequestsParams

      SearchIssuesAndPullRequestsParams: { order?: "desc" | "asc"; page?: undefined | number; per_page?: undefined | number; q: string; sort?: "comments" | "reactions" | "reactions-+1" | "reactions--1" | "reactions-smile" | "reactions-thinking_face" | "reactions-heart" | "reactions-tada" | "interactions" | "created" | "updated" }

      Type declaration

      • Optional order?: "desc" | "asc"

        Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.

      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • q: string

        The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see Constructing a search query. See "Searching issues and pull requests" for a detailed list of qualifiers.

      • Optional sort?: "comments" | "reactions" | "reactions-+1" | "reactions--1" | "reactions-smile" | "reactions-thinking_face" | "reactions-heart" | "reactions-tada" | "interactions" | "created" | "updated"

        Sorts the results of your query by the number of comments, reactions, reactions-+1, reactions--1, reactions-smile, reactions-thinking_face, reactions-heart, reactions-tada, or interactions. You can also sort results by how recently the items were created or updated, Default: best match

      SearchIssuesAndPullRequestsResponse

      SearchIssuesAndPullRequestsResponse: { incomplete_results: boolean; items: Array<SearchIssuesAndPullRequestsResponseItemsItem>; total_count: number }

      Type declaration

      SearchIssuesAndPullRequestsResponseItemsItem

      SearchIssuesAndPullRequestsResponseItemsItem: { assignee: null; body: string; closed_at: null; comments: number; comments_url: string; created_at: string; events_url: string; html_url: string; id: number; labels: Array<SearchIssuesAndPullRequestsResponseItemsItemLabelsItem>; labels_url: string; milestone: null; node_id: string; number: number; pull_request: SearchIssuesAndPullRequestsResponseItemsItemPullRequest; repository_url: string; score: number; state: string; title: string; updated_at: string; url: string; user: SearchIssuesAndPullRequestsResponseItemsItemUser }

      Type declaration

      SearchIssuesAndPullRequestsResponseItemsItemLabelsItem

      SearchIssuesAndPullRequestsResponseItemsItemLabelsItem: { color: string; id: number; name: string; node_id: string; url: string }

      Type declaration

      • color: string
      • id: number
      • name: string
      • node_id: string
      • url: string

      SearchIssuesAndPullRequestsResponseItemsItemPullRequest

      SearchIssuesAndPullRequestsResponseItemsItemPullRequest: { diff_url: null; html_url: null; patch_url: null }

      Type declaration

      • diff_url: null
      • html_url: null
      • patch_url: null

      SearchIssuesAndPullRequestsResponseItemsItemUser

      SearchIssuesAndPullRequestsResponseItemsItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      SearchIssuesLegacyParams

      SearchIssuesLegacyParams: { keyword: string; owner: string; repository: string; state: "open" | "closed" }

      Type declaration

      • keyword: string

        The search term.

      • owner: string
      • repository: string
      • state: "open" | "closed"

        Indicates the state of the issues to return. Can be either open or closed.

      SearchIssuesLegacyResponse

      SearchIssuesLegacyResponse: { issues: Array<SearchIssuesLegacyResponseIssuesItem> }

      Type declaration

      SearchIssuesLegacyResponseIssuesItem

      SearchIssuesLegacyResponseIssuesItem: { body: string; comments: number; created_at: string; gravatar_id: string; html_url: string; labels: Array<string>; number: number; position: number; state: string; title: string; updated_at: string; user: string; votes: number }

      Type declaration

      • body: string
      • comments: number
      • created_at: string
      • gravatar_id: string
      • html_url: string
      • labels: Array<string>
      • number: number
      • position: number
      • state: string
      • title: string
      • updated_at: string
      • user: string
      • votes: number

      SearchIssuesParams

      SearchIssuesParams: { order?: "desc" | "asc"; page?: undefined | number; per_page?: undefined | number; q: string; sort?: "comments" | "reactions" | "reactions-+1" | "reactions--1" | "reactions-smile" | "reactions-thinking_face" | "reactions-heart" | "reactions-tada" | "interactions" | "created" | "updated" }

      Type declaration

      • Optional order?: "desc" | "asc"

        Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.

      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • q: string

        The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see Constructing a search query. See "Searching issues and pull requests" for a detailed list of qualifiers.

      • Optional sort?: "comments" | "reactions" | "reactions-+1" | "reactions--1" | "reactions-smile" | "reactions-thinking_face" | "reactions-heart" | "reactions-tada" | "interactions" | "created" | "updated"

        Sorts the results of your query by the number of comments, reactions, reactions-+1, reactions--1, reactions-smile, reactions-thinking_face, reactions-heart, reactions-tada, or interactions. You can also sort results by how recently the items were created or updated, Default: best match

      SearchIssuesResponse

      SearchIssuesResponse: { incomplete_results: boolean; items: Array<SearchIssuesResponseItemsItem>; total_count: number }

      Type declaration

      SearchIssuesResponseItemsItem

      SearchIssuesResponseItemsItem: { assignee: null; body: string; closed_at: null; comments: number; comments_url: string; created_at: string; events_url: string; html_url: string; id: number; labels: Array<SearchIssuesResponseItemsItemLabelsItem>; labels_url: string; milestone: null; node_id: string; number: number; pull_request: SearchIssuesResponseItemsItemPullRequest; repository_url: string; score: number; state: string; title: string; updated_at: string; url: string; user: SearchIssuesResponseItemsItemUser }

      Type declaration

      SearchIssuesResponseItemsItemLabelsItem

      SearchIssuesResponseItemsItemLabelsItem: { color: string; id: number; name: string; node_id: string; url: string }

      Type declaration

      • color: string
      • id: number
      • name: string
      • node_id: string
      • url: string

      SearchIssuesResponseItemsItemPullRequest

      SearchIssuesResponseItemsItemPullRequest: { diff_url: null; html_url: null; patch_url: null }

      Type declaration

      • diff_url: null
      • html_url: null
      • patch_url: null

      SearchIssuesResponseItemsItemUser

      SearchIssuesResponseItemsItemUser: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      SearchLabelsParams

      SearchLabelsParams: { order?: "desc" | "asc"; q: string; repository_id: number; sort?: "created" | "updated" }

      Type declaration

      • Optional order?: "desc" | "asc"

        Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.

      • q: string

        The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see Constructing a search query.

      • repository_id: number

        The id of the repository.

      • Optional sort?: "created" | "updated"

        Sorts the results of your query by when the label was created or updated. Default: best match

      SearchLabelsResponse

      SearchLabelsResponse: { incomplete_results: boolean; items: Array<SearchLabelsResponseItemsItem>; total_count: number }

      Type declaration

      SearchLabelsResponseItemsItem

      SearchLabelsResponseItemsItem: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; score: number; url: string }

      Type declaration

      • color: string
      • default: boolean
      • description: string
      • id: number
      • name: string
      • node_id: string
      • score: number
      • url: string

      SearchReposLegacyParams

      SearchReposLegacyParams: { keyword: string; language?: undefined | string; order?: "asc" | "desc"; sort?: "stars" | "forks" | "updated"; start_page?: undefined | string }

      Type declaration

      • keyword: string

        The search term.

      • Optional language?: undefined | string

        Filter results by language.

      • Optional order?: "asc" | "desc"

        The sort field. if sort param is provided. Can be either asc or desc.

      • Optional sort?: "stars" | "forks" | "updated"

        The sort field. One of stars, forks, or updated. Default: results are sorted by best match.

      • Optional start_page?: undefined | string

        The page number to fetch.

      SearchReposLegacyResponse

      SearchReposLegacyResponse: { repositories: Array<SearchReposLegacyResponseRepositoriesItem> }

      Type declaration

      SearchReposLegacyResponseRepositoriesItem

      SearchReposLegacyResponseRepositoriesItem: { created: string; created_at: string; description: string; followers: number; fork: boolean; forks: number; has_downloads: boolean; has_issues: boolean; has_wiki: boolean; homepage: string; language: string; name: string; open_issues: number; owner: string; private: boolean; pushed: string; pushed_at: string; score: number; size: number; type: string; url: string; username: string; watchers: number }

      Type declaration

      • created: string
      • created_at: string
      • description: string
      • followers: number
      • fork: boolean
      • forks: number
      • has_downloads: boolean
      • has_issues: boolean
      • has_wiki: boolean
      • homepage: string
      • language: string
      • name: string
      • open_issues: number
      • owner: string
      • private: boolean
      • pushed: string
      • pushed_at: string
      • score: number
      • size: number
      • type: string
      • url: string
      • username: string
      • watchers: number

      SearchReposParams

      SearchReposParams: { order?: "desc" | "asc"; page?: undefined | number; per_page?: undefined | number; q: string; sort?: "stars" | "forks" | "help-wanted-issues" | "updated" }

      Type declaration

      • Optional order?: "desc" | "asc"

        Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.

      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • q: string

        The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see Constructing a search query. See "Searching for repositories" for a detailed list of qualifiers.

      • Optional sort?: "stars" | "forks" | "help-wanted-issues" | "updated"

        Sorts the results of your query by number of stars, forks, or help-wanted-issues or how recently the items were updated. Default: best match

      SearchReposResponse

      SearchReposResponse: { incomplete_results: boolean; items: Array<SearchReposResponseItemsItem>; total_count: number }

      Type declaration

      SearchReposResponseItemsItem

      SearchReposResponseItemsItem: { created_at: string; default_branch: string; description: string; fork: boolean; forks_count: number; full_name: string; homepage: string; html_url: string; id: number; language: string; master_branch: string; name: string; node_id: string; open_issues_count: number; owner: SearchReposResponseItemsItemOwner; private: boolean; pushed_at: string; score: number; size: number; stargazers_count: number; updated_at: string; url: string; watchers_count: number }

      Type declaration

      • created_at: string
      • default_branch: string
      • description: string
      • fork: boolean
      • forks_count: number
      • full_name: string
      • homepage: string
      • html_url: string
      • id: number
      • language: string
      • master_branch: string
      • name: string
      • node_id: string
      • open_issues_count: number
      • owner: SearchReposResponseItemsItemOwner
      • private: boolean
      • pushed_at: string
      • score: number
      • size: number
      • stargazers_count: number
      • updated_at: string
      • url: string
      • watchers_count: number

      SearchReposResponseItemsItemOwner

      SearchReposResponseItemsItemOwner: { avatar_url: string; gravatar_id: string; id: number; login: string; node_id: string; received_events_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • gravatar_id: string
      • id: number
      • login: string
      • node_id: string
      • received_events_url: string
      • type: string
      • url: string

      SearchTopicsParams

      SearchTopicsParams: { q: string }

      Type declaration

      • q: string

        The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see Constructing a search query.

      SearchTopicsResponse

      SearchTopicsResponse: { incomplete_results: boolean; items: Array<SearchTopicsResponseItemsItem>; total_count: number }

      Type declaration

      SearchTopicsResponseItemsItem

      SearchTopicsResponseItemsItem: { created_at: string; created_by: string; curated: boolean; description: string; display_name: string; featured: boolean; name: string; released: string; score: number; short_description: string; updated_at: string }

      Type declaration

      • created_at: string
      • created_by: string
      • curated: boolean
      • description: string
      • display_name: string
      • featured: boolean
      • name: string
      • released: string
      • score: number
      • short_description: string
      • updated_at: string

      SearchUsersLegacyParams

      SearchUsersLegacyParams: { keyword: string; order?: "asc" | "desc"; sort?: "stars" | "forks" | "updated"; start_page?: undefined | string }

      Type declaration

      • keyword: string

        The search term.

      • Optional order?: "asc" | "desc"

        The sort field. if sort param is provided. Can be either asc or desc.

      • Optional sort?: "stars" | "forks" | "updated"

        The sort field. One of stars, forks, or updated. Default: results are sorted by best match.

      • Optional start_page?: undefined | string

        The page number to fetch.

      SearchUsersLegacyResponse

      SearchUsersLegacyResponse: { users: Array<SearchUsersLegacyResponseUsersItem> }

      Type declaration

      SearchUsersLegacyResponseUsersItem

      SearchUsersLegacyResponseUsersItem: { created: string; created_at: string; followers: number; followers_count: number; fullname: string; gravatar_id: string; id: string; language: string; location: string; login: string; name: string; public_repo_count: number; repos: number; score: number; type: string; username: string }

      Type declaration

      • created: string
      • created_at: string
      • followers: number
      • followers_count: number
      • fullname: string
      • gravatar_id: string
      • id: string
      • language: string
      • location: string
      • login: string
      • name: string
      • public_repo_count: number
      • repos: number
      • score: number
      • type: string
      • username: string

      SearchUsersParams

      SearchUsersParams: { order?: "desc" | "asc"; page?: undefined | number; per_page?: undefined | number; q: string; sort?: "followers" | "repositories" | "joined" }

      Type declaration

      • Optional order?: "desc" | "asc"

        Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.

      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • q: string

        The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see Constructing a search query. See "Searching users" for a detailed list of qualifiers.

      • Optional sort?: "followers" | "repositories" | "joined"

        Sorts the results of your query by number of followers or repositories, or when the person joined GitHub. Default: best match

      SearchUsersResponse

      SearchUsersResponse: { incomplete_results: boolean; items: Array<SearchUsersResponseItemsItem>; total_count: number }

      Type declaration

      SearchUsersResponseItemsItem

      SearchUsersResponseItemsItem: { avatar_url: string; followers_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; score: number; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • followers_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • score: number
      • subscriptions_url: string
      • type: string
      • url: string

      TeamsAddMemberLegacyParams

      TeamsAddMemberLegacyParams: { team_id: number; username: string }

      Type declaration

      • team_id: number
      • username: string

      TeamsAddMemberLegacyResponse

      TeamsAddMemberLegacyResponse: { errors: Array<TeamsAddMemberLegacyResponseErrorsItem>; message: string }

      Type declaration

      TeamsAddMemberLegacyResponseErrorsItem

      TeamsAddMemberLegacyResponseErrorsItem: { code: string; field: string; resource: string }

      Type declaration

      • code: string
      • field: string
      • resource: string

      TeamsAddMemberParams

      TeamsAddMemberParams: { team_id: number; username: string }

      Type declaration

      • team_id: number
      • username: string

      TeamsAddMemberResponse

      TeamsAddMemberResponse: { errors: Array<TeamsAddMemberResponseErrorsItem>; message: string }

      Type declaration

      TeamsAddMemberResponseErrorsItem

      TeamsAddMemberResponseErrorsItem: { code: string; field: string; resource: string }

      Type declaration

      • code: string
      • field: string
      • resource: string

      TeamsAddOrUpdateMembershipInOrgParams

      TeamsAddOrUpdateMembershipInOrgParams: { org: string; role?: "member" | "maintainer"; team_slug: string; username: string }

      Type declaration

      • org: string
      • Optional role?: "member" | "maintainer"

        The role that this user should have in the team. Can be one of: * member - a normal member of the team. * maintainer - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description.

      • team_slug: string
      • username: string

      TeamsAddOrUpdateMembershipInOrgResponse

      TeamsAddOrUpdateMembershipInOrgResponse: { role: string; state: string; url: string }

      Type declaration

      • role: string
      • state: string
      • url: string

      TeamsAddOrUpdateMembershipLegacyParams

      TeamsAddOrUpdateMembershipLegacyParams: { role?: "member" | "maintainer"; team_id: number; username: string }

      Type declaration

      • Optional role?: "member" | "maintainer"

        The role that this user should have in the team. Can be one of: * member - a normal member of the team. * maintainer - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description.

      • team_id: number
      • username: string

      TeamsAddOrUpdateMembershipLegacyResponse

      TeamsAddOrUpdateMembershipLegacyResponse: { role: string; state: string; url: string }

      Type declaration

      • role: string
      • state: string
      • url: string

      TeamsAddOrUpdateMembershipParams

      TeamsAddOrUpdateMembershipParams: { role?: "member" | "maintainer"; team_id: number; username: string }

      Type declaration

      • Optional role?: "member" | "maintainer"

        The role that this user should have in the team. Can be one of: * member - a normal member of the team. * maintainer - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description.

      • team_id: number
      • username: string

      TeamsAddOrUpdateMembershipResponse

      TeamsAddOrUpdateMembershipResponse: { role: string; state: string; url: string }

      Type declaration

      • role: string
      • state: string
      • url: string

      TeamsAddOrUpdateProjectInOrgParams

      TeamsAddOrUpdateProjectInOrgParams: { org: string; permission?: "read" | "write" | "admin"; project_id: number; team_slug: string }

      Type declaration

      • org: string
      • Optional permission?: "read" | "write" | "admin"

        The permission to grant to the team for this project. Can be one of: * read - team members can read, but not write to or administer this project. * write - team members can read and write, but not administer this project. * admin - team members can read, write and administer this project. Default: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."

      • project_id: number
      • team_slug: string

      TeamsAddOrUpdateProjectInOrgResponse

      TeamsAddOrUpdateProjectInOrgResponse: { documentation_url: string; message: string }

      Type declaration

      • documentation_url: string
      • message: string

      TeamsAddOrUpdateProjectLegacyParams

      TeamsAddOrUpdateProjectLegacyParams: { permission?: "read" | "write" | "admin"; project_id: number; team_id: number }

      Type declaration

      • Optional permission?: "read" | "write" | "admin"

        The permission to grant to the team for this project. Can be one of: * read - team members can read, but not write to or administer this project. * write - team members can read and write, but not administer this project. * admin - team members can read, write and administer this project. Default: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."

      • project_id: number
      • team_id: number

      TeamsAddOrUpdateProjectLegacyResponse

      TeamsAddOrUpdateProjectLegacyResponse: { documentation_url: string; message: string }

      Type declaration

      • documentation_url: string
      • message: string

      TeamsAddOrUpdateProjectParams

      TeamsAddOrUpdateProjectParams: { permission?: "read" | "write" | "admin"; project_id: number; team_id: number }

      Type declaration

      • Optional permission?: "read" | "write" | "admin"

        The permission to grant to the team for this project. Can be one of: * read - team members can read, but not write to or administer this project. * write - team members can read and write, but not administer this project. * admin - team members can read, write and administer this project. Default: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."

      • project_id: number
      • team_id: number

      TeamsAddOrUpdateProjectResponse

      TeamsAddOrUpdateProjectResponse: { documentation_url: string; message: string }

      Type declaration

      • documentation_url: string
      • message: string

      TeamsAddOrUpdateRepoInOrgParams

      TeamsAddOrUpdateRepoInOrgParams: { org: string; owner: string; permission?: "pull" | "push" | "admin"; repo: string; team_slug: string }

      Type declaration

      • org: string
      • owner: string
      • Optional permission?: "pull" | "push" | "admin"

        The permission to grant the team on this repository. Can be one of: * pull - team members can pull, but not push to or administer this repository. * push - team members can pull and push, but not administer this repository. * admin - team members can pull, push and administer this repository.

        If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.

      • repo: string
      • team_slug: string

      TeamsAddOrUpdateRepoLegacyParams

      TeamsAddOrUpdateRepoLegacyParams: { owner: string; permission?: "pull" | "push" | "admin"; repo: string; team_id: number }

      Type declaration

      • owner: string
      • Optional permission?: "pull" | "push" | "admin"

        The permission to grant the team on this repository. Can be one of: * pull - team members can pull, but not push to or administer this repository. * push - team members can pull and push, but not administer this repository. * admin - team members can pull, push and administer this repository.

        If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.

      • repo: string
      • team_id: number

      TeamsAddOrUpdateRepoParams

      TeamsAddOrUpdateRepoParams: { owner: string; permission?: "pull" | "push" | "admin"; repo: string; team_id: number }

      Type declaration

      • owner: string
      • Optional permission?: "pull" | "push" | "admin"

        The permission to grant the team on this repository. Can be one of: * pull - team members can pull, but not push to or administer this repository. * push - team members can pull and push, but not administer this repository. * admin - team members can pull, push and administer this repository.

        If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.

      • repo: string
      • team_id: number

      TeamsCheckManagesRepoInOrgParams

      TeamsCheckManagesRepoInOrgParams: { org: string; owner: string; repo: string; team_slug: string }

      Type declaration

      • org: string
      • owner: string
      • repo: string
      • team_slug: string

      TeamsCheckManagesRepoInOrgResponse

      TeamsCheckManagesRepoInOrgResponse: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: TeamsCheckManagesRepoInOrgResponseOwner; permissions: TeamsCheckManagesRepoInOrgResponsePermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

      Type declaration

      • allow_merge_commit: boolean
      • allow_rebase_merge: boolean
      • allow_squash_merge: boolean
      • archive_url: string
      • archived: boolean
      • assignees_url: string
      • blobs_url: string
      • branches_url: string
      • clone_url: string
      • collaborators_url: string
      • comments_url: string
      • commits_url: string
      • compare_url: string
      • contents_url: string
      • contributors_url: string
      • created_at: string
      • default_branch: string
      • deployments_url: string
      • description: string
      • disabled: boolean
      • downloads_url: string
      • events_url: string
      • fork: boolean
      • forks_count: number
      • forks_url: string
      • full_name: string
      • git_commits_url: string
      • git_refs_url: string
      • git_tags_url: string
      • git_url: string
      • has_downloads: boolean
      • has_issues: boolean
      • has_pages: boolean
      • has_projects: boolean
      • has_wiki: boolean
      • homepage: string
      • hooks_url: string
      • html_url: string
      • id: number
      • is_template: boolean
      • issue_comment_url: string
      • issue_events_url: string
      • issues_url: string
      • keys_url: string
      • labels_url: string
      • language: null
      • languages_url: string
      • merges_url: string
      • milestones_url: string
      • mirror_url: string
      • name: string
      • network_count: number
      • node_id: string
      • notifications_url: string
      • open_issues_count: number
      • owner: TeamsCheckManagesRepoInOrgResponseOwner
      • permissions: TeamsCheckManagesRepoInOrgResponsePermissions
      • private: boolean
      • pulls_url: string
      • pushed_at: string
      • releases_url: string
      • size: number
      • ssh_url: string
      • stargazers_count: number
      • stargazers_url: string
      • statuses_url: string
      • subscribers_count: number
      • subscribers_url: string
      • subscription_url: string
      • svn_url: string
      • tags_url: string
      • teams_url: string
      • temp_clone_token: string
      • template_repository: null
      • topics: Array<string>
      • trees_url: string
      • updated_at: string
      • url: string
      • visibility: string
      • watchers_count: number

      TeamsCheckManagesRepoInOrgResponseOwner

      TeamsCheckManagesRepoInOrgResponseOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      TeamsCheckManagesRepoInOrgResponsePermissions

      TeamsCheckManagesRepoInOrgResponsePermissions: { admin: boolean; pull: boolean; push: boolean }

      Type declaration

      • admin: boolean
      • pull: boolean
      • push: boolean

      TeamsCheckManagesRepoLegacyParams

      TeamsCheckManagesRepoLegacyParams: { owner: string; repo: string; team_id: number }

      Type declaration

      • owner: string
      • repo: string
      • team_id: number

      TeamsCheckManagesRepoLegacyResponse

      TeamsCheckManagesRepoLegacyResponse: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: TeamsCheckManagesRepoLegacyResponseOwner; permissions: TeamsCheckManagesRepoLegacyResponsePermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

      Type declaration

      • allow_merge_commit: boolean
      • allow_rebase_merge: boolean
      • allow_squash_merge: boolean
      • archive_url: string
      • archived: boolean
      • assignees_url: string
      • blobs_url: string
      • branches_url: string
      • clone_url: string
      • collaborators_url: string
      • comments_url: string
      • commits_url: string
      • compare_url: string
      • contents_url: string
      • contributors_url: string
      • created_at: string
      • default_branch: string
      • deployments_url: string
      • description: string
      • disabled: boolean
      • downloads_url: string
      • events_url: string
      • fork: boolean
      • forks_count: number
      • forks_url: string
      • full_name: string
      • git_commits_url: string
      • git_refs_url: string
      • git_tags_url: string
      • git_url: string
      • has_downloads: boolean
      • has_issues: boolean
      • has_pages: boolean
      • has_projects: boolean
      • has_wiki: boolean
      • homepage: string
      • hooks_url: string
      • html_url: string
      • id: number
      • is_template: boolean
      • issue_comment_url: string
      • issue_events_url: string
      • issues_url: string
      • keys_url: string
      • labels_url: string
      • language: null
      • languages_url: string
      • merges_url: string
      • milestones_url: string
      • mirror_url: string
      • name: string
      • network_count: number
      • node_id: string
      • notifications_url: string
      • open_issues_count: number
      • owner: TeamsCheckManagesRepoLegacyResponseOwner
      • permissions: TeamsCheckManagesRepoLegacyResponsePermissions
      • private: boolean
      • pulls_url: string
      • pushed_at: string
      • releases_url: string
      • size: number
      • ssh_url: string
      • stargazers_count: number
      • stargazers_url: string
      • statuses_url: string
      • subscribers_count: number
      • subscribers_url: string
      • subscription_url: string
      • svn_url: string
      • tags_url: string
      • teams_url: string
      • temp_clone_token: string
      • template_repository: null
      • topics: Array<string>
      • trees_url: string
      • updated_at: string
      • url: string
      • visibility: string
      • watchers_count: number

      TeamsCheckManagesRepoLegacyResponseOwner

      TeamsCheckManagesRepoLegacyResponseOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      TeamsCheckManagesRepoLegacyResponsePermissions

      TeamsCheckManagesRepoLegacyResponsePermissions: { admin: boolean; pull: boolean; push: boolean }

      Type declaration

      • admin: boolean
      • pull: boolean
      • push: boolean

      TeamsCheckManagesRepoParams

      TeamsCheckManagesRepoParams: { owner: string; repo: string; team_id: number }

      Type declaration

      • owner: string
      • repo: string
      • team_id: number

      TeamsCheckManagesRepoResponse

      TeamsCheckManagesRepoResponse: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: TeamsCheckManagesRepoResponseOwner; permissions: TeamsCheckManagesRepoResponsePermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

      Type declaration

      • allow_merge_commit: boolean
      • allow_rebase_merge: boolean
      • allow_squash_merge: boolean
      • archive_url: string
      • archived: boolean
      • assignees_url: string
      • blobs_url: string
      • branches_url: string
      • clone_url: string
      • collaborators_url: string
      • comments_url: string
      • commits_url: string
      • compare_url: string
      • contents_url: string
      • contributors_url: string
      • created_at: string
      • default_branch: string
      • deployments_url: string
      • description: string
      • disabled: boolean
      • downloads_url: string
      • events_url: string
      • fork: boolean
      • forks_count: number
      • forks_url: string
      • full_name: string
      • git_commits_url: string
      • git_refs_url: string
      • git_tags_url: string
      • git_url: string
      • has_downloads: boolean
      • has_issues: boolean
      • has_pages: boolean
      • has_projects: boolean
      • has_wiki: boolean
      • homepage: string
      • hooks_url: string
      • html_url: string
      • id: number
      • is_template: boolean
      • issue_comment_url: string
      • issue_events_url: string
      • issues_url: string
      • keys_url: string
      • labels_url: string
      • language: null
      • languages_url: string
      • merges_url: string
      • milestones_url: string
      • mirror_url: string
      • name: string
      • network_count: number
      • node_id: string
      • notifications_url: string
      • open_issues_count: number
      • owner: TeamsCheckManagesRepoResponseOwner
      • permissions: TeamsCheckManagesRepoResponsePermissions
      • private: boolean
      • pulls_url: string
      • pushed_at: string
      • releases_url: string
      • size: number
      • ssh_url: string
      • stargazers_count: number
      • stargazers_url: string
      • statuses_url: string
      • subscribers_count: number
      • subscribers_url: string
      • subscription_url: string
      • svn_url: string
      • tags_url: string
      • teams_url: string
      • temp_clone_token: string
      • template_repository: null
      • topics: Array<string>
      • trees_url: string
      • updated_at: string
      • url: string
      • visibility: string
      • watchers_count: number

      TeamsCheckManagesRepoResponseOwner

      TeamsCheckManagesRepoResponseOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      TeamsCheckManagesRepoResponsePermissions

      TeamsCheckManagesRepoResponsePermissions: { admin: boolean; pull: boolean; push: boolean }

      Type declaration

      • admin: boolean
      • pull: boolean
      • push: boolean

      TeamsCreateDiscussionCommentInOrgParams

      TeamsCreateDiscussionCommentInOrgParams: { body: string; discussion_number: number; org: string; team_slug: string }

      Type declaration

      • body: string

        The discussion comment's body text.

      • discussion_number: number
      • org: string
      • team_slug: string

      TeamsCreateDiscussionCommentInOrgResponse

      TeamsCreateDiscussionCommentInOrgResponse: { author: TeamsCreateDiscussionCommentInOrgResponseAuthor; body: string; body_html: string; body_version: string; created_at: string; discussion_url: string; html_url: string; last_edited_at: null; node_id: string; number: number; reactions: TeamsCreateDiscussionCommentInOrgResponseReactions; updated_at: string; url: string }

      Type declaration

      TeamsCreateDiscussionCommentInOrgResponseAuthor

      TeamsCreateDiscussionCommentInOrgResponseAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      TeamsCreateDiscussionCommentInOrgResponseReactions

      TeamsCreateDiscussionCommentInOrgResponseReactions: { +1: number; -1: number; confused: number; heart: number; hooray: number; laugh: number; total_count: number; url: string }

      Type declaration

      • +1: number
      • -1: number
      • confused: number
      • heart: number
      • hooray: number
      • laugh: number
      • total_count: number
      • url: string

      TeamsCreateDiscussionCommentLegacyParams

      TeamsCreateDiscussionCommentLegacyParams: { body: string; discussion_number: number; team_id: number }

      Type declaration

      • body: string

        The discussion comment's body text.

      • discussion_number: number
      • team_id: number

      TeamsCreateDiscussionCommentLegacyResponse

      TeamsCreateDiscussionCommentLegacyResponse: { author: TeamsCreateDiscussionCommentLegacyResponseAuthor; body: string; body_html: string; body_version: string; created_at: string; discussion_url: string; html_url: string; last_edited_at: null; node_id: string; number: number; reactions: TeamsCreateDiscussionCommentLegacyResponseReactions; updated_at: string; url: string }

      Type declaration

      TeamsCreateDiscussionCommentLegacyResponseAuthor

      TeamsCreateDiscussionCommentLegacyResponseAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      TeamsCreateDiscussionCommentLegacyResponseReactions

      TeamsCreateDiscussionCommentLegacyResponseReactions: { +1: number; -1: number; confused: number; heart: number; hooray: number; laugh: number; total_count: number; url: string }

      Type declaration

      • +1: number
      • -1: number
      • confused: number
      • heart: number
      • hooray: number
      • laugh: number
      • total_count: number
      • url: string

      TeamsCreateDiscussionCommentParams

      TeamsCreateDiscussionCommentParams: { body: string; discussion_number: number; team_id: number }

      Type declaration

      • body: string

        The discussion comment's body text.

      • discussion_number: number
      • team_id: number

      TeamsCreateDiscussionCommentResponse

      TeamsCreateDiscussionCommentResponse: { author: TeamsCreateDiscussionCommentResponseAuthor; body: string; body_html: string; body_version: string; created_at: string; discussion_url: string; html_url: string; last_edited_at: null; node_id: string; number: number; reactions: TeamsCreateDiscussionCommentResponseReactions; updated_at: string; url: string }

      Type declaration

      TeamsCreateDiscussionCommentResponseAuthor

      TeamsCreateDiscussionCommentResponseAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      TeamsCreateDiscussionCommentResponseReactions

      TeamsCreateDiscussionCommentResponseReactions: { +1: number; -1: number; confused: number; heart: number; hooray: number; laugh: number; total_count: number; url: string }

      Type declaration

      • +1: number
      • -1: number
      • confused: number
      • heart: number
      • hooray: number
      • laugh: number
      • total_count: number
      • url: string

      TeamsCreateDiscussionInOrgParams

      TeamsCreateDiscussionInOrgParams: { body: string; org: string; private?: undefined | false | true; team_slug: string; title: string }

      Type declaration

      • body: string

        The discussion post's body text.

      • org: string
      • Optional private?: undefined | false | true

        Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.

      • team_slug: string
      • title: string

        The discussion post's title.

      TeamsCreateDiscussionInOrgResponse

      TeamsCreateDiscussionInOrgResponse: { author: TeamsCreateDiscussionInOrgResponseAuthor; body: string; body_html: string; body_version: string; comments_count: number; comments_url: string; created_at: string; html_url: string; last_edited_at: null; node_id: string; number: number; pinned: boolean; private: boolean; reactions: TeamsCreateDiscussionInOrgResponseReactions; team_url: string; title: string; updated_at: string; url: string }

      Type declaration

      TeamsCreateDiscussionInOrgResponseAuthor

      TeamsCreateDiscussionInOrgResponseAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      TeamsCreateDiscussionInOrgResponseReactions

      TeamsCreateDiscussionInOrgResponseReactions: { +1: number; -1: number; confused: number; heart: number; hooray: number; laugh: number; total_count: number; url: string }

      Type declaration

      • +1: number
      • -1: number
      • confused: number
      • heart: number
      • hooray: number
      • laugh: number
      • total_count: number
      • url: string

      TeamsCreateDiscussionLegacyParams

      TeamsCreateDiscussionLegacyParams: { body: string; private?: undefined | false | true; team_id: number; title: string }

      Type declaration

      • body: string

        The discussion post's body text.

      • Optional private?: undefined | false | true

        Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.

      • team_id: number
      • title: string

        The discussion post's title.

      TeamsCreateDiscussionLegacyResponse

      TeamsCreateDiscussionLegacyResponse: { author: TeamsCreateDiscussionLegacyResponseAuthor; body: string; body_html: string; body_version: string; comments_count: number; comments_url: string; created_at: string; html_url: string; last_edited_at: null; node_id: string; number: number; pinned: boolean; private: boolean; reactions: TeamsCreateDiscussionLegacyResponseReactions; team_url: string; title: string; updated_at: string; url: string }

      Type declaration

      TeamsCreateDiscussionLegacyResponseAuthor

      TeamsCreateDiscussionLegacyResponseAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      TeamsCreateDiscussionLegacyResponseReactions

      TeamsCreateDiscussionLegacyResponseReactions: { +1: number; -1: number; confused: number; heart: number; hooray: number; laugh: number; total_count: number; url: string }

      Type declaration

      • +1: number
      • -1: number
      • confused: number
      • heart: number
      • hooray: number
      • laugh: number
      • total_count: number
      • url: string

      TeamsCreateDiscussionParams

      TeamsCreateDiscussionParams: { body: string; private?: undefined | false | true; team_id: number; title: string }

      Type declaration

      • body: string

        The discussion post's body text.

      • Optional private?: undefined | false | true

        Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.

      • team_id: number
      • title: string

        The discussion post's title.

      TeamsCreateDiscussionResponse

      TeamsCreateDiscussionResponse: { author: TeamsCreateDiscussionResponseAuthor; body: string; body_html: string; body_version: string; comments_count: number; comments_url: string; created_at: string; html_url: string; last_edited_at: null; node_id: string; number: number; pinned: boolean; private: boolean; reactions: TeamsCreateDiscussionResponseReactions; team_url: string; title: string; updated_at: string; url: string }

      Type declaration

      • author: TeamsCreateDiscussionResponseAuthor
      • body: string
      • body_html: string
      • body_version: string
      • comments_count: number
      • comments_url: string
      • created_at: string
      • html_url: string
      • last_edited_at: null
      • node_id: string
      • number: number
      • pinned: boolean
      • private: boolean
      • reactions: TeamsCreateDiscussionResponseReactions
      • team_url: string
      • title: string
      • updated_at: string
      • url: string

      TeamsCreateDiscussionResponseAuthor

      TeamsCreateDiscussionResponseAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      TeamsCreateDiscussionResponseReactions

      TeamsCreateDiscussionResponseReactions: { +1: number; -1: number; confused: number; heart: number; hooray: number; laugh: number; total_count: number; url: string }

      Type declaration

      • +1: number
      • -1: number
      • confused: number
      • heart: number
      • hooray: number
      • laugh: number
      • total_count: number
      • url: string

      TeamsCreateParams

      TeamsCreateParams: { description?: undefined | string; maintainers?: string[]; name: string; org: string; parent_team_id?: undefined | number; privacy?: "secret" | "closed"; repo_names?: string[] }

      Type declaration

      • Optional description?: undefined | string

        The description of the team.

      • Optional maintainers?: string[]

        List GitHub IDs for organization members who will become team maintainers.

      • name: string

        The name of the team.

      • org: string
      • Optional parent_team_id?: undefined | number

        The ID of a team to set as the parent team.

      • Optional privacy?: "secret" | "closed"

        The level of privacy this team should have. The options are: For a non-nested team: * secret - only visible to organization owners and members of this team. * closed - visible to all members of this organization. Default: secret For a parent or child team: * closed - visible to all members of this organization. Default for child team: closed

      • Optional repo_names?: string[]

        The full name (e.g., "organization-name/repository-name") of repositories to add the team to.

      TeamsCreateParamsDeprecatedPermission

      TeamsCreateParamsDeprecatedPermission: { description?: undefined | string; maintainers?: string[]; name: string; org: string; parent_team_id?: undefined | number; permission?: undefined | string; privacy?: "secret" | "closed"; repo_names?: string[] }

      Type declaration

      • Optional description?: undefined | string

        The description of the team.

      • Optional maintainers?: string[]

        List GitHub IDs for organization members who will become team maintainers.

      • name: string

        The name of the team.

      • org: string
      • Optional parent_team_id?: undefined | number

        The ID of a team to set as the parent team.

      • Optional permission?: undefined | string

        Deprecated. The permission that new repositories will be added to the team with when none is specified. Can be one of: * pull - team members can pull, but not push to or administer newly-added repositories. * push - team members can pull and push, but not administer newly-added repositories. * admin - team members can pull, push and administer newly-added repositories.

        deprecated

        "permission" parameter has been deprecated and will be removed in future

      • Optional privacy?: "secret" | "closed"

        The level of privacy this team should have. The options are: For a non-nested team: * secret - only visible to organization owners and members of this team. * closed - visible to all members of this organization. Default: secret For a parent or child team: * closed - visible to all members of this organization. Default for child team: closed

      • Optional repo_names?: string[]

        The full name (e.g., "organization-name/repository-name") of repositories to add the team to.

      TeamsCreateResponse

      TeamsCreateResponse: { created_at: string; description: string; html_url: string; id: number; members_count: number; members_url: string; name: string; node_id: string; organization: TeamsCreateResponseOrganization; parent: null; permission: string; privacy: string; repos_count: number; repositories_url: string; slug: string; updated_at: string; url: string }

      Type declaration

      • created_at: string
      • description: string
      • html_url: string
      • id: number
      • members_count: number
      • members_url: string
      • name: string
      • node_id: string
      • organization: TeamsCreateResponseOrganization
      • parent: null
      • permission: string
      • privacy: string
      • repos_count: number
      • repositories_url: string
      • slug: string
      • updated_at: string
      • url: string

      TeamsCreateResponseOrganization

      TeamsCreateResponseOrganization: { avatar_url: string; blog: string; company: string; created_at: string; description: string; email: string; events_url: string; followers: number; following: number; has_organization_projects: boolean; has_repository_projects: boolean; hooks_url: string; html_url: string; id: number; is_verified: boolean; issues_url: string; location: string; login: string; members_url: string; name: string; node_id: string; public_gists: number; public_members_url: string; public_repos: number; repos_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • blog: string
      • company: string
      • created_at: string
      • description: string
      • email: string
      • events_url: string
      • followers: number
      • following: number
      • has_organization_projects: boolean
      • has_repository_projects: boolean
      • hooks_url: string
      • html_url: string
      • id: number
      • is_verified: boolean
      • issues_url: string
      • location: string
      • login: string
      • members_url: string
      • name: string
      • node_id: string
      • public_gists: number
      • public_members_url: string
      • public_repos: number
      • repos_url: string
      • type: string
      • url: string

      TeamsDeleteDiscussionCommentInOrgParams

      TeamsDeleteDiscussionCommentInOrgParams: { comment_number: number; discussion_number: number; org: string; team_slug: string }

      Type declaration

      • comment_number: number
      • discussion_number: number
      • org: string
      • team_slug: string

      TeamsDeleteDiscussionCommentLegacyParams

      TeamsDeleteDiscussionCommentLegacyParams: { comment_number: number; discussion_number: number; team_id: number }

      Type declaration

      • comment_number: number
      • discussion_number: number
      • team_id: number

      TeamsDeleteDiscussionCommentParams

      TeamsDeleteDiscussionCommentParams: { comment_number: number; discussion_number: number; team_id: number }

      Type declaration

      • comment_number: number
      • discussion_number: number
      • team_id: number

      TeamsDeleteDiscussionInOrgParams

      TeamsDeleteDiscussionInOrgParams: { discussion_number: number; org: string; team_slug: string }

      Type declaration

      • discussion_number: number
      • org: string
      • team_slug: string

      TeamsDeleteDiscussionLegacyParams

      TeamsDeleteDiscussionLegacyParams: { discussion_number: number; team_id: number }

      Type declaration

      • discussion_number: number
      • team_id: number

      TeamsDeleteDiscussionParams

      TeamsDeleteDiscussionParams: { discussion_number: number; team_id: number }

      Type declaration

      • discussion_number: number
      • team_id: number

      TeamsDeleteInOrgParams

      TeamsDeleteInOrgParams: { org: string; team_slug: string }

      Type declaration

      • org: string
      • team_slug: string

      TeamsDeleteLegacyParams

      TeamsDeleteLegacyParams: { team_id: number }

      Type declaration

      • team_id: number

      TeamsDeleteParams

      TeamsDeleteParams: { team_id: number }

      Type declaration

      • team_id: number

      TeamsGetByNameParams

      TeamsGetByNameParams: { org: string; team_slug: string }

      Type declaration

      • org: string
      • team_slug: string

      TeamsGetByNameResponse

      TeamsGetByNameResponse: { created_at: string; description: string; html_url: string; id: number; members_count: number; members_url: string; name: string; node_id: string; organization: TeamsGetByNameResponseOrganization; parent: null; permission: string; privacy: string; repos_count: number; repositories_url: string; slug: string; updated_at: string; url: string }

      Type declaration

      • created_at: string
      • description: string
      • html_url: string
      • id: number
      • members_count: number
      • members_url: string
      • name: string
      • node_id: string
      • organization: TeamsGetByNameResponseOrganization
      • parent: null
      • permission: string
      • privacy: string
      • repos_count: number
      • repositories_url: string
      • slug: string
      • updated_at: string
      • url: string

      TeamsGetByNameResponseOrganization

      TeamsGetByNameResponseOrganization: { avatar_url: string; blog: string; company: string; created_at: string; description: string; email: string; events_url: string; followers: number; following: number; has_organization_projects: boolean; has_repository_projects: boolean; hooks_url: string; html_url: string; id: number; is_verified: boolean; issues_url: string; location: string; login: string; members_url: string; name: string; node_id: string; public_gists: number; public_members_url: string; public_repos: number; repos_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • blog: string
      • company: string
      • created_at: string
      • description: string
      • email: string
      • events_url: string
      • followers: number
      • following: number
      • has_organization_projects: boolean
      • has_repository_projects: boolean
      • hooks_url: string
      • html_url: string
      • id: number
      • is_verified: boolean
      • issues_url: string
      • location: string
      • login: string
      • members_url: string
      • name: string
      • node_id: string
      • public_gists: number
      • public_members_url: string
      • public_repos: number
      • repos_url: string
      • type: string
      • url: string

      TeamsGetDiscussionCommentInOrgParams

      TeamsGetDiscussionCommentInOrgParams: { comment_number: number; discussion_number: number; org: string; team_slug: string }

      Type declaration

      • comment_number: number
      • discussion_number: number
      • org: string
      • team_slug: string

      TeamsGetDiscussionCommentInOrgResponse

      TeamsGetDiscussionCommentInOrgResponse: { author: TeamsGetDiscussionCommentInOrgResponseAuthor; body: string; body_html: string; body_version: string; created_at: string; discussion_url: string; html_url: string; last_edited_at: null; node_id: string; number: number; reactions: TeamsGetDiscussionCommentInOrgResponseReactions; updated_at: string; url: string }

      Type declaration

      TeamsGetDiscussionCommentInOrgResponseAuthor

      TeamsGetDiscussionCommentInOrgResponseAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      TeamsGetDiscussionCommentInOrgResponseReactions

      TeamsGetDiscussionCommentInOrgResponseReactions: { +1: number; -1: number; confused: number; heart: number; hooray: number; laugh: number; total_count: number; url: string }

      Type declaration

      • +1: number
      • -1: number
      • confused: number
      • heart: number
      • hooray: number
      • laugh: number
      • total_count: number
      • url: string

      TeamsGetDiscussionCommentLegacyParams

      TeamsGetDiscussionCommentLegacyParams: { comment_number: number; discussion_number: number; team_id: number }

      Type declaration

      • comment_number: number
      • discussion_number: number
      • team_id: number

      TeamsGetDiscussionCommentLegacyResponse

      TeamsGetDiscussionCommentLegacyResponse: { author: TeamsGetDiscussionCommentLegacyResponseAuthor; body: string; body_html: string; body_version: string; created_at: string; discussion_url: string; html_url: string; last_edited_at: null; node_id: string; number: number; reactions: TeamsGetDiscussionCommentLegacyResponseReactions; updated_at: string; url: string }

      Type declaration

      TeamsGetDiscussionCommentLegacyResponseAuthor

      TeamsGetDiscussionCommentLegacyResponseAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      TeamsGetDiscussionCommentLegacyResponseReactions

      TeamsGetDiscussionCommentLegacyResponseReactions: { +1: number; -1: number; confused: number; heart: number; hooray: number; laugh: number; total_count: number; url: string }

      Type declaration

      • +1: number
      • -1: number
      • confused: number
      • heart: number
      • hooray: number
      • laugh: number
      • total_count: number
      • url: string

      TeamsGetDiscussionCommentParams

      TeamsGetDiscussionCommentParams: { comment_number: number; discussion_number: number; team_id: number }

      Type declaration

      • comment_number: number
      • discussion_number: number
      • team_id: number

      TeamsGetDiscussionCommentResponse

      TeamsGetDiscussionCommentResponse: { author: TeamsGetDiscussionCommentResponseAuthor; body: string; body_html: string; body_version: string; created_at: string; discussion_url: string; html_url: string; last_edited_at: null; node_id: string; number: number; reactions: TeamsGetDiscussionCommentResponseReactions; updated_at: string; url: string }

      Type declaration

      TeamsGetDiscussionCommentResponseAuthor

      TeamsGetDiscussionCommentResponseAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      TeamsGetDiscussionCommentResponseReactions

      TeamsGetDiscussionCommentResponseReactions: { +1: number; -1: number; confused: number; heart: number; hooray: number; laugh: number; total_count: number; url: string }

      Type declaration

      • +1: number
      • -1: number
      • confused: number
      • heart: number
      • hooray: number
      • laugh: number
      • total_count: number
      • url: string

      TeamsGetDiscussionInOrgParams

      TeamsGetDiscussionInOrgParams: { discussion_number: number; org: string; team_slug: string }

      Type declaration

      • discussion_number: number
      • org: string
      • team_slug: string

      TeamsGetDiscussionInOrgResponse

      TeamsGetDiscussionInOrgResponse: { author: TeamsGetDiscussionInOrgResponseAuthor; body: string; body_html: string; body_version: string; comments_count: number; comments_url: string; created_at: string; html_url: string; last_edited_at: null; node_id: string; number: number; pinned: boolean; private: boolean; reactions: TeamsGetDiscussionInOrgResponseReactions; team_url: string; title: string; updated_at: string; url: string }

      Type declaration

      TeamsGetDiscussionInOrgResponseAuthor

      TeamsGetDiscussionInOrgResponseAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      TeamsGetDiscussionInOrgResponseReactions

      TeamsGetDiscussionInOrgResponseReactions: { +1: number; -1: number; confused: number; heart: number; hooray: number; laugh: number; total_count: number; url: string }

      Type declaration

      • +1: number
      • -1: number
      • confused: number
      • heart: number
      • hooray: number
      • laugh: number
      • total_count: number
      • url: string

      TeamsGetDiscussionLegacyParams

      TeamsGetDiscussionLegacyParams: { discussion_number: number; team_id: number }

      Type declaration

      • discussion_number: number
      • team_id: number

      TeamsGetDiscussionLegacyResponse

      TeamsGetDiscussionLegacyResponse: { author: TeamsGetDiscussionLegacyResponseAuthor; body: string; body_html: string; body_version: string; comments_count: number; comments_url: string; created_at: string; html_url: string; last_edited_at: null; node_id: string; number: number; pinned: boolean; private: boolean; reactions: TeamsGetDiscussionLegacyResponseReactions; team_url: string; title: string; updated_at: string; url: string }

      Type declaration

      TeamsGetDiscussionLegacyResponseAuthor

      TeamsGetDiscussionLegacyResponseAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      TeamsGetDiscussionLegacyResponseReactions

      TeamsGetDiscussionLegacyResponseReactions: { +1: number; -1: number; confused: number; heart: number; hooray: number; laugh: number; total_count: number; url: string }

      Type declaration

      • +1: number
      • -1: number
      • confused: number
      • heart: number
      • hooray: number
      • laugh: number
      • total_count: number
      • url: string

      TeamsGetDiscussionParams

      TeamsGetDiscussionParams: { discussion_number: number; team_id: number }

      Type declaration

      • discussion_number: number
      • team_id: number

      TeamsGetDiscussionResponse

      TeamsGetDiscussionResponse: { author: TeamsGetDiscussionResponseAuthor; body: string; body_html: string; body_version: string; comments_count: number; comments_url: string; created_at: string; html_url: string; last_edited_at: null; node_id: string; number: number; pinned: boolean; private: boolean; reactions: TeamsGetDiscussionResponseReactions; team_url: string; title: string; updated_at: string; url: string }

      Type declaration

      • author: TeamsGetDiscussionResponseAuthor
      • body: string
      • body_html: string
      • body_version: string
      • comments_count: number
      • comments_url: string
      • created_at: string
      • html_url: string
      • last_edited_at: null
      • node_id: string
      • number: number
      • pinned: boolean
      • private: boolean
      • reactions: TeamsGetDiscussionResponseReactions
      • team_url: string
      • title: string
      • updated_at: string
      • url: string

      TeamsGetDiscussionResponseAuthor

      TeamsGetDiscussionResponseAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      TeamsGetDiscussionResponseReactions

      TeamsGetDiscussionResponseReactions: { +1: number; -1: number; confused: number; heart: number; hooray: number; laugh: number; total_count: number; url: string }

      Type declaration

      • +1: number
      • -1: number
      • confused: number
      • heart: number
      • hooray: number
      • laugh: number
      • total_count: number
      • url: string

      TeamsGetLegacyParams

      TeamsGetLegacyParams: { team_id: number }

      Type declaration

      • team_id: number

      TeamsGetLegacyResponse

      TeamsGetLegacyResponse: { created_at: string; description: string; html_url: string; id: number; members_count: number; members_url: string; name: string; node_id: string; organization: TeamsGetLegacyResponseOrganization; parent: null; permission: string; privacy: string; repos_count: number; repositories_url: string; slug: string; updated_at: string; url: string }

      Type declaration

      • created_at: string
      • description: string
      • html_url: string
      • id: number
      • members_count: number
      • members_url: string
      • name: string
      • node_id: string
      • organization: TeamsGetLegacyResponseOrganization
      • parent: null
      • permission: string
      • privacy: string
      • repos_count: number
      • repositories_url: string
      • slug: string
      • updated_at: string
      • url: string

      TeamsGetLegacyResponseOrganization

      TeamsGetLegacyResponseOrganization: { avatar_url: string; blog: string; company: string; created_at: string; description: string; email: string; events_url: string; followers: number; following: number; has_organization_projects: boolean; has_repository_projects: boolean; hooks_url: string; html_url: string; id: number; is_verified: boolean; issues_url: string; location: string; login: string; members_url: string; name: string; node_id: string; public_gists: number; public_members_url: string; public_repos: number; repos_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • blog: string
      • company: string
      • created_at: string
      • description: string
      • email: string
      • events_url: string
      • followers: number
      • following: number
      • has_organization_projects: boolean
      • has_repository_projects: boolean
      • hooks_url: string
      • html_url: string
      • id: number
      • is_verified: boolean
      • issues_url: string
      • location: string
      • login: string
      • members_url: string
      • name: string
      • node_id: string
      • public_gists: number
      • public_members_url: string
      • public_repos: number
      • repos_url: string
      • type: string
      • url: string

      TeamsGetMemberLegacyParams

      TeamsGetMemberLegacyParams: { team_id: number; username: string }

      Type declaration

      • team_id: number
      • username: string

      TeamsGetMemberParams

      TeamsGetMemberParams: { team_id: number; username: string }

      Type declaration

      • team_id: number
      • username: string

      TeamsGetMembershipInOrgParams

      TeamsGetMembershipInOrgParams: { org: string; team_slug: string; username: string }

      Type declaration

      • org: string
      • team_slug: string
      • username: string

      TeamsGetMembershipInOrgResponse

      TeamsGetMembershipInOrgResponse: { role: string; state: string; url: string }

      Type declaration

      • role: string
      • state: string
      • url: string

      TeamsGetMembershipLegacyParams

      TeamsGetMembershipLegacyParams: { team_id: number; username: string }

      Type declaration

      • team_id: number
      • username: string

      TeamsGetMembershipLegacyResponse

      TeamsGetMembershipLegacyResponse: { role: string; state: string; url: string }

      Type declaration

      • role: string
      • state: string
      • url: string

      TeamsGetMembershipParams

      TeamsGetMembershipParams: { team_id: number; username: string }

      Type declaration

      • team_id: number
      • username: string

      TeamsGetMembershipResponse

      TeamsGetMembershipResponse: { role: string; state: string; url: string }

      Type declaration

      • role: string
      • state: string
      • url: string

      TeamsGetParams

      TeamsGetParams: { team_id: number }

      Type declaration

      • team_id: number

      TeamsGetResponse

      TeamsGetResponse: { created_at: string; description: string; html_url: string; id: number; members_count: number; members_url: string; name: string; node_id: string; organization: TeamsGetResponseOrganization; parent: null; permission: string; privacy: string; repos_count: number; repositories_url: string; slug: string; updated_at: string; url: string }

      Type declaration

      • created_at: string
      • description: string
      • html_url: string
      • id: number
      • members_count: number
      • members_url: string
      • name: string
      • node_id: string
      • organization: TeamsGetResponseOrganization
      • parent: null
      • permission: string
      • privacy: string
      • repos_count: number
      • repositories_url: string
      • slug: string
      • updated_at: string
      • url: string

      TeamsGetResponseOrganization

      TeamsGetResponseOrganization: { avatar_url: string; blog: string; company: string; created_at: string; description: string; email: string; events_url: string; followers: number; following: number; has_organization_projects: boolean; has_repository_projects: boolean; hooks_url: string; html_url: string; id: number; is_verified: boolean; issues_url: string; location: string; login: string; members_url: string; name: string; node_id: string; public_gists: number; public_members_url: string; public_repos: number; repos_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • blog: string
      • company: string
      • created_at: string
      • description: string
      • email: string
      • events_url: string
      • followers: number
      • following: number
      • has_organization_projects: boolean
      • has_repository_projects: boolean
      • hooks_url: string
      • html_url: string
      • id: number
      • is_verified: boolean
      • issues_url: string
      • location: string
      • login: string
      • members_url: string
      • name: string
      • node_id: string
      • public_gists: number
      • public_members_url: string
      • public_repos: number
      • repos_url: string
      • type: string
      • url: string

      TeamsListChildInOrgParams

      TeamsListChildInOrgParams: { org: string; page?: undefined | number; per_page?: undefined | number; team_slug: string }

      Type declaration

      • org: string
      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • team_slug: string

      TeamsListChildInOrgResponse

      TeamsListChildInOrgResponse: Array<TeamsListChildInOrgResponseItem>

      TeamsListChildInOrgResponseItem

      TeamsListChildInOrgResponseItem: { description: string; id: number; members_url: string; name: string; node_id: string; parent: TeamsListChildInOrgResponseItemParent; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

      Type declaration

      • description: string
      • id: number
      • members_url: string
      • name: string
      • node_id: string
      • parent: TeamsListChildInOrgResponseItemParent
      • permission: string
      • privacy: string
      • repositories_url: string
      • slug: string
      • url: string

      TeamsListChildInOrgResponseItemParent

      TeamsListChildInOrgResponseItemParent: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

      Type declaration

      • description: string
      • html_url: string
      • id: number
      • members_url: string
      • name: string
      • node_id: string
      • permission: string
      • privacy: string
      • repositories_url: string
      • slug: string
      • url: string

      TeamsListChildLegacyParams

      TeamsListChildLegacyParams: { page?: undefined | number; per_page?: undefined | number; team_id: number }

      Type declaration

      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • team_id: number

      TeamsListChildLegacyResponse

      TeamsListChildLegacyResponse: Array<TeamsListChildLegacyResponseItem>

      TeamsListChildLegacyResponseItem

      TeamsListChildLegacyResponseItem: { description: string; id: number; members_url: string; name: string; node_id: string; parent: TeamsListChildLegacyResponseItemParent; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

      Type declaration

      • description: string
      • id: number
      • members_url: string
      • name: string
      • node_id: string
      • parent: TeamsListChildLegacyResponseItemParent
      • permission: string
      • privacy: string
      • repositories_url: string
      • slug: string
      • url: string

      TeamsListChildLegacyResponseItemParent

      TeamsListChildLegacyResponseItemParent: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

      Type declaration

      • description: string
      • html_url: string
      • id: number
      • members_url: string
      • name: string
      • node_id: string
      • permission: string
      • privacy: string
      • repositories_url: string
      • slug: string
      • url: string

      TeamsListChildParams

      TeamsListChildParams: { page?: undefined | number; per_page?: undefined | number; team_id: number }

      Type declaration

      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • team_id: number

      TeamsListChildResponse

      TeamsListChildResponse: Array<TeamsListChildResponseItem>

      TeamsListChildResponseItem

      TeamsListChildResponseItem: { description: string; id: number; members_url: string; name: string; node_id: string; parent: TeamsListChildResponseItemParent; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

      Type declaration

      • description: string
      • id: number
      • members_url: string
      • name: string
      • node_id: string
      • parent: TeamsListChildResponseItemParent
      • permission: string
      • privacy: string
      • repositories_url: string
      • slug: string
      • url: string

      TeamsListChildResponseItemParent

      TeamsListChildResponseItemParent: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

      Type declaration

      • description: string
      • html_url: string
      • id: number
      • members_url: string
      • name: string
      • node_id: string
      • permission: string
      • privacy: string
      • repositories_url: string
      • slug: string
      • url: string

      TeamsListDiscussionCommentsInOrgParams

      TeamsListDiscussionCommentsInOrgParams: { direction?: "asc" | "desc"; discussion_number: number; org: string; page?: undefined | number; per_page?: undefined | number; team_slug: string }

      Type declaration

      • Optional direction?: "asc" | "desc"

        Sorts the discussion comments by the date they were created. To return the oldest comments first, set to asc. Can be one of asc or desc.

      • discussion_number: number
      • org: string
      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • team_slug: string

      TeamsListDiscussionCommentsInOrgResponse

      TeamsListDiscussionCommentsInOrgResponse: Array<TeamsListDiscussionCommentsInOrgResponseItem>

      TeamsListDiscussionCommentsInOrgResponseItem

      TeamsListDiscussionCommentsInOrgResponseItem: { author: TeamsListDiscussionCommentsInOrgResponseItemAuthor; body: string; body_html: string; body_version: string; created_at: string; discussion_url: string; html_url: string; last_edited_at: null; node_id: string; number: number; reactions: TeamsListDiscussionCommentsInOrgResponseItemReactions; updated_at: string; url: string }

      Type declaration

      TeamsListDiscussionCommentsInOrgResponseItemAuthor

      TeamsListDiscussionCommentsInOrgResponseItemAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      TeamsListDiscussionCommentsInOrgResponseItemReactions

      TeamsListDiscussionCommentsInOrgResponseItemReactions: { +1: number; -1: number; confused: number; heart: number; hooray: number; laugh: number; total_count: number; url: string }

      Type declaration

      • +1: number
      • -1: number
      • confused: number
      • heart: number
      • hooray: number
      • laugh: number
      • total_count: number
      • url: string

      TeamsListDiscussionCommentsLegacyParams

      TeamsListDiscussionCommentsLegacyParams: { direction?: "asc" | "desc"; discussion_number: number; page?: undefined | number; per_page?: undefined | number; team_id: number }

      Type declaration

      • Optional direction?: "asc" | "desc"

        Sorts the discussion comments by the date they were created. To return the oldest comments first, set to asc. Can be one of asc or desc.

      • discussion_number: number
      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • team_id: number

      TeamsListDiscussionCommentsLegacyResponse

      TeamsListDiscussionCommentsLegacyResponse: Array<TeamsListDiscussionCommentsLegacyResponseItem>

      TeamsListDiscussionCommentsLegacyResponseItem

      TeamsListDiscussionCommentsLegacyResponseItem: { author: TeamsListDiscussionCommentsLegacyResponseItemAuthor; body: string; body_html: string; body_version: string; created_at: string; discussion_url: string; html_url: string; last_edited_at: null; node_id: string; number: number; reactions: TeamsListDiscussionCommentsLegacyResponseItemReactions; updated_at: string; url: string }

      Type declaration

      TeamsListDiscussionCommentsLegacyResponseItemAuthor

      TeamsListDiscussionCommentsLegacyResponseItemAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      TeamsListDiscussionCommentsLegacyResponseItemReactions

      TeamsListDiscussionCommentsLegacyResponseItemReactions: { +1: number; -1: number; confused: number; heart: number; hooray: number; laugh: number; total_count: number; url: string }

      Type declaration

      • +1: number
      • -1: number
      • confused: number
      • heart: number
      • hooray: number
      • laugh: number
      • total_count: number
      • url: string

      TeamsListDiscussionCommentsParams

      TeamsListDiscussionCommentsParams: { direction?: "asc" | "desc"; discussion_number: number; page?: undefined | number; per_page?: undefined | number; team_id: number }

      Type declaration

      • Optional direction?: "asc" | "desc"

        Sorts the discussion comments by the date they were created. To return the oldest comments first, set to asc. Can be one of asc or desc.

      • discussion_number: number
      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • team_id: number

      TeamsListDiscussionCommentsResponse

      TeamsListDiscussionCommentsResponse: Array<TeamsListDiscussionCommentsResponseItem>

      TeamsListDiscussionCommentsResponseItem

      TeamsListDiscussionCommentsResponseItem: { author: TeamsListDiscussionCommentsResponseItemAuthor; body: string; body_html: string; body_version: string; created_at: string; discussion_url: string; html_url: string; last_edited_at: null; node_id: string; number: number; reactions: TeamsListDiscussionCommentsResponseItemReactions; updated_at: string; url: string }

      Type declaration

      TeamsListDiscussionCommentsResponseItemAuthor

      TeamsListDiscussionCommentsResponseItemAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      TeamsListDiscussionCommentsResponseItemReactions

      TeamsListDiscussionCommentsResponseItemReactions: { +1: number; -1: number; confused: number; heart: number; hooray: number; laugh: number; total_count: number; url: string }

      Type declaration

      • +1: number
      • -1: number
      • confused: number
      • heart: number
      • hooray: number
      • laugh: number
      • total_count: number
      • url: string

      TeamsListDiscussionsInOrgParams

      TeamsListDiscussionsInOrgParams: { direction?: "asc" | "desc"; org: string; page?: undefined | number; per_page?: undefined | number; team_slug: string }

      Type declaration

      • Optional direction?: "asc" | "desc"

        Sorts the discussion comments by the date they were created. To return the oldest comments first, set to asc. Can be one of asc or desc.

      • org: string
      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • team_slug: string

      TeamsListDiscussionsInOrgResponse

      TeamsListDiscussionsInOrgResponse: Array<TeamsListDiscussionsInOrgResponseItem>

      TeamsListDiscussionsInOrgResponseItem

      TeamsListDiscussionsInOrgResponseItem: { author: TeamsListDiscussionsInOrgResponseItemAuthor; body: string; body_html: string; body_version: string; comments_count: number; comments_url: string; created_at: string; html_url: string; last_edited_at: null; node_id: string; number: number; pinned: boolean; private: boolean; reactions: TeamsListDiscussionsInOrgResponseItemReactions; team_url: string; title: string; updated_at: string; url: string }

      Type declaration

      TeamsListDiscussionsInOrgResponseItemAuthor

      TeamsListDiscussionsInOrgResponseItemAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      TeamsListDiscussionsInOrgResponseItemReactions

      TeamsListDiscussionsInOrgResponseItemReactions: { +1: number; -1: number; confused: number; heart: number; hooray: number; laugh: number; total_count: number; url: string }

      Type declaration

      • +1: number
      • -1: number
      • confused: number
      • heart: number
      • hooray: number
      • laugh: number
      • total_count: number
      • url: string

      TeamsListDiscussionsLegacyParams

      TeamsListDiscussionsLegacyParams: { direction?: "asc" | "desc"; page?: undefined | number; per_page?: undefined | number; team_id: number }

      Type declaration

      • Optional direction?: "asc" | "desc"

        Sorts the discussion comments by the date they were created. To return the oldest comments first, set to asc. Can be one of asc or desc.

      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • team_id: number

      TeamsListDiscussionsLegacyResponse

      TeamsListDiscussionsLegacyResponse: Array<TeamsListDiscussionsLegacyResponseItem>

      TeamsListDiscussionsLegacyResponseItem

      TeamsListDiscussionsLegacyResponseItem: { author: TeamsListDiscussionsLegacyResponseItemAuthor; body: string; body_html: string; body_version: string; comments_count: number; comments_url: string; created_at: string; html_url: string; last_edited_at: null; node_id: string; number: number; pinned: boolean; private: boolean; reactions: TeamsListDiscussionsLegacyResponseItemReactions; team_url: string; title: string; updated_at: string; url: string }

      Type declaration

      TeamsListDiscussionsLegacyResponseItemAuthor

      TeamsListDiscussionsLegacyResponseItemAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      TeamsListDiscussionsLegacyResponseItemReactions

      TeamsListDiscussionsLegacyResponseItemReactions: { +1: number; -1: number; confused: number; heart: number; hooray: number; laugh: number; total_count: number; url: string }

      Type declaration

      • +1: number
      • -1: number
      • confused: number
      • heart: number
      • hooray: number
      • laugh: number
      • total_count: number
      • url: string

      TeamsListDiscussionsParams

      TeamsListDiscussionsParams: { direction?: "asc" | "desc"; page?: undefined | number; per_page?: undefined | number; team_id: number }

      Type declaration

      • Optional direction?: "asc" | "desc"

        Sorts the discussion comments by the date they were created. To return the oldest comments first, set to asc. Can be one of asc or desc.

      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • team_id: number

      TeamsListDiscussionsResponse

      TeamsListDiscussionsResponse: Array<TeamsListDiscussionsResponseItem>

      TeamsListDiscussionsResponseItem

      TeamsListDiscussionsResponseItem: { author: TeamsListDiscussionsResponseItemAuthor; body: string; body_html: string; body_version: string; comments_count: number; comments_url: string; created_at: string; html_url: string; last_edited_at: null; node_id: string; number: number; pinned: boolean; private: boolean; reactions: TeamsListDiscussionsResponseItemReactions; team_url: string; title: string; updated_at: string; url: string }

      Type declaration

      TeamsListDiscussionsResponseItemAuthor

      TeamsListDiscussionsResponseItemAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      TeamsListDiscussionsResponseItemReactions

      TeamsListDiscussionsResponseItemReactions: { +1: number; -1: number; confused: number; heart: number; hooray: number; laugh: number; total_count: number; url: string }

      Type declaration

      • +1: number
      • -1: number
      • confused: number
      • heart: number
      • hooray: number
      • laugh: number
      • total_count: number
      • url: string

      TeamsListForAuthenticatedUserParams

      TeamsListForAuthenticatedUserParams: { page?: undefined | number; per_page?: undefined | number }

      Type declaration

      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      TeamsListForAuthenticatedUserResponse

      TeamsListForAuthenticatedUserResponse: Array<TeamsListForAuthenticatedUserResponseItem>

      TeamsListForAuthenticatedUserResponseItem

      TeamsListForAuthenticatedUserResponseItem: { created_at: string; description: string; html_url: string; id: number; members_count: number; members_url: string; name: string; node_id: string; organization: TeamsListForAuthenticatedUserResponseItemOrganization; parent: null; permission: string; privacy: string; repos_count: number; repositories_url: string; slug: string; updated_at: string; url: string }

      Type declaration

      • created_at: string
      • description: string
      • html_url: string
      • id: number
      • members_count: number
      • members_url: string
      • name: string
      • node_id: string
      • organization: TeamsListForAuthenticatedUserResponseItemOrganization
      • parent: null
      • permission: string
      • privacy: string
      • repos_count: number
      • repositories_url: string
      • slug: string
      • updated_at: string
      • url: string

      TeamsListForAuthenticatedUserResponseItemOrganization

      TeamsListForAuthenticatedUserResponseItemOrganization: { avatar_url: string; blog: string; company: string; created_at: string; description: string; email: string; events_url: string; followers: number; following: number; has_organization_projects: boolean; has_repository_projects: boolean; hooks_url: string; html_url: string; id: number; is_verified: boolean; issues_url: string; location: string; login: string; members_url: string; name: string; node_id: string; public_gists: number; public_members_url: string; public_repos: number; repos_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • blog: string
      • company: string
      • created_at: string
      • description: string
      • email: string
      • events_url: string
      • followers: number
      • following: number
      • has_organization_projects: boolean
      • has_repository_projects: boolean
      • hooks_url: string
      • html_url: string
      • id: number
      • is_verified: boolean
      • issues_url: string
      • location: string
      • login: string
      • members_url: string
      • name: string
      • node_id: string
      • public_gists: number
      • public_members_url: string
      • public_repos: number
      • repos_url: string
      • type: string
      • url: string

      TeamsListMembersInOrgParams

      TeamsListMembersInOrgParams: { org: string; page?: undefined | number; per_page?: undefined | number; role?: "member" | "maintainer" | "all"; team_slug: string }

      Type declaration

      • org: string
      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • Optional role?: "member" | "maintainer" | "all"

        Filters members returned by their role in the team. Can be one of: * member - normal members of the team. * maintainer - team maintainers. * all - all members of the team.

      • team_slug: string

      TeamsListMembersInOrgResponse

      TeamsListMembersInOrgResponse: Array<TeamsListMembersInOrgResponseItem>

      TeamsListMembersInOrgResponseItem

      TeamsListMembersInOrgResponseItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      TeamsListMembersLegacyParams

      TeamsListMembersLegacyParams: { page?: undefined | number; per_page?: undefined | number; role?: "member" | "maintainer" | "all"; team_id: number }

      Type declaration

      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • Optional role?: "member" | "maintainer" | "all"

        Filters members returned by their role in the team. Can be one of: * member - normal members of the team. * maintainer - team maintainers. * all - all members of the team.

      • team_id: number

      TeamsListMembersLegacyResponse

      TeamsListMembersLegacyResponse: Array<TeamsListMembersLegacyResponseItem>

      TeamsListMembersLegacyResponseItem

      TeamsListMembersLegacyResponseItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      TeamsListMembersParams

      TeamsListMembersParams: { page?: undefined | number; per_page?: undefined | number; role?: "member" | "maintainer" | "all"; team_id: number }

      Type declaration

      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • Optional role?: "member" | "maintainer" | "all"

        Filters members returned by their role in the team. Can be one of: * member - normal members of the team. * maintainer - team maintainers. * all - all members of the team.

      • team_id: number

      TeamsListMembersResponse

      TeamsListMembersResponse: Array<TeamsListMembersResponseItem>

      TeamsListMembersResponseItem

      TeamsListMembersResponseItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      TeamsListParams

      TeamsListParams: { org: string; page?: undefined | number; per_page?: undefined | number }

      Type declaration

      • org: string
      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      TeamsListPendingInvitationsInOrgParams

      TeamsListPendingInvitationsInOrgParams: { org: string; page?: undefined | number; per_page?: undefined | number; team_slug: string }

      Type declaration

      • org: string
      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • team_slug: string

      TeamsListPendingInvitationsInOrgResponse

      TeamsListPendingInvitationsInOrgResponse: Array<TeamsListPendingInvitationsInOrgResponseItem>

      TeamsListPendingInvitationsInOrgResponseItem

      TeamsListPendingInvitationsInOrgResponseItem: { created_at: string; email: string; id: number; invitation_team_url: string; inviter: TeamsListPendingInvitationsInOrgResponseItemInviter; login: string; role: string; team_count: number }

      Type declaration

      TeamsListPendingInvitationsInOrgResponseItemInviter

      TeamsListPendingInvitationsInOrgResponseItemInviter: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      TeamsListPendingInvitationsLegacyParams

      TeamsListPendingInvitationsLegacyParams: { page?: undefined | number; per_page?: undefined | number; team_id: number }

      Type declaration

      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • team_id: number

      TeamsListPendingInvitationsLegacyResponse

      TeamsListPendingInvitationsLegacyResponse: Array<TeamsListPendingInvitationsLegacyResponseItem>

      TeamsListPendingInvitationsLegacyResponseItem

      TeamsListPendingInvitationsLegacyResponseItem: { created_at: string; email: string; id: number; invitation_team_url: string; inviter: TeamsListPendingInvitationsLegacyResponseItemInviter; login: string; role: string; team_count: number }

      Type declaration

      TeamsListPendingInvitationsLegacyResponseItemInviter

      TeamsListPendingInvitationsLegacyResponseItemInviter: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      TeamsListPendingInvitationsParams

      TeamsListPendingInvitationsParams: { page?: undefined | number; per_page?: undefined | number; team_id: number }

      Type declaration

      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • team_id: number

      TeamsListPendingInvitationsResponse

      TeamsListPendingInvitationsResponse: Array<TeamsListPendingInvitationsResponseItem>

      TeamsListPendingInvitationsResponseItem

      TeamsListPendingInvitationsResponseItem: { created_at: string; email: string; id: number; invitation_team_url: string; inviter: TeamsListPendingInvitationsResponseItemInviter; login: string; role: string; team_count: number }

      Type declaration

      TeamsListPendingInvitationsResponseItemInviter

      TeamsListPendingInvitationsResponseItemInviter: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      TeamsListProjectsInOrgParams

      TeamsListProjectsInOrgParams: { org: string; page?: undefined | number; per_page?: undefined | number; team_slug: string }

      Type declaration

      • org: string
      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • team_slug: string

      TeamsListProjectsInOrgResponse

      TeamsListProjectsInOrgResponse: Array<TeamsListProjectsInOrgResponseItem>

      TeamsListProjectsInOrgResponseItem

      TeamsListProjectsInOrgResponseItem: { body: string; columns_url: string; created_at: string; creator: TeamsListProjectsInOrgResponseItemCreator; html_url: string; id: number; name: string; node_id: string; number: number; organization_permission: string; owner_url: string; permissions: TeamsListProjectsInOrgResponseItemPermissions; private: boolean; state: string; updated_at: string; url: string }

      Type declaration

      TeamsListProjectsInOrgResponseItemCreator

      TeamsListProjectsInOrgResponseItemCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      TeamsListProjectsInOrgResponseItemPermissions

      TeamsListProjectsInOrgResponseItemPermissions: { admin: boolean; read: boolean; write: boolean }

      Type declaration

      • admin: boolean
      • read: boolean
      • write: boolean

      TeamsListProjectsLegacyParams

      TeamsListProjectsLegacyParams: { page?: undefined | number; per_page?: undefined | number; team_id: number }

      Type declaration

      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • team_id: number

      TeamsListProjectsLegacyResponse

      TeamsListProjectsLegacyResponse: Array<TeamsListProjectsLegacyResponseItem>

      TeamsListProjectsLegacyResponseItem

      TeamsListProjectsLegacyResponseItem: { body: string; columns_url: string; created_at: string; creator: TeamsListProjectsLegacyResponseItemCreator; html_url: string; id: number; name: string; node_id: string; number: number; organization_permission: string; owner_url: string; permissions: TeamsListProjectsLegacyResponseItemPermissions; private: boolean; state: string; updated_at: string; url: string }

      Type declaration

      TeamsListProjectsLegacyResponseItemCreator

      TeamsListProjectsLegacyResponseItemCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      TeamsListProjectsLegacyResponseItemPermissions

      TeamsListProjectsLegacyResponseItemPermissions: { admin: boolean; read: boolean; write: boolean }

      Type declaration

      • admin: boolean
      • read: boolean
      • write: boolean

      TeamsListProjectsParams

      TeamsListProjectsParams: { page?: undefined | number; per_page?: undefined | number; team_id: number }

      Type declaration

      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • team_id: number

      TeamsListProjectsResponse

      TeamsListProjectsResponse: Array<TeamsListProjectsResponseItem>

      TeamsListProjectsResponseItem

      TeamsListProjectsResponseItem: { body: string; columns_url: string; created_at: string; creator: TeamsListProjectsResponseItemCreator; html_url: string; id: number; name: string; node_id: string; number: number; organization_permission: string; owner_url: string; permissions: TeamsListProjectsResponseItemPermissions; private: boolean; state: string; updated_at: string; url: string }

      Type declaration

      TeamsListProjectsResponseItemCreator

      TeamsListProjectsResponseItemCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      TeamsListProjectsResponseItemPermissions

      TeamsListProjectsResponseItemPermissions: { admin: boolean; read: boolean; write: boolean }

      Type declaration

      • admin: boolean
      • read: boolean
      • write: boolean

      TeamsListReposInOrgParams

      TeamsListReposInOrgParams: { org: string; page?: undefined | number; per_page?: undefined | number; team_slug: string }

      Type declaration

      • org: string
      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • team_slug: string

      TeamsListReposInOrgResponse

      TeamsListReposInOrgResponse: Array<TeamsListReposInOrgResponseItem>

      TeamsListReposInOrgResponseItem

      TeamsListReposInOrgResponseItem: { archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; license: TeamsListReposInOrgResponseItemLicense; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: TeamsListReposInOrgResponseItemOwner; permissions: TeamsListReposInOrgResponseItemPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

      Type declaration

      • archive_url: string
      • archived: boolean
      • assignees_url: string
      • blobs_url: string
      • branches_url: string
      • clone_url: string
      • collaborators_url: string
      • comments_url: string
      • commits_url: string
      • compare_url: string
      • contents_url: string
      • contributors_url: string
      • created_at: string
      • default_branch: string
      • deployments_url: string
      • description: string
      • disabled: boolean
      • downloads_url: string
      • events_url: string
      • fork: boolean
      • forks_count: number
      • forks_url: string
      • full_name: string
      • git_commits_url: string
      • git_refs_url: string
      • git_tags_url: string
      • git_url: string
      • has_downloads: boolean
      • has_issues: boolean
      • has_pages: boolean
      • has_projects: boolean
      • has_wiki: boolean
      • homepage: string
      • hooks_url: string
      • html_url: string
      • id: number
      • is_template: boolean
      • issue_comment_url: string
      • issue_events_url: string
      • issues_url: string
      • keys_url: string
      • labels_url: string
      • language: null
      • languages_url: string
      • license: TeamsListReposInOrgResponseItemLicense
      • merges_url: string
      • milestones_url: string
      • mirror_url: string
      • name: string
      • network_count: number
      • node_id: string
      • notifications_url: string
      • open_issues_count: number
      • owner: TeamsListReposInOrgResponseItemOwner
      • permissions: TeamsListReposInOrgResponseItemPermissions
      • private: boolean
      • pulls_url: string
      • pushed_at: string
      • releases_url: string
      • size: number
      • ssh_url: string
      • stargazers_count: number
      • stargazers_url: string
      • statuses_url: string
      • subscribers_count: number
      • subscribers_url: string
      • subscription_url: string
      • svn_url: string
      • tags_url: string
      • teams_url: string
      • temp_clone_token: string
      • template_repository: null
      • topics: Array<string>
      • trees_url: string
      • updated_at: string
      • url: string
      • visibility: string
      • watchers_count: number

      TeamsListReposInOrgResponseItemLicense

      TeamsListReposInOrgResponseItemLicense: { key: string; name: string; node_id: string; spdx_id: string; url: string }

      Type declaration

      • key: string
      • name: string
      • node_id: string
      • spdx_id: string
      • url: string

      TeamsListReposInOrgResponseItemOwner

      TeamsListReposInOrgResponseItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      TeamsListReposInOrgResponseItemPermissions

      TeamsListReposInOrgResponseItemPermissions: { admin: boolean; pull: boolean; push: boolean }

      Type declaration

      • admin: boolean
      • pull: boolean
      • push: boolean

      TeamsListReposLegacyParams

      TeamsListReposLegacyParams: { page?: undefined | number; per_page?: undefined | number; team_id: number }

      Type declaration

      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • team_id: number

      TeamsListReposLegacyResponse

      TeamsListReposLegacyResponse: Array<TeamsListReposLegacyResponseItem>

      TeamsListReposLegacyResponseItem

      TeamsListReposLegacyResponseItem: { archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; license: TeamsListReposLegacyResponseItemLicense; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: TeamsListReposLegacyResponseItemOwner; permissions: TeamsListReposLegacyResponseItemPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

      Type declaration

      • archive_url: string
      • archived: boolean
      • assignees_url: string
      • blobs_url: string
      • branches_url: string
      • clone_url: string
      • collaborators_url: string
      • comments_url: string
      • commits_url: string
      • compare_url: string
      • contents_url: string
      • contributors_url: string
      • created_at: string
      • default_branch: string
      • deployments_url: string
      • description: string
      • disabled: boolean
      • downloads_url: string
      • events_url: string
      • fork: boolean
      • forks_count: number
      • forks_url: string
      • full_name: string
      • git_commits_url: string
      • git_refs_url: string
      • git_tags_url: string
      • git_url: string
      • has_downloads: boolean
      • has_issues: boolean
      • has_pages: boolean
      • has_projects: boolean
      • has_wiki: boolean
      • homepage: string
      • hooks_url: string
      • html_url: string
      • id: number
      • is_template: boolean
      • issue_comment_url: string
      • issue_events_url: string
      • issues_url: string
      • keys_url: string
      • labels_url: string
      • language: null
      • languages_url: string
      • license: TeamsListReposLegacyResponseItemLicense
      • merges_url: string
      • milestones_url: string
      • mirror_url: string
      • name: string
      • network_count: number
      • node_id: string
      • notifications_url: string
      • open_issues_count: number
      • owner: TeamsListReposLegacyResponseItemOwner
      • permissions: TeamsListReposLegacyResponseItemPermissions
      • private: boolean
      • pulls_url: string
      • pushed_at: string
      • releases_url: string
      • size: number
      • ssh_url: string
      • stargazers_count: number
      • stargazers_url: string
      • statuses_url: string
      • subscribers_count: number
      • subscribers_url: string
      • subscription_url: string
      • svn_url: string
      • tags_url: string
      • teams_url: string
      • temp_clone_token: string
      • template_repository: null
      • topics: Array<string>
      • trees_url: string
      • updated_at: string
      • url: string
      • visibility: string
      • watchers_count: number

      TeamsListReposLegacyResponseItemLicense

      TeamsListReposLegacyResponseItemLicense: { key: string; name: string; node_id: string; spdx_id: string; url: string }

      Type declaration

      • key: string
      • name: string
      • node_id: string
      • spdx_id: string
      • url: string

      TeamsListReposLegacyResponseItemOwner

      TeamsListReposLegacyResponseItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      TeamsListReposLegacyResponseItemPermissions

      TeamsListReposLegacyResponseItemPermissions: { admin: boolean; pull: boolean; push: boolean }

      Type declaration

      • admin: boolean
      • pull: boolean
      • push: boolean

      TeamsListReposParams

      TeamsListReposParams: { page?: undefined | number; per_page?: undefined | number; team_id: number }

      Type declaration

      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • team_id: number

      TeamsListReposResponse

      TeamsListReposResponse: Array<TeamsListReposResponseItem>

      TeamsListReposResponseItem

      TeamsListReposResponseItem: { archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: null; languages_url: string; license: TeamsListReposResponseItemLicense; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: TeamsListReposResponseItemOwner; permissions: TeamsListReposResponseItemPermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: null; topics: Array<string>; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }

      Type declaration

      • archive_url: string
      • archived: boolean
      • assignees_url: string
      • blobs_url: string
      • branches_url: string
      • clone_url: string
      • collaborators_url: string
      • comments_url: string
      • commits_url: string
      • compare_url: string
      • contents_url: string
      • contributors_url: string
      • created_at: string
      • default_branch: string
      • deployments_url: string
      • description: string
      • disabled: boolean
      • downloads_url: string
      • events_url: string
      • fork: boolean
      • forks_count: number
      • forks_url: string
      • full_name: string
      • git_commits_url: string
      • git_refs_url: string
      • git_tags_url: string
      • git_url: string
      • has_downloads: boolean
      • has_issues: boolean
      • has_pages: boolean
      • has_projects: boolean
      • has_wiki: boolean
      • homepage: string
      • hooks_url: string
      • html_url: string
      • id: number
      • is_template: boolean
      • issue_comment_url: string
      • issue_events_url: string
      • issues_url: string
      • keys_url: string
      • labels_url: string
      • language: null
      • languages_url: string
      • license: TeamsListReposResponseItemLicense
      • merges_url: string
      • milestones_url: string
      • mirror_url: string
      • name: string
      • network_count: number
      • node_id: string
      • notifications_url: string
      • open_issues_count: number
      • owner: TeamsListReposResponseItemOwner
      • permissions: TeamsListReposResponseItemPermissions
      • private: boolean
      • pulls_url: string
      • pushed_at: string
      • releases_url: string
      • size: number
      • ssh_url: string
      • stargazers_count: number
      • stargazers_url: string
      • statuses_url: string
      • subscribers_count: number
      • subscribers_url: string
      • subscription_url: string
      • svn_url: string
      • tags_url: string
      • teams_url: string
      • temp_clone_token: string
      • template_repository: null
      • topics: Array<string>
      • trees_url: string
      • updated_at: string
      • url: string
      • visibility: string
      • watchers_count: number

      TeamsListReposResponseItemLicense

      TeamsListReposResponseItemLicense: { key: string; name: string; node_id: string; spdx_id: string; url: string }

      Type declaration

      • key: string
      • name: string
      • node_id: string
      • spdx_id: string
      • url: string

      TeamsListReposResponseItemOwner

      TeamsListReposResponseItemOwner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      TeamsListReposResponseItemPermissions

      TeamsListReposResponseItemPermissions: { admin: boolean; pull: boolean; push: boolean }

      Type declaration

      • admin: boolean
      • pull: boolean
      • push: boolean

      TeamsListResponse

      TeamsListResponse: Array<TeamsListResponseItem>

      TeamsListResponseItem

      TeamsListResponseItem: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: null; permission: string; privacy: string; repositories_url: string; slug: string; url: string }

      Type declaration

      • description: string
      • html_url: string
      • id: number
      • members_url: string
      • name: string
      • node_id: string
      • parent: null
      • permission: string
      • privacy: string
      • repositories_url: string
      • slug: string
      • url: string

      TeamsRemoveMemberLegacyParams

      TeamsRemoveMemberLegacyParams: { team_id: number; username: string }

      Type declaration

      • team_id: number
      • username: string

      TeamsRemoveMemberParams

      TeamsRemoveMemberParams: { team_id: number; username: string }

      Type declaration

      • team_id: number
      • username: string

      TeamsRemoveMembershipInOrgParams

      TeamsRemoveMembershipInOrgParams: { org: string; team_slug: string; username: string }

      Type declaration

      • org: string
      • team_slug: string
      • username: string

      TeamsRemoveMembershipLegacyParams

      TeamsRemoveMembershipLegacyParams: { team_id: number; username: string }

      Type declaration

      • team_id: number
      • username: string

      TeamsRemoveMembershipParams

      TeamsRemoveMembershipParams: { team_id: number; username: string }

      Type declaration

      • team_id: number
      • username: string

      TeamsRemoveProjectInOrgParams

      TeamsRemoveProjectInOrgParams: { org: string; project_id: number; team_slug: string }

      Type declaration

      • org: string
      • project_id: number
      • team_slug: string

      TeamsRemoveProjectLegacyParams

      TeamsRemoveProjectLegacyParams: { project_id: number; team_id: number }

      Type declaration

      • project_id: number
      • team_id: number

      TeamsRemoveProjectParams

      TeamsRemoveProjectParams: { project_id: number; team_id: number }

      Type declaration

      • project_id: number
      • team_id: number

      TeamsRemoveRepoInOrgParams

      TeamsRemoveRepoInOrgParams: { org: string; owner: string; repo: string; team_slug: string }

      Type declaration

      • org: string
      • owner: string
      • repo: string
      • team_slug: string

      TeamsRemoveRepoLegacyParams

      TeamsRemoveRepoLegacyParams: { owner: string; repo: string; team_id: number }

      Type declaration

      • owner: string
      • repo: string
      • team_id: number

      TeamsRemoveRepoParams

      TeamsRemoveRepoParams: { owner: string; repo: string; team_id: number }

      Type declaration

      • owner: string
      • repo: string
      • team_id: number

      TeamsReviewProjectInOrgParams

      TeamsReviewProjectInOrgParams: { org: string; project_id: number; team_slug: string }

      Type declaration

      • org: string
      • project_id: number
      • team_slug: string

      TeamsReviewProjectInOrgResponse

      TeamsReviewProjectInOrgResponse: { body: string; columns_url: string; created_at: string; creator: TeamsReviewProjectInOrgResponseCreator; html_url: string; id: number; name: string; node_id: string; number: number; organization_permission: string; owner_url: string; permissions: TeamsReviewProjectInOrgResponsePermissions; private: boolean; state: string; updated_at: string; url: string }

      Type declaration

      TeamsReviewProjectInOrgResponseCreator

      TeamsReviewProjectInOrgResponseCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      TeamsReviewProjectInOrgResponsePermissions

      TeamsReviewProjectInOrgResponsePermissions: { admin: boolean; read: boolean; write: boolean }

      Type declaration

      • admin: boolean
      • read: boolean
      • write: boolean

      TeamsReviewProjectLegacyParams

      TeamsReviewProjectLegacyParams: { project_id: number; team_id: number }

      Type declaration

      • project_id: number
      • team_id: number

      TeamsReviewProjectLegacyResponse

      TeamsReviewProjectLegacyResponse: { body: string; columns_url: string; created_at: string; creator: TeamsReviewProjectLegacyResponseCreator; html_url: string; id: number; name: string; node_id: string; number: number; organization_permission: string; owner_url: string; permissions: TeamsReviewProjectLegacyResponsePermissions; private: boolean; state: string; updated_at: string; url: string }

      Type declaration

      TeamsReviewProjectLegacyResponseCreator

      TeamsReviewProjectLegacyResponseCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      TeamsReviewProjectLegacyResponsePermissions

      TeamsReviewProjectLegacyResponsePermissions: { admin: boolean; read: boolean; write: boolean }

      Type declaration

      • admin: boolean
      • read: boolean
      • write: boolean

      TeamsReviewProjectParams

      TeamsReviewProjectParams: { project_id: number; team_id: number }

      Type declaration

      • project_id: number
      • team_id: number

      TeamsReviewProjectResponse

      TeamsReviewProjectResponse: { body: string; columns_url: string; created_at: string; creator: TeamsReviewProjectResponseCreator; html_url: string; id: number; name: string; node_id: string; number: number; organization_permission: string; owner_url: string; permissions: TeamsReviewProjectResponsePermissions; private: boolean; state: string; updated_at: string; url: string }

      Type declaration

      TeamsReviewProjectResponseCreator

      TeamsReviewProjectResponseCreator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      TeamsReviewProjectResponsePermissions

      TeamsReviewProjectResponsePermissions: { admin: boolean; read: boolean; write: boolean }

      Type declaration

      • admin: boolean
      • read: boolean
      • write: boolean

      TeamsUpdateDiscussionCommentInOrgParams

      TeamsUpdateDiscussionCommentInOrgParams: { body: string; comment_number: number; discussion_number: number; org: string; team_slug: string }

      Type declaration

      • body: string

        The discussion comment's body text.

      • comment_number: number
      • discussion_number: number
      • org: string
      • team_slug: string

      TeamsUpdateDiscussionCommentInOrgResponse

      TeamsUpdateDiscussionCommentInOrgResponse: { author: TeamsUpdateDiscussionCommentInOrgResponseAuthor; body: string; body_html: string; body_version: string; created_at: string; discussion_url: string; html_url: string; last_edited_at: string; node_id: string; number: number; reactions: TeamsUpdateDiscussionCommentInOrgResponseReactions; updated_at: string; url: string }

      Type declaration

      TeamsUpdateDiscussionCommentInOrgResponseAuthor

      TeamsUpdateDiscussionCommentInOrgResponseAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      TeamsUpdateDiscussionCommentInOrgResponseReactions

      TeamsUpdateDiscussionCommentInOrgResponseReactions: { +1: number; -1: number; confused: number; heart: number; hooray: number; laugh: number; total_count: number; url: string }

      Type declaration

      • +1: number
      • -1: number
      • confused: number
      • heart: number
      • hooray: number
      • laugh: number
      • total_count: number
      • url: string

      TeamsUpdateDiscussionCommentLegacyParams

      TeamsUpdateDiscussionCommentLegacyParams: { body: string; comment_number: number; discussion_number: number; team_id: number }

      Type declaration

      • body: string

        The discussion comment's body text.

      • comment_number: number
      • discussion_number: number
      • team_id: number

      TeamsUpdateDiscussionCommentLegacyResponse

      TeamsUpdateDiscussionCommentLegacyResponse: { author: TeamsUpdateDiscussionCommentLegacyResponseAuthor; body: string; body_html: string; body_version: string; created_at: string; discussion_url: string; html_url: string; last_edited_at: string; node_id: string; number: number; reactions: TeamsUpdateDiscussionCommentLegacyResponseReactions; updated_at: string; url: string }

      Type declaration

      TeamsUpdateDiscussionCommentLegacyResponseAuthor

      TeamsUpdateDiscussionCommentLegacyResponseAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      TeamsUpdateDiscussionCommentLegacyResponseReactions

      TeamsUpdateDiscussionCommentLegacyResponseReactions: { +1: number; -1: number; confused: number; heart: number; hooray: number; laugh: number; total_count: number; url: string }

      Type declaration

      • +1: number
      • -1: number
      • confused: number
      • heart: number
      • hooray: number
      • laugh: number
      • total_count: number
      • url: string

      TeamsUpdateDiscussionCommentParams

      TeamsUpdateDiscussionCommentParams: { body: string; comment_number: number; discussion_number: number; team_id: number }

      Type declaration

      • body: string

        The discussion comment's body text.

      • comment_number: number
      • discussion_number: number
      • team_id: number

      TeamsUpdateDiscussionCommentResponse

      TeamsUpdateDiscussionCommentResponse: { author: TeamsUpdateDiscussionCommentResponseAuthor; body: string; body_html: string; body_version: string; created_at: string; discussion_url: string; html_url: string; last_edited_at: string; node_id: string; number: number; reactions: TeamsUpdateDiscussionCommentResponseReactions; updated_at: string; url: string }

      Type declaration

      TeamsUpdateDiscussionCommentResponseAuthor

      TeamsUpdateDiscussionCommentResponseAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      TeamsUpdateDiscussionCommentResponseReactions

      TeamsUpdateDiscussionCommentResponseReactions: { +1: number; -1: number; confused: number; heart: number; hooray: number; laugh: number; total_count: number; url: string }

      Type declaration

      • +1: number
      • -1: number
      • confused: number
      • heart: number
      • hooray: number
      • laugh: number
      • total_count: number
      • url: string

      TeamsUpdateDiscussionInOrgParams

      TeamsUpdateDiscussionInOrgParams: { body?: undefined | string; discussion_number: number; org: string; team_slug: string; title?: undefined | string }

      Type declaration

      • Optional body?: undefined | string

        The discussion post's body text.

      • discussion_number: number
      • org: string
      • team_slug: string
      • Optional title?: undefined | string

        The discussion post's title.

      TeamsUpdateDiscussionInOrgResponse

      TeamsUpdateDiscussionInOrgResponse: { author: TeamsUpdateDiscussionInOrgResponseAuthor; body: string; body_html: string; body_version: string; comments_count: number; comments_url: string; created_at: string; html_url: string; last_edited_at: string; node_id: string; number: number; pinned: boolean; private: boolean; reactions: TeamsUpdateDiscussionInOrgResponseReactions; team_url: string; title: string; updated_at: string; url: string }

      Type declaration

      TeamsUpdateDiscussionInOrgResponseAuthor

      TeamsUpdateDiscussionInOrgResponseAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      TeamsUpdateDiscussionInOrgResponseReactions

      TeamsUpdateDiscussionInOrgResponseReactions: { +1: number; -1: number; confused: number; heart: number; hooray: number; laugh: number; total_count: number; url: string }

      Type declaration

      • +1: number
      • -1: number
      • confused: number
      • heart: number
      • hooray: number
      • laugh: number
      • total_count: number
      • url: string

      TeamsUpdateDiscussionLegacyParams

      TeamsUpdateDiscussionLegacyParams: { body?: undefined | string; discussion_number: number; team_id: number; title?: undefined | string }

      Type declaration

      • Optional body?: undefined | string

        The discussion post's body text.

      • discussion_number: number
      • team_id: number
      • Optional title?: undefined | string

        The discussion post's title.

      TeamsUpdateDiscussionLegacyResponse

      TeamsUpdateDiscussionLegacyResponse: { author: TeamsUpdateDiscussionLegacyResponseAuthor; body: string; body_html: string; body_version: string; comments_count: number; comments_url: string; created_at: string; html_url: string; last_edited_at: string; node_id: string; number: number; pinned: boolean; private: boolean; reactions: TeamsUpdateDiscussionLegacyResponseReactions; team_url: string; title: string; updated_at: string; url: string }

      Type declaration

      TeamsUpdateDiscussionLegacyResponseAuthor

      TeamsUpdateDiscussionLegacyResponseAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      TeamsUpdateDiscussionLegacyResponseReactions

      TeamsUpdateDiscussionLegacyResponseReactions: { +1: number; -1: number; confused: number; heart: number; hooray: number; laugh: number; total_count: number; url: string }

      Type declaration

      • +1: number
      • -1: number
      • confused: number
      • heart: number
      • hooray: number
      • laugh: number
      • total_count: number
      • url: string

      TeamsUpdateDiscussionParams

      TeamsUpdateDiscussionParams: { body?: undefined | string; discussion_number: number; team_id: number; title?: undefined | string }

      Type declaration

      • Optional body?: undefined | string

        The discussion post's body text.

      • discussion_number: number
      • team_id: number
      • Optional title?: undefined | string

        The discussion post's title.

      TeamsUpdateDiscussionResponse

      TeamsUpdateDiscussionResponse: { author: TeamsUpdateDiscussionResponseAuthor; body: string; body_html: string; body_version: string; comments_count: number; comments_url: string; created_at: string; html_url: string; last_edited_at: string; node_id: string; number: number; pinned: boolean; private: boolean; reactions: TeamsUpdateDiscussionResponseReactions; team_url: string; title: string; updated_at: string; url: string }

      Type declaration

      • author: TeamsUpdateDiscussionResponseAuthor
      • body: string
      • body_html: string
      • body_version: string
      • comments_count: number
      • comments_url: string
      • created_at: string
      • html_url: string
      • last_edited_at: string
      • node_id: string
      • number: number
      • pinned: boolean
      • private: boolean
      • reactions: TeamsUpdateDiscussionResponseReactions
      • team_url: string
      • title: string
      • updated_at: string
      • url: string

      TeamsUpdateDiscussionResponseAuthor

      TeamsUpdateDiscussionResponseAuthor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      TeamsUpdateDiscussionResponseReactions

      TeamsUpdateDiscussionResponseReactions: { +1: number; -1: number; confused: number; heart: number; hooray: number; laugh: number; total_count: number; url: string }

      Type declaration

      • +1: number
      • -1: number
      • confused: number
      • heart: number
      • hooray: number
      • laugh: number
      • total_count: number
      • url: string

      TeamsUpdateInOrgParams

      TeamsUpdateInOrgParams: { description?: undefined | string; name: string; org: string; parent_team_id?: undefined | number; privacy?: "secret" | "closed"; team_slug: string }

      Type declaration

      • Optional description?: undefined | string

        The description of the team.

      • name: string

        The name of the team.

      • org: string
      • Optional parent_team_id?: undefined | number

        The ID of a team to set as the parent team.

      • Optional privacy?: "secret" | "closed"

        The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. When a team is nested, the privacy for parent teams cannot be secret. The options are: For a non-nested team: * secret - only visible to organization owners and members of this team. * closed - visible to all members of this organization. For a parent or child team: * closed - visible to all members of this organization.

      • team_slug: string

      TeamsUpdateInOrgParamsDeprecatedPermission

      TeamsUpdateInOrgParamsDeprecatedPermission: { description?: undefined | string; name: string; org: string; parent_team_id?: undefined | number; permission?: undefined | string; privacy?: "secret" | "closed"; team_slug: string }

      Type declaration

      • Optional description?: undefined | string

        The description of the team.

      • name: string

        The name of the team.

      • org: string
      • Optional parent_team_id?: undefined | number

        The ID of a team to set as the parent team.

      • Optional permission?: undefined | string

        Deprecated. The permission that new repositories will be added to the team with when none is specified. Can be one of: * pull - team members can pull, but not push to or administer newly-added repositories. * push - team members can pull and push, but not administer newly-added repositories. * admin - team members can pull, push and administer newly-added repositories.

        deprecated

        "permission" parameter has been deprecated and will be removed in future

      • Optional privacy?: "secret" | "closed"

        The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. When a team is nested, the privacy for parent teams cannot be secret. The options are: For a non-nested team: * secret - only visible to organization owners and members of this team. * closed - visible to all members of this organization. For a parent or child team: * closed - visible to all members of this organization.

      • team_slug: string

      TeamsUpdateInOrgResponse

      TeamsUpdateInOrgResponse: { created_at: string; description: string; html_url: string; id: number; members_count: number; members_url: string; name: string; node_id: string; organization: TeamsUpdateInOrgResponseOrganization; parent: null; permission: string; privacy: string; repos_count: number; repositories_url: string; slug: string; updated_at: string; url: string }

      Type declaration

      • created_at: string
      • description: string
      • html_url: string
      • id: number
      • members_count: number
      • members_url: string
      • name: string
      • node_id: string
      • organization: TeamsUpdateInOrgResponseOrganization
      • parent: null
      • permission: string
      • privacy: string
      • repos_count: number
      • repositories_url: string
      • slug: string
      • updated_at: string
      • url: string

      TeamsUpdateInOrgResponseOrganization

      TeamsUpdateInOrgResponseOrganization: { avatar_url: string; blog: string; company: string; created_at: string; description: string; email: string; events_url: string; followers: number; following: number; has_organization_projects: boolean; has_repository_projects: boolean; hooks_url: string; html_url: string; id: number; is_verified: boolean; issues_url: string; location: string; login: string; members_url: string; name: string; node_id: string; public_gists: number; public_members_url: string; public_repos: number; repos_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • blog: string
      • company: string
      • created_at: string
      • description: string
      • email: string
      • events_url: string
      • followers: number
      • following: number
      • has_organization_projects: boolean
      • has_repository_projects: boolean
      • hooks_url: string
      • html_url: string
      • id: number
      • is_verified: boolean
      • issues_url: string
      • location: string
      • login: string
      • members_url: string
      • name: string
      • node_id: string
      • public_gists: number
      • public_members_url: string
      • public_repos: number
      • repos_url: string
      • type: string
      • url: string

      TeamsUpdateLegacyParams

      TeamsUpdateLegacyParams: { description?: undefined | string; name: string; parent_team_id?: undefined | number; privacy?: "secret" | "closed"; team_id: number }

      Type declaration

      • Optional description?: undefined | string

        The description of the team.

      • name: string

        The name of the team.

      • Optional parent_team_id?: undefined | number

        The ID of a team to set as the parent team.

      • Optional privacy?: "secret" | "closed"

        The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. The options are: For a non-nested team: * secret - only visible to organization owners and members of this team. * closed - visible to all members of this organization. For a parent or child team: * closed - visible to all members of this organization.

      • team_id: number

      TeamsUpdateLegacyParamsDeprecatedPermission

      TeamsUpdateLegacyParamsDeprecatedPermission: { description?: undefined | string; name: string; parent_team_id?: undefined | number; permission?: undefined | string; privacy?: "secret" | "closed"; team_id: number }

      Type declaration

      • Optional description?: undefined | string

        The description of the team.

      • name: string

        The name of the team.

      • Optional parent_team_id?: undefined | number

        The ID of a team to set as the parent team.

      • Optional permission?: undefined | string

        Deprecated. The permission that new repositories will be added to the team with when none is specified. Can be one of: * pull - team members can pull, but not push to or administer newly-added repositories. * push - team members can pull and push, but not administer newly-added repositories. * admin - team members can pull, push and administer newly-added repositories.

        deprecated

        "permission" parameter has been deprecated and will be removed in future

      • Optional privacy?: "secret" | "closed"

        The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. The options are: For a non-nested team: * secret - only visible to organization owners and members of this team. * closed - visible to all members of this organization. For a parent or child team: * closed - visible to all members of this organization.

      • team_id: number

      TeamsUpdateLegacyResponse

      TeamsUpdateLegacyResponse: { created_at: string; description: string; html_url: string; id: number; members_count: number; members_url: string; name: string; node_id: string; organization: TeamsUpdateLegacyResponseOrganization; parent: null; permission: string; privacy: string; repos_count: number; repositories_url: string; slug: string; updated_at: string; url: string }

      Type declaration

      • created_at: string
      • description: string
      • html_url: string
      • id: number
      • members_count: number
      • members_url: string
      • name: string
      • node_id: string
      • organization: TeamsUpdateLegacyResponseOrganization
      • parent: null
      • permission: string
      • privacy: string
      • repos_count: number
      • repositories_url: string
      • slug: string
      • updated_at: string
      • url: string

      TeamsUpdateLegacyResponseOrganization

      TeamsUpdateLegacyResponseOrganization: { avatar_url: string; blog: string; company: string; created_at: string; description: string; email: string; events_url: string; followers: number; following: number; has_organization_projects: boolean; has_repository_projects: boolean; hooks_url: string; html_url: string; id: number; is_verified: boolean; issues_url: string; location: string; login: string; members_url: string; name: string; node_id: string; public_gists: number; public_members_url: string; public_repos: number; repos_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • blog: string
      • company: string
      • created_at: string
      • description: string
      • email: string
      • events_url: string
      • followers: number
      • following: number
      • has_organization_projects: boolean
      • has_repository_projects: boolean
      • hooks_url: string
      • html_url: string
      • id: number
      • is_verified: boolean
      • issues_url: string
      • location: string
      • login: string
      • members_url: string
      • name: string
      • node_id: string
      • public_gists: number
      • public_members_url: string
      • public_repos: number
      • repos_url: string
      • type: string
      • url: string

      TeamsUpdateParams

      TeamsUpdateParams: { description?: undefined | string; name: string; parent_team_id?: undefined | number; privacy?: "secret" | "closed"; team_id: number }

      Type declaration

      • Optional description?: undefined | string

        The description of the team.

      • name: string

        The name of the team.

      • Optional parent_team_id?: undefined | number

        The ID of a team to set as the parent team.

      • Optional privacy?: "secret" | "closed"

        The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. The options are: For a non-nested team: * secret - only visible to organization owners and members of this team. * closed - visible to all members of this organization. For a parent or child team: * closed - visible to all members of this organization.

      • team_id: number

      TeamsUpdateParamsDeprecatedPermission

      TeamsUpdateParamsDeprecatedPermission: { description?: undefined | string; name: string; parent_team_id?: undefined | number; permission?: undefined | string; privacy?: "secret" | "closed"; team_id: number }

      Type declaration

      • Optional description?: undefined | string

        The description of the team.

      • name: string

        The name of the team.

      • Optional parent_team_id?: undefined | number

        The ID of a team to set as the parent team.

      • Optional permission?: undefined | string

        Deprecated. The permission that new repositories will be added to the team with when none is specified. Can be one of: * pull - team members can pull, but not push to or administer newly-added repositories. * push - team members can pull and push, but not administer newly-added repositories. * admin - team members can pull, push and administer newly-added repositories.

        deprecated

        "permission" parameter has been deprecated and will be removed in future

      • Optional privacy?: "secret" | "closed"

        The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. The options are: For a non-nested team: * secret - only visible to organization owners and members of this team. * closed - visible to all members of this organization. For a parent or child team: * closed - visible to all members of this organization.

      • team_id: number

      TeamsUpdateResponse

      TeamsUpdateResponse: { created_at: string; description: string; html_url: string; id: number; members_count: number; members_url: string; name: string; node_id: string; organization: TeamsUpdateResponseOrganization; parent: null; permission: string; privacy: string; repos_count: number; repositories_url: string; slug: string; updated_at: string; url: string }

      Type declaration

      • created_at: string
      • description: string
      • html_url: string
      • id: number
      • members_count: number
      • members_url: string
      • name: string
      • node_id: string
      • organization: TeamsUpdateResponseOrganization
      • parent: null
      • permission: string
      • privacy: string
      • repos_count: number
      • repositories_url: string
      • slug: string
      • updated_at: string
      • url: string

      TeamsUpdateResponseOrganization

      TeamsUpdateResponseOrganization: { avatar_url: string; blog: string; company: string; created_at: string; description: string; email: string; events_url: string; followers: number; following: number; has_organization_projects: boolean; has_repository_projects: boolean; hooks_url: string; html_url: string; id: number; is_verified: boolean; issues_url: string; location: string; login: string; members_url: string; name: string; node_id: string; public_gists: number; public_members_url: string; public_repos: number; repos_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • blog: string
      • company: string
      • created_at: string
      • description: string
      • email: string
      • events_url: string
      • followers: number
      • following: number
      • has_organization_projects: boolean
      • has_repository_projects: boolean
      • hooks_url: string
      • html_url: string
      • id: number
      • is_verified: boolean
      • issues_url: string
      • location: string
      • login: string
      • members_url: string
      • name: string
      • node_id: string
      • public_gists: number
      • public_members_url: string
      • public_repos: number
      • repos_url: string
      • type: string
      • url: string

      UsersAddEmailsParams

      UsersAddEmailsParams: { emails: string[] }

      Type declaration

      • emails: string[]

        Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

      UsersAddEmailsResponse

      UsersAddEmailsResponse: Array<UsersAddEmailsResponseItem>

      UsersAddEmailsResponseItem

      UsersAddEmailsResponseItem: { email: string; primary: boolean; verified: boolean; visibility: string | null }

      Type declaration

      • email: string
      • primary: boolean
      • verified: boolean
      • visibility: string | null

      UsersBlockParams

      UsersBlockParams: { username: string }

      Type declaration

      • username: string

      UsersCheckBlockedParams

      UsersCheckBlockedParams: { username: string }

      Type declaration

      • username: string

      UsersCheckFollowingForUserParams

      UsersCheckFollowingForUserParams: { target_user: string; username: string }

      Type declaration

      • target_user: string
      • username: string

      UsersCheckFollowingParams

      UsersCheckFollowingParams: { username: string }

      Type declaration

      • username: string

      UsersCreateGpgKeyParams

      UsersCreateGpgKeyParams: { armored_public_key?: undefined | string }

      Type declaration

      • Optional armored_public_key?: undefined | string

        Your GPG key, generated in ASCII-armored format. See "Generating a new GPG key" for help creating a GPG key.

      UsersCreateGpgKeyResponse

      UsersCreateGpgKeyResponse: { can_certify: boolean; can_encrypt_comms: boolean; can_encrypt_storage: boolean; can_sign: boolean; created_at: string; emails: Array<UsersCreateGpgKeyResponseEmailsItem>; expires_at: null; id: number; key_id: string; primary_key_id: null; public_key: string; subkeys: Array<UsersCreateGpgKeyResponseSubkeysItem> }

      Type declaration

      UsersCreateGpgKeyResponseEmailsItem

      UsersCreateGpgKeyResponseEmailsItem: { email: string; verified: boolean }

      Type declaration

      • email: string
      • verified: boolean

      UsersCreateGpgKeyResponseSubkeysItem

      UsersCreateGpgKeyResponseSubkeysItem: { can_certify: boolean; can_encrypt_comms: boolean; can_encrypt_storage: boolean; can_sign: boolean; created_at: string; emails: Array<any>; expires_at: null; id: number; key_id: string; primary_key_id: number; public_key: string; subkeys: Array<any> }

      Type declaration

      • can_certify: boolean
      • can_encrypt_comms: boolean
      • can_encrypt_storage: boolean
      • can_sign: boolean
      • created_at: string
      • emails: Array<any>
      • expires_at: null
      • id: number
      • key_id: string
      • primary_key_id: number
      • public_key: string
      • subkeys: Array<any>

      UsersCreatePublicKeyParams

      UsersCreatePublicKeyParams: { key?: undefined | string; title?: undefined | string }

      Type declaration

      • Optional key?: undefined | string

        The public SSH key to add to your GitHub account. See "Generating a new SSH key" for guidance on how to create a public SSH key.

      • Optional title?: undefined | string

        A descriptive name for the new key. Use a name that will help you recognize this key in your GitHub account. For example, if you're using a personal Mac, you might call this key "Personal MacBook Air".

      UsersCreatePublicKeyResponse

      UsersCreatePublicKeyResponse: { key: string; key_id: string }

      Type declaration

      • key: string
      • key_id: string

      UsersDeleteEmailsParams

      UsersDeleteEmailsParams: { emails: string[] }

      Type declaration

      • emails: string[]

        Deletes one or more email addresses from your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

      UsersDeleteGpgKeyParams

      UsersDeleteGpgKeyParams: { gpg_key_id: number }

      Type declaration

      • gpg_key_id: number

      UsersDeletePublicKeyParams

      UsersDeletePublicKeyParams: { key_id: number }

      Type declaration

      • key_id: number

      UsersFollowParams

      UsersFollowParams: { username: string }

      Type declaration

      • username: string

      UsersGetAuthenticatedResponse

      UsersGetAuthenticatedResponse: { avatar_url: string; bio: string; blog: string; collaborators?: undefined | number; company: string; created_at: string; disk_usage?: undefined | number; email: string; events_url: string; followers: number; followers_url: string; following: number; following_url: string; gists_url: string; gravatar_id: string; hireable: boolean; html_url: string; id: number; location: string; login: string; name: string; node_id: string; organizations_url: string; owned_private_repos?: undefined | number; plan?: UsersGetAuthenticatedResponsePlan; private_gists?: undefined | number; public_gists: number; public_repos: number; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; total_private_repos?: undefined | number; two_factor_authentication?: undefined | false | true; type: string; updated_at: string; url: string }

      Type declaration

      • avatar_url: string
      • bio: string
      • blog: string
      • Optional collaborators?: undefined | number
      • company: string
      • created_at: string
      • Optional disk_usage?: undefined | number
      • email: string
      • events_url: string
      • followers: number
      • followers_url: string
      • following: number
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • hireable: boolean
      • html_url: string
      • id: number
      • location: string
      • login: string
      • name: string
      • node_id: string
      • organizations_url: string
      • Optional owned_private_repos?: undefined | number
      • Optional plan?: UsersGetAuthenticatedResponsePlan
      • Optional private_gists?: undefined | number
      • public_gists: number
      • public_repos: number
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • Optional total_private_repos?: undefined | number
      • Optional two_factor_authentication?: undefined | false | true
      • type: string
      • updated_at: string
      • url: string

      UsersGetAuthenticatedResponsePlan

      UsersGetAuthenticatedResponsePlan: { collaborators: number; name: string; private_repos: number; space: number }

      Type declaration

      • collaborators: number
      • name: string
      • private_repos: number
      • space: number

      UsersGetByUsernameParams

      UsersGetByUsernameParams: { username: string }

      Type declaration

      • username: string

      UsersGetByUsernameResponse

      UsersGetByUsernameResponse: { avatar_url: string; bio: string; blog: string; company: string; created_at: string; email: string; events_url: string; followers: number; followers_url: string; following: number; following_url: string; gists_url: string; gravatar_id: string; hireable: boolean; html_url: string; id: number; location: string; login: string; name: string; node_id: string; organizations_url: string; plan?: UsersGetByUsernameResponsePlan; public_gists: number; public_repos: number; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; updated_at: string; url: string }

      Type declaration

      • avatar_url: string
      • bio: string
      • blog: string
      • company: string
      • created_at: string
      • email: string
      • events_url: string
      • followers: number
      • followers_url: string
      • following: number
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • hireable: boolean
      • html_url: string
      • id: number
      • location: string
      • login: string
      • name: string
      • node_id: string
      • organizations_url: string
      • Optional plan?: UsersGetByUsernameResponsePlan
      • public_gists: number
      • public_repos: number
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • updated_at: string
      • url: string

      UsersGetByUsernameResponsePlan

      UsersGetByUsernameResponsePlan: { collaborators: number; name: string; private_repos: number; space: number }

      Type declaration

      • collaborators: number
      • name: string
      • private_repos: number
      • space: number

      UsersGetContextForUserParams

      UsersGetContextForUserParams: { subject_id?: undefined | string; subject_type?: "organization" | "repository" | "issue" | "pull_request"; username: string }

      Type declaration

      • Optional subject_id?: undefined | string

        Uses the ID for the subject_type you specified. Required when using subject_type.

      • Optional subject_type?: "organization" | "repository" | "issue" | "pull_request"

        Identifies which additional information you'd like to receive about the person's hovercard. Can be organization, repository, issue, pull_request. Required when using subject_id.

      • username: string

      UsersGetContextForUserResponse

      UsersGetContextForUserResponse: { contexts: Array<UsersGetContextForUserResponseContextsItem> }

      Type declaration

      UsersGetContextForUserResponseContextsItem

      UsersGetContextForUserResponseContextsItem: { message: string; octicon: string }

      Type declaration

      • message: string
      • octicon: string

      UsersGetGpgKeyParams

      UsersGetGpgKeyParams: { gpg_key_id: number }

      Type declaration

      • gpg_key_id: number

      UsersGetGpgKeyResponse

      UsersGetGpgKeyResponse: { can_certify: boolean; can_encrypt_comms: boolean; can_encrypt_storage: boolean; can_sign: boolean; created_at: string; emails: Array<UsersGetGpgKeyResponseEmailsItem>; expires_at: null; id: number; key_id: string; primary_key_id: null; public_key: string; subkeys: Array<UsersGetGpgKeyResponseSubkeysItem> }

      Type declaration

      UsersGetGpgKeyResponseEmailsItem

      UsersGetGpgKeyResponseEmailsItem: { email: string; verified: boolean }

      Type declaration

      • email: string
      • verified: boolean

      UsersGetGpgKeyResponseSubkeysItem

      UsersGetGpgKeyResponseSubkeysItem: { can_certify: boolean; can_encrypt_comms: boolean; can_encrypt_storage: boolean; can_sign: boolean; created_at: string; emails: Array<any>; expires_at: null; id: number; key_id: string; primary_key_id: number; public_key: string; subkeys: Array<any> }

      Type declaration

      • can_certify: boolean
      • can_encrypt_comms: boolean
      • can_encrypt_storage: boolean
      • can_sign: boolean
      • created_at: string
      • emails: Array<any>
      • expires_at: null
      • id: number
      • key_id: string
      • primary_key_id: number
      • public_key: string
      • subkeys: Array<any>

      UsersGetPublicKeyParams

      UsersGetPublicKeyParams: { key_id: number }

      Type declaration

      • key_id: number

      UsersGetPublicKeyResponse

      UsersGetPublicKeyResponse: { key: string; key_id: string }

      Type declaration

      • key: string
      • key_id: string

      UsersListBlockedResponse

      UsersListBlockedResponse: Array<UsersListBlockedResponseItem>

      UsersListBlockedResponseItem

      UsersListBlockedResponseItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      UsersListEmailsParams

      UsersListEmailsParams: { page?: undefined | number; per_page?: undefined | number }

      Type declaration

      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      UsersListEmailsResponse

      UsersListEmailsResponse: Array<UsersListEmailsResponseItem>

      UsersListEmailsResponseItem

      UsersListEmailsResponseItem: { email: string; primary: boolean; verified: boolean; visibility: string }

      Type declaration

      • email: string
      • primary: boolean
      • verified: boolean
      • visibility: string

      UsersListFollowersForAuthenticatedUserParams

      UsersListFollowersForAuthenticatedUserParams: { page?: undefined | number; per_page?: undefined | number }

      Type declaration

      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      UsersListFollowersForAuthenticatedUserResponse

      UsersListFollowersForAuthenticatedUserResponse: Array<UsersListFollowersForAuthenticatedUserResponseItem>

      UsersListFollowersForAuthenticatedUserResponseItem

      UsersListFollowersForAuthenticatedUserResponseItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      UsersListFollowersForUserParams

      UsersListFollowersForUserParams: { page?: undefined | number; per_page?: undefined | number; username: string }

      Type declaration

      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • username: string

      UsersListFollowersForUserResponse

      UsersListFollowersForUserResponse: Array<UsersListFollowersForUserResponseItem>

      UsersListFollowersForUserResponseItem

      UsersListFollowersForUserResponseItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      UsersListFollowingForAuthenticatedUserParams

      UsersListFollowingForAuthenticatedUserParams: { page?: undefined | number; per_page?: undefined | number }

      Type declaration

      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      UsersListFollowingForAuthenticatedUserResponse

      UsersListFollowingForAuthenticatedUserResponse: Array<UsersListFollowingForAuthenticatedUserResponseItem>

      UsersListFollowingForAuthenticatedUserResponseItem

      UsersListFollowingForAuthenticatedUserResponseItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      UsersListFollowingForUserParams

      UsersListFollowingForUserParams: { page?: undefined | number; per_page?: undefined | number; username: string }

      Type declaration

      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • username: string

      UsersListFollowingForUserResponse

      UsersListFollowingForUserResponse: Array<UsersListFollowingForUserResponseItem>

      UsersListFollowingForUserResponseItem

      UsersListFollowingForUserResponseItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      UsersListGpgKeysForUserParams

      UsersListGpgKeysForUserParams: { page?: undefined | number; per_page?: undefined | number; username: string }

      Type declaration

      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • username: string

      UsersListGpgKeysForUserResponse

      UsersListGpgKeysForUserResponse: Array<UsersListGpgKeysForUserResponseItem>

      UsersListGpgKeysForUserResponseItem

      UsersListGpgKeysForUserResponseItem: { can_certify: boolean; can_encrypt_comms: boolean; can_encrypt_storage: boolean; can_sign: boolean; created_at: string; emails: Array<UsersListGpgKeysForUserResponseItemEmailsItem>; expires_at: null; id: number; key_id: string; primary_key_id: null; public_key: string; subkeys: Array<UsersListGpgKeysForUserResponseItemSubkeysItem> }

      Type declaration

      UsersListGpgKeysForUserResponseItemEmailsItem

      UsersListGpgKeysForUserResponseItemEmailsItem: { email: string; verified: boolean }

      Type declaration

      • email: string
      • verified: boolean

      UsersListGpgKeysForUserResponseItemSubkeysItem

      UsersListGpgKeysForUserResponseItemSubkeysItem: { can_certify: boolean; can_encrypt_comms: boolean; can_encrypt_storage: boolean; can_sign: boolean; created_at: string; emails: Array<any>; expires_at: null; id: number; key_id: string; primary_key_id: number; public_key: string; subkeys: Array<any> }

      Type declaration

      • can_certify: boolean
      • can_encrypt_comms: boolean
      • can_encrypt_storage: boolean
      • can_sign: boolean
      • created_at: string
      • emails: Array<any>
      • expires_at: null
      • id: number
      • key_id: string
      • primary_key_id: number
      • public_key: string
      • subkeys: Array<any>

      UsersListGpgKeysParams

      UsersListGpgKeysParams: { page?: undefined | number; per_page?: undefined | number }

      Type declaration

      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      UsersListGpgKeysResponse

      UsersListGpgKeysResponse: Array<UsersListGpgKeysResponseItem>

      UsersListGpgKeysResponseItem

      UsersListGpgKeysResponseItem: { can_certify: boolean; can_encrypt_comms: boolean; can_encrypt_storage: boolean; can_sign: boolean; created_at: string; emails: Array<UsersListGpgKeysResponseItemEmailsItem>; expires_at: null; id: number; key_id: string; primary_key_id: null; public_key: string; subkeys: Array<UsersListGpgKeysResponseItemSubkeysItem> }

      Type declaration

      UsersListGpgKeysResponseItemEmailsItem

      UsersListGpgKeysResponseItemEmailsItem: { email: string; verified: boolean }

      Type declaration

      • email: string
      • verified: boolean

      UsersListGpgKeysResponseItemSubkeysItem

      UsersListGpgKeysResponseItemSubkeysItem: { can_certify: boolean; can_encrypt_comms: boolean; can_encrypt_storage: boolean; can_sign: boolean; created_at: string; emails: Array<any>; expires_at: null; id: number; key_id: string; primary_key_id: number; public_key: string; subkeys: Array<any> }

      Type declaration

      • can_certify: boolean
      • can_encrypt_comms: boolean
      • can_encrypt_storage: boolean
      • can_sign: boolean
      • created_at: string
      • emails: Array<any>
      • expires_at: null
      • id: number
      • key_id: string
      • primary_key_id: number
      • public_key: string
      • subkeys: Array<any>

      UsersListParams

      UsersListParams: { page?: undefined | number; per_page?: undefined | number; since?: undefined | string }

      Type declaration

      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • Optional since?: undefined | string

        The integer ID of the last User that you've seen.

      UsersListPublicEmailsParams

      UsersListPublicEmailsParams: { page?: undefined | number; per_page?: undefined | number }

      Type declaration

      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      UsersListPublicEmailsResponse

      UsersListPublicEmailsResponse: Array<UsersListPublicEmailsResponseItem>

      UsersListPublicEmailsResponseItem

      UsersListPublicEmailsResponseItem: { email: string; primary: boolean; verified: boolean; visibility: string }

      Type declaration

      • email: string
      • primary: boolean
      • verified: boolean
      • visibility: string

      UsersListPublicKeysForUserParams

      UsersListPublicKeysForUserParams: { page?: undefined | number; per_page?: undefined | number; username: string }

      Type declaration

      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      • username: string

      UsersListPublicKeysForUserResponse

      UsersListPublicKeysForUserResponse: Array<UsersListPublicKeysForUserResponseItem>

      UsersListPublicKeysForUserResponseItem

      UsersListPublicKeysForUserResponseItem: { id: number; key: string }

      Type declaration

      • id: number
      • key: string

      UsersListPublicKeysParams

      UsersListPublicKeysParams: { page?: undefined | number; per_page?: undefined | number }

      Type declaration

      • Optional page?: undefined | number

        Page number of the results to fetch.

      • Optional per_page?: undefined | number

        Results per page (max 100)

      UsersListPublicKeysResponse

      UsersListPublicKeysResponse: Array<UsersListPublicKeysResponseItem>

      UsersListPublicKeysResponseItem

      UsersListPublicKeysResponseItem: { key: string; key_id: string }

      Type declaration

      • key: string
      • key_id: string

      UsersListResponse

      UsersListResponse: Array<UsersListResponseItem>

      UsersListResponseItem

      UsersListResponseItem: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }

      Type declaration

      • avatar_url: string
      • events_url: string
      • followers_url: string
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • html_url: string
      • id: number
      • login: string
      • node_id: string
      • organizations_url: string
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • type: string
      • url: string

      UsersTogglePrimaryEmailVisibilityParams

      UsersTogglePrimaryEmailVisibilityParams: { email: string; visibility: string }

      Type declaration

      • email: string

        Specify the primary email address that needs a visibility change.

      • visibility: string

        Use public to enable an authenticated user to view the specified email address, or use private so this primary email address cannot be seen publicly.

      UsersTogglePrimaryEmailVisibilityResponse

      UsersTogglePrimaryEmailVisibilityResponse: Array<UsersTogglePrimaryEmailVisibilityResponseItem>

      UsersTogglePrimaryEmailVisibilityResponseItem

      UsersTogglePrimaryEmailVisibilityResponseItem: { email: string; primary: boolean; verified: boolean; visibility: string }

      Type declaration

      • email: string
      • primary: boolean
      • verified: boolean
      • visibility: string

      UsersUnblockParams

      UsersUnblockParams: { username: string }

      Type declaration

      • username: string

      UsersUnfollowParams

      UsersUnfollowParams: { username: string }

      Type declaration

      • username: string

      UsersUpdateAuthenticatedParams

      UsersUpdateAuthenticatedParams: { bio?: undefined | string; blog?: undefined | string; company?: undefined | string; email?: undefined | string; hireable?: undefined | false | true; location?: undefined | string; name?: undefined | string }

      Type declaration

      • Optional bio?: undefined | string

        The new short biography of the user.

      • Optional blog?: undefined | string

        The new blog URL of the user.

      • Optional company?: undefined | string

        The new company of the user.

      • Optional email?: undefined | string

        The publicly visible email address of the user.

      • Optional hireable?: undefined | false | true

        The new hiring availability of the user.

      • Optional location?: undefined | string

        The new location of the user.

      • Optional name?: undefined | string

        The new name of the user.

      UsersUpdateAuthenticatedResponse

      UsersUpdateAuthenticatedResponse: { avatar_url: string; bio: string; blog: string; collaborators: number; company: string; created_at: string; disk_usage: number; email: string; events_url: string; followers: number; followers_url: string; following: number; following_url: string; gists_url: string; gravatar_id: string; hireable: boolean; html_url: string; id: number; location: string; login: string; name: string; node_id: string; organizations_url: string; owned_private_repos: number; plan: UsersUpdateAuthenticatedResponsePlan; private_gists: number; public_gists: number; public_repos: number; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; total_private_repos: number; two_factor_authentication: boolean; type: string; updated_at: string; url: string }

      Type declaration

      • avatar_url: string
      • bio: string
      • blog: string
      • collaborators: number
      • company: string
      • created_at: string
      • disk_usage: number
      • email: string
      • events_url: string
      • followers: number
      • followers_url: string
      • following: number
      • following_url: string
      • gists_url: string
      • gravatar_id: string
      • hireable: boolean
      • html_url: string
      • id: number
      • location: string
      • login: string
      • name: string
      • node_id: string
      • organizations_url: string
      • owned_private_repos: number
      • plan: UsersUpdateAuthenticatedResponsePlan
      • private_gists: number
      • public_gists: number
      • public_repos: number
      • received_events_url: string
      • repos_url: string
      • site_admin: boolean
      • starred_url: string
      • subscriptions_url: string
      • total_private_repos: number
      • two_factor_authentication: boolean
      • type: string
      • updated_at: string
      • url: string

      UsersUpdateAuthenticatedResponsePlan

      UsersUpdateAuthenticatedResponsePlan: { collaborators: number; name: string; private_repos: number; space: number }

      Type declaration

      • collaborators: number
      • name: string
      • private_repos: number
      • space: number

      date

      date: string

      json

      json: any

      Constructors

      constructor

      • new GitHubAPI(options?: Octokit.Options): GitHubAPI

      • Parameters

        • Optional options: Octokit.Options

        Returns GitHubAPI

      Properties

      actions

      actions: { cancelWorkflowRun: { endpoint: Endpoint }; createOrUpdateSecretForRepo: { endpoint: Endpoint }; createRegistrationToken: { endpoint: Endpoint }; createRemoveToken: { endpoint: Endpoint }; deleteArtifact: { endpoint: Endpoint }; deleteSecretFromRepo: { endpoint: Endpoint }; downloadArtifact: { endpoint: Endpoint }; getArtifact: { endpoint: Endpoint }; getPublicKey: { endpoint: Endpoint }; getSecret: { endpoint: Endpoint }; getSelfHostedRunner: { endpoint: Endpoint }; getWorkflow: { endpoint: Endpoint }; getWorkflowJob: { endpoint: Endpoint }; getWorkflowRun: { endpoint: Endpoint }; listDownloadsForSelfHostedRunnerApplication: { endpoint: Endpoint }; listJobsForWorkflowRun: { endpoint: Endpoint }; listRepoWorkflowRuns: { endpoint: Endpoint }; listRepoWorkflows: { endpoint: Endpoint }; listSecretsForRepo: { endpoint: Endpoint }; listSelfHostedRunnersForRepo: { endpoint: Endpoint }; listWorkflowJobLogs: { endpoint: Endpoint }; listWorkflowRunArtifacts: { endpoint: Endpoint }; listWorkflowRunLogs: { endpoint: Endpoint }; listWorkflowRuns: { endpoint: Endpoint }; reRunWorkflow: { endpoint: Endpoint }; removeSelfHostedRunner: { endpoint: Endpoint } }

      Type declaration

      • cancelWorkflowRun: { endpoint: Endpoint }

        Cancels a workflow run using its id. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the actions permission to use this endpoint.

          • (params?: RequestOptions & Octokit.ActionsCancelWorkflowRunParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActionsCancelWorkflowRunParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • createOrUpdateSecretForRepo: { endpoint: Endpoint }

        Creates or updates a secret with an encrypted value. Encrypt your secret using LibSodium. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the secrets permission to use this endpoint.

        Encrypt your secret using the tweetsodium library.

        Encrypt your secret using pynacl with Python 3.

        Encrypt your secret using the Sodium.Core package.

        Encrypt your secret using the rbnacl gem.

          • (params?: RequestOptions & Octokit.ActionsCreateOrUpdateSecretForRepoParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActionsCreateOrUpdateSecretForRepoParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • createRegistrationToken: { endpoint: Endpoint }

        Returns a token that you can pass to the config script. The token expires after one hour. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the administration permission to use this endpoint.

        Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

          • (params?: RequestOptions & Octokit.ActionsCreateRegistrationTokenParams): Promise<Response<Octokit.ActionsCreateRegistrationTokenResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActionsCreateRegistrationTokenParams

            Returns Promise<Response<Octokit.ActionsCreateRegistrationTokenResponse>>

        • endpoint: Endpoint
      • createRemoveToken: { endpoint: Endpoint }

        Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the administration permission to use this endpoint.

        Remove your self-hosted runner from a repository, replacing TOKEN with the remove token provided by this endpoint.

          • (params?: RequestOptions & Octokit.ActionsCreateRemoveTokenParams): Promise<Response<Octokit.ActionsCreateRemoveTokenResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActionsCreateRemoveTokenParams

            Returns Promise<Response<Octokit.ActionsCreateRemoveTokenResponse>>

        • endpoint: Endpoint
      • deleteArtifact: { endpoint: Endpoint }

        Deletes an artifact for a workflow run. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the actions permission to use this endpoint.

          • (params?: RequestOptions & Octokit.ActionsDeleteArtifactParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActionsDeleteArtifactParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • deleteSecretFromRepo: { endpoint: Endpoint }

        Deletes a secret in a repository using the secret name. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the secrets permission to use this endpoint.

          • (params?: RequestOptions & Octokit.ActionsDeleteSecretFromRepoParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActionsDeleteSecretFromRepoParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • downloadArtifact: { endpoint: Endpoint }

        Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for Location: in the response header to find the URL for the download. The :archive_format must be zip. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the actions permission to use this endpoint.

        Call this endpoint using the -v flag, which enables verbose output and allows you to see the download URL in the header. To download the file into the current working directory, specify the filename using the -o flag.

          • (params?: RequestOptions & Octokit.ActionsDownloadArtifactParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActionsDownloadArtifactParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • getArtifact: { endpoint: Endpoint }

        Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the actions permission to use this endpoint.

          • (params?: RequestOptions & Octokit.ActionsGetArtifactParams): Promise<Response<Octokit.ActionsGetArtifactResponse>>

          • Parameters

            Returns Promise<Response<Octokit.ActionsGetArtifactResponse>>

        • endpoint: Endpoint
      • getPublicKey: { endpoint: Endpoint }

        Gets your public key, which you must store. You need your public key to use other secrets endpoints. Use the returned key to encrypt your secrets. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the secrets permission to use this endpoint.

          • (params?: RequestOptions & Octokit.ActionsGetPublicKeyParams): Promise<Response<Octokit.ActionsGetPublicKeyResponse>>

          • Parameters

            Returns Promise<Response<Octokit.ActionsGetPublicKeyResponse>>

        • endpoint: Endpoint
      • getSecret: { endpoint: Endpoint }

        Gets a single secret without revealing its encrypted value. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the secrets permission to use this endpoint.

          • (params?: RequestOptions & Octokit.ActionsGetSecretParams): Promise<Response<Octokit.ActionsGetSecretResponse>>

          • Parameters

            Returns Promise<Response<Octokit.ActionsGetSecretResponse>>

        • endpoint: Endpoint
      • getSelfHostedRunner: { endpoint: Endpoint }

        Gets a specific self-hosted runner. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the administration permission to use this endpoint.

          • (params?: RequestOptions & Octokit.ActionsGetSelfHostedRunnerParams): Promise<Response<Octokit.ActionsGetSelfHostedRunnerResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActionsGetSelfHostedRunnerParams

            Returns Promise<Response<Octokit.ActionsGetSelfHostedRunnerResponse>>

        • endpoint: Endpoint
      • getWorkflow: { endpoint: Endpoint }

        Gets a specific workflow. You can also replace :workflow_id with :workflow_file_name. For example, you could use main.yml. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the actions permission to use this endpoint.

          • (params?: RequestOptions & Octokit.ActionsGetWorkflowParams): Promise<Response<Octokit.ActionsGetWorkflowResponse>>

          • Parameters

            Returns Promise<Response<Octokit.ActionsGetWorkflowResponse>>

        • endpoint: Endpoint
      • getWorkflowJob: { endpoint: Endpoint }

        Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the actions permission to use this endpoint.

          • (params?: RequestOptions & Octokit.ActionsGetWorkflowJobParams): Promise<Response<Octokit.ActionsGetWorkflowJobResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActionsGetWorkflowJobParams

            Returns Promise<Response<Octokit.ActionsGetWorkflowJobResponse>>

        • endpoint: Endpoint
      • getWorkflowRun: { endpoint: Endpoint }

        Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the actions permission to use this endpoint.

          • (params?: RequestOptions & Octokit.ActionsGetWorkflowRunParams): Promise<Response<Octokit.ActionsGetWorkflowRunResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActionsGetWorkflowRunParams

            Returns Promise<Response<Octokit.ActionsGetWorkflowRunResponse>>

        • endpoint: Endpoint
      • listDownloadsForSelfHostedRunnerApplication: { endpoint: Endpoint }

        Lists binaries for the self-hosted runner application that you can download and run. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the administration permission to use this endpoint.

          • (params?: RequestOptions & Octokit.ActionsListDownloadsForSelfHostedRunnerApplicationParams): Promise<Response<Octokit.ActionsListDownloadsForSelfHostedRunnerApplicationResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActionsListDownloadsForSelfHostedRunnerApplicationParams

            Returns Promise<Response<Octokit.ActionsListDownloadsForSelfHostedRunnerApplicationResponse>>

        • endpoint: Endpoint
      • listJobsForWorkflowRun: { endpoint: Endpoint }

        Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the actions permission to use this endpoint.

          • (params?: RequestOptions & Octokit.ActionsListJobsForWorkflowRunParams): Promise<Response<Octokit.ActionsListJobsForWorkflowRunResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActionsListJobsForWorkflowRunParams

            Returns Promise<Response<Octokit.ActionsListJobsForWorkflowRunResponse>>

        • endpoint: Endpoint
      • listRepoWorkflowRuns: { endpoint: Endpoint }

        Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.

        Anyone with read access to the repository can use this endpoint. GitHub Apps must have the actions permission to use this endpoint.

          • (params?: RequestOptions & Octokit.ActionsListRepoWorkflowRunsParams): Promise<Response<Octokit.ActionsListRepoWorkflowRunsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActionsListRepoWorkflowRunsParams

            Returns Promise<Response<Octokit.ActionsListRepoWorkflowRunsResponse>>

        • endpoint: Endpoint
      • listRepoWorkflows: { endpoint: Endpoint }

        Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the actions permission to use this endpoint.

          • (params?: RequestOptions & Octokit.ActionsListRepoWorkflowsParams): Promise<Response<Octokit.ActionsListRepoWorkflowsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActionsListRepoWorkflowsParams

            Returns Promise<Response<Octokit.ActionsListRepoWorkflowsResponse>>

        • endpoint: Endpoint
      • listSecretsForRepo: { endpoint: Endpoint }

        Lists all secrets available in a repository without revealing their encrypted values. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the secrets permission to use this endpoint.

          • (params?: RequestOptions & Octokit.ActionsListSecretsForRepoParams): Promise<Response<Octokit.ActionsListSecretsForRepoResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActionsListSecretsForRepoParams

            Returns Promise<Response<Octokit.ActionsListSecretsForRepoResponse>>

        • endpoint: Endpoint
      • listSelfHostedRunnersForRepo: { endpoint: Endpoint }

        Lists all self-hosted runners for a repository. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the administration permission to use this endpoint.

          • (params?: RequestOptions & Octokit.ActionsListSelfHostedRunnersForRepoParams): Promise<Response<Octokit.ActionsListSelfHostedRunnersForRepoResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActionsListSelfHostedRunnersForRepoParams

            Returns Promise<Response<Octokit.ActionsListSelfHostedRunnersForRepoResponse>>

        • endpoint: Endpoint
      • listWorkflowJobLogs: { endpoint: Endpoint }

        Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look for Location: in the response header to find the URL for the download. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the actions permission to use this endpoint.

        Call this endpoint using the -v flag, which enables verbose output and allows you to see the download URL in the header. To download the file into the current working directory, specify the filename using the -o flag.

          • (params?: RequestOptions & Octokit.ActionsListWorkflowJobLogsParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActionsListWorkflowJobLogsParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • listWorkflowRunArtifacts: { endpoint: Endpoint }

        Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the actions permission to use this endpoint.

          • (params?: RequestOptions & Octokit.ActionsListWorkflowRunArtifactsParams): Promise<Response<Octokit.ActionsListWorkflowRunArtifactsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActionsListWorkflowRunArtifactsParams

            Returns Promise<Response<Octokit.ActionsListWorkflowRunArtifactsResponse>>

        • endpoint: Endpoint
      • listWorkflowRunLogs: { endpoint: Endpoint }

        Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for Location: in the response header to find the URL for the download. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the actions permission to use this endpoint.

        Call this endpoint using the -v flag, which enables verbose output and allows you to see the download URL in the header. To download the file into the current working directory, specify the filename using the -o flag.

          • (params?: RequestOptions & Octokit.ActionsListWorkflowRunLogsParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActionsListWorkflowRunLogsParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • listWorkflowRuns: { endpoint: Endpoint }

        List all workflow runs for a workflow. You can also replace :workflow_id with :workflow_file_name. For example, you could use main.yml. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.

        Anyone with read access to the repository can use this endpoint.

          • (params?: RequestOptions & Octokit.ActionsListWorkflowRunsParams): Promise<Response<Octokit.ActionsListWorkflowRunsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActionsListWorkflowRunsParams

            Returns Promise<Response<Octokit.ActionsListWorkflowRunsResponse>>

        • endpoint: Endpoint
      • reRunWorkflow: { endpoint: Endpoint }

        Re-runs your workflow run using its id. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the actions permission to use this endpoint.

          • (params?: RequestOptions & Octokit.ActionsReRunWorkflowParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActionsReRunWorkflowParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • removeSelfHostedRunner: { endpoint: Endpoint }

        Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the administration permission to use this endpoint.

          • (params?: RequestOptions & Octokit.ActionsRemoveSelfHostedRunnerParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActionsRemoveSelfHostedRunnerParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint

      activity

      activity: { checkStarringRepo: { endpoint: Endpoint }; checkWatchingRepoLegacy: { endpoint: Endpoint }; deleteRepoSubscription: { endpoint: Endpoint }; deleteThreadSubscription: { endpoint: Endpoint }; getRepoSubscription: { endpoint: Endpoint }; getThread: { endpoint: Endpoint }; getThreadSubscription: { endpoint: Endpoint }; listEventsForOrg: { endpoint: Endpoint }; listEventsForUser: { endpoint: Endpoint }; listFeeds: { endpoint: Endpoint }; listNotifications: { endpoint: Endpoint }; listNotificationsForRepo: { endpoint: Endpoint }; listPublicEvents: { endpoint: Endpoint }; listPublicEventsForOrg: { endpoint: Endpoint }; listPublicEventsForRepoNetwork: { endpoint: Endpoint }; listPublicEventsForUser: { endpoint: Endpoint }; listReceivedEventsForUser: { endpoint: Endpoint }; listReceivedPublicEventsForUser: { endpoint: Endpoint }; listRepoEvents: { endpoint: Endpoint }; listReposStarredByAuthenticatedUser: { endpoint: Endpoint }; listReposStarredByUser: { endpoint: Endpoint }; listReposWatchedByUser: { endpoint: Endpoint }; listStargazersForRepo: { endpoint: Endpoint }; listWatchedReposForAuthenticatedUser: { endpoint: Endpoint }; listWatchersForRepo: { endpoint: Endpoint }; markAsRead: { endpoint: Endpoint }; markNotificationsAsReadForRepo: { endpoint: Endpoint }; markThreadAsRead: { endpoint: Endpoint }; setRepoSubscription: { endpoint: Endpoint }; setThreadSubscription: { endpoint: Endpoint }; starRepo: { endpoint: Endpoint }; stopWatchingRepoLegacy: { endpoint: Endpoint }; unstarRepo: { endpoint: Endpoint }; watchRepoLegacy: { endpoint: Endpoint } }

      Type declaration

      • checkStarringRepo: { endpoint: Endpoint }

        Requires for the user to be authenticated.

          • (params?: RequestOptions & Octokit.ActivityCheckStarringRepoParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActivityCheckStarringRepoParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • checkWatchingRepoLegacy: { endpoint: Endpoint }

        Requires for the user to be authenticated.

          • (params?: RequestOptions & Octokit.ActivityCheckWatchingRepoLegacyParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActivityCheckWatchingRepoLegacyParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • deleteRepoSubscription: { endpoint: Endpoint }

        This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, set the repository's subscription manually.

          • (params?: RequestOptions & Octokit.ActivityDeleteRepoSubscriptionParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActivityDeleteRepoSubscriptionParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • deleteThreadSubscription: { endpoint: Endpoint }

        Mutes all future notifications for a conversation until you comment on the thread or get @mentioned.

          • (params?: RequestOptions & Octokit.ActivityDeleteThreadSubscriptionParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActivityDeleteThreadSubscriptionParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • getRepoSubscription: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ActivityGetRepoSubscriptionParams): Promise<Response<Octokit.ActivityGetRepoSubscriptionResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActivityGetRepoSubscriptionParams

            Returns Promise<Response<Octokit.ActivityGetRepoSubscriptionResponse>>

        • endpoint: Endpoint
      • getThread: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ActivityGetThreadParams): Promise<Response<Octokit.ActivityGetThreadResponse>>

          • Parameters

            Returns Promise<Response<Octokit.ActivityGetThreadResponse>>

        • endpoint: Endpoint
      • getThreadSubscription: { endpoint: Endpoint }

        This checks to see if the current user is subscribed to a thread. You can also get a repository subscription.

        Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were @mentioned, or manually subscribe to a thread.

          • (params?: RequestOptions & Octokit.ActivityGetThreadSubscriptionParams): Promise<Response<Octokit.ActivityGetThreadSubscriptionResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActivityGetThreadSubscriptionParams

            Returns Promise<Response<Octokit.ActivityGetThreadSubscriptionResponse>>

        • endpoint: Endpoint
      • listEventsForOrg: { endpoint: Endpoint }

        This is the user's organization dashboard. You must be authenticated as the user to view this.

          • (params?: RequestOptions & Octokit.ActivityListEventsForOrgParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActivityListEventsForOrgParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • listEventsForUser: { endpoint: Endpoint }

        If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.

          • (params?: RequestOptions & Octokit.ActivityListEventsForUserParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActivityListEventsForUserParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • listFeeds: { endpoint: Endpoint }

        GitHub provides several timeline resources in Atom format. The Feeds API lists all the feeds available to the authenticated user:

        • Timeline: The GitHub global public timeline
        • User: The public timeline for any user, using URI template
        • Current user public: The public timeline for the authenticated user
        • Current user: The private timeline for the authenticated user
        • Current user actor: The private timeline for activity created by the authenticated user
        • Current user organizations: The private timeline for the organizations the authenticated user is a member of.
        • Security advisories: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub.

        Note: Private feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.

      • listNotifications: { endpoint: Endpoint }

        List all notifications for the current user, sorted by most recently updated.

        The following example uses the since parameter to list notifications that have been updated after the specified time.

          • (params?: RequestOptions & Octokit.ActivityListNotificationsParams): Promise<Response<Octokit.ActivityListNotificationsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActivityListNotificationsParams

            Returns Promise<Response<Octokit.ActivityListNotificationsResponse>>

        • endpoint: Endpoint
      • listNotificationsForRepo: { endpoint: Endpoint }

        List all notifications for the current user.

          • (params?: RequestOptions & Octokit.ActivityListNotificationsForRepoParams): Promise<Response<Octokit.ActivityListNotificationsForRepoResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActivityListNotificationsForRepoParams

            Returns Promise<Response<Octokit.ActivityListNotificationsForRepoResponse>>

        • endpoint: Endpoint
      • listPublicEvents: { endpoint: Endpoint }

        We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.

          • (params?: RequestOptions & Octokit.ActivityListPublicEventsParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActivityListPublicEventsParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • listPublicEventsForOrg: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ActivityListPublicEventsForOrgParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActivityListPublicEventsForOrgParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • listPublicEventsForRepoNetwork: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ActivityListPublicEventsForRepoNetworkParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActivityListPublicEventsForRepoNetworkParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • listPublicEventsForUser: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ActivityListPublicEventsForUserParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActivityListPublicEventsForUserParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • listReceivedEventsForUser: { endpoint: Endpoint }

        These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.

          • (params?: RequestOptions & Octokit.ActivityListReceivedEventsForUserParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActivityListReceivedEventsForUserParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • listReceivedPublicEventsForUser: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ActivityListReceivedPublicEventsForUserParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActivityListReceivedPublicEventsForUserParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • listRepoEvents: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ActivityListRepoEventsParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActivityListRepoEventsParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • listReposStarredByAuthenticatedUser: { endpoint: Endpoint }

        You can also find out when stars were created by passing the following custom media type via the Accept header:

          • (params?: RequestOptions & Octokit.ActivityListReposStarredByAuthenticatedUserParams): Promise<Response<Octokit.ActivityListReposStarredByAuthenticatedUserResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActivityListReposStarredByAuthenticatedUserParams

            Returns Promise<Response<Octokit.ActivityListReposStarredByAuthenticatedUserResponse>>

        • endpoint: Endpoint
      • listReposStarredByUser: { endpoint: Endpoint }

        You can also find out when stars were created by passing the following custom media type via the Accept header:

          • (params?: RequestOptions & Octokit.ActivityListReposStarredByUserParams): Promise<Response<Octokit.ActivityListReposStarredByUserResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActivityListReposStarredByUserParams

            Returns Promise<Response<Octokit.ActivityListReposStarredByUserResponse>>

        • endpoint: Endpoint
      • listReposWatchedByUser: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ActivityListReposWatchedByUserParams): Promise<Response<Octokit.ActivityListReposWatchedByUserResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActivityListReposWatchedByUserParams

            Returns Promise<Response<Octokit.ActivityListReposWatchedByUserResponse>>

        • endpoint: Endpoint
      • listStargazersForRepo: { endpoint: Endpoint }

        You can also find out when stars were created by passing the following custom media type via the Accept header:

          • (params?: RequestOptions & Octokit.ActivityListStargazersForRepoParams): Promise<Response<Octokit.ActivityListStargazersForRepoResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActivityListStargazersForRepoParams

            Returns Promise<Response<Octokit.ActivityListStargazersForRepoResponse>>

        • endpoint: Endpoint
      • listWatchedReposForAuthenticatedUser: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ActivityListWatchedReposForAuthenticatedUserParams): Promise<Response<Octokit.ActivityListWatchedReposForAuthenticatedUserResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActivityListWatchedReposForAuthenticatedUserParams

            Returns Promise<Response<Octokit.ActivityListWatchedReposForAuthenticatedUserResponse>>

        • endpoint: Endpoint
      • listWatchersForRepo: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ActivityListWatchersForRepoParams): Promise<Response<Octokit.ActivityListWatchersForRepoResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActivityListWatchersForRepoParams

            Returns Promise<Response<Octokit.ActivityListWatchersForRepoResponse>>

        • endpoint: Endpoint
      • markAsRead: { endpoint: Endpoint }

        Marks a notification as "read" removes it from the default view on GitHub. If the number of notifications is too large to complete in one request, you will receive a 202 Accepted status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the List your notifications endpoint and pass the query parameter all=false.

          • (params?: RequestOptions & Octokit.ActivityMarkAsReadParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • markNotificationsAsReadForRepo: { endpoint: Endpoint }

        Marks all notifications in a repository as "read" removes them from the default view on GitHub. If the number of notifications is too large to complete in one request, you will receive a 202 Accepted status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the List your notifications in a repository endpoint and pass the query parameter all=false.

          • (params?: RequestOptions & Octokit.ActivityMarkNotificationsAsReadForRepoParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActivityMarkNotificationsAsReadForRepoParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • markThreadAsRead: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ActivityMarkThreadAsReadParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActivityMarkThreadAsReadParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • setRepoSubscription: { endpoint: Endpoint }

        If you would like to watch a repository, set subscribed to true. If you would like to ignore notifications made within a repository, set ignored to true. If you would like to stop watching a repository, delete the repository's subscription completely.

          • (params?: RequestOptions & Octokit.ActivitySetRepoSubscriptionParams): Promise<Response<Octokit.ActivitySetRepoSubscriptionResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActivitySetRepoSubscriptionParams

            Returns Promise<Response<Octokit.ActivitySetRepoSubscriptionResponse>>

        • endpoint: Endpoint
      • setThreadSubscription: { endpoint: Endpoint }

        This lets you subscribe or unsubscribe from a conversation.

          • (params?: RequestOptions & Octokit.ActivitySetThreadSubscriptionParams): Promise<Response<Octokit.ActivitySetThreadSubscriptionResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActivitySetThreadSubscriptionParams

            Returns Promise<Response<Octokit.ActivitySetThreadSubscriptionResponse>>

        • endpoint: Endpoint
      • starRepo: { endpoint: Endpoint }

        Requires for the user to be authenticated.

        Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."

          • (params?: RequestOptions & Octokit.ActivityStarRepoParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • stopWatchingRepoLegacy: { endpoint: Endpoint }

        Requires for the user to be authenticated.

          • (params?: RequestOptions & Octokit.ActivityStopWatchingRepoLegacyParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActivityStopWatchingRepoLegacyParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • unstarRepo: { endpoint: Endpoint }

        Requires for the user to be authenticated.

          • (params?: RequestOptions & Octokit.ActivityUnstarRepoParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • watchRepoLegacy: { endpoint: Endpoint }

        Requires the user to be authenticated.

        Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."

          • (params?: RequestOptions & Octokit.ActivityWatchRepoLegacyParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ActivityWatchRepoLegacyParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint

      apps

      apps: { addRepoToInstallation: { endpoint: Endpoint }; checkAccountIsAssociatedWithAny: { endpoint: Endpoint }; checkAccountIsAssociatedWithAnyStubbed: { endpoint: Endpoint }; checkAuthorization: { endpoint: Endpoint }; checkToken: { endpoint: Endpoint }; createContentAttachment: { endpoint: Endpoint }; createFromManifest: { endpoint: Endpoint }; createInstallationToken: { endpoint: Endpoint }; deleteAuthorization: { endpoint: Endpoint }; deleteInstallation: { endpoint: Endpoint }; deleteToken: { endpoint: Endpoint }; findOrgInstallation: { endpoint: Endpoint }; findRepoInstallation: { endpoint: Endpoint }; findUserInstallation: { endpoint: Endpoint }; getAuthenticated: { endpoint: Endpoint }; getBySlug: { endpoint: Endpoint }; getInstallation: { endpoint: Endpoint }; getOrgInstallation: { endpoint: Endpoint }; getRepoInstallation: { endpoint: Endpoint }; getUserInstallation: { endpoint: Endpoint }; listAccountsUserOrOrgOnPlan: { endpoint: Endpoint }; listAccountsUserOrOrgOnPlanStubbed: { endpoint: Endpoint }; listInstallationReposForAuthenticatedUser: { endpoint: Endpoint }; listInstallations: { endpoint: Endpoint }; listInstallationsForAuthenticatedUser: { endpoint: Endpoint }; listMarketplacePurchasesForAuthenticatedUser: { endpoint: Endpoint }; listMarketplacePurchasesForAuthenticatedUserStubbed: { endpoint: Endpoint }; listPlans: { endpoint: Endpoint }; listPlansStubbed: { endpoint: Endpoint }; listRepos: { endpoint: Endpoint }; removeRepoFromInstallation: { endpoint: Endpoint }; resetAuthorization: { endpoint: Endpoint }; resetToken: { endpoint: Endpoint }; revokeAuthorizationForApplication: { endpoint: Endpoint }; revokeGrantForApplication: { endpoint: Endpoint }; revokeInstallationToken: { endpoint: Endpoint } }

      Type declaration

      • addRepoToInstallation: { endpoint: Endpoint }

        Add a single repository to an installation. The authenticated user must have admin access to the repository.

        You must use a personal access token (which you can create via the command line or the OAuth Authorizations API) or Basic Authentication to access this endpoint.

          • (params?: RequestOptions & Octokit.AppsAddRepoToInstallationParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.AppsAddRepoToInstallationParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • checkAccountIsAssociatedWithAny: { endpoint: Endpoint }

        Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

        GitHub Apps must use a JWT to access this endpoint. OAuth Apps must use basic authentication with their client ID and client secret to access this endpoint.

          • (params?: RequestOptions & Octokit.AppsCheckAccountIsAssociatedWithAnyParams): Promise<Response<Octokit.AppsCheckAccountIsAssociatedWithAnyResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.AppsCheckAccountIsAssociatedWithAnyParams

            Returns Promise<Response<Octokit.AppsCheckAccountIsAssociatedWithAnyResponse>>

        • endpoint: Endpoint
      • checkAccountIsAssociatedWithAnyStubbed: { endpoint: Endpoint }

        Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

        GitHub Apps must use a JWT to access this endpoint. OAuth Apps must use basic authentication with their client ID and client secret to access this endpoint.

          • (params?: RequestOptions & Octokit.AppsCheckAccountIsAssociatedWithAnyStubbedParams): Promise<Response<Octokit.AppsCheckAccountIsAssociatedWithAnyStubbedResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.AppsCheckAccountIsAssociatedWithAnyStubbedParams

            Returns Promise<Response<Octokit.AppsCheckAccountIsAssociatedWithAnyStubbedResponse>>

        • endpoint: Endpoint
      • checkAuthorization: { endpoint: Endpoint }

        Deprecation Notice: GitHub will replace and discontinue OAuth endpoints containing access_token in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using access_token as an input parameter. For more information, see the blog post.

        OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use Basic Authentication when accessing this endpoint, using the OAuth application's client_id and client_secret as the username and password. Invalid tokens will return 404 NOT FOUND.

        deprecated

        octokit.apps.checkAuthorization() is deprecated, see https://developer.github.com/v3/apps/oauth_applications/#check-an-authorization

          • (params?: RequestOptions & Octokit.AppsCheckAuthorizationParams): Promise<Response<Octokit.AppsCheckAuthorizationResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.AppsCheckAuthorizationParams

            Returns Promise<Response<Octokit.AppsCheckAuthorizationResponse>>

        • endpoint: Endpoint
      • checkToken: { endpoint: Endpoint }

        OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use Basic Authentication to use this endpoint, where the username is the OAuth application client_id and the password is its client_secret. Invalid tokens will return 404 NOT FOUND.

          • Parameters

            Returns Promise<Response<Octokit.AppsCheckTokenResponse>>

        • endpoint: Endpoint
      • createContentAttachment: { endpoint: Endpoint }

        Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id of the content reference from the content_reference event to create an attachment.

        The app must create a content attachment within six hours of the content reference URL being posted. See "Using content attachments" for details about content attachments.

        You must use an installation access token to access this endpoint.

        This example creates a content attachment for the domain https://errors.ai/.

          • (params?: RequestOptions & Octokit.AppsCreateContentAttachmentParams): Promise<Response<Octokit.AppsCreateContentAttachmentResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.AppsCreateContentAttachmentParams

            Returns Promise<Response<Octokit.AppsCreateContentAttachmentResponse>>

        • endpoint: Endpoint
      • createFromManifest: { endpoint: Endpoint }

        Use this endpoint to complete the handshake necessary when implementing the GitHub App Manifest flow. When you create a GitHub App with the manifest flow, you receive a temporary code used to retrieve the GitHub App's id, pem (private key), and webhook_secret.

          • (params?: RequestOptions & Octokit.AppsCreateFromManifestParams): Promise<Response<Octokit.AppsCreateFromManifestResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.AppsCreateFromManifestParams

            Returns Promise<Response<Octokit.AppsCreateFromManifestResponse>>

        • endpoint: Endpoint
      • createInstallationToken: { endpoint: Endpoint }

        Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of 401 - Unauthorized, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the repository_ids when creating the token. When you omit repository_ids, the response does not contain the repositories key.

        You must use a JWT to access this endpoint.

        This example grants the token "Read and write" permission to issues and "Read" permission to contents, and restricts the token's access to the repository with an id of 1296269.

          • (params?: RequestOptions & Octokit.AppsCreateInstallationTokenParams): Promise<Response<Octokit.AppsCreateInstallationTokenResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.AppsCreateInstallationTokenParams

            Returns Promise<Response<Octokit.AppsCreateInstallationTokenResponse>>

        • endpoint: Endpoint
      • deleteAuthorization: { endpoint: Endpoint }

        OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use Basic Authentication when accessing this endpoint, using the OAuth application's client_id and client_secret as the username and password. You must also provide a valid OAuth access_token as an input parameter and the grant for the token's owner will be deleted.

        Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on the application authorizations settings screen within GitHub.

          • (params?: RequestOptions & Octokit.AppsDeleteAuthorizationParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.AppsDeleteAuthorizationParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • deleteInstallation: { endpoint: Endpoint }

        Uninstalls a GitHub App on a user, organization, or business account.

        You must use a JWT to access this endpoint.

          • (params?: RequestOptions & Octokit.AppsDeleteInstallationParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.AppsDeleteInstallationParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • deleteToken: { endpoint: Endpoint }

        OAuth application owners can revoke a single token for an OAuth application. You must use Basic Authentication when accessing this endpoint, using the OAuth application's client_id and client_secret as the username and password.

          • (params?: RequestOptions & Octokit.AppsDeleteTokenParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • findOrgInstallation: { endpoint: Endpoint }

        Enables an authenticated GitHub App to find the organization's installation information.

        You must use a JWT to access this endpoint.

        deprecated

        octokit.apps.findOrgInstallation() has been renamed to octokit.apps.getOrgInstallation() (2019-04-10)

          • (params?: RequestOptions & Octokit.AppsFindOrgInstallationParams): Promise<Response<Octokit.AppsFindOrgInstallationResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.AppsFindOrgInstallationParams

            Returns Promise<Response<Octokit.AppsFindOrgInstallationResponse>>

        • endpoint: Endpoint
      • findRepoInstallation: { endpoint: Endpoint }

        Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.

        You must use a JWT to access this endpoint.

        deprecated

        octokit.apps.findRepoInstallation() has been renamed to octokit.apps.getRepoInstallation() (2019-04-10)

          • (params?: RequestOptions & Octokit.AppsFindRepoInstallationParams): Promise<Response<Octokit.AppsFindRepoInstallationResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.AppsFindRepoInstallationParams

            Returns Promise<Response<Octokit.AppsFindRepoInstallationResponse>>

        • endpoint: Endpoint
      • findUserInstallation: { endpoint: Endpoint }

        Enables an authenticated GitHub App to find the user’s installation information.

        You must use a JWT to access this endpoint.

        deprecated

        octokit.apps.findUserInstallation() has been renamed to octokit.apps.getUserInstallation() (2019-04-10)

          • (params?: RequestOptions & Octokit.AppsFindUserInstallationParams): Promise<Response<Octokit.AppsFindUserInstallationResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.AppsFindUserInstallationParams

            Returns Promise<Response<Octokit.AppsFindUserInstallationResponse>>

        • endpoint: Endpoint
      • getAuthenticated: { endpoint: Endpoint }

        Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the installations_count in the response. For more details about your app's installations, see the "List installations" endpoint.

        You must use a JWT to access this endpoint.

      • getBySlug: { endpoint: Endpoint }

        Note: The :app_slug is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/:app_slug).

        If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a personal access token or an installation access token to access this endpoint.

      • getInstallation: { endpoint: Endpoint }

        You must use a JWT to access this endpoint.

          • (params?: RequestOptions & Octokit.AppsGetInstallationParams): Promise<Response<Octokit.AppsGetInstallationResponse>>

          • Parameters

            Returns Promise<Response<Octokit.AppsGetInstallationResponse>>

        • endpoint: Endpoint
      • getOrgInstallation: { endpoint: Endpoint }

        Enables an authenticated GitHub App to find the organization's installation information.

        You must use a JWT to access this endpoint.

          • (params?: RequestOptions & Octokit.AppsGetOrgInstallationParams): Promise<Response<Octokit.AppsGetOrgInstallationResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.AppsGetOrgInstallationParams

            Returns Promise<Response<Octokit.AppsGetOrgInstallationResponse>>

        • endpoint: Endpoint
      • getRepoInstallation: { endpoint: Endpoint }

        Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.

        You must use a JWT to access this endpoint.

          • (params?: RequestOptions & Octokit.AppsGetRepoInstallationParams): Promise<Response<Octokit.AppsGetRepoInstallationResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.AppsGetRepoInstallationParams

            Returns Promise<Response<Octokit.AppsGetRepoInstallationResponse>>

        • endpoint: Endpoint
      • getUserInstallation: { endpoint: Endpoint }

        Enables an authenticated GitHub App to find the user’s installation information.

        You must use a JWT to access this endpoint.

          • (params?: RequestOptions & Octokit.AppsGetUserInstallationParams): Promise<Response<Octokit.AppsGetUserInstallationResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.AppsGetUserInstallationParams

            Returns Promise<Response<Octokit.AppsGetUserInstallationResponse>>

        • endpoint: Endpoint
      • listAccountsUserOrOrgOnPlan: { endpoint: Endpoint }

        Returns any accounts associated with a plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

        GitHub Apps must use a JWT to access this endpoint. OAuth Apps must use basic authentication with their client ID and client secret to access this endpoint.

          • (params?: RequestOptions & Octokit.AppsListAccountsUserOrOrgOnPlanParams): Promise<Response<Octokit.AppsListAccountsUserOrOrgOnPlanResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.AppsListAccountsUserOrOrgOnPlanParams

            Returns Promise<Response<Octokit.AppsListAccountsUserOrOrgOnPlanResponse>>

        • endpoint: Endpoint
      • listAccountsUserOrOrgOnPlanStubbed: { endpoint: Endpoint }

        Returns any accounts associated with a plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

        GitHub Apps must use a JWT to access this endpoint. OAuth Apps must use basic authentication with their client ID and client secret to access this endpoint.

          • (params?: RequestOptions & Octokit.AppsListAccountsUserOrOrgOnPlanStubbedParams): Promise<Response<Octokit.AppsListAccountsUserOrOrgOnPlanStubbedResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.AppsListAccountsUserOrOrgOnPlanStubbedParams

            Returns Promise<Response<Octokit.AppsListAccountsUserOrOrgOnPlanStubbedResponse>>

        • endpoint: Endpoint
      • listInstallationReposForAuthenticatedUser: { endpoint: Endpoint }

        List repositories that the authenticated user has explicit permission (:read, :write, or :admin) to access for an installation.

        The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

        You must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint.

        The access the user has to each repository is included in the hash under the permissions key.

          • (params?: RequestOptions & Octokit.AppsListInstallationReposForAuthenticatedUserParams): Promise<Response<Octokit.AppsListInstallationReposForAuthenticatedUserResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.AppsListInstallationReposForAuthenticatedUserParams

            Returns Promise<Response<Octokit.AppsListInstallationReposForAuthenticatedUserResponse>>

        • endpoint: Endpoint
      • listInstallations: { endpoint: Endpoint }

        You must use a JWT to access this endpoint.

        The permissions the installation has are included under the permissions key.

          • (params?: RequestOptions & Octokit.AppsListInstallationsParams): Promise<Response<Octokit.AppsListInstallationsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.AppsListInstallationsParams

            Returns Promise<Response<Octokit.AppsListInstallationsResponse>>

        • endpoint: Endpoint
      • listInstallationsForAuthenticatedUser: { endpoint: Endpoint }

        Lists installations of your GitHub App that the authenticated user has explicit permission (:read, :write, or :admin) to access.

        You must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint.

        The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

        You can find the permissions for the installation under the permissions key.

          • (params?: RequestOptions & Octokit.AppsListInstallationsForAuthenticatedUserParams): Promise<Response<Octokit.AppsListInstallationsForAuthenticatedUserResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.AppsListInstallationsForAuthenticatedUserParams

            Returns Promise<Response<Octokit.AppsListInstallationsForAuthenticatedUserResponse>>

        • endpoint: Endpoint
      • listMarketplacePurchasesForAuthenticatedUser: { endpoint: Endpoint }

        Returns only active subscriptions. You must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an OAuth token.

          • (params?: RequestOptions & Octokit.AppsListMarketplacePurchasesForAuthenticatedUserParams): Promise<Response<Octokit.AppsListMarketplacePurchasesForAuthenticatedUserResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.AppsListMarketplacePurchasesForAuthenticatedUserParams

            Returns Promise<Response<Octokit.AppsListMarketplacePurchasesForAuthenticatedUserResponse>>

        • endpoint: Endpoint
      • listMarketplacePurchasesForAuthenticatedUserStubbed: { endpoint: Endpoint }

        Returns only active subscriptions. You must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an OAuth token.

          • (params?: RequestOptions & Octokit.AppsListMarketplacePurchasesForAuthenticatedUserStubbedParams): Promise<Response<Octokit.AppsListMarketplacePurchasesForAuthenticatedUserStubbedResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.AppsListMarketplacePurchasesForAuthenticatedUserStubbedParams

            Returns Promise<Response<Octokit.AppsListMarketplacePurchasesForAuthenticatedUserStubbedResponse>>

        • endpoint: Endpoint
      • listPlans: { endpoint: Endpoint }

        GitHub Apps must use a JWT to access this endpoint. OAuth Apps must use basic authentication with their client ID and client secret to access this endpoint.

      • listPlansStubbed: { endpoint: Endpoint }

        GitHub Apps must use a JWT to access this endpoint. OAuth Apps must use basic authentication with their client ID and client secret to access this endpoint.

          • (params?: RequestOptions & Octokit.AppsListPlansStubbedParams): Promise<Response<Octokit.AppsListPlansStubbedResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.AppsListPlansStubbedParams

            Returns Promise<Response<Octokit.AppsListPlansStubbedResponse>>

        • endpoint: Endpoint
      • listRepos: { endpoint: Endpoint }

        List repositories that an installation can access.

        You must use an installation access token to access this endpoint.

      • removeRepoFromInstallation: { endpoint: Endpoint }

        Remove a single repository from an installation. The authenticated user must have admin access to the repository.

        You must use a personal access token (which you can create via the command line or the OAuth Authorizations API) or Basic Authentication to access this endpoint.

          • (params?: RequestOptions & Octokit.AppsRemoveRepoFromInstallationParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.AppsRemoveRepoFromInstallationParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • resetAuthorization: { endpoint: Endpoint }

        Deprecation Notice: GitHub will replace and discontinue OAuth endpoints containing access_token in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using access_token as an input parameter. For more information, see the blog post.

        OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use Basic Authentication when accessing this endpoint, using the OAuth application's client_id and client_secret as the username and password. Invalid tokens will return 404 NOT FOUND.

        deprecated

        octokit.apps.resetAuthorization() is deprecated, see https://developer.github.com/v3/apps/oauth_applications/#reset-an-authorization

          • (params?: RequestOptions & Octokit.AppsResetAuthorizationParams): Promise<Response<Octokit.AppsResetAuthorizationResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.AppsResetAuthorizationParams

            Returns Promise<Response<Octokit.AppsResetAuthorizationResponse>>

        • endpoint: Endpoint
      • resetToken: { endpoint: Endpoint }

        OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use Basic Authentication when accessing this endpoint, using the OAuth application's client_id and client_secret as the username and password. Invalid tokens will return 404 NOT FOUND.

          • Parameters

            Returns Promise<Response<Octokit.AppsResetTokenResponse>>

        • endpoint: Endpoint
      • revokeAuthorizationForApplication: { endpoint: Endpoint }

        Deprecation Notice: GitHub will replace and discontinue OAuth endpoints containing access_token in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using access_token as an input parameter. For more information, see the blog post.

        OAuth application owners can revoke a single token for an OAuth application. You must use Basic Authentication when accessing this endpoint, using the OAuth application's client_id and client_secret as the username and password.

        deprecated

        octokit.apps.revokeAuthorizationForApplication() is deprecated, see https://developer.github.com/v3/apps/oauth_applications/#revoke-an-authorization-for-an-application

          • (params?: RequestOptions & Octokit.AppsRevokeAuthorizationForApplicationParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.AppsRevokeAuthorizationForApplicationParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • revokeGrantForApplication: { endpoint: Endpoint }

        Deprecation Notice: GitHub will replace and discontinue OAuth endpoints containing access_token in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using access_token as an input parameter. For more information, see the blog post.

        OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use Basic Authentication when accessing this endpoint, using the OAuth application's client_id and client_secret as the username and password. You must also provide a valid token as :access_token and the grant for the token's owner will be deleted.

        Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on the Applications settings page under "Authorized OAuth Apps" on GitHub.

        deprecated

        octokit.apps.revokeGrantForApplication() is deprecated, see https://developer.github.com/v3/apps/oauth_applications/#revoke-a-grant-for-an-application

          • (params?: RequestOptions & Octokit.AppsRevokeGrantForApplicationParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.AppsRevokeGrantForApplicationParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • revokeInstallationToken: { endpoint: Endpoint }

        Revokes the installation token you're using to authenticate as an installation and access this endpoint.

        Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "Create a new installation token" endpoint.

        You must use an installation access token to access this endpoint.

      checks

      checks: { create: { endpoint: Endpoint }; createSuite: { endpoint: Endpoint }; get: { endpoint: Endpoint }; getSuite: { endpoint: Endpoint }; listAnnotations: { endpoint: Endpoint }; listForRef: { endpoint: Endpoint }; listForSuite: { endpoint: Endpoint }; listSuitesForRef: { endpoint: Endpoint }; rerequestSuite: { endpoint: Endpoint }; setSuitesPreferences: { endpoint: Endpoint }; update: { endpoint: Endpoint } }

      Type declaration

      • create: { endpoint: Endpoint }

        Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

        Creates a new check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to create check runs.

      • createSuite: { endpoint: Endpoint }

        Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

        By default, check suites are automatically created when you create a check run. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "Set preferences for check suites on a repository". Your GitHub App must have the checks:write permission to create check suites.

          • (params?: RequestOptions & Octokit.ChecksCreateSuiteParams): Promise<Response<Octokit.ChecksCreateSuiteResponse>>

          • Parameters

            Returns Promise<Response<Octokit.ChecksCreateSuiteResponse>>

        • endpoint: Endpoint
      • get: { endpoint: Endpoint }

        Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

        Gets a single check run using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.

      • getSuite: { endpoint: Endpoint }

        Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

        Gets a single check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.

          • Parameters

            Returns Promise<Response<Octokit.ChecksGetSuiteResponse>>

        • endpoint: Endpoint
      • listAnnotations: { endpoint: Endpoint }

        Lists annotations for a check run using the annotation id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the repo scope to get annotations for a check run in a private repository.

          • (params?: RequestOptions & Octokit.ChecksListAnnotationsParams): Promise<Response<Octokit.ChecksListAnnotationsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ChecksListAnnotationsParams

            Returns Promise<Response<Octokit.ChecksListAnnotationsResponse>>

        • endpoint: Endpoint
      • listForRef: { endpoint: Endpoint }

        Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

        Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.

          • (params?: RequestOptions & Octokit.ChecksListForRefParams): Promise<Response<Octokit.ChecksListForRefResponse>>

          • Parameters

            Returns Promise<Response<Octokit.ChecksListForRefResponse>>

        • endpoint: Endpoint
      • listForSuite: { endpoint: Endpoint }

        Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

        Lists check runs for a check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.

          • (params?: RequestOptions & Octokit.ChecksListForSuiteParams): Promise<Response<Octokit.ChecksListForSuiteResponse>>

          • Parameters

            Returns Promise<Response<Octokit.ChecksListForSuiteResponse>>

        • endpoint: Endpoint
      • listSuitesForRef: { endpoint: Endpoint }

        Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

        Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.

          • (params?: RequestOptions & Octokit.ChecksListSuitesForRefParams): Promise<Response<Octokit.ChecksListSuitesForRefResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ChecksListSuitesForRefParams

            Returns Promise<Response<Octokit.ChecksListSuitesForRefResponse>>

        • endpoint: Endpoint
      • rerequestSuite: { endpoint: Endpoint }

        Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the check_suite webhook event with the action rerequested. When a check suite is rerequested, its status is reset to queued and the conclusion is cleared.

        To rerequest a check suite, your GitHub App must have the checks:read permission on a private repository or pull access to a public repository.

          • (params?: RequestOptions & Octokit.ChecksRerequestSuiteParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ChecksRerequestSuiteParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • setSuitesPreferences: { endpoint: Endpoint }

        Changes the default automatic flow when creating check suites. By default, the CheckSuiteEvent is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually Create a check suite. You must have admin permissions in the repository to set preferences for check suites.

          • (params?: RequestOptions & Octokit.ChecksSetSuitesPreferencesParams): Promise<Response<Octokit.ChecksSetSuitesPreferencesResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ChecksSetSuitesPreferencesParams

            Returns Promise<Response<Octokit.ChecksSetSuitesPreferencesResponse>>

        • endpoint: Endpoint
      • update: { endpoint: Endpoint }

        Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

        Updates a check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to edit check runs.

      codesOfConduct

      codesOfConduct: { getConductCode: { endpoint: Endpoint }; getForRepo: { endpoint: Endpoint }; listConductCodes: { endpoint: Endpoint } }

      Type declaration

      • getConductCode: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.CodesOfConductGetConductCodeParams): Promise<Response<Octokit.CodesOfConductGetConductCodeResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.CodesOfConductGetConductCodeParams

            Returns Promise<Response<Octokit.CodesOfConductGetConductCodeResponse>>

        • endpoint: Endpoint
      • getForRepo: { endpoint: Endpoint }

        This method returns the contents of the repository's code of conduct file, if one is detected.

          • (params?: RequestOptions & Octokit.CodesOfConductGetForRepoParams): Promise<Response<Octokit.CodesOfConductGetForRepoResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.CodesOfConductGetForRepoParams

            Returns Promise<Response<Octokit.CodesOfConductGetForRepoResponse>>

        • endpoint: Endpoint
      • listConductCodes: { endpoint: Endpoint }

      emojis

      emojis: { get: { endpoint: Endpoint } }

      Type declaration

      gists

      gists: { checkIsStarred: { endpoint: Endpoint }; create: { endpoint: Endpoint }; createComment: { endpoint: Endpoint }; delete: { endpoint: Endpoint }; deleteComment: { endpoint: Endpoint }; fork: { endpoint: Endpoint }; get: { endpoint: Endpoint }; getComment: { endpoint: Endpoint }; getRevision: { endpoint: Endpoint }; list: { endpoint: Endpoint }; listComments: { endpoint: Endpoint }; listCommits: { endpoint: Endpoint }; listForks: { endpoint: Endpoint }; listPublic: { endpoint: Endpoint }; listPublicForUser: { endpoint: Endpoint }; listStarred: { endpoint: Endpoint }; star: { endpoint: Endpoint }; unstar: { endpoint: Endpoint }; update: { endpoint: Endpoint }; updateComment: { endpoint: Endpoint } }

      Type declaration

      • checkIsStarred: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.GistsCheckIsStarredParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • create: { endpoint: Endpoint }

        Allows you to add a new gist with one or more files.

        Note: Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.

      • createComment: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.GistsCreateCommentParams): Promise<Response<Octokit.GistsCreateCommentResponse>>

          • Parameters

            Returns Promise<Response<Octokit.GistsCreateCommentResponse>>

        • endpoint: Endpoint
      • delete: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.GistsDeleteParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • deleteComment: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.GistsDeleteCommentParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • fork: { endpoint: Endpoint }

        Note: This was previously /gists/:gist_id/fork.

      • get: { endpoint: Endpoint }
      • getComment: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.GistsGetCommentParams): Promise<Response<Octokit.GistsGetCommentResponse>>

          • Parameters

            Returns Promise<Response<Octokit.GistsGetCommentResponse>>

        • endpoint: Endpoint
      • getRevision: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.GistsGetRevisionParams): Promise<Response<Octokit.GistsGetRevisionResponse>>

          • Parameters

            Returns Promise<Response<Octokit.GistsGetRevisionResponse>>

        • endpoint: Endpoint
      • list: { endpoint: Endpoint }
      • listComments: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.GistsListCommentsParams): Promise<Response<Octokit.GistsListCommentsResponse>>

          • Parameters

            Returns Promise<Response<Octokit.GistsListCommentsResponse>>

        • endpoint: Endpoint
      • listCommits: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.GistsListCommitsParams): Promise<Response<Octokit.GistsListCommitsResponse>>

          • Parameters

            Returns Promise<Response<Octokit.GistsListCommitsResponse>>

        • endpoint: Endpoint
      • listForks: { endpoint: Endpoint }

          • Parameters

            Returns Promise<Response<Octokit.GistsListForksResponse>>

        • endpoint: Endpoint
      • listPublic: { endpoint: Endpoint }

        List all public gists sorted by most recently updated to least recently updated.

        Note: With pagination, you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.

          • (params?: RequestOptions & Octokit.GistsListPublicParams): Promise<Response<Octokit.GistsListPublicResponse>>

          • Parameters

            Returns Promise<Response<Octokit.GistsListPublicResponse>>

        • endpoint: Endpoint
      • listPublicForUser: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.GistsListPublicForUserParams): Promise<Response<Octokit.GistsListPublicForUserResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.GistsListPublicForUserParams

            Returns Promise<Response<Octokit.GistsListPublicForUserResponse>>

        • endpoint: Endpoint
      • listStarred: { endpoint: Endpoint }

        List the authenticated user's starred gists:

          • (params?: RequestOptions & Octokit.GistsListStarredParams): Promise<Response<Octokit.GistsListStarredResponse>>

          • Parameters

            Returns Promise<Response<Octokit.GistsListStarredResponse>>

        • endpoint: Endpoint
      • star: { endpoint: Endpoint }

        Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."

          • (params?: RequestOptions & Octokit.GistsStarParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • unstar: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.GistsUnstarParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • update: { endpoint: Endpoint }

        Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.

      • updateComment: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.GistsUpdateCommentParams): Promise<Response<Octokit.GistsUpdateCommentResponse>>

          • Parameters

            Returns Promise<Response<Octokit.GistsUpdateCommentResponse>>

        • endpoint: Endpoint

      git

      git: { createBlob: { endpoint: Endpoint }; createCommit: { endpoint: Endpoint }; createRef: { endpoint: Endpoint }; createTag: { endpoint: Endpoint }; createTree: { endpoint: Endpoint }; deleteRef: { endpoint: Endpoint }; getBlob: { endpoint: Endpoint }; getCommit: { endpoint: Endpoint }; getRef: { endpoint: Endpoint }; getTag: { endpoint: Endpoint }; getTree: { endpoint: Endpoint }; listMatchingRefs: { endpoint: Endpoint }; listRefs: { endpoint: Endpoint }; updateRef: { endpoint: Endpoint } }

      Type declaration

      • createBlob: { endpoint: Endpoint }
      • createCommit: { endpoint: Endpoint }

        Creates a new Git commit object.

        In this example, the payload of the signature would be:

        Signature verification object

        The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:

        These are the possible values for reason in the verification object:

        Value Description
        expired_key The key that made the signature is expired.
        not_signing_key The "signing" flag is not among the usage flags in the GPG key that made the signature.
        gpgverify_error There was an error communicating with the signature verification service.
        gpgverify_unavailable The signature verification service is currently unavailable.
        unsigned The object does not include a signature.
        unknown_signature_type A non-PGP signature was found in the commit.
        no_user No user was associated with the committer email address in the commit.
        unverified_email The committer email address in the commit was associated with a user, but the email address is not verified on her/his account.
        bad_email The committer email address in the commit is not included in the identities of the PGP key that made the signature.
        unknown_key The key that made the signature has not been registered with any user's account.
        malformed_signature There was an error parsing the signature.
        invalid The signature could not be cryptographically verified using the key whose key-id was found in the signature.
        valid None of the above errors applied, so the signature is considered to be verified.
          • (params?: RequestOptions & Octokit.GitCreateCommitParams): Promise<Response<Octokit.GitCreateCommitResponse>>

          • Parameters

            Returns Promise<Response<Octokit.GitCreateCommitResponse>>

        • endpoint: Endpoint
      • createRef: { endpoint: Endpoint }

        Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.

      • createTag: { endpoint: Endpoint }

        Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then create the refs/tags/[tag] reference. If you want to create a lightweight tag, you only have to create the tag reference - this call would be unnecessary.

        Signature verification object

        The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:

        These are the possible values for reason in the verification object:

        Value Description
        expired_key The key that made the signature is expired.
        not_signing_key The "signing" flag is not among the usage flags in the GPG key that made the signature.
        gpgverify_error There was an error communicating with the signature verification service.
        gpgverify_unavailable The signature verification service is currently unavailable.
        unsigned The object does not include a signature.
        unknown_signature_type A non-PGP signature was found in the commit.
        no_user No user was associated with the committer email address in the commit.
        unverified_email The committer email address in the commit was associated with a user, but the email address is not verified on her/his account.
        bad_email The committer email address in the commit is not included in the identities of the PGP key that made the signature.
        unknown_key The key that made the signature has not been registered with any user's account.
        malformed_signature There was an error parsing the signature.
        invalid The signature could not be cryptographically verified using the key whose key-id was found in the signature.
        valid None of the above errors applied, so the signature is considered to be verified.
      • createTree: { endpoint: Endpoint }

        The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.

        If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "Create a commit" and "Update a reference."

      • deleteRef: { endpoint: Endpoint } 
        DELETE /repos/octocat/Hello-World/git/refs/heads/feature-a
        DELETE /repos/octocat/Hello-World/git/refs/tags/v1.0
          • (params?: RequestOptions & Octokit.GitDeleteRefParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • getBlob: { endpoint: Endpoint }

        The content in the response will always be Base64 encoded.

        Note: This API supports blobs up to 100 megabytes in size.

      • getCommit: { endpoint: Endpoint }

        Gets a Git commit object.

        Signature verification object

        The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:

        These are the possible values for reason in the verification object:

        Value Description
        expired_key The key that made the signature is expired.
        not_signing_key The "signing" flag is not among the usage flags in the GPG key that made the signature.
        gpgverify_error There was an error communicating with the signature verification service.
        gpgverify_unavailable The signature verification service is currently unavailable.
        unsigned The object does not include a signature.
        unknown_signature_type A non-PGP signature was found in the commit.
        no_user No user was associated with the committer email address in the commit.
        unverified_email The committer email address in the commit was associated with a user, but the email address is not verified on her/his account.
        bad_email The committer email address in the commit is not included in the identities of the PGP key that made the signature.
        unknown_key The key that made the signature has not been registered with any user's account.
        malformed_signature There was an error parsing the signature.
        invalid The signature could not be cryptographically verified using the key whose key-id was found in the signature.
        valid None of the above errors applied, so the signature is considered to be verified.
      • getRef: { endpoint: Endpoint }

        Returns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.

        Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "Checking mergeability of pull requests".

        To get the reference for a branch named skunkworkz/featureA, the endpoint route is:

      • getTag: { endpoint: Endpoint }

        Signature verification object

        The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:

        These are the possible values for reason in the verification object:

        Value Description
        expired_key The key that made the signature is expired.
        not_signing_key The "signing" flag is not among the usage flags in the GPG key that made the signature.
        gpgverify_error There was an error communicating with the signature verification service.
        gpgverify_unavailable The signature verification service is currently unavailable.
        unsigned The object does not include a signature.
        unknown_signature_type A non-PGP signature was found in the commit.
        no_user No user was associated with the committer email address in the commit.
        unverified_email The committer email address in the commit was associated with a user, but the email address is not verified on her/his account.
        bad_email The committer email address in the commit is not included in the identities of the PGP key that made the signature.
        unknown_key The key that made the signature has not been registered with any user's account.
        malformed_signature There was an error parsing the signature.
        invalid The signature could not be cryptographically verified using the key whose key-id was found in the signature.
        valid None of the above errors applied, so the signature is considered to be verified.
      • getTree: { endpoint: Endpoint }

        Returns a single tree using the SHA1 value for that tree.

        If truncated is true in the response then the number of items in the tree array exceeded our maximum limit. If you need to fetch more items, you can clone the repository and iterate over the Git data locally.

      • listMatchingRefs: { endpoint: Endpoint }

        Returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.

        When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.

        Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "Checking mergeability of pull requests".

        If you request matching references for a branch named feature but the branch feature doesn't exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.

          • (params?: RequestOptions & Octokit.GitListMatchingRefsParams): Promise<Response<Octokit.GitListMatchingRefsResponse>>

          • Parameters

            Returns Promise<Response<Octokit.GitListMatchingRefsResponse>>

        • endpoint: Endpoint
      • listRefs: { endpoint: Endpoint }

        Returns an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags. If there are no references to list, a 404 is returned.

          • (params?: RequestOptions & Octokit.GitListRefsParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • updateRef: { endpoint: Endpoint }

      gitignore

      gitignore: { getTemplate: { endpoint: Endpoint }; listTemplates: { endpoint: Endpoint } }

      Type declaration

      graphql

      graphql: Graphql

      hook

      hook: { after: any; before: any; error: any; wrap: any }

      Type declaration

      • after: function
        • after(name: string, callback: (response: Response<any>, options: Octokit.HookOptions) => void): void

        • Parameters

          • name: string
          • callback: (response: Response<any>, options: Octokit.HookOptions) => void
              • (response: Response<any>, options: Octokit.HookOptions): void

              • Parameters

                • response: Response<any>
                • options: Octokit.HookOptions

                Returns void

          Returns void

      • before: function
        • before(name: string, callback: (options: Octokit.HookOptions) => void): void

        • Parameters

          • name: string
          • callback: (options: Octokit.HookOptions) => void
              • (options: Octokit.HookOptions): void

              • Parameters

                • options: Octokit.HookOptions

                Returns void

          Returns void

      • error: function
        • error(name: string, callback: (error: Octokit.HookError, options: Octokit.HookOptions) => void): void

        • Parameters

          • name: string
          • callback: (error: Octokit.HookError, options: Octokit.HookOptions) => void
              • (error: Octokit.HookError, options: Octokit.HookOptions): void

              • Parameters

                • error: Octokit.HookError
                • options: Octokit.HookOptions

                Returns void

          Returns void

      • wrap: function
        • wrap(name: string, callback: (request: (options: Octokit.HookOptions) => Promise<Response<any>>, options: Octokit.HookOptions) => void): void

        • Parameters

          • name: string
          • callback: (request: (options: Octokit.HookOptions) => Promise<Response<any>>, options: Octokit.HookOptions) => void
              • (request: (options: Octokit.HookOptions) => Promise<Response<any>>, options: Octokit.HookOptions): void

              • Parameters

                • request: (options: Octokit.HookOptions) => Promise<Response<any>>
                    • (options: Octokit.HookOptions): Promise<Response<any>>

                    • Parameters

                      • options: Octokit.HookOptions

                      Returns Promise<Response<any>>

                • options: Octokit.HookOptions

                Returns void

          Returns void

      interactions

      interactions: { addOrUpdateRestrictionsForOrg: { endpoint: Endpoint }; addOrUpdateRestrictionsForRepo: { endpoint: Endpoint }; getRestrictionsForOrg: { endpoint: Endpoint }; getRestrictionsForRepo: { endpoint: Endpoint }; removeRestrictionsForOrg: { endpoint: Endpoint }; removeRestrictionsForRepo: { endpoint: Endpoint } }

      Type declaration

      • addOrUpdateRestrictionsForOrg: { endpoint: Endpoint }

        Temporarily restricts interactions to certain GitHub users in any public repository in the given organization. You must be an organization owner to set these restrictions.

          • (params?: RequestOptions & Octokit.InteractionsAddOrUpdateRestrictionsForOrgParams): Promise<Response<Octokit.InteractionsAddOrUpdateRestrictionsForOrgResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.InteractionsAddOrUpdateRestrictionsForOrgParams

            Returns Promise<Response<Octokit.InteractionsAddOrUpdateRestrictionsForOrgResponse>>

        • endpoint: Endpoint
      • addOrUpdateRestrictionsForRepo: { endpoint: Endpoint }

        Temporarily restricts interactions to certain GitHub users within the given repository. You must have owner or admin access to set restrictions.

          • (params?: RequestOptions & Octokit.InteractionsAddOrUpdateRestrictionsForRepoParams): Promise<Response<Octokit.InteractionsAddOrUpdateRestrictionsForRepoResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.InteractionsAddOrUpdateRestrictionsForRepoParams

            Returns Promise<Response<Octokit.InteractionsAddOrUpdateRestrictionsForRepoResponse>>

        • endpoint: Endpoint
      • getRestrictionsForOrg: { endpoint: Endpoint }

        Shows which group of GitHub users can interact with this organization and when the restriction expires. If there are no restrictions, you will see an empty response.

          • (params?: RequestOptions & Octokit.InteractionsGetRestrictionsForOrgParams): Promise<Response<Octokit.InteractionsGetRestrictionsForOrgResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.InteractionsGetRestrictionsForOrgParams

            Returns Promise<Response<Octokit.InteractionsGetRestrictionsForOrgResponse>>

        • endpoint: Endpoint
      • getRestrictionsForRepo: { endpoint: Endpoint }

        Shows which group of GitHub users can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response.

          • (params?: RequestOptions & Octokit.InteractionsGetRestrictionsForRepoParams): Promise<Response<Octokit.InteractionsGetRestrictionsForRepoResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.InteractionsGetRestrictionsForRepoParams

            Returns Promise<Response<Octokit.InteractionsGetRestrictionsForRepoResponse>>

        • endpoint: Endpoint
      • removeRestrictionsForOrg: { endpoint: Endpoint }

        Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions.

          • (params?: RequestOptions & Octokit.InteractionsRemoveRestrictionsForOrgParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.InteractionsRemoveRestrictionsForOrgParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • removeRestrictionsForRepo: { endpoint: Endpoint }

        Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions.

          • (params?: RequestOptions & Octokit.InteractionsRemoveRestrictionsForRepoParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.InteractionsRemoveRestrictionsForRepoParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint

      issues

      issues: { addAssignees: { endpoint: Endpoint }; addLabels: { endpoint: Endpoint }; checkAssignee: { endpoint: Endpoint }; create: { endpoint: Endpoint }; createComment: { endpoint: Endpoint }; createLabel: { endpoint: Endpoint }; createMilestone: { endpoint: Endpoint }; deleteComment: { endpoint: Endpoint }; deleteLabel: { endpoint: Endpoint }; deleteMilestone: { endpoint: Endpoint }; get: { endpoint: Endpoint }; getComment: { endpoint: Endpoint }; getEvent: { endpoint: Endpoint }; getLabel: { endpoint: Endpoint }; getMilestone: { endpoint: Endpoint }; list: { endpoint: Endpoint }; listAssignees: { endpoint: Endpoint }; listComments: { endpoint: Endpoint }; listCommentsForRepo: { endpoint: Endpoint }; listEvents: { endpoint: Endpoint }; listEventsForRepo: { endpoint: Endpoint }; listEventsForTimeline: { endpoint: Endpoint }; listForAuthenticatedUser: { endpoint: Endpoint }; listForOrg: { endpoint: Endpoint }; listForRepo: { endpoint: Endpoint }; listLabelsForMilestone: { endpoint: Endpoint }; listLabelsForRepo: { endpoint: Endpoint }; listLabelsOnIssue: { endpoint: Endpoint }; listMilestonesForRepo: { endpoint: Endpoint }; lock: { endpoint: Endpoint }; removeAssignees: { endpoint: Endpoint }; removeLabel: { endpoint: Endpoint }; removeLabels: { endpoint: Endpoint }; replaceLabels: { endpoint: Endpoint }; unlock: { endpoint: Endpoint }; update: { endpoint: Endpoint }; updateComment: { endpoint: Endpoint }; updateLabel: { endpoint: Endpoint }; updateMilestone: { endpoint: Endpoint } }

      Type declaration

      • addAssignees: { endpoint: Endpoint }

        Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.

        This example adds two assignees to the existing octocat assignee.

          • (params?: RequestOptions & Octokit.IssuesAddAssigneesParamsDeprecatedNumber): Promise<Response<Octokit.IssuesAddAssigneesResponse>>
          • (params?: RequestOptions & Octokit.IssuesAddAssigneesParams): Promise<Response<Octokit.IssuesAddAssigneesResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.IssuesAddAssigneesParamsDeprecatedNumber

            Returns Promise<Response<Octokit.IssuesAddAssigneesResponse>>

          • Parameters

            Returns Promise<Response<Octokit.IssuesAddAssigneesResponse>>

        • endpoint: Endpoint
      • addLabels: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.IssuesAddLabelsParamsDeprecatedNumber): Promise<Response<Octokit.IssuesAddLabelsResponse>>
          • (params?: RequestOptions & Octokit.IssuesAddLabelsParams): Promise<Response<Octokit.IssuesAddLabelsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.IssuesAddLabelsParamsDeprecatedNumber

            Returns Promise<Response<Octokit.IssuesAddLabelsResponse>>

          • Parameters

            Returns Promise<Response<Octokit.IssuesAddLabelsResponse>>

        • endpoint: Endpoint
      • checkAssignee: { endpoint: Endpoint }

        Checks if a user has permission to be assigned to an issue in this repository.

        If the assignee can be assigned to issues in the repository, a 204 header with no content is returned.

        Otherwise a 404 status code is returned.

          • (params?: RequestOptions & Octokit.IssuesCheckAssigneeParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • create: { endpoint: Endpoint }

        Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

        This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

          • (params?: RequestOptions & Octokit.IssuesCreateParamsDeprecatedAssignee): Promise<Response<Octokit.IssuesCreateResponse>>
          • (params?: RequestOptions & Octokit.IssuesCreateParams): Promise<Response<Octokit.IssuesCreateResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.IssuesCreateParamsDeprecatedAssignee

            Returns Promise<Response<Octokit.IssuesCreateResponse>>

          • Parameters

            Returns Promise<Response<Octokit.IssuesCreateResponse>>

        • endpoint: Endpoint
      • createComment: { endpoint: Endpoint }

        This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

          • (params?: RequestOptions & Octokit.IssuesCreateCommentParamsDeprecatedNumber): Promise<Response<Octokit.IssuesCreateCommentResponse>>
          • (params?: RequestOptions & Octokit.IssuesCreateCommentParams): Promise<Response<Octokit.IssuesCreateCommentResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.IssuesCreateCommentParamsDeprecatedNumber

            Returns Promise<Response<Octokit.IssuesCreateCommentResponse>>

          • Parameters

            Returns Promise<Response<Octokit.IssuesCreateCommentResponse>>

        • endpoint: Endpoint
      • createLabel: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.IssuesCreateLabelParams): Promise<Response<Octokit.IssuesCreateLabelResponse>>

          • Parameters

            Returns Promise<Response<Octokit.IssuesCreateLabelResponse>>

        • endpoint: Endpoint
      • createMilestone: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.IssuesCreateMilestoneParams): Promise<Response<Octokit.IssuesCreateMilestoneResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.IssuesCreateMilestoneParams

            Returns Promise<Response<Octokit.IssuesCreateMilestoneResponse>>

        • endpoint: Endpoint
      • deleteComment: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.IssuesDeleteCommentParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • deleteLabel: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.IssuesDeleteLabelParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • deleteMilestone: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.IssuesDeleteMilestoneParamsDeprecatedNumber): Promise<Octokit.AnyResponse>
          • (params?: RequestOptions & Octokit.IssuesDeleteMilestoneParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.IssuesDeleteMilestoneParamsDeprecatedNumber

            Returns Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.IssuesDeleteMilestoneParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • get: { endpoint: Endpoint }

        The API returns a 301 Moved Permanently status if the issue was transferred to another repository. If the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API returns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read access, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe to the issues webhook.

        Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key.

        Be aware that the id of a pull request returned from "Issues" endpoints will be an issue id. To find out the pull request id, use the "List pull requests" endpoint.

          • Parameters

            • Optional params: RequestOptions & Octokit.IssuesGetParamsDeprecatedNumber

            Returns Promise<Response<Octokit.IssuesGetResponse>>

          • Parameters

            Returns Promise<Response<Octokit.IssuesGetResponse>>

        • endpoint: Endpoint
      • getComment: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.IssuesGetCommentParams): Promise<Response<Octokit.IssuesGetCommentResponse>>

          • Parameters

            Returns Promise<Response<Octokit.IssuesGetCommentResponse>>

        • endpoint: Endpoint
      • getEvent: { endpoint: Endpoint }

          • Parameters

            Returns Promise<Response<Octokit.IssuesGetEventResponse>>

        • endpoint: Endpoint
      • getLabel: { endpoint: Endpoint }

          • Parameters

            Returns Promise<Response<Octokit.IssuesGetLabelResponse>>

        • endpoint: Endpoint
      • getMilestone: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.IssuesGetMilestoneParamsDeprecatedNumber): Promise<Response<Octokit.IssuesGetMilestoneResponse>>
          • (params?: RequestOptions & Octokit.IssuesGetMilestoneParams): Promise<Response<Octokit.IssuesGetMilestoneResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.IssuesGetMilestoneParamsDeprecatedNumber

            Returns Promise<Response<Octokit.IssuesGetMilestoneResponse>>

          • Parameters

            Returns Promise<Response<Octokit.IssuesGetMilestoneResponse>>

        • endpoint: Endpoint
      • list: { endpoint: Endpoint }

        Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key.

        Be aware that the id of a pull request returned from "Issues" endpoints will be an issue id. To find out the pull request id, use the "List pull requests" endpoint.

      • listAssignees: { endpoint: Endpoint }

        Lists the available assignees for issues in a repository.

          • (params?: RequestOptions & Octokit.IssuesListAssigneesParams): Promise<Response<Octokit.IssuesListAssigneesResponse>>

          • Parameters

            Returns Promise<Response<Octokit.IssuesListAssigneesResponse>>

        • endpoint: Endpoint
      • listComments: { endpoint: Endpoint }

        Issue Comments are ordered by ascending ID.

          • (params?: RequestOptions & Octokit.IssuesListCommentsParamsDeprecatedNumber): Promise<Response<Octokit.IssuesListCommentsResponse>>
          • (params?: RequestOptions & Octokit.IssuesListCommentsParams): Promise<Response<Octokit.IssuesListCommentsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.IssuesListCommentsParamsDeprecatedNumber

            Returns Promise<Response<Octokit.IssuesListCommentsResponse>>

          • Parameters

            Returns Promise<Response<Octokit.IssuesListCommentsResponse>>

        • endpoint: Endpoint
      • listCommentsForRepo: { endpoint: Endpoint }

        By default, Issue Comments are ordered by ascending ID.

          • (params?: RequestOptions & Octokit.IssuesListCommentsForRepoParams): Promise<Response<Octokit.IssuesListCommentsForRepoResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.IssuesListCommentsForRepoParams

            Returns Promise<Response<Octokit.IssuesListCommentsForRepoResponse>>

        • endpoint: Endpoint
      • listEvents: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.IssuesListEventsParamsDeprecatedNumber): Promise<Response<Octokit.IssuesListEventsResponse>>
          • (params?: RequestOptions & Octokit.IssuesListEventsParams): Promise<Response<Octokit.IssuesListEventsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.IssuesListEventsParamsDeprecatedNumber

            Returns Promise<Response<Octokit.IssuesListEventsResponse>>

          • Parameters

            Returns Promise<Response<Octokit.IssuesListEventsResponse>>

        • endpoint: Endpoint
      • listEventsForRepo: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.IssuesListEventsForRepoParams): Promise<Response<Octokit.IssuesListEventsForRepoResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.IssuesListEventsForRepoParams

            Returns Promise<Response<Octokit.IssuesListEventsForRepoResponse>>

        • endpoint: Endpoint
      • listEventsForTimeline: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.IssuesListEventsForTimelineParamsDeprecatedNumber): Promise<Response<Octokit.IssuesListEventsForTimelineResponse>>
          • (params?: RequestOptions & Octokit.IssuesListEventsForTimelineParams): Promise<Response<Octokit.IssuesListEventsForTimelineResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.IssuesListEventsForTimelineParamsDeprecatedNumber

            Returns Promise<Response<Octokit.IssuesListEventsForTimelineResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.IssuesListEventsForTimelineParams

            Returns Promise<Response<Octokit.IssuesListEventsForTimelineResponse>>

        • endpoint: Endpoint
      • listForAuthenticatedUser: { endpoint: Endpoint }

        Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key.

        Be aware that the id of a pull request returned from "Issues" endpoints will be an issue id. To find out the pull request id, use the "List pull requests" endpoint.

          • (params?: RequestOptions & Octokit.IssuesListForAuthenticatedUserParams): Promise<Response<Octokit.IssuesListForAuthenticatedUserResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.IssuesListForAuthenticatedUserParams

            Returns Promise<Response<Octokit.IssuesListForAuthenticatedUserResponse>>

        • endpoint: Endpoint
      • listForOrg: { endpoint: Endpoint }

        Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key.

        Be aware that the id of a pull request returned from "Issues" endpoints will be an issue id. To find out the pull request id, use the "List pull requests" endpoint.

          • (params?: RequestOptions & Octokit.IssuesListForOrgParams): Promise<Response<Octokit.IssuesListForOrgResponse>>

          • Parameters

            Returns Promise<Response<Octokit.IssuesListForOrgResponse>>

        • endpoint: Endpoint
      • listForRepo: { endpoint: Endpoint }

        Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key.

        Be aware that the id of a pull request returned from "Issues" endpoints will be an issue id. To find out the pull request id, use the "List pull requests" endpoint.

          • (params?: RequestOptions & Octokit.IssuesListForRepoParams): Promise<Response<Octokit.IssuesListForRepoResponse>>

          • Parameters

            Returns Promise<Response<Octokit.IssuesListForRepoResponse>>

        • endpoint: Endpoint
      • listLabelsForMilestone: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.IssuesListLabelsForMilestoneParamsDeprecatedNumber): Promise<Response<Octokit.IssuesListLabelsForMilestoneResponse>>
          • (params?: RequestOptions & Octokit.IssuesListLabelsForMilestoneParams): Promise<Response<Octokit.IssuesListLabelsForMilestoneResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.IssuesListLabelsForMilestoneParamsDeprecatedNumber

            Returns Promise<Response<Octokit.IssuesListLabelsForMilestoneResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.IssuesListLabelsForMilestoneParams

            Returns Promise<Response<Octokit.IssuesListLabelsForMilestoneResponse>>

        • endpoint: Endpoint
      • listLabelsForRepo: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.IssuesListLabelsForRepoParams): Promise<Response<Octokit.IssuesListLabelsForRepoResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.IssuesListLabelsForRepoParams

            Returns Promise<Response<Octokit.IssuesListLabelsForRepoResponse>>

        • endpoint: Endpoint
      • listLabelsOnIssue: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.IssuesListLabelsOnIssueParamsDeprecatedNumber): Promise<Response<Octokit.IssuesListLabelsOnIssueResponse>>
          • (params?: RequestOptions & Octokit.IssuesListLabelsOnIssueParams): Promise<Response<Octokit.IssuesListLabelsOnIssueResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.IssuesListLabelsOnIssueParamsDeprecatedNumber

            Returns Promise<Response<Octokit.IssuesListLabelsOnIssueResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.IssuesListLabelsOnIssueParams

            Returns Promise<Response<Octokit.IssuesListLabelsOnIssueResponse>>

        • endpoint: Endpoint
      • listMilestonesForRepo: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.IssuesListMilestonesForRepoParams): Promise<Response<Octokit.IssuesListMilestonesForRepoResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.IssuesListMilestonesForRepoParams

            Returns Promise<Response<Octokit.IssuesListMilestonesForRepoResponse>>

        • endpoint: Endpoint
      • lock: { endpoint: Endpoint }

        Users with push access can lock an issue or pull request's conversation.

        Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."

          • (params?: RequestOptions & Octokit.IssuesLockParamsDeprecatedNumber): Promise<Octokit.AnyResponse>
          • (params?: RequestOptions & Octokit.IssuesLockParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.IssuesLockParamsDeprecatedNumber

            Returns Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • removeAssignees: { endpoint: Endpoint }

        Removes one or more assignees from an issue.

        This example removes two of three assignees, leaving the octocat assignee.

          • (params?: RequestOptions & Octokit.IssuesRemoveAssigneesParamsDeprecatedNumber): Promise<Response<Octokit.IssuesRemoveAssigneesResponse>>
          • (params?: RequestOptions & Octokit.IssuesRemoveAssigneesParams): Promise<Response<Octokit.IssuesRemoveAssigneesResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.IssuesRemoveAssigneesParamsDeprecatedNumber

            Returns Promise<Response<Octokit.IssuesRemoveAssigneesResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.IssuesRemoveAssigneesParams

            Returns Promise<Response<Octokit.IssuesRemoveAssigneesResponse>>

        • endpoint: Endpoint
      • removeLabel: { endpoint: Endpoint }

        Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a 404 Not Found status if the label does not exist.

          • (params?: RequestOptions & Octokit.IssuesRemoveLabelParamsDeprecatedNumber): Promise<Response<Octokit.IssuesRemoveLabelResponse>>
          • (params?: RequestOptions & Octokit.IssuesRemoveLabelParams): Promise<Response<Octokit.IssuesRemoveLabelResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.IssuesRemoveLabelParamsDeprecatedNumber

            Returns Promise<Response<Octokit.IssuesRemoveLabelResponse>>

          • Parameters

            Returns Promise<Response<Octokit.IssuesRemoveLabelResponse>>

        • endpoint: Endpoint
      • removeLabels: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.IssuesRemoveLabelsParamsDeprecatedNumber): Promise<Octokit.AnyResponse>
          • (params?: RequestOptions & Octokit.IssuesRemoveLabelsParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.IssuesRemoveLabelsParamsDeprecatedNumber

            Returns Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • replaceLabels: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.IssuesReplaceLabelsParamsDeprecatedNumber): Promise<Response<Octokit.IssuesReplaceLabelsResponse>>
          • (params?: RequestOptions & Octokit.IssuesReplaceLabelsParams): Promise<Response<Octokit.IssuesReplaceLabelsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.IssuesReplaceLabelsParamsDeprecatedNumber

            Returns Promise<Response<Octokit.IssuesReplaceLabelsResponse>>

          • Parameters

            Returns Promise<Response<Octokit.IssuesReplaceLabelsResponse>>

        • endpoint: Endpoint
      • unlock: { endpoint: Endpoint }

        Users with push access can unlock an issue's conversation.

          • (params?: RequestOptions & Octokit.IssuesUnlockParamsDeprecatedNumber): Promise<Octokit.AnyResponse>
          • (params?: RequestOptions & Octokit.IssuesUnlockParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.IssuesUnlockParamsDeprecatedNumber

            Returns Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • update: { endpoint: Endpoint }

        Issue owners and users with push access can edit an issue.

          • (params?: RequestOptions & Octokit.IssuesUpdateParamsDeprecatedNumber): Promise<Response<Octokit.IssuesUpdateResponse>>
          • (params?: RequestOptions & Octokit.IssuesUpdateParamsDeprecatedAssignee): Promise<Response<Octokit.IssuesUpdateResponse>>
          • (params?: RequestOptions & Octokit.IssuesUpdateParams): Promise<Response<Octokit.IssuesUpdateResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.IssuesUpdateParamsDeprecatedNumber

            Returns Promise<Response<Octokit.IssuesUpdateResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.IssuesUpdateParamsDeprecatedAssignee

            Returns Promise<Response<Octokit.IssuesUpdateResponse>>

          • Parameters

            Returns Promise<Response<Octokit.IssuesUpdateResponse>>

        • endpoint: Endpoint
      • updateComment: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.IssuesUpdateCommentParams): Promise<Response<Octokit.IssuesUpdateCommentResponse>>

          • Parameters

            Returns Promise<Response<Octokit.IssuesUpdateCommentResponse>>

        • endpoint: Endpoint
      • updateLabel: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.IssuesUpdateLabelParams): Promise<Response<Octokit.IssuesUpdateLabelResponse>>

          • Parameters

            Returns Promise<Response<Octokit.IssuesUpdateLabelResponse>>

        • endpoint: Endpoint
      • updateMilestone: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.IssuesUpdateMilestoneParamsDeprecatedNumber): Promise<Response<Octokit.IssuesUpdateMilestoneResponse>>
          • (params?: RequestOptions & Octokit.IssuesUpdateMilestoneParams): Promise<Response<Octokit.IssuesUpdateMilestoneResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.IssuesUpdateMilestoneParamsDeprecatedNumber

            Returns Promise<Response<Octokit.IssuesUpdateMilestoneResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.IssuesUpdateMilestoneParams

            Returns Promise<Response<Octokit.IssuesUpdateMilestoneResponse>>

        • endpoint: Endpoint

      licenses

      licenses: { get: { endpoint: Endpoint }; getForRepo: { endpoint: Endpoint }; list: { endpoint: Endpoint }; listCommonlyUsed: { endpoint: Endpoint } }

      Type declaration

      log

      log: Log

      markdown

      markdown: { render: { endpoint: Endpoint }; renderRaw: { endpoint: Endpoint } }

      Type declaration

      • render: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.MarkdownRenderParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • renderRaw: { endpoint: Endpoint }

        You must send Markdown as plain text (using a Content-Type header of text/plain or text/x-markdown) to this endpoint, rather than using JSON format. In raw mode, GitHub Flavored Markdown is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less.

          • (params?: RequestOptions & Octokit.MarkdownRenderRawParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint

      meta

      meta: { get: { endpoint: Endpoint } }

      Type declaration

      migrations

      migrations: { cancelImport: { endpoint: Endpoint }; deleteArchiveForAuthenticatedUser: { endpoint: Endpoint }; deleteArchiveForOrg: { endpoint: Endpoint }; downloadArchiveForOrg: { endpoint: Endpoint }; getArchiveForAuthenticatedUser: { endpoint: Endpoint }; getArchiveForOrg: { endpoint: Endpoint }; getCommitAuthors: { endpoint: Endpoint }; getImportProgress: { endpoint: Endpoint }; getLargeFiles: { endpoint: Endpoint }; getStatusForAuthenticatedUser: { endpoint: Endpoint }; getStatusForOrg: { endpoint: Endpoint }; listForAuthenticatedUser: { endpoint: Endpoint }; listForOrg: { endpoint: Endpoint }; listReposForOrg: { endpoint: Endpoint }; listReposForUser: { endpoint: Endpoint }; mapCommitAuthor: { endpoint: Endpoint }; setLfsPreference: { endpoint: Endpoint }; startForAuthenticatedUser: { endpoint: Endpoint }; startForOrg: { endpoint: Endpoint }; startImport: { endpoint: Endpoint }; unlockRepoForAuthenticatedUser: { endpoint: Endpoint }; unlockRepoForOrg: { endpoint: Endpoint }; updateImport: { endpoint: Endpoint } }

      Type declaration

      • cancelImport: { endpoint: Endpoint }

        Stop an import for a repository.

          • (params?: RequestOptions & Octokit.MigrationsCancelImportParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.MigrationsCancelImportParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • deleteArchiveForAuthenticatedUser: { endpoint: Endpoint }

        Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the List user migrations and Get the status of a user migration endpoints, will continue to be available even after an archive is deleted.

          • (params?: RequestOptions & Octokit.MigrationsDeleteArchiveForAuthenticatedUserParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.MigrationsDeleteArchiveForAuthenticatedUserParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • deleteArchiveForOrg: { endpoint: Endpoint }

        Deletes a previous migration archive. Migration archives are automatically deleted after seven days.

          • (params?: RequestOptions & Octokit.MigrationsDeleteArchiveForOrgParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.MigrationsDeleteArchiveForOrgParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • downloadArchiveForOrg: { endpoint: Endpoint }

        Fetches the URL to a migration archive.

          • (params?: RequestOptions & Octokit.MigrationsDownloadArchiveForOrgParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.MigrationsDownloadArchiveForOrgParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • getArchiveForAuthenticatedUser: { endpoint: Endpoint }

        Fetches the URL to download the migration archive as a tar.gz file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects:

        • attachments
        • bases
        • commit_comments
        • issue_comments
        • issue_events
        • issues
        • milestones
        • organizations
        • projects
        • protected_branches
        • pull_request_reviews
        • pull_requests
        • releases
        • repositories
        • review_comments
        • schema
        • users

        The archive will also contain an attachments directory that includes all attachment files uploaded to GitHub.com and a repositories directory that contains the repository's Git data.

          • (params?: RequestOptions & Octokit.MigrationsGetArchiveForAuthenticatedUserParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.MigrationsGetArchiveForAuthenticatedUserParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • getArchiveForOrg: { endpoint: Endpoint }

        Fetches the URL to a migration archive.

        deprecated

        octokit.migrations.getArchiveForOrg() has been renamed to octokit.migrations.downloadArchiveForOrg() (2020-01-27)

          • (params?: RequestOptions & Octokit.MigrationsGetArchiveForOrgParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.MigrationsGetArchiveForOrgParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • getCommitAuthors: { endpoint: Endpoint }

        Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username hubot into something like hubot <hubot@12341234-abab-fefe-8787-fedcba987654>.

        This API method and the "Map a commit author" method allow you to provide correct Git author information.

          • (params?: RequestOptions & Octokit.MigrationsGetCommitAuthorsParams): Promise<Response<Octokit.MigrationsGetCommitAuthorsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.MigrationsGetCommitAuthorsParams

            Returns Promise<Response<Octokit.MigrationsGetCommitAuthorsResponse>>

        • endpoint: Endpoint
      • getImportProgress: { endpoint: Endpoint }

        View the progress of an import.

        Import status

        This section includes details about the possible values of the status field of the Import Progress response.

        An import that does not have errors will progress through these steps:

        • detecting - the "detection" step of the import is in progress because the request did not include a vcs parameter. The import is identifying the type of source control present at the URL.
        • importing - the "raw" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include commit_count (the total number of raw commits that will be imported) and percent (0 - 100, the current progress through the import).
        • mapping - the "rewrite" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.
        • pushing - the "push" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include push_percent, which is the percent value reported by git push when it is "Writing objects".
        • complete - the import is complete, and the repository is ready on GitHub.

        If there are problems, you will see one of these in the status field:

        • auth_failed - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the Update Existing Import section.
        • error - the import encountered an error. The import progress response will include the failed_step and an error message. Contact GitHub Support or GitHub Premium Support for more information.
        • detection_needs_auth - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the Update Existing Import section.
        • detection_found_nothing - the importer didn't recognize any source control at the URL. To resolve, Cancel the import and retry with the correct URL.
        • detection_found_multiple - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a project_choices field with the possible project choices as values. To update project choice, please see the Update Existing Import section.

        The project_choices field

        When multiple projects are found at the provided URL, the response hash will include a project_choices field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.

        Git LFS related fields

        This section includes details about Git LFS related fields that may be present in the Import Progress response.

        • use_lfs - describes whether the import has been opted in or out of using Git LFS. The value can be opt_in, opt_out, or undecided if no action has been taken.
        • has_large_files - the boolean value describing whether files larger than 100MB were found during the importing step.
        • large_files_size - the total size in gigabytes of files larger than 100MB found in the originating repository.
        • large_files_count - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a "Get Large Files" request.
          • (params?: RequestOptions & Octokit.MigrationsGetImportProgressParams): Promise<Response<Octokit.MigrationsGetImportProgressResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.MigrationsGetImportProgressParams

            Returns Promise<Response<Octokit.MigrationsGetImportProgressResponse>>

        • endpoint: Endpoint
      • getLargeFiles: { endpoint: Endpoint }

        List files larger than 100MB found during the import

          • (params?: RequestOptions & Octokit.MigrationsGetLargeFilesParams): Promise<Response<Octokit.MigrationsGetLargeFilesResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.MigrationsGetLargeFilesParams

            Returns Promise<Response<Octokit.MigrationsGetLargeFilesResponse>>

        • endpoint: Endpoint
      • getStatusForAuthenticatedUser: { endpoint: Endpoint }

        Fetches a single user migration. The response includes the state of the migration, which can be one of the following values:

        • pending - the migration hasn't started yet.
        • exporting - the migration is in progress.
        • exported - the migration finished successfully.
        • failed - the migration failed.

        Once the migration has been exported you can download the migration archive.

          • (params?: RequestOptions & Octokit.MigrationsGetStatusForAuthenticatedUserParams): Promise<Response<Octokit.MigrationsGetStatusForAuthenticatedUserResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.MigrationsGetStatusForAuthenticatedUserParams

            Returns Promise<Response<Octokit.MigrationsGetStatusForAuthenticatedUserResponse>>

        • endpoint: Endpoint
      • getStatusForOrg: { endpoint: Endpoint }

        Fetches the status of a migration.

        The state of a migration can be one of the following values:

        • pending, which means the migration hasn't started yet.
        • exporting, which means the migration is in progress.
        • exported, which means the migration finished successfully.
        • failed, which means the migration failed.
          • (params?: RequestOptions & Octokit.MigrationsGetStatusForOrgParams): Promise<Response<Octokit.MigrationsGetStatusForOrgResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.MigrationsGetStatusForOrgParams

            Returns Promise<Response<Octokit.MigrationsGetStatusForOrgResponse>>

        • endpoint: Endpoint
      • listForAuthenticatedUser: { endpoint: Endpoint }

        Lists all migrations a user has started.

          • (params?: RequestOptions & Octokit.MigrationsListForAuthenticatedUserParams): Promise<Response<Octokit.MigrationsListForAuthenticatedUserResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.MigrationsListForAuthenticatedUserParams

            Returns Promise<Response<Octokit.MigrationsListForAuthenticatedUserResponse>>

        • endpoint: Endpoint
      • listForOrg: { endpoint: Endpoint }

        Lists the most recent migrations.

          • (params?: RequestOptions & Octokit.MigrationsListForOrgParams): Promise<Response<Octokit.MigrationsListForOrgResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.MigrationsListForOrgParams

            Returns Promise<Response<Octokit.MigrationsListForOrgResponse>>

        • endpoint: Endpoint
      • listReposForOrg: { endpoint: Endpoint }

        List all the repositories for this organization migration.

          • (params?: RequestOptions & Octokit.MigrationsListReposForOrgParams): Promise<Response<Octokit.MigrationsListReposForOrgResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.MigrationsListReposForOrgParams

            Returns Promise<Response<Octokit.MigrationsListReposForOrgResponse>>

        • endpoint: Endpoint
      • listReposForUser: { endpoint: Endpoint }

        Lists all the repositories for this user migration.

          • (params?: RequestOptions & Octokit.MigrationsListReposForUserParams): Promise<Response<Octokit.MigrationsListReposForUserResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.MigrationsListReposForUserParams

            Returns Promise<Response<Octokit.MigrationsListReposForUserResponse>>

        • endpoint: Endpoint
      • mapCommitAuthor: { endpoint: Endpoint }

        Update an author's identity for the import. Your application can continue updating authors any time before you push new commits to the repository.

          • (params?: RequestOptions & Octokit.MigrationsMapCommitAuthorParams): Promise<Response<Octokit.MigrationsMapCommitAuthorResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.MigrationsMapCommitAuthorParams

            Returns Promise<Response<Octokit.MigrationsMapCommitAuthorResponse>>

        • endpoint: Endpoint
      • setLfsPreference: { endpoint: Endpoint }

        You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability is powered by Git LFS. You can learn more about our LFS feature and working with large files on our help site.

          • (params?: RequestOptions & Octokit.MigrationsSetLfsPreferenceParams): Promise<Response<Octokit.MigrationsSetLfsPreferenceResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.MigrationsSetLfsPreferenceParams

            Returns Promise<Response<Octokit.MigrationsSetLfsPreferenceResponse>>

        • endpoint: Endpoint
      • startForAuthenticatedUser: { endpoint: Endpoint }

        Initiates the generation of a user migration archive.

          • (params?: RequestOptions & Octokit.MigrationsStartForAuthenticatedUserParams): Promise<Response<Octokit.MigrationsStartForAuthenticatedUserResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.MigrationsStartForAuthenticatedUserParams

            Returns Promise<Response<Octokit.MigrationsStartForAuthenticatedUserResponse>>

        • endpoint: Endpoint
      • startForOrg: { endpoint: Endpoint }

        Initiates the generation of a migration archive.

          • (params?: RequestOptions & Octokit.MigrationsStartForOrgParams): Promise<Response<Octokit.MigrationsStartForOrgResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.MigrationsStartForOrgParams

            Returns Promise<Response<Octokit.MigrationsStartForOrgResponse>>

        • endpoint: Endpoint
      • startImport: { endpoint: Endpoint }

        Start a source import to a GitHub repository using GitHub Importer.

          • (params?: RequestOptions & Octokit.MigrationsStartImportParams): Promise<Response<Octokit.MigrationsStartImportResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.MigrationsStartImportParams

            Returns Promise<Response<Octokit.MigrationsStartImportResponse>>

        • endpoint: Endpoint
      • unlockRepoForAuthenticatedUser: { endpoint: Endpoint }

        Unlocks a repository. You can lock repositories when you start a user migration. Once the migration is complete you can unlock each repository to begin using it again or delete the repository if you no longer need the source data. Returns a status of 404 Not Found if the repository is not locked.

          • (params?: RequestOptions & Octokit.MigrationsUnlockRepoForAuthenticatedUserParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.MigrationsUnlockRepoForAuthenticatedUserParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • unlockRepoForOrg: { endpoint: Endpoint }

        Unlocks a repository that was locked for migration. You should unlock each migrated repository and delete them when the migration is complete and you no longer need the source data.

          • (params?: RequestOptions & Octokit.MigrationsUnlockRepoForOrgParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.MigrationsUnlockRepoForOrgParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • updateImport: { endpoint: Endpoint }

        An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API request. If no parameters are provided, the import will be restarted.

        Some servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will have the status detection_found_multiple and the Import Progress response will include a project_choices array. You can select the project to import by providing one of the objects in the project_choices array in the update request.

        The following example demonstrates the workflow for updating an import with "project1" as the project choice. Given a project_choices array like such:

        To restart an import, no parameters are provided in the update request.

          • (params?: RequestOptions & Octokit.MigrationsUpdateImportParams): Promise<Response<Octokit.MigrationsUpdateImportResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.MigrationsUpdateImportParams

            Returns Promise<Response<Octokit.MigrationsUpdateImportResponse>>

        • endpoint: Endpoint

      oauthAuthorizations

      oauthAuthorizations: { checkAuthorization: { endpoint: Endpoint }; createAuthorization: { endpoint: Endpoint }; deleteAuthorization: { endpoint: Endpoint }; deleteGrant: { endpoint: Endpoint }; getAuthorization: { endpoint: Endpoint }; getGrant: { endpoint: Endpoint }; getOrCreateAuthorizationForApp: { endpoint: Endpoint }; getOrCreateAuthorizationForAppAndFingerprint: { endpoint: Endpoint }; getOrCreateAuthorizationForAppFingerprint: { endpoint: Endpoint }; listAuthorizations: { endpoint: Endpoint }; listGrants: { endpoint: Endpoint }; resetAuthorization: { endpoint: Endpoint }; revokeAuthorizationForApplication: { endpoint: Endpoint }; revokeGrantForApplication: { endpoint: Endpoint }; updateAuthorization: { endpoint: Endpoint } }

      Type declaration

      • checkAuthorization: { endpoint: Endpoint }

        Deprecation Notice: GitHub will replace and discontinue OAuth endpoints containing access_token in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using access_token as an input parameter. For more information, see the blog post.

        OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use Basic Authentication when accessing this endpoint, using the OAuth application's client_id and client_secret as the username and password. Invalid tokens will return 404 NOT FOUND.

        deprecated

        octokit.oauthAuthorizations.checkAuthorization() is deprecated, see https://developer.github.com/v3/apps/oauth_applications/#check-an-authorization

          • (params?: RequestOptions & Octokit.OauthAuthorizationsCheckAuthorizationParams): Promise<Response<Octokit.OauthAuthorizationsCheckAuthorizationResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.OauthAuthorizationsCheckAuthorizationParams

            Returns Promise<Response<Octokit.OauthAuthorizationsCheckAuthorizationResponse>>

        • endpoint: Endpoint
      • createAuthorization: { endpoint: Endpoint }

        Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. For more information, see the blog post.

        Warning: Apps must use the web application flow to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub SAML organizations. For more information, see the blog post.

        Creates OAuth tokens using Basic Authentication. If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "Working with two-factor authentication."

        To create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use fingerprint to differentiate between them.

        You can also create tokens on GitHub from the personal access tokens settings page. Read more about these tokens in the GitHub Help documentation.

        Organizations that enforce SAML SSO require personal access tokens to be whitelisted. Read more about whitelisting tokens in the GitHub Help documentation.

        deprecated

        octokit.oauthAuthorizations.createAuthorization() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization

          • (params?: RequestOptions & Octokit.OauthAuthorizationsCreateAuthorizationParams): Promise<Response<Octokit.OauthAuthorizationsCreateAuthorizationResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.OauthAuthorizationsCreateAuthorizationParams

            Returns Promise<Response<Octokit.OauthAuthorizationsCreateAuthorizationResponse>>

        • endpoint: Endpoint
      • deleteAuthorization: { endpoint: Endpoint }

        Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. For more information, see the blog post.

        deprecated

        octokit.oauthAuthorizations.deleteAuthorization() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#delete-an-authorization

          • (params?: RequestOptions & Octokit.OauthAuthorizationsDeleteAuthorizationParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.OauthAuthorizationsDeleteAuthorizationParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • deleteGrant: { endpoint: Endpoint }

        Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. For more information, see the blog post.

        Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on the application authorizations settings screen within GitHub.

        deprecated

        octokit.oauthAuthorizations.deleteGrant() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#delete-a-grant

          • (params?: RequestOptions & Octokit.OauthAuthorizationsDeleteGrantParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.OauthAuthorizationsDeleteGrantParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • getAuthorization: { endpoint: Endpoint }

        Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. For more information, see the blog post.

        deprecated

        octokit.oauthAuthorizations.getAuthorization() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#get-a-single-authorization

          • (params?: RequestOptions & Octokit.OauthAuthorizationsGetAuthorizationParams): Promise<Response<Octokit.OauthAuthorizationsGetAuthorizationResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.OauthAuthorizationsGetAuthorizationParams

            Returns Promise<Response<Octokit.OauthAuthorizationsGetAuthorizationResponse>>

        • endpoint: Endpoint
      • getGrant: { endpoint: Endpoint }

        Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. For more information, see the blog post.

        deprecated

        octokit.oauthAuthorizations.getGrant() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#get-a-single-grant

          • (params?: RequestOptions & Octokit.OauthAuthorizationsGetGrantParams): Promise<Response<Octokit.OauthAuthorizationsGetGrantResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.OauthAuthorizationsGetGrantParams

            Returns Promise<Response<Octokit.OauthAuthorizationsGetGrantResponse>>

        • endpoint: Endpoint
      • getOrCreateAuthorizationForApp: { endpoint: Endpoint }

        Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. For more information, see the blog post.

        Warning: Apps must use the web application flow to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub SAML organizations. For more information, see the blog post.

        Creates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.

        If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "Working with two-factor authentication."

        Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. For more information, see the blog post.

        deprecated

        octokit.oauthAuthorizations.getOrCreateAuthorizationForApp() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app

          • (params?: RequestOptions & Octokit.OauthAuthorizationsGetOrCreateAuthorizationForAppParams): Promise<Response<Octokit.OauthAuthorizationsGetOrCreateAuthorizationForAppResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.OauthAuthorizationsGetOrCreateAuthorizationForAppParams

            Returns Promise<Response<Octokit.OauthAuthorizationsGetOrCreateAuthorizationForAppResponse>>

        • endpoint: Endpoint
      • getOrCreateAuthorizationForAppAndFingerprint: { endpoint: Endpoint }

        Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. For more information, see the blog post.

        Warning: Apps must use the web application flow to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub SAML organizations. For more information, see the blog post.

        This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. fingerprint is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.

        If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "Working with two-factor authentication."

        deprecated

        octokit.oauthAuthorizations.getOrCreateAuthorizationForAppAndFingerprint() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint

          • (params?: RequestOptions & Octokit.OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintParams): Promise<Response<Octokit.OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintParams

            Returns Promise<Response<Octokit.OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintResponse>>

        • endpoint: Endpoint
      • getOrCreateAuthorizationForAppFingerprint: { endpoint: Endpoint }

        Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. For more information, see the blog post.

        Warning: Apps must use the web application flow to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub SAML organizations. For more information, see the blog post.

        This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. fingerprint is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.

        If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "Working with two-factor authentication."

        deprecated

        octokit.oauthAuthorizations.getOrCreateAuthorizationForAppFingerprint() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint

          • (params?: RequestOptions & Octokit.OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintParams): Promise<Response<Octokit.OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintParams

            Returns Promise<Response<Octokit.OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintResponse>>

        • endpoint: Endpoint
      • listAuthorizations: { endpoint: Endpoint }

        Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. For more information, see the blog post.

        deprecated

        octokit.oauthAuthorizations.listAuthorizations() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#list-your-authorizations

          • (params?: RequestOptions & Octokit.OauthAuthorizationsListAuthorizationsParams): Promise<Response<Octokit.OauthAuthorizationsListAuthorizationsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.OauthAuthorizationsListAuthorizationsParams

            Returns Promise<Response<Octokit.OauthAuthorizationsListAuthorizationsResponse>>

        • endpoint: Endpoint
      • listGrants: { endpoint: Endpoint }

        Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. For more information, see the blog post.

        You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the list your authorizations API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on the application authorizations settings screen within GitHub. The scopes returned are the union of scopes authorized for the application. For example, if an application has one token with repo scope and another token with user scope, the grant will return ["repo", "user"].

        deprecated

        octokit.oauthAuthorizations.listGrants() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#list-your-grants

          • (params?: RequestOptions & Octokit.OauthAuthorizationsListGrantsParams): Promise<Response<Octokit.OauthAuthorizationsListGrantsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.OauthAuthorizationsListGrantsParams

            Returns Promise<Response<Octokit.OauthAuthorizationsListGrantsResponse>>

        • endpoint: Endpoint
      • resetAuthorization: { endpoint: Endpoint }

        Deprecation Notice: GitHub will replace and discontinue OAuth endpoints containing access_token in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using access_token as an input parameter. For more information, see the blog post.

        OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use Basic Authentication when accessing this endpoint, using the OAuth application's client_id and client_secret as the username and password. Invalid tokens will return 404 NOT FOUND.

        deprecated

        octokit.oauthAuthorizations.resetAuthorization() is deprecated, see https://developer.github.com/v3/apps/oauth_applications/#reset-an-authorization

          • (params?: RequestOptions & Octokit.OauthAuthorizationsResetAuthorizationParams): Promise<Response<Octokit.OauthAuthorizationsResetAuthorizationResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.OauthAuthorizationsResetAuthorizationParams

            Returns Promise<Response<Octokit.OauthAuthorizationsResetAuthorizationResponse>>

        • endpoint: Endpoint
      • revokeAuthorizationForApplication: { endpoint: Endpoint }

        Deprecation Notice: GitHub will replace and discontinue OAuth endpoints containing access_token in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using access_token as an input parameter. For more information, see the blog post.

        OAuth application owners can revoke a single token for an OAuth application. You must use Basic Authentication when accessing this endpoint, using the OAuth application's client_id and client_secret as the username and password.

        deprecated

        octokit.oauthAuthorizations.revokeAuthorizationForApplication() is deprecated, see https://developer.github.com/v3/apps/oauth_applications/#revoke-an-authorization-for-an-application

          • (params?: RequestOptions & Octokit.OauthAuthorizationsRevokeAuthorizationForApplicationParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.OauthAuthorizationsRevokeAuthorizationForApplicationParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • revokeGrantForApplication: { endpoint: Endpoint }

        Deprecation Notice: GitHub will replace and discontinue OAuth endpoints containing access_token in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using access_token as an input parameter. For more information, see the blog post.

        OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use Basic Authentication when accessing this endpoint, using the OAuth application's client_id and client_secret as the username and password. You must also provide a valid token as :access_token and the grant for the token's owner will be deleted.

        Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on the Applications settings page under "Authorized OAuth Apps" on GitHub.

        deprecated

        octokit.oauthAuthorizations.revokeGrantForApplication() is deprecated, see https://developer.github.com/v3/apps/oauth_applications/#revoke-a-grant-for-an-application

          • (params?: RequestOptions & Octokit.OauthAuthorizationsRevokeGrantForApplicationParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.OauthAuthorizationsRevokeGrantForApplicationParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • updateAuthorization: { endpoint: Endpoint }

        Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. For more information, see the blog post.

        If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "Working with two-factor authentication."

        You can only send one of these scope keys at a time.

        deprecated

        octokit.oauthAuthorizations.updateAuthorization() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#update-an-existing-authorization

          • (params?: RequestOptions & Octokit.OauthAuthorizationsUpdateAuthorizationParams): Promise<Response<Octokit.OauthAuthorizationsUpdateAuthorizationResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.OauthAuthorizationsUpdateAuthorizationParams

            Returns Promise<Response<Octokit.OauthAuthorizationsUpdateAuthorizationResponse>>

        • endpoint: Endpoint

      orgs

      orgs: { addOrUpdateMembership: { endpoint: Endpoint }; blockUser: { endpoint: Endpoint }; checkBlockedUser: { endpoint: Endpoint }; checkMembership: { endpoint: Endpoint }; checkPublicMembership: { endpoint: Endpoint }; concealMembership: { endpoint: Endpoint }; convertMemberToOutsideCollaborator: { endpoint: Endpoint }; createHook: { endpoint: Endpoint }; createInvitation: { endpoint: Endpoint }; deleteHook: { endpoint: Endpoint }; get: { endpoint: Endpoint }; getHook: { endpoint: Endpoint }; getMembership: { endpoint: Endpoint }; getMembershipForAuthenticatedUser: { endpoint: Endpoint }; list: { endpoint: Endpoint }; listBlockedUsers: { endpoint: Endpoint }; listForAuthenticatedUser: { endpoint: Endpoint }; listForUser: { endpoint: Endpoint }; listHooks: { endpoint: Endpoint }; listInstallations: { endpoint: Endpoint }; listInvitationTeams: { endpoint: Endpoint }; listMembers: { endpoint: Endpoint }; listMemberships: { endpoint: Endpoint }; listOutsideCollaborators: { endpoint: Endpoint }; listPendingInvitations: { endpoint: Endpoint }; listPublicMembers: { endpoint: Endpoint }; pingHook: { endpoint: Endpoint }; publicizeMembership: { endpoint: Endpoint }; removeMember: { endpoint: Endpoint }; removeMembership: { endpoint: Endpoint }; removeOutsideCollaborator: { endpoint: Endpoint }; unblockUser: { endpoint: Endpoint }; update: { endpoint: Endpoint }; updateHook: { endpoint: Endpoint }; updateMembership: { endpoint: Endpoint } }

      Type declaration

      • addOrUpdateMembership: { endpoint: Endpoint }

        Only authenticated organization owners can add a member to the organization or update the member's role.

        • If the authenticated user is adding a member to the organization, the invited user will receive an email inviting them to the organization. The user's membership status will be pending until they accept the invitation.

        • Authenticated users can update a user's membership by passing the role parameter. If the authenticated user changes a member's role to admin, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to member, no email will be sent.

        Rate limits

        To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.

          • (params?: RequestOptions & Octokit.OrgsAddOrUpdateMembershipParams): Promise<Response<Octokit.OrgsAddOrUpdateMembershipResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.OrgsAddOrUpdateMembershipParams

            Returns Promise<Response<Octokit.OrgsAddOrUpdateMembershipResponse>>

        • endpoint: Endpoint
      • blockUser: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.OrgsBlockUserParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • checkBlockedUser: { endpoint: Endpoint }

        If the user is blocked:

        If the user is not blocked:

          • (params?: RequestOptions & Octokit.OrgsCheckBlockedUserParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.OrgsCheckBlockedUserParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • checkMembership: { endpoint: Endpoint }

        Check if a user is, publicly or privately, a member of the organization.

          • (params?: RequestOptions & Octokit.OrgsCheckMembershipParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • checkPublicMembership: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.OrgsCheckPublicMembershipParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.OrgsCheckPublicMembershipParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • concealMembership: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.OrgsConcealMembershipParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.OrgsConcealMembershipParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • convertMemberToOutsideCollaborator: { endpoint: Endpoint }

        When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "Converting an organization member to an outside collaborator".

          • (params?: RequestOptions & Octokit.OrgsConvertMemberToOutsideCollaboratorParams): Promise<Response<Octokit.OrgsConvertMemberToOutsideCollaboratorResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.OrgsConvertMemberToOutsideCollaboratorParams

            Returns Promise<Response<Octokit.OrgsConvertMemberToOutsideCollaboratorResponse>>

        • endpoint: Endpoint
      • createHook: { endpoint: Endpoint }

        Here's how you can create a hook that posts payloads in JSON format:

          • Parameters

            Returns Promise<Response<Octokit.OrgsCreateHookResponse>>

        • endpoint: Endpoint
      • createInvitation: { endpoint: Endpoint }

        Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.

        This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

          • (params?: RequestOptions & Octokit.OrgsCreateInvitationParams): Promise<Response<Octokit.OrgsCreateInvitationResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.OrgsCreateInvitationParams

            Returns Promise<Response<Octokit.OrgsCreateInvitationResponse>>

        • endpoint: Endpoint
      • deleteHook: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.OrgsDeleteHookParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • get: { endpoint: Endpoint }

        To see many of the organization response values, you need to be an authenticated organization owner with the admin:org scope. When the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication.

        GitHub Apps with the Organization plan permission can use this endpoint to retrieve information about an organization's GitHub plan. See "Authenticating with GitHub Apps" for details. For an example response, see "Response with GitHub plan information."

      • getHook: { endpoint: Endpoint }
      • getMembership: { endpoint: Endpoint }

        In order to get a user's membership with an organization, the authenticated user must be an organization member.

          • (params?: RequestOptions & Octokit.OrgsGetMembershipParams): Promise<Response<Octokit.OrgsGetMembershipResponse>>

          • Parameters

            Returns Promise<Response<Octokit.OrgsGetMembershipResponse>>

        • endpoint: Endpoint
      • getMembershipForAuthenticatedUser: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.OrgsGetMembershipForAuthenticatedUserParams): Promise<Response<Octokit.OrgsGetMembershipForAuthenticatedUserResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.OrgsGetMembershipForAuthenticatedUserParams

            Returns Promise<Response<Octokit.OrgsGetMembershipForAuthenticatedUserResponse>>

        • endpoint: Endpoint
      • list: { endpoint: Endpoint }

        Lists all organizations, in the order that they were created on GitHub.

        Note: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.

      • listBlockedUsers: { endpoint: Endpoint }

        List the users blocked by an organization.

          • (params?: RequestOptions & Octokit.OrgsListBlockedUsersParams): Promise<Response<Octokit.OrgsListBlockedUsersResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.OrgsListBlockedUsersParams

            Returns Promise<Response<Octokit.OrgsListBlockedUsersResponse>>

        • endpoint: Endpoint
      • listForAuthenticatedUser: { endpoint: Endpoint }

        List organizations for the authenticated user.

        OAuth scope requirements

        This only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with read:org scope, you can publicize your organization membership with user scope, etc.). Therefore, this API requires at least user or read:org scope. OAuth requests with insufficient scope receive a 403 Forbidden response.

          • (params?: RequestOptions & Octokit.OrgsListForAuthenticatedUserParams): Promise<Response<Octokit.OrgsListForAuthenticatedUserResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.OrgsListForAuthenticatedUserParams

            Returns Promise<Response<Octokit.OrgsListForAuthenticatedUserResponse>>

        • endpoint: Endpoint
      • listForUser: { endpoint: Endpoint }

        List public organization memberships for the specified user.

        This method only lists public memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the List your organizations API instead.

          • (params?: RequestOptions & Octokit.OrgsListForUserParams): Promise<Response<Octokit.OrgsListForUserResponse>>

          • Parameters

            Returns Promise<Response<Octokit.OrgsListForUserResponse>>

        • endpoint: Endpoint
      • listHooks: { endpoint: Endpoint }
      • listInstallations: { endpoint: Endpoint }

        Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with admin:read scope to use this endpoint.

          • (params?: RequestOptions & Octokit.OrgsListInstallationsParams): Promise<Response<Octokit.OrgsListInstallationsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.OrgsListInstallationsParams

            Returns Promise<Response<Octokit.OrgsListInstallationsResponse>>

        • endpoint: Endpoint
      • listInvitationTeams: { endpoint: Endpoint }

        List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner.

          • (params?: RequestOptions & Octokit.OrgsListInvitationTeamsParams): Promise<Response<Octokit.OrgsListInvitationTeamsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.OrgsListInvitationTeamsParams

            Returns Promise<Response<Octokit.OrgsListInvitationTeamsResponse>>

        • endpoint: Endpoint
      • listMembers: { endpoint: Endpoint }

        List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.

          • (params?: RequestOptions & Octokit.OrgsListMembersParams): Promise<Response<Octokit.OrgsListMembersResponse>>

          • Parameters

            Returns Promise<Response<Octokit.OrgsListMembersResponse>>

        • endpoint: Endpoint
      • listMemberships: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.OrgsListMembershipsParams): Promise<Response<Octokit.OrgsListMembershipsResponse>>

          • Parameters

            Returns Promise<Response<Octokit.OrgsListMembershipsResponse>>

        • endpoint: Endpoint
      • listOutsideCollaborators: { endpoint: Endpoint }

        List all users who are outside collaborators of an organization.

          • (params?: RequestOptions & Octokit.OrgsListOutsideCollaboratorsParams): Promise<Response<Octokit.OrgsListOutsideCollaboratorsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.OrgsListOutsideCollaboratorsParams

            Returns Promise<Response<Octokit.OrgsListOutsideCollaboratorsResponse>>

        • endpoint: Endpoint
      • listPendingInvitations: { endpoint: Endpoint }

        The return hash contains a role field which refers to the Organization Invitation role and will be one of the following values: direct_member, admin, billing_manager, hiring_manager, or reinstate. If the invitee is not a GitHub member, the login field in the return hash will be null.

          • (params?: RequestOptions & Octokit.OrgsListPendingInvitationsParams): Promise<Response<Octokit.OrgsListPendingInvitationsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.OrgsListPendingInvitationsParams

            Returns Promise<Response<Octokit.OrgsListPendingInvitationsResponse>>

        • endpoint: Endpoint
      • listPublicMembers: { endpoint: Endpoint }

        Members of an organization can choose to have their membership publicized or not.

          • (params?: RequestOptions & Octokit.OrgsListPublicMembersParams): Promise<Response<Octokit.OrgsListPublicMembersResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.OrgsListPublicMembersParams

            Returns Promise<Response<Octokit.OrgsListPublicMembersResponse>>

        • endpoint: Endpoint
      • pingHook: { endpoint: Endpoint }

        This will trigger a ping event to be sent to the hook.

          • (params?: RequestOptions & Octokit.OrgsPingHookParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • publicizeMembership: { endpoint: Endpoint }

        The user can publicize their own membership. (A user cannot publicize the membership for another user.)

        Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."

          • (params?: RequestOptions & Octokit.OrgsPublicizeMembershipParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.OrgsPublicizeMembershipParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • removeMember: { endpoint: Endpoint }

        Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.

          • (params?: RequestOptions & Octokit.OrgsRemoveMemberParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • removeMembership: { endpoint: Endpoint }

        In order to remove a user's membership with an organization, the authenticated user must be an organization owner.

        If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.

          • (params?: RequestOptions & Octokit.OrgsRemoveMembershipParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.OrgsRemoveMembershipParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • removeOutsideCollaborator: { endpoint: Endpoint }

        Removing a user from this list will remove them from all the organization's repositories.

          • (params?: RequestOptions & Octokit.OrgsRemoveOutsideCollaboratorParams): Promise<Response<Octokit.OrgsRemoveOutsideCollaboratorResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.OrgsRemoveOutsideCollaboratorParams

            Returns Promise<Response<Octokit.OrgsRemoveOutsideCollaboratorResponse>>

        • endpoint: Endpoint
      • unblockUser: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.OrgsUnblockUserParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • update: { endpoint: Endpoint }

        Parameter Deprecation Notice: GitHub will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud. For more information, see the blog post.

        Enables an authenticated organization owner with the admin:org scope to update the organization's profile and member privileges.

          • (params?: RequestOptions & Octokit.OrgsUpdateParamsDeprecatedMembersAllowedRepositoryCreationType): Promise<Response<Octokit.OrgsUpdateResponse>>
          • (params?: RequestOptions & Octokit.OrgsUpdateParams): Promise<Response<Octokit.OrgsUpdateResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.OrgsUpdateParamsDeprecatedMembersAllowedRepositoryCreationType

            Returns Promise<Response<Octokit.OrgsUpdateResponse>>

          • Parameters

            Returns Promise<Response<Octokit.OrgsUpdateResponse>>

        • endpoint: Endpoint
      • updateHook: { endpoint: Endpoint }

          • Parameters

            Returns Promise<Response<Octokit.OrgsUpdateHookResponse>>

        • endpoint: Endpoint
      • updateMembership: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.OrgsUpdateMembershipParams): Promise<Response<Octokit.OrgsUpdateMembershipResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.OrgsUpdateMembershipParams

            Returns Promise<Response<Octokit.OrgsUpdateMembershipResponse>>

        • endpoint: Endpoint

      paginate

      paginate: Paginate

      projects

      projects: { addCollaborator: { endpoint: Endpoint }; createCard: { endpoint: Endpoint }; createColumn: { endpoint: Endpoint }; createForAuthenticatedUser: { endpoint: Endpoint }; createForOrg: { endpoint: Endpoint }; createForRepo: { endpoint: Endpoint }; delete: { endpoint: Endpoint }; deleteCard: { endpoint: Endpoint }; deleteColumn: { endpoint: Endpoint }; get: { endpoint: Endpoint }; getCard: { endpoint: Endpoint }; getColumn: { endpoint: Endpoint }; listCards: { endpoint: Endpoint }; listCollaborators: { endpoint: Endpoint }; listColumns: { endpoint: Endpoint }; listForOrg: { endpoint: Endpoint }; listForRepo: { endpoint: Endpoint }; listForUser: { endpoint: Endpoint }; moveCard: { endpoint: Endpoint }; moveColumn: { endpoint: Endpoint }; removeCollaborator: { endpoint: Endpoint }; reviewUserPermissionLevel: { endpoint: Endpoint }; update: { endpoint: Endpoint }; updateCard: { endpoint: Endpoint }; updateColumn: { endpoint: Endpoint } }

      Type declaration

      • addCollaborator: { endpoint: Endpoint }

        Adds a collaborator to a an organization project and sets their permission level. You must be an organization owner or a project admin to add a collaborator.

          • (params?: RequestOptions & Octokit.ProjectsAddCollaboratorParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ProjectsAddCollaboratorParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • createCard: { endpoint: Endpoint }

        Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key.

        Be aware that the id of a pull request returned from "Issues" endpoints will be an issue id. To find out the pull request id, use the "List pull requests" endpoint.

          • (params?: RequestOptions & Octokit.ProjectsCreateCardParams): Promise<Response<Octokit.ProjectsCreateCardResponse>>

          • Parameters

            Returns Promise<Response<Octokit.ProjectsCreateCardResponse>>

        • endpoint: Endpoint
      • createColumn: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ProjectsCreateColumnParams): Promise<Response<Octokit.ProjectsCreateColumnResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ProjectsCreateColumnParams

            Returns Promise<Response<Octokit.ProjectsCreateColumnResponse>>

        • endpoint: Endpoint
      • createForAuthenticatedUser: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ProjectsCreateForAuthenticatedUserParams): Promise<Response<Octokit.ProjectsCreateForAuthenticatedUserResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ProjectsCreateForAuthenticatedUserParams

            Returns Promise<Response<Octokit.ProjectsCreateForAuthenticatedUserResponse>>

        • endpoint: Endpoint
      • createForOrg: { endpoint: Endpoint }

        Creates an organization project board. Returns a 404 Not Found status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

          • (params?: RequestOptions & Octokit.ProjectsCreateForOrgParams): Promise<Response<Octokit.ProjectsCreateForOrgResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ProjectsCreateForOrgParams

            Returns Promise<Response<Octokit.ProjectsCreateForOrgResponse>>

        • endpoint: Endpoint
      • createForRepo: { endpoint: Endpoint }

        Creates a repository project board. Returns a 404 Not Found status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

          • (params?: RequestOptions & Octokit.ProjectsCreateForRepoParams): Promise<Response<Octokit.ProjectsCreateForRepoResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ProjectsCreateForRepoParams

            Returns Promise<Response<Octokit.ProjectsCreateForRepoResponse>>

        • endpoint: Endpoint
      • delete: { endpoint: Endpoint }

        Deletes a project board. Returns a 404 Not Found status if projects are disabled.

          • (params?: RequestOptions & Octokit.ProjectsDeleteParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • deleteCard: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ProjectsDeleteCardParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • deleteColumn: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ProjectsDeleteColumnParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ProjectsDeleteColumnParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • get: { endpoint: Endpoint }

        Gets a project by its id. Returns a 404 Not Found status if projects are disabled. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

      • getCard: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ProjectsGetCardParams): Promise<Response<Octokit.ProjectsGetCardResponse>>

          • Parameters

            Returns Promise<Response<Octokit.ProjectsGetCardResponse>>

        • endpoint: Endpoint
      • getColumn: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ProjectsGetColumnParams): Promise<Response<Octokit.ProjectsGetColumnResponse>>

          • Parameters

            Returns Promise<Response<Octokit.ProjectsGetColumnResponse>>

        • endpoint: Endpoint
      • listCards: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ProjectsListCardsParams): Promise<Response<Octokit.ProjectsListCardsResponse>>

          • Parameters

            Returns Promise<Response<Octokit.ProjectsListCardsResponse>>

        • endpoint: Endpoint
      • listCollaborators: { endpoint: Endpoint }

        Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project admin to list collaborators.

          • (params?: RequestOptions & Octokit.ProjectsListCollaboratorsParams): Promise<Response<Octokit.ProjectsListCollaboratorsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ProjectsListCollaboratorsParams

            Returns Promise<Response<Octokit.ProjectsListCollaboratorsResponse>>

        • endpoint: Endpoint
      • listColumns: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ProjectsListColumnsParams): Promise<Response<Octokit.ProjectsListColumnsResponse>>

          • Parameters

            Returns Promise<Response<Octokit.ProjectsListColumnsResponse>>

        • endpoint: Endpoint
      • listForOrg: { endpoint: Endpoint }

        Lists the projects in an organization. Returns a 404 Not Found status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

        s

          • (params?: RequestOptions & Octokit.ProjectsListForOrgParams): Promise<Response<Octokit.ProjectsListForOrgResponse>>

          • Parameters

            Returns Promise<Response<Octokit.ProjectsListForOrgResponse>>

        • endpoint: Endpoint
      • listForRepo: { endpoint: Endpoint }

        Lists the projects in a repository. Returns a 404 Not Found status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

          • (params?: RequestOptions & Octokit.ProjectsListForRepoParams): Promise<Response<Octokit.ProjectsListForRepoResponse>>

          • Parameters

            Returns Promise<Response<Octokit.ProjectsListForRepoResponse>>

        • endpoint: Endpoint
      • listForUser: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ProjectsListForUserParams): Promise<Response<Octokit.ProjectsListForUserResponse>>

          • Parameters

            Returns Promise<Response<Octokit.ProjectsListForUserResponse>>

        • endpoint: Endpoint
      • moveCard: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ProjectsMoveCardParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • moveColumn: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ProjectsMoveColumnParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • removeCollaborator: { endpoint: Endpoint }

        Removes a collaborator from an organization project. You must be an organization owner or a project admin to remove a collaborator.

          • (params?: RequestOptions & Octokit.ProjectsRemoveCollaboratorParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ProjectsRemoveCollaboratorParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • reviewUserPermissionLevel: { endpoint: Endpoint }

        Returns the collaborator's permission level for an organization project. Possible values for the permission key: admin, write, read, none. You must be an organization owner or a project admin to review a user's permission level.

          • (params?: RequestOptions & Octokit.ProjectsReviewUserPermissionLevelParams): Promise<Response<Octokit.ProjectsReviewUserPermissionLevelResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ProjectsReviewUserPermissionLevelParams

            Returns Promise<Response<Octokit.ProjectsReviewUserPermissionLevelResponse>>

        • endpoint: Endpoint
      • update: { endpoint: Endpoint }

        Updates a project board's information. Returns a 404 Not Found status if projects are disabled. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

          • Parameters

            Returns Promise<Response<Octokit.ProjectsUpdateResponse>>

        • endpoint: Endpoint
      • updateCard: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ProjectsUpdateCardParams): Promise<Response<Octokit.ProjectsUpdateCardResponse>>

          • Parameters

            Returns Promise<Response<Octokit.ProjectsUpdateCardResponse>>

        • endpoint: Endpoint
      • updateColumn: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ProjectsUpdateColumnParams): Promise<Response<Octokit.ProjectsUpdateColumnResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ProjectsUpdateColumnParams

            Returns Promise<Response<Octokit.ProjectsUpdateColumnResponse>>

        • endpoint: Endpoint

      pulls

      pulls: { checkIfMerged: { endpoint: Endpoint }; create: { endpoint: Endpoint }; createComment: { endpoint: Endpoint }; createCommentReply: { endpoint: Endpoint }; createFromIssue: { endpoint: Endpoint }; createReview: { endpoint: Endpoint }; createReviewCommentReply: { endpoint: Endpoint }; createReviewRequest: { endpoint: Endpoint }; deleteComment: { endpoint: Endpoint }; deletePendingReview: { endpoint: Endpoint }; deleteReviewRequest: { endpoint: Endpoint }; dismissReview: { endpoint: Endpoint }; get: { endpoint: Endpoint }; getComment: { endpoint: Endpoint }; getCommentsForReview: { endpoint: Endpoint }; getReview: { endpoint: Endpoint }; list: { endpoint: Endpoint }; listComments: { endpoint: Endpoint }; listCommentsForRepo: { endpoint: Endpoint }; listCommits: { endpoint: Endpoint }; listFiles: { endpoint: Endpoint }; listReviewRequests: { endpoint: Endpoint }; listReviews: { endpoint: Endpoint }; merge: { endpoint: Endpoint }; submitReview: { endpoint: Endpoint }; update: { endpoint: Endpoint }; updateBranch: { endpoint: Endpoint }; updateComment: { endpoint: Endpoint }; updateReview: { endpoint: Endpoint } }

      Type declaration

      • checkIfMerged: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.PullsCheckIfMergedParamsDeprecatedNumber): Promise<Octokit.AnyResponse>
          • (params?: RequestOptions & Octokit.PullsCheckIfMergedParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.PullsCheckIfMergedParamsDeprecatedNumber

            Returns Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • create: { endpoint: Endpoint }

        Draft pull requests are available in public repositories with GitHub Free and GitHub Pro, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

        To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

        You can create a new pull request.

        This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

      • createComment: { endpoint: Endpoint }

        Note: Multi-line comments on pull requests are currently in public beta and subject to change.

        Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see "Comments." We recommend creating a review comment using line, side, and optionally start_line and start_side if your comment applies to more than one line in the pull request diff.

        You can still create a review comment using the position parameter. When you use position, the line, side, start_line, and start_side parameters are not required. For more information, see Multi-line comment summary.

        Note: The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

        This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

        Multi-line comment summary

        Note: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.

        Use the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.

        If you use the comfort-fade preview header, your response will show:

        • For multi-line comments, values for start_line, original_start_line, start_side, line, original_line, and side.
        • For single-line comments, values for line, original_line, and side and a null value for start_line, original_start_line, and start_side.

        If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:

        • For multi-line comments, the last line of the comment range for the position attribute.
        • For single-line comments, the diff-positioned way of referencing comments for the position attribute. For more information, see position in the input parameters table.
          • (params?: RequestOptions & Octokit.PullsCreateCommentParamsDeprecatedNumber): Promise<Response<Octokit.PullsCreateCommentResponse>>
          • (params?: RequestOptions & Octokit.PullsCreateCommentParamsDeprecatedInReplyTo): Promise<Response<Octokit.PullsCreateCommentResponse>>
          • (params?: RequestOptions & Octokit.PullsCreateCommentParams): Promise<Response<Octokit.PullsCreateCommentResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.PullsCreateCommentParamsDeprecatedNumber

            Returns Promise<Response<Octokit.PullsCreateCommentResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.PullsCreateCommentParamsDeprecatedInReplyTo

            Returns Promise<Response<Octokit.PullsCreateCommentResponse>>

          • Parameters

            Returns Promise<Response<Octokit.PullsCreateCommentResponse>>

        • endpoint: Endpoint
      • createCommentReply: { endpoint: Endpoint }

        Note: Multi-line comments on pull requests are currently in public beta and subject to change.

        Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see "Comments." We recommend creating a review comment using line, side, and optionally start_line and start_side if your comment applies to more than one line in the pull request diff.

        You can still create a review comment using the position parameter. When you use position, the line, side, start_line, and start_side parameters are not required. For more information, see Multi-line comment summary.

        Note: The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

        This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

        Multi-line comment summary

        Note: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.

        Use the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.

        If you use the comfort-fade preview header, your response will show:

        • For multi-line comments, values for start_line, original_start_line, start_side, line, original_line, and side.
        • For single-line comments, values for line, original_line, and side and a null value for start_line, original_start_line, and start_side.

        If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:

        • For multi-line comments, the last line of the comment range for the position attribute.
        • For single-line comments, the diff-positioned way of referencing comments for the position attribute. For more information, see position in the input parameters table.
        deprecated

        octokit.pulls.createCommentReply() has been renamed to octokit.pulls.createComment() (2019-09-09)

          • (params?: RequestOptions & Octokit.PullsCreateCommentReplyParamsDeprecatedNumber): Promise<Response<Octokit.PullsCreateCommentReplyResponse>>
          • (params?: RequestOptions & Octokit.PullsCreateCommentReplyParamsDeprecatedInReplyTo): Promise<Response<Octokit.PullsCreateCommentReplyResponse>>
          • (params?: RequestOptions & Octokit.PullsCreateCommentReplyParams): Promise<Response<Octokit.PullsCreateCommentReplyResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.PullsCreateCommentReplyParamsDeprecatedNumber

            Returns Promise<Response<Octokit.PullsCreateCommentReplyResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.PullsCreateCommentReplyParamsDeprecatedInReplyTo

            Returns Promise<Response<Octokit.PullsCreateCommentReplyResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.PullsCreateCommentReplyParams

            Returns Promise<Response<Octokit.PullsCreateCommentReplyResponse>>

        • endpoint: Endpoint
      • createFromIssue: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.PullsCreateFromIssueParams): Promise<Response<Octokit.PullsCreateFromIssueResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.PullsCreateFromIssueParams

            Returns Promise<Response<Octokit.PullsCreateFromIssueResponse>>

        • endpoint: Endpoint
      • createReview: { endpoint: Endpoint }

        This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

        Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API v3 offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.

        The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

          • (params?: RequestOptions & Octokit.PullsCreateReviewParamsDeprecatedNumber): Promise<Response<Octokit.PullsCreateReviewResponse>>
          • (params?: RequestOptions & Octokit.PullsCreateReviewParams): Promise<Response<Octokit.PullsCreateReviewResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.PullsCreateReviewParamsDeprecatedNumber

            Returns Promise<Response<Octokit.PullsCreateReviewResponse>>

          • Parameters

            Returns Promise<Response<Octokit.PullsCreateReviewResponse>>

        • endpoint: Endpoint
      • createReviewCommentReply: { endpoint: Endpoint }

        Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.

        This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

          • (params?: RequestOptions & Octokit.PullsCreateReviewCommentReplyParams): Promise<Response<Octokit.PullsCreateReviewCommentReplyResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.PullsCreateReviewCommentReplyParams

            Returns Promise<Response<Octokit.PullsCreateReviewCommentReplyResponse>>

        • endpoint: Endpoint
      • createReviewRequest: { endpoint: Endpoint }

        This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

          • (params?: RequestOptions & Octokit.PullsCreateReviewRequestParamsDeprecatedNumber): Promise<Response<Octokit.PullsCreateReviewRequestResponse>>
          • (params?: RequestOptions & Octokit.PullsCreateReviewRequestParams): Promise<Response<Octokit.PullsCreateReviewRequestResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.PullsCreateReviewRequestParamsDeprecatedNumber

            Returns Promise<Response<Octokit.PullsCreateReviewRequestResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.PullsCreateReviewRequestParams

            Returns Promise<Response<Octokit.PullsCreateReviewRequestResponse>>

        • endpoint: Endpoint
      • deleteComment: { endpoint: Endpoint }

        Deletes a review comment.

          • (params?: RequestOptions & Octokit.PullsDeleteCommentParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • deletePendingReview: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.PullsDeletePendingReviewParamsDeprecatedNumber): Promise<Response<Octokit.PullsDeletePendingReviewResponse>>
          • (params?: RequestOptions & Octokit.PullsDeletePendingReviewParams): Promise<Response<Octokit.PullsDeletePendingReviewResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.PullsDeletePendingReviewParamsDeprecatedNumber

            Returns Promise<Response<Octokit.PullsDeletePendingReviewResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.PullsDeletePendingReviewParams

            Returns Promise<Response<Octokit.PullsDeletePendingReviewResponse>>

        • endpoint: Endpoint
      • deleteReviewRequest: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.PullsDeleteReviewRequestParamsDeprecatedNumber): Promise<Octokit.AnyResponse>
          • (params?: RequestOptions & Octokit.PullsDeleteReviewRequestParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.PullsDeleteReviewRequestParamsDeprecatedNumber

            Returns Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.PullsDeleteReviewRequestParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • dismissReview: { endpoint: Endpoint }

        Note: To dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.

          • (params?: RequestOptions & Octokit.PullsDismissReviewParamsDeprecatedNumber): Promise<Response<Octokit.PullsDismissReviewResponse>>
          • (params?: RequestOptions & Octokit.PullsDismissReviewParams): Promise<Response<Octokit.PullsDismissReviewResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.PullsDismissReviewParamsDeprecatedNumber

            Returns Promise<Response<Octokit.PullsDismissReviewResponse>>

          • Parameters

            Returns Promise<Response<Octokit.PullsDismissReviewResponse>>

        • endpoint: Endpoint
      • get: { endpoint: Endpoint }

        Draft pull requests are available in public repositories with GitHub Free and GitHub Pro, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

        Lists details of a pull request by providing its number.

        When you get, create, or edit a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see "Checking mergeability of pull requests".

        The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.

        The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:

        • If merged as a merge commit, merge_commit_sha represents the SHA of the merge commit.
        • If merged via a squash, merge_commit_sha represents the SHA of the squashed commit on the base branch.
        • If rebased, merge_commit_sha represents the commit that the base branch was updated to.

        Pass the appropriate media type to fetch diff and patch formats.

          • Parameters

            • Optional params: RequestOptions & Octokit.PullsGetParamsDeprecatedNumber

            Returns Promise<Response<Octokit.PullsGetResponse>>

          • Parameters

            Returns Promise<Response<Octokit.PullsGetResponse>>

        • endpoint: Endpoint
      • getComment: { endpoint: Endpoint }

        Note: Multi-line comments on pull requests are currently in public beta and subject to change.

        Provides details for a review comment.

        Multi-line comment summary

        Note: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.

        Use the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.

        If you use the comfort-fade preview header, your response will show:

        • For multi-line comments, values for start_line, original_start_line, start_side, line, original_line, and side.
        • For single-line comments, values for line, original_line, and side and a null value for start_line, original_start_line, and start_side.

        If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:

        • For multi-line comments, the last line of the comment range for the position attribute.
        • For single-line comments, the diff-positioned way of referencing comments for the position attribute. For more information, see position in the input parameters table.

        The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

          • (params?: RequestOptions & Octokit.PullsGetCommentParams): Promise<Response<Octokit.PullsGetCommentResponse>>

          • Parameters

            Returns Promise<Response<Octokit.PullsGetCommentResponse>>

        • endpoint: Endpoint
      • getCommentsForReview: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.PullsGetCommentsForReviewParamsDeprecatedNumber): Promise<Response<Octokit.PullsGetCommentsForReviewResponse>>
          • (params?: RequestOptions & Octokit.PullsGetCommentsForReviewParams): Promise<Response<Octokit.PullsGetCommentsForReviewResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.PullsGetCommentsForReviewParamsDeprecatedNumber

            Returns Promise<Response<Octokit.PullsGetCommentsForReviewResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.PullsGetCommentsForReviewParams

            Returns Promise<Response<Octokit.PullsGetCommentsForReviewResponse>>

        • endpoint: Endpoint
      • getReview: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.PullsGetReviewParamsDeprecatedNumber): Promise<Response<Octokit.PullsGetReviewResponse>>
          • (params?: RequestOptions & Octokit.PullsGetReviewParams): Promise<Response<Octokit.PullsGetReviewResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.PullsGetReviewParamsDeprecatedNumber

            Returns Promise<Response<Octokit.PullsGetReviewResponse>>

          • Parameters

            Returns Promise<Response<Octokit.PullsGetReviewResponse>>

        • endpoint: Endpoint
      • list: { endpoint: Endpoint }

        Draft pull requests are available in public repositories with GitHub Free and GitHub Pro, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

      • listComments: { endpoint: Endpoint }

        Note: Multi-line comments on pull requests are currently in public beta and subject to change.

        Lists review comments for a pull request. By default, review comments are in ascending order by ID.

        Multi-line comment summary

        Note: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.

        Use the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.

        If you use the comfort-fade preview header, your response will show:

        • For multi-line comments, values for start_line, original_start_line, start_side, line, original_line, and side.
        • For single-line comments, values for line, original_line, and side and a null value for start_line, original_start_line, and start_side.

        If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:

        • For multi-line comments, the last line of the comment range for the position attribute.
        • For single-line comments, the diff-positioned way of referencing comments for the position attribute. For more information, see position in the input parameters table.

        The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

          • (params?: RequestOptions & Octokit.PullsListCommentsParamsDeprecatedNumber): Promise<Response<Octokit.PullsListCommentsResponse>>
          • (params?: RequestOptions & Octokit.PullsListCommentsParams): Promise<Response<Octokit.PullsListCommentsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.PullsListCommentsParamsDeprecatedNumber

            Returns Promise<Response<Octokit.PullsListCommentsResponse>>

          • Parameters

            Returns Promise<Response<Octokit.PullsListCommentsResponse>>

        • endpoint: Endpoint
      • listCommentsForRepo: { endpoint: Endpoint }

        Note: Multi-line comments on pull requests are currently in public beta and subject to change.

        Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.

        Multi-line comment summary

        Note: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.

        Use the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.

        If you use the comfort-fade preview header, your response will show:

        • For multi-line comments, values for start_line, original_start_line, start_side, line, original_line, and side.
        • For single-line comments, values for line, original_line, and side and a null value for start_line, original_start_line, and start_side.

        If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:

        • For multi-line comments, the last line of the comment range for the position attribute.
        • For single-line comments, the diff-positioned way of referencing comments for the position attribute. For more information, see position in the input parameters table.

        The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

          • (params?: RequestOptions & Octokit.PullsListCommentsForRepoParams): Promise<Response<Octokit.PullsListCommentsForRepoResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.PullsListCommentsForRepoParams

            Returns Promise<Response<Octokit.PullsListCommentsForRepoResponse>>

        • endpoint: Endpoint
      • listCommits: { endpoint: Endpoint }

        Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the Commit List API.

          • (params?: RequestOptions & Octokit.PullsListCommitsParamsDeprecatedNumber): Promise<Response<Octokit.PullsListCommitsResponse>>
          • (params?: RequestOptions & Octokit.PullsListCommitsParams): Promise<Response<Octokit.PullsListCommitsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.PullsListCommitsParamsDeprecatedNumber

            Returns Promise<Response<Octokit.PullsListCommitsResponse>>

          • Parameters

            Returns Promise<Response<Octokit.PullsListCommitsResponse>>

        • endpoint: Endpoint
      • listFiles: { endpoint: Endpoint }

        Note: Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.

          • (params?: RequestOptions & Octokit.PullsListFilesParamsDeprecatedNumber): Promise<Response<Octokit.PullsListFilesResponse>>
          • (params?: RequestOptions & Octokit.PullsListFilesParams): Promise<Response<Octokit.PullsListFilesResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.PullsListFilesParamsDeprecatedNumber

            Returns Promise<Response<Octokit.PullsListFilesResponse>>

          • Parameters

            Returns Promise<Response<Octokit.PullsListFilesResponse>>

        • endpoint: Endpoint
      • listReviewRequests: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.PullsListReviewRequestsParamsDeprecatedNumber): Promise<Response<Octokit.PullsListReviewRequestsResponse>>
          • (params?: RequestOptions & Octokit.PullsListReviewRequestsParams): Promise<Response<Octokit.PullsListReviewRequestsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.PullsListReviewRequestsParamsDeprecatedNumber

            Returns Promise<Response<Octokit.PullsListReviewRequestsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.PullsListReviewRequestsParams

            Returns Promise<Response<Octokit.PullsListReviewRequestsResponse>>

        • endpoint: Endpoint
      • listReviews: { endpoint: Endpoint }

        The list of reviews returns in chronological order.

          • (params?: RequestOptions & Octokit.PullsListReviewsParamsDeprecatedNumber): Promise<Response<Octokit.PullsListReviewsResponse>>
          • (params?: RequestOptions & Octokit.PullsListReviewsParams): Promise<Response<Octokit.PullsListReviewsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.PullsListReviewsParamsDeprecatedNumber

            Returns Promise<Response<Octokit.PullsListReviewsResponse>>

          • Parameters

            Returns Promise<Response<Octokit.PullsListReviewsResponse>>

        • endpoint: Endpoint
      • merge: { endpoint: Endpoint }

        This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

          • Parameters

            • Optional params: RequestOptions & Octokit.PullsMergeParamsDeprecatedNumber

            Returns Promise<Response<Octokit.PullsMergeResponse>>

          • Parameters

            Returns Promise<Response<Octokit.PullsMergeResponse>>

        • endpoint: Endpoint
      • submitReview: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.PullsSubmitReviewParamsDeprecatedNumber): Promise<Response<Octokit.PullsSubmitReviewResponse>>
          • (params?: RequestOptions & Octokit.PullsSubmitReviewParams): Promise<Response<Octokit.PullsSubmitReviewResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.PullsSubmitReviewParamsDeprecatedNumber

            Returns Promise<Response<Octokit.PullsSubmitReviewResponse>>

          • Parameters

            Returns Promise<Response<Octokit.PullsSubmitReviewResponse>>

        • endpoint: Endpoint
      • update: { endpoint: Endpoint }

        Draft pull requests are available in public repositories with GitHub Free and GitHub Pro, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

        To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

          • (params?: RequestOptions & Octokit.PullsUpdateParamsDeprecatedNumber): Promise<Response<Octokit.PullsUpdateResponse>>
          • (params?: RequestOptions & Octokit.PullsUpdateParams): Promise<Response<Octokit.PullsUpdateResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.PullsUpdateParamsDeprecatedNumber

            Returns Promise<Response<Octokit.PullsUpdateResponse>>

          • Parameters

            Returns Promise<Response<Octokit.PullsUpdateResponse>>

        • endpoint: Endpoint
      • updateBranch: { endpoint: Endpoint }

        Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.

          • (params?: RequestOptions & Octokit.PullsUpdateBranchParams): Promise<Response<Octokit.PullsUpdateBranchResponse>>

          • Parameters

            Returns Promise<Response<Octokit.PullsUpdateBranchResponse>>

        • endpoint: Endpoint
      • updateComment: { endpoint: Endpoint }

        Note: Multi-line comments on pull requests are currently in public beta and subject to change.

        Enables you to edit a review comment.

        Multi-line comment summary

        Note: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.

        Use the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.

        If you use the comfort-fade preview header, your response will show:

        • For multi-line comments, values for start_line, original_start_line, start_side, line, original_line, and side.
        • For single-line comments, values for line, original_line, and side and a null value for start_line, original_start_line, and start_side.

        If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:

        • For multi-line comments, the last line of the comment range for the position attribute.
        • For single-line comments, the diff-positioned way of referencing comments for the position attribute. For more information, see position in the input parameters table.
          • (params?: RequestOptions & Octokit.PullsUpdateCommentParams): Promise<Response<Octokit.PullsUpdateCommentResponse>>

          • Parameters

            Returns Promise<Response<Octokit.PullsUpdateCommentResponse>>

        • endpoint: Endpoint
      • updateReview: { endpoint: Endpoint }

        Update the review summary comment with new text.

          • (params?: RequestOptions & Octokit.PullsUpdateReviewParamsDeprecatedNumber): Promise<Response<Octokit.PullsUpdateReviewResponse>>
          • (params?: RequestOptions & Octokit.PullsUpdateReviewParams): Promise<Response<Octokit.PullsUpdateReviewResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.PullsUpdateReviewParamsDeprecatedNumber

            Returns Promise<Response<Octokit.PullsUpdateReviewResponse>>

          • Parameters

            Returns Promise<Response<Octokit.PullsUpdateReviewResponse>>

        • endpoint: Endpoint

      query

      query: Graphql
      deprecated

      .query() is deprecated, use .graphql() instead

      rateLimit

      rateLimit: { get: { endpoint: Endpoint } }

      Type declaration

      • get: { endpoint: Endpoint }

        Note: Accessing this endpoint does not count against your REST API rate limit.

        Understanding your rate limit status

        The Search API has a custom rate limit, separate from the rate limit governing the rest of the REST API. The GraphQL API also has a custom rate limit that is separate from and calculated differently than rate limits in the REST API.

        For these reasons, the Rate Limit API response categorizes your rate limit. Under resources, you'll see four objects:

        • The core object provides your rate limit status for all non-search-related resources in the REST API.
        • The search object provides your rate limit status for the Search API.
        • The graphql object provides your rate limit status for the GraphQL API.
        • The integration_manifest object provides your rate limit status for the GitHub App Manifest code conversion endpoint.

        For more information on the headers and values in the rate limit response, see "Rate limiting."

        The rate object (shown at the bottom of the response above) is deprecated.

        If you're writing new API client code or updating existing code, you should use the core object instead of the rate object. The core object contains the same information that is present in the rate object.

      reactions

      reactions: { createForCommitComment: { endpoint: Endpoint }; createForIssue: { endpoint: Endpoint }; createForIssueComment: { endpoint: Endpoint }; createForPullRequestReviewComment: { endpoint: Endpoint }; createForTeamDiscussion: { endpoint: Endpoint }; createForTeamDiscussionComment: { endpoint: Endpoint }; createForTeamDiscussionCommentInOrg: { endpoint: Endpoint }; createForTeamDiscussionCommentLegacy: { endpoint: Endpoint }; createForTeamDiscussionInOrg: { endpoint: Endpoint }; createForTeamDiscussionLegacy: { endpoint: Endpoint }; delete: { endpoint: Endpoint }; listForCommitComment: { endpoint: Endpoint }; listForIssue: { endpoint: Endpoint }; listForIssueComment: { endpoint: Endpoint }; listForPullRequestReviewComment: { endpoint: Endpoint }; listForTeamDiscussion: { endpoint: Endpoint }; listForTeamDiscussionComment: { endpoint: Endpoint }; listForTeamDiscussionCommentInOrg: { endpoint: Endpoint }; listForTeamDiscussionCommentLegacy: { endpoint: Endpoint }; listForTeamDiscussionInOrg: { endpoint: Endpoint }; listForTeamDiscussionLegacy: { endpoint: Endpoint } }

      Type declaration

      • createForCommitComment: { endpoint: Endpoint }

        Create a reaction to a commit comment. A response with a Status: 200 OK means that you already added the reaction type to this commit comment.

          • (params?: RequestOptions & Octokit.ReactionsCreateForCommitCommentParams): Promise<Response<Octokit.ReactionsCreateForCommitCommentResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReactionsCreateForCommitCommentParams

            Returns Promise<Response<Octokit.ReactionsCreateForCommitCommentResponse>>

        • endpoint: Endpoint
      • createForIssue: { endpoint: Endpoint }

        Create a reaction to an issue. A response with a Status: 200 OK means that you already added the reaction type to this issue.

          • (params?: RequestOptions & Octokit.ReactionsCreateForIssueParamsDeprecatedNumber): Promise<Response<Octokit.ReactionsCreateForIssueResponse>>
          • (params?: RequestOptions & Octokit.ReactionsCreateForIssueParams): Promise<Response<Octokit.ReactionsCreateForIssueResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReactionsCreateForIssueParamsDeprecatedNumber

            Returns Promise<Response<Octokit.ReactionsCreateForIssueResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReactionsCreateForIssueParams

            Returns Promise<Response<Octokit.ReactionsCreateForIssueResponse>>

        • endpoint: Endpoint
      • createForIssueComment: { endpoint: Endpoint }

        Create a reaction to an issue comment. A response with a Status: 200 OK means that you already added the reaction type to this issue comment.

          • (params?: RequestOptions & Octokit.ReactionsCreateForIssueCommentParams): Promise<Response<Octokit.ReactionsCreateForIssueCommentResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReactionsCreateForIssueCommentParams

            Returns Promise<Response<Octokit.ReactionsCreateForIssueCommentResponse>>

        • endpoint: Endpoint
      • createForPullRequestReviewComment: { endpoint: Endpoint }

        Create a reaction to a pull request review comment. A response with a Status: 200 OK means that you already added the reaction type to this pull request review comment.

          • (params?: RequestOptions & Octokit.ReactionsCreateForPullRequestReviewCommentParams): Promise<Response<Octokit.ReactionsCreateForPullRequestReviewCommentResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReactionsCreateForPullRequestReviewCommentParams

            Returns Promise<Response<Octokit.ReactionsCreateForPullRequestReviewCommentResponse>>

        • endpoint: Endpoint
      • createForTeamDiscussion: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.

        Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with a Status: 200 OK means that you already added the reaction type to this team discussion.

        deprecated

        octokit.reactions.createForTeamDiscussion() is deprecated, see https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion-legacy

          • (params?: RequestOptions & Octokit.ReactionsCreateForTeamDiscussionParams): Promise<Response<Octokit.ReactionsCreateForTeamDiscussionResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReactionsCreateForTeamDiscussionParams

            Returns Promise<Response<Octokit.ReactionsCreateForTeamDiscussionResponse>>

        • endpoint: Endpoint
      • createForTeamDiscussionComment: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion comment endpoint.

        Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with a Status: 200 OK means that you already added the reaction type to this team discussion comment.

        deprecated

        octokit.reactions.createForTeamDiscussionComment() is deprecated, see https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion-comment-legacy

          • (params?: RequestOptions & Octokit.ReactionsCreateForTeamDiscussionCommentParams): Promise<Response<Octokit.ReactionsCreateForTeamDiscussionCommentResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReactionsCreateForTeamDiscussionCommentParams

            Returns Promise<Response<Octokit.ReactionsCreateForTeamDiscussionCommentResponse>>

        • endpoint: Endpoint
      • createForTeamDiscussionCommentInOrg: { endpoint: Endpoint }

        Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with a Status: 200 OK means that you already added the reaction type to this team discussion comment.

        Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.

          • (params?: RequestOptions & Octokit.ReactionsCreateForTeamDiscussionCommentInOrgParams): Promise<Response<Octokit.ReactionsCreateForTeamDiscussionCommentInOrgResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReactionsCreateForTeamDiscussionCommentInOrgParams

            Returns Promise<Response<Octokit.ReactionsCreateForTeamDiscussionCommentInOrgResponse>>

        • endpoint: Endpoint
      • createForTeamDiscussionCommentLegacy: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion comment endpoint.

        Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with a Status: 200 OK means that you already added the reaction type to this team discussion comment.

        deprecated

        octokit.reactions.createForTeamDiscussionCommentLegacy() is deprecated, see https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion-comment-legacy

          • (params?: RequestOptions & Octokit.ReactionsCreateForTeamDiscussionCommentLegacyParams): Promise<Response<Octokit.ReactionsCreateForTeamDiscussionCommentLegacyResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReactionsCreateForTeamDiscussionCommentLegacyParams

            Returns Promise<Response<Octokit.ReactionsCreateForTeamDiscussionCommentLegacyResponse>>

        • endpoint: Endpoint
      • createForTeamDiscussionInOrg: { endpoint: Endpoint }

        Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with a Status: 200 OK means that you already added the reaction type to this team discussion.

        Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.

          • (params?: RequestOptions & Octokit.ReactionsCreateForTeamDiscussionInOrgParams): Promise<Response<Octokit.ReactionsCreateForTeamDiscussionInOrgResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReactionsCreateForTeamDiscussionInOrgParams

            Returns Promise<Response<Octokit.ReactionsCreateForTeamDiscussionInOrgResponse>>

        • endpoint: Endpoint
      • createForTeamDiscussionLegacy: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.

        Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with a Status: 200 OK means that you already added the reaction type to this team discussion.

        deprecated

        octokit.reactions.createForTeamDiscussionLegacy() is deprecated, see https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion-legacy

          • (params?: RequestOptions & Octokit.ReactionsCreateForTeamDiscussionLegacyParams): Promise<Response<Octokit.ReactionsCreateForTeamDiscussionLegacyResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReactionsCreateForTeamDiscussionLegacyParams

            Returns Promise<Response<Octokit.ReactionsCreateForTeamDiscussionLegacyResponse>>

        • endpoint: Endpoint
      • delete: { endpoint: Endpoint }

        OAuth access tokens require the write:discussion scope, when deleting a team discussion or team discussion comment.

          • (params?: RequestOptions & Octokit.ReactionsDeleteParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • listForCommitComment: { endpoint: Endpoint }

        List the reactions to a commit comment.

          • (params?: RequestOptions & Octokit.ReactionsListForCommitCommentParams): Promise<Response<Octokit.ReactionsListForCommitCommentResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReactionsListForCommitCommentParams

            Returns Promise<Response<Octokit.ReactionsListForCommitCommentResponse>>

        • endpoint: Endpoint
      • listForIssue: { endpoint: Endpoint }

        List the reactions to an issue.

          • (params?: RequestOptions & Octokit.ReactionsListForIssueParamsDeprecatedNumber): Promise<Response<Octokit.ReactionsListForIssueResponse>>
          • (params?: RequestOptions & Octokit.ReactionsListForIssueParams): Promise<Response<Octokit.ReactionsListForIssueResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReactionsListForIssueParamsDeprecatedNumber

            Returns Promise<Response<Octokit.ReactionsListForIssueResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReactionsListForIssueParams

            Returns Promise<Response<Octokit.ReactionsListForIssueResponse>>

        • endpoint: Endpoint
      • listForIssueComment: { endpoint: Endpoint }

        List the reactions to an issue comment.

          • (params?: RequestOptions & Octokit.ReactionsListForIssueCommentParams): Promise<Response<Octokit.ReactionsListForIssueCommentResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReactionsListForIssueCommentParams

            Returns Promise<Response<Octokit.ReactionsListForIssueCommentResponse>>

        • endpoint: Endpoint
      • listForPullRequestReviewComment: { endpoint: Endpoint }

        List the reactions to a pull request review comment.

          • (params?: RequestOptions & Octokit.ReactionsListForPullRequestReviewCommentParams): Promise<Response<Octokit.ReactionsListForPullRequestReviewCommentResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReactionsListForPullRequestReviewCommentParams

            Returns Promise<Response<Octokit.ReactionsListForPullRequestReviewCommentResponse>>

        • endpoint: Endpoint
      • listForTeamDiscussion: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.

        List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.

        deprecated

        octokit.reactions.listForTeamDiscussion() is deprecated, see https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-legacy

          • (params?: RequestOptions & Octokit.ReactionsListForTeamDiscussionParams): Promise<Response<Octokit.ReactionsListForTeamDiscussionResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReactionsListForTeamDiscussionParams

            Returns Promise<Response<Octokit.ReactionsListForTeamDiscussionResponse>>

        • endpoint: Endpoint
      • listForTeamDiscussionComment: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.

        List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.

        deprecated

        octokit.reactions.listForTeamDiscussionComment() is deprecated, see https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-comment-legacy

          • (params?: RequestOptions & Octokit.ReactionsListForTeamDiscussionCommentParams): Promise<Response<Octokit.ReactionsListForTeamDiscussionCommentResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReactionsListForTeamDiscussionCommentParams

            Returns Promise<Response<Octokit.ReactionsListForTeamDiscussionCommentResponse>>

        • endpoint: Endpoint
      • listForTeamDiscussionCommentInOrg: { endpoint: Endpoint }

        List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.

        Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.

          • (params?: RequestOptions & Octokit.ReactionsListForTeamDiscussionCommentInOrgParams): Promise<Response<Octokit.ReactionsListForTeamDiscussionCommentInOrgResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReactionsListForTeamDiscussionCommentInOrgParams

            Returns Promise<Response<Octokit.ReactionsListForTeamDiscussionCommentInOrgResponse>>

        • endpoint: Endpoint
      • listForTeamDiscussionCommentLegacy: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.

        List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.

        deprecated

        octokit.reactions.listForTeamDiscussionCommentLegacy() is deprecated, see https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-comment-legacy

          • (params?: RequestOptions & Octokit.ReactionsListForTeamDiscussionCommentLegacyParams): Promise<Response<Octokit.ReactionsListForTeamDiscussionCommentLegacyResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReactionsListForTeamDiscussionCommentLegacyParams

            Returns Promise<Response<Octokit.ReactionsListForTeamDiscussionCommentLegacyResponse>>

        • endpoint: Endpoint
      • listForTeamDiscussionInOrg: { endpoint: Endpoint }

        List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.

        Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.

          • (params?: RequestOptions & Octokit.ReactionsListForTeamDiscussionInOrgParams): Promise<Response<Octokit.ReactionsListForTeamDiscussionInOrgResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReactionsListForTeamDiscussionInOrgParams

            Returns Promise<Response<Octokit.ReactionsListForTeamDiscussionInOrgResponse>>

        • endpoint: Endpoint
      • listForTeamDiscussionLegacy: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.

        List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.

        deprecated

        octokit.reactions.listForTeamDiscussionLegacy() is deprecated, see https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-legacy

          • (params?: RequestOptions & Octokit.ReactionsListForTeamDiscussionLegacyParams): Promise<Response<Octokit.ReactionsListForTeamDiscussionLegacyResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReactionsListForTeamDiscussionLegacyParams

            Returns Promise<Response<Octokit.ReactionsListForTeamDiscussionLegacyResponse>>

        • endpoint: Endpoint

      repos

      repos: { acceptInvitation: { endpoint: Endpoint }; addCollaborator: { endpoint: Endpoint }; addDeployKey: { endpoint: Endpoint }; addProtectedBranchAdminEnforcement: { endpoint: Endpoint }; addProtectedBranchAppRestrictions: { endpoint: Endpoint }; addProtectedBranchRequiredSignatures: { endpoint: Endpoint }; addProtectedBranchRequiredStatusChecksContexts: { endpoint: Endpoint }; addProtectedBranchTeamRestrictions: { endpoint: Endpoint }; addProtectedBranchUserRestrictions: { endpoint: Endpoint }; checkCollaborator: { endpoint: Endpoint }; checkVulnerabilityAlerts: { endpoint: Endpoint }; compareCommits: { endpoint: Endpoint }; createCommitComment: { endpoint: Endpoint }; createDeployment: { endpoint: Endpoint }; createDeploymentStatus: { endpoint: Endpoint }; createDispatchEvent: { endpoint: Endpoint }; createFile: { endpoint: Endpoint }; createForAuthenticatedUser: { endpoint: Endpoint }; createFork: { endpoint: Endpoint }; createHook: { endpoint: Endpoint }; createInOrg: { endpoint: Endpoint }; createOrUpdateFile: { endpoint: Endpoint }; createRelease: { endpoint: Endpoint }; createStatus: { endpoint: Endpoint }; createUsingTemplate: { endpoint: Endpoint }; declineInvitation: { endpoint: Endpoint }; delete: { endpoint: Endpoint }; deleteCommitComment: { endpoint: Endpoint }; deleteDownload: { endpoint: Endpoint }; deleteFile: { endpoint: Endpoint }; deleteHook: { endpoint: Endpoint }; deleteInvitation: { endpoint: Endpoint }; deleteRelease: { endpoint: Endpoint }; deleteReleaseAsset: { endpoint: Endpoint }; disableAutomatedSecurityFixes: { endpoint: Endpoint }; disablePagesSite: { endpoint: Endpoint }; disableVulnerabilityAlerts: { endpoint: Endpoint }; enableAutomatedSecurityFixes: { endpoint: Endpoint }; enablePagesSite: { endpoint: Endpoint }; enableVulnerabilityAlerts: { endpoint: Endpoint }; get: { endpoint: Endpoint }; getAppsWithAccessToProtectedBranch: { endpoint: Endpoint }; getArchiveLink: { endpoint: Endpoint }; getBranch: { endpoint: Endpoint }; getBranchProtection: { endpoint: Endpoint }; getClones: { endpoint: Endpoint }; getCodeFrequencyStats: { endpoint: Endpoint }; getCollaboratorPermissionLevel: { endpoint: Endpoint }; getCombinedStatusForRef: { endpoint: Endpoint }; getCommit: { endpoint: Endpoint }; getCommitActivityStats: { endpoint: Endpoint }; getCommitComment: { endpoint: Endpoint }; getCommitRefSha: { endpoint: Endpoint }; getContents: { endpoint: Endpoint }; getContributorsStats: { endpoint: Endpoint }; getDeployKey: { endpoint: Endpoint }; getDeployment: { endpoint: Endpoint }; getDeploymentStatus: { endpoint: Endpoint }; getDownload: { endpoint: Endpoint }; getHook: { endpoint: Endpoint }; getLatestPagesBuild: { endpoint: Endpoint }; getLatestRelease: { endpoint: Endpoint }; getPages: { endpoint: Endpoint }; getPagesBuild: { endpoint: Endpoint }; getParticipationStats: { endpoint: Endpoint }; getProtectedBranchAdminEnforcement: { endpoint: Endpoint }; getProtectedBranchPullRequestReviewEnforcement: { endpoint: Endpoint }; getProtectedBranchRequiredSignatures: { endpoint: Endpoint }; getProtectedBranchRequiredStatusChecks: { endpoint: Endpoint }; getProtectedBranchRestrictions: { endpoint: Endpoint }; getPunchCardStats: { endpoint: Endpoint }; getReadme: { endpoint: Endpoint }; getRelease: { endpoint: Endpoint }; getReleaseAsset: { endpoint: Endpoint }; getReleaseByTag: { endpoint: Endpoint }; getTeamsWithAccessToProtectedBranch: { endpoint: Endpoint }; getTopPaths: { endpoint: Endpoint }; getTopReferrers: { endpoint: Endpoint }; getUsersWithAccessToProtectedBranch: { endpoint: Endpoint }; getViews: { endpoint: Endpoint }; list: { endpoint: Endpoint }; listAppsWithAccessToProtectedBranch: { endpoint: Endpoint }; listAssetsForRelease: { endpoint: Endpoint }; listBranches: { endpoint: Endpoint }; listBranchesForHeadCommit: { endpoint: Endpoint }; listCollaborators: { endpoint: Endpoint }; listCommentsForCommit: { endpoint: Endpoint }; listCommitComments: { endpoint: Endpoint }; listCommits: { endpoint: Endpoint }; listContributors: { endpoint: Endpoint }; listDeployKeys: { endpoint: Endpoint }; listDeploymentStatuses: { endpoint: Endpoint }; listDeployments: { endpoint: Endpoint }; listDownloads: { endpoint: Endpoint }; listForOrg: { endpoint: Endpoint }; listForUser: { endpoint: Endpoint }; listForks: { endpoint: Endpoint }; listHooks: { endpoint: Endpoint }; listInvitations: { endpoint: Endpoint }; listInvitationsForAuthenticatedUser: { endpoint: Endpoint }; listLanguages: { endpoint: Endpoint }; listPagesBuilds: { endpoint: Endpoint }; listProtectedBranchRequiredStatusChecksContexts: { endpoint: Endpoint }; listProtectedBranchTeamRestrictions: { endpoint: Endpoint }; listProtectedBranchUserRestrictions: { endpoint: Endpoint }; listPublic: { endpoint: Endpoint }; listPullRequestsAssociatedWithCommit: { endpoint: Endpoint }; listReleases: { endpoint: Endpoint }; listStatusesForRef: { endpoint: Endpoint }; listTags: { endpoint: Endpoint }; listTeams: { endpoint: Endpoint }; listTeamsWithAccessToProtectedBranch: { endpoint: Endpoint }; listTopics: { endpoint: Endpoint }; listUsersWithAccessToProtectedBranch: { endpoint: Endpoint }; merge: { endpoint: Endpoint }; pingHook: { endpoint: Endpoint }; removeBranchProtection: { endpoint: Endpoint }; removeCollaborator: { endpoint: Endpoint }; removeDeployKey: { endpoint: Endpoint }; removeProtectedBranchAdminEnforcement: { endpoint: Endpoint }; removeProtectedBranchAppRestrictions: { endpoint: Endpoint }; removeProtectedBranchPullRequestReviewEnforcement: { endpoint: Endpoint }; removeProtectedBranchRequiredSignatures: { endpoint: Endpoint }; removeProtectedBranchRequiredStatusChecks: { endpoint: Endpoint }; removeProtectedBranchRequiredStatusChecksContexts: { endpoint: Endpoint }; removeProtectedBranchRestrictions: { endpoint: Endpoint }; removeProtectedBranchTeamRestrictions: { endpoint: Endpoint }; removeProtectedBranchUserRestrictions: { endpoint: Endpoint }; replaceProtectedBranchAppRestrictions: { endpoint: Endpoint }; replaceProtectedBranchRequiredStatusChecksContexts: { endpoint: Endpoint }; replaceProtectedBranchTeamRestrictions: { endpoint: Endpoint }; replaceProtectedBranchUserRestrictions: { endpoint: Endpoint }; replaceTopics: { endpoint: Endpoint }; requestPageBuild: { endpoint: Endpoint }; retrieveCommunityProfileMetrics: { endpoint: Endpoint }; testPushHook: { endpoint: Endpoint }; transfer: { endpoint: Endpoint }; update: { endpoint: Endpoint }; updateBranchProtection: { endpoint: Endpoint }; updateCommitComment: { endpoint: Endpoint }; updateFile: { endpoint: Endpoint }; updateHook: { endpoint: Endpoint }; updateInformationAboutPagesSite: { endpoint: Endpoint }; updateInvitation: { endpoint: Endpoint }; updateProtectedBranchPullRequestReviewEnforcement: { endpoint: Endpoint }; updateProtectedBranchRequiredStatusChecks: { endpoint: Endpoint }; updateRelease: { endpoint: Endpoint }; updateReleaseAsset: { endpoint: Endpoint }; uploadReleaseAsset: { endpoint: Endpoint } }

      Type declaration

      • acceptInvitation: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ReposAcceptInvitationParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposAcceptInvitationParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • addCollaborator: { endpoint: Endpoint }

        This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

        Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."

        The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.

        Rate limits

        To prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.

          • (params?: RequestOptions & Octokit.ReposAddCollaboratorParams): Promise<Response<Octokit.ReposAddCollaboratorResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposAddCollaboratorParams

            Returns Promise<Response<Octokit.ReposAddCollaboratorResponse>>

        • endpoint: Endpoint
      • addDeployKey: { endpoint: Endpoint }

        Here's how you can create a read-only deploy key:

          • (params?: RequestOptions & Octokit.ReposAddDeployKeyParams): Promise<Response<Octokit.ReposAddDeployKeyResponse>>

          • Parameters

            Returns Promise<Response<Octokit.ReposAddDeployKeyResponse>>

        • endpoint: Endpoint
      • addProtectedBranchAdminEnforcement: { endpoint: Endpoint }

        Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

        Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.

          • (params?: RequestOptions & Octokit.ReposAddProtectedBranchAdminEnforcementParams): Promise<Response<Octokit.ReposAddProtectedBranchAdminEnforcementResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposAddProtectedBranchAdminEnforcementParams

            Returns Promise<Response<Octokit.ReposAddProtectedBranchAdminEnforcementResponse>>

        • endpoint: Endpoint
      • addProtectedBranchAppRestrictions: { endpoint: Endpoint }

        Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

        Grants the specified apps push access for this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

        Type Description
        array The GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
          • (params?: RequestOptions & Octokit.ReposAddProtectedBranchAppRestrictionsParams): Promise<Response<Octokit.ReposAddProtectedBranchAppRestrictionsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposAddProtectedBranchAppRestrictionsParams

            Returns Promise<Response<Octokit.ReposAddProtectedBranchAppRestrictionsResponse>>

        • endpoint: Endpoint
      • addProtectedBranchRequiredSignatures: { endpoint: Endpoint }

        Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

        When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.

          • (params?: RequestOptions & Octokit.ReposAddProtectedBranchRequiredSignaturesParams): Promise<Response<Octokit.ReposAddProtectedBranchRequiredSignaturesResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposAddProtectedBranchRequiredSignaturesParams

            Returns Promise<Response<Octokit.ReposAddProtectedBranchRequiredSignaturesResponse>>

        • endpoint: Endpoint
      • addProtectedBranchRequiredStatusChecksContexts: { endpoint: Endpoint }

        Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

          • (params?: RequestOptions & Octokit.ReposAddProtectedBranchRequiredStatusChecksContextsParams): Promise<Response<Octokit.ReposAddProtectedBranchRequiredStatusChecksContextsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposAddProtectedBranchRequiredStatusChecksContextsParams

            Returns Promise<Response<Octokit.ReposAddProtectedBranchRequiredStatusChecksContextsResponse>>

        • endpoint: Endpoint
      • addProtectedBranchTeamRestrictions: { endpoint: Endpoint }

        Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

        Grants the specified teams push access for this branch. You can also give push access to child teams.

        Type Description
        array The teams that can have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
          • (params?: RequestOptions & Octokit.ReposAddProtectedBranchTeamRestrictionsParams): Promise<Response<Octokit.ReposAddProtectedBranchTeamRestrictionsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposAddProtectedBranchTeamRestrictionsParams

            Returns Promise<Response<Octokit.ReposAddProtectedBranchTeamRestrictionsResponse>>

        • endpoint: Endpoint
      • addProtectedBranchUserRestrictions: { endpoint: Endpoint }

        Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

        Grants the specified people push access for this branch.

        Type Description
        array Usernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
          • (params?: RequestOptions & Octokit.ReposAddProtectedBranchUserRestrictionsParams): Promise<Response<Octokit.ReposAddProtectedBranchUserRestrictionsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposAddProtectedBranchUserRestrictionsParams

            Returns Promise<Response<Octokit.ReposAddProtectedBranchUserRestrictionsResponse>>

        • endpoint: Endpoint
      • checkCollaborator: { endpoint: Endpoint }

        For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.

        Team members will include the members of child teams.

          • (params?: RequestOptions & Octokit.ReposCheckCollaboratorParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposCheckCollaboratorParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • checkVulnerabilityAlerts: { endpoint: Endpoint }

        Shows whether vulnerability alerts are enabled or disabled for a repository. The authenticated user must have admin access to the repository. For more information, see "About security alerts for vulnerable dependencies" in the GitHub Help documentation.

          • (params?: RequestOptions & Octokit.ReposCheckVulnerabilityAlertsParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposCheckVulnerabilityAlertsParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • compareCommits: { endpoint: Endpoint }

        Both :base and :head must be branch names in :repo. To compare branches across other repositories in the same network as :repo, use the format <USERNAME>:branch.

        The response from the API is equivalent to running the git log base..head command; however, commits are returned in chronological order. Pass the appropriate media type to fetch diff and patch formats.

        The response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a renamed status have a previous_filename field showing the previous filename of the file, and files with a modified status have a patch field showing the changes made to the file.

        Working with large comparisons

        The response will include a comparison of up to 250 commits. If you are working with a larger commit range, you can use the Commit List API to enumerate all commits in the range.

        For comparisons with extremely large diffs, you may receive an error response indicating that the diff took too long to generate. You can typically resolve this error by using a smaller commit range.

        Signature verification object

        The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:

        These are the possible values for reason in the verification object:

        Value Description
        expired_key The key that made the signature is expired.
        not_signing_key The "signing" flag is not among the usage flags in the GPG key that made the signature.
        gpgverify_error There was an error communicating with the signature verification service.
        gpgverify_unavailable The signature verification service is currently unavailable.
        unsigned The object does not include a signature.
        unknown_signature_type A non-PGP signature was found in the commit.
        no_user No user was associated with the committer email address in the commit.
        unverified_email The committer email address in the commit was associated with a user, but the email address is not verified on her/his account.
        bad_email The committer email address in the commit is not included in the identities of the PGP key that made the signature.
        unknown_key The key that made the signature has not been registered with any user's account.
        malformed_signature There was an error parsing the signature.
        invalid The signature could not be cryptographically verified using the key whose key-id was found in the signature.
        valid None of the above errors applied, so the signature is considered to be verified.
          • (params?: RequestOptions & Octokit.ReposCompareCommitsParams): Promise<Response<Octokit.ReposCompareCommitsResponse>>

          • Parameters

            Returns Promise<Response<Octokit.ReposCompareCommitsResponse>>

        • endpoint: Endpoint
      • createCommitComment: { endpoint: Endpoint }

        Create a comment for a commit using its :commit_sha.

        This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

          • (params?: RequestOptions & Octokit.ReposCreateCommitCommentParamsDeprecatedSha): Promise<Response<Octokit.ReposCreateCommitCommentResponse>>
          • (params?: RequestOptions & Octokit.ReposCreateCommitCommentParamsDeprecatedLine): Promise<Response<Octokit.ReposCreateCommitCommentResponse>>
          • (params?: RequestOptions & Octokit.ReposCreateCommitCommentParams): Promise<Response<Octokit.ReposCreateCommitCommentResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposCreateCommitCommentParamsDeprecatedSha

            Returns Promise<Response<Octokit.ReposCreateCommitCommentResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposCreateCommitCommentParamsDeprecatedLine

            Returns Promise<Response<Octokit.ReposCreateCommitCommentResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposCreateCommitCommentParams

            Returns Promise<Response<Octokit.ReposCreateCommitCommentResponse>>

        • endpoint: Endpoint
      • createDeployment: { endpoint: Endpoint }

        Deployments offer a few configurable parameters with sane defaults.

        The ref parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them before we merge a pull request.

        The environment parameter allows deployments to be issued to different runtime environments. Teams often have multiple environments for verifying their applications, such as production, staging, and qa. This parameter makes it easier to track which environments have requested deployments. The default environment is production.

        The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If the ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds, the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will return a failure response.

        By default, commit statuses for every submitted context must be in a success state. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do not require any contexts or create any commit statuses, the deployment will always succeed.

        The payload parameter is available for any extra information that a deployment system might need. It is a JSON text field that will be passed on when a deployment event is dispatched.

        The task parameter is used by the deployment system to allow different execution paths. In the web world this might be deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an application with debugging enabled.

        Users with repo or repo_deployment scopes can create a deployment for a given ref:

        A simple example putting the user and room into the payload to notify back to chat networks.

        A more advanced example specifying required commit statuses and bypassing auto-merging.

        You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating a deployment. This auto-merge happens when:

        • Auto-merge option is enabled in the repository
        • Topic branch does not include the latest changes on the base branch, which is masterin the response example
        • There are no merge conflicts

        If there are no new commits in the base branch, a new request to create a deployment should give a successful response.

        This error happens when the auto_merge option is enabled and when the default branch (in this case master), can't be merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.

        This error happens when the required_contexts parameter indicates that one or more contexts need to have a success status for the commit to be deployed, but one or more of the required contexts do not have a state of success.

          • (params?: RequestOptions & Octokit.ReposCreateDeploymentParams): Promise<Response<Octokit.ReposCreateDeploymentResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposCreateDeploymentParams

            Returns Promise<Response<Octokit.ReposCreateDeploymentResponse>>

        • endpoint: Endpoint
      • createDeploymentStatus: { endpoint: Endpoint }

        Users with push access can create deployment statuses for a given deployment.

        GitHub Apps require read & write access to "Deployments" and read-only access to "Repo contents" (for private repos). OAuth Apps require the repo_deployment scope.

          • (params?: RequestOptions & Octokit.ReposCreateDeploymentStatusParams): Promise<Response<Octokit.ReposCreateDeploymentStatusResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposCreateDeploymentStatusParams

            Returns Promise<Response<Octokit.ReposCreateDeploymentStatusResponse>>

        • endpoint: Endpoint
      • createDispatchEvent: { endpoint: Endpoint }

        You can use this endpoint to trigger a webhook event called repository_dispatch when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the repository_dispatch event occurs. For an example repository_dispatch webhook payload, see "RepositoryDispatchEvent."

        The client_payload parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the client_payload can include a message that a user would like to send using a GitHub Actions workflow. Or the client_payload can be used as a test to debug your workflow. For a test example, see the input example.

        To give you write access to the repository, you must use a personal access token with the repo scope. For more information, see "Creating a personal access token for the command line" in the GitHub Help documentation.

        This input example shows how you can use the client_payload as a test to debug your workflow.

          • (params?: RequestOptions & Octokit.ReposCreateDispatchEventParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposCreateDispatchEventParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • createFile: { endpoint: Endpoint }

        Creates a new file or updates an existing file in a repository.

        deprecated

        octokit.repos.createFile() has been renamed to octokit.repos.createOrUpdateFile() (2019-06-07)

          • (params?: RequestOptions & Octokit.ReposCreateFileParams): Promise<Response<Octokit.ReposCreateFileResponse>>

          • Parameters

            Returns Promise<Response<Octokit.ReposCreateFileResponse>>

        • endpoint: Endpoint
      • createForAuthenticatedUser: { endpoint: Endpoint }

        Creates a new repository for the authenticated user.

        OAuth scope requirements

        When using OAuth, authorizations must include:

        • public_repo scope or repo scope to create a public repository
        • repo scope to create a private repository
          • (params?: RequestOptions & Octokit.ReposCreateForAuthenticatedUserParams): Promise<Response<Octokit.ReposCreateForAuthenticatedUserResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposCreateForAuthenticatedUserParams

            Returns Promise<Response<Octokit.ReposCreateForAuthenticatedUserResponse>>

        • endpoint: Endpoint
      • createFork: { endpoint: Endpoint }

        Create a fork for the authenticated user.

        Note: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact GitHub Support or GitHub Premium Support.

          • (params?: RequestOptions & Octokit.ReposCreateForkParams): Promise<Response<Octokit.ReposCreateForkResponse>>

          • Parameters

            Returns Promise<Response<Octokit.ReposCreateForkResponse>>

        • endpoint: Endpoint
      • createHook: { endpoint: Endpoint }

        Repositories can have multiple webhooks installed. Each webhook should have a unique config. Multiple webhooks can share the same config as long as those webhooks do not have any events that overlap.

        Here's how you can create a hook that posts payloads in JSON format:

          • (params?: RequestOptions & Octokit.ReposCreateHookParams): Promise<Response<Octokit.ReposCreateHookResponse>>

          • Parameters

            Returns Promise<Response<Octokit.ReposCreateHookResponse>>

        • endpoint: Endpoint
      • createInOrg: { endpoint: Endpoint }

        Creates a new repository for the authenticated user.

        OAuth scope requirements

        When using OAuth, authorizations must include:

        • public_repo scope or repo scope to create a public repository
        • repo scope to create a private repository
          • (params?: RequestOptions & Octokit.ReposCreateInOrgParams): Promise<Response<Octokit.ReposCreateInOrgResponse>>

          • Parameters

            Returns Promise<Response<Octokit.ReposCreateInOrgResponse>>

        • endpoint: Endpoint
      • createOrUpdateFile: { endpoint: Endpoint }

        Creates a new file or updates an existing file in a repository.

          • (params?: RequestOptions & Octokit.ReposCreateOrUpdateFileParams): Promise<Response<Octokit.ReposCreateOrUpdateFileResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposCreateOrUpdateFileParams

            Returns Promise<Response<Octokit.ReposCreateOrUpdateFileResponse>>

        • endpoint: Endpoint
      • createRelease: { endpoint: Endpoint }

        Users with push access to the repository can create a release.

        This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

          • (params?: RequestOptions & Octokit.ReposCreateReleaseParams): Promise<Response<Octokit.ReposCreateReleaseResponse>>

          • Parameters

            Returns Promise<Response<Octokit.ReposCreateReleaseResponse>>

        • endpoint: Endpoint
      • createStatus: { endpoint: Endpoint }

        Users with push access in a repository can create commit statuses for a given SHA.

        Note: there is a limit of 1000 statuses per sha and context within a repository. Attempts to create more than 1000 statuses will result in a validation error.

          • (params?: RequestOptions & Octokit.ReposCreateStatusParams): Promise<Response<Octokit.ReposCreateStatusResponse>>

          • Parameters

            Returns Promise<Response<Octokit.ReposCreateStatusResponse>>

        • endpoint: Endpoint
      • createUsingTemplate: { endpoint: Endpoint }

        Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the GET /repos/:owner/:repo endpoint and check that the is_template key is true.

        OAuth scope requirements

        When using OAuth, authorizations must include:

        • public_repo scope or repo scope to create a public repository
        • repo scope to create a private repository

        `

          • (params?: RequestOptions & Octokit.ReposCreateUsingTemplateParams): Promise<Response<Octokit.ReposCreateUsingTemplateResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposCreateUsingTemplateParams

            Returns Promise<Response<Octokit.ReposCreateUsingTemplateResponse>>

        • endpoint: Endpoint
      • declineInvitation: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ReposDeclineInvitationParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposDeclineInvitationParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • delete: { endpoint: Endpoint }

        Deleting a repository requires admin access. If OAuth is used, the delete_repo scope is required.

        If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response:

      • deleteCommitComment: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ReposDeleteCommitCommentParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposDeleteCommitCommentParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • deleteDownload: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ReposDeleteDownloadParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • deleteFile: { endpoint: Endpoint }

        Deletes a file in a repository.

        You can provide an additional committer parameter, which is an object containing information about the committer. Or, you can provide an author parameter, which is an object containing information about the author.

        The author section is optional and is filled in with the committer information if omitted. If the committer information is omitted, the authenticated user's information is used.

        You must provide values for both name and email, whether you choose to use author or committer. Otherwise, you'll receive a 422 status code.

          • (params?: RequestOptions & Octokit.ReposDeleteFileParams): Promise<Response<Octokit.ReposDeleteFileResponse>>

          • Parameters

            Returns Promise<Response<Octokit.ReposDeleteFileResponse>>

        • endpoint: Endpoint
      • deleteHook: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ReposDeleteHookParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • deleteInvitation: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ReposDeleteInvitationParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposDeleteInvitationParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • deleteRelease: { endpoint: Endpoint }

        Users with push access to the repository can delete a release.

          • (params?: RequestOptions & Octokit.ReposDeleteReleaseParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • deleteReleaseAsset: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ReposDeleteReleaseAssetParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposDeleteReleaseAssetParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • disableAutomatedSecurityFixes: { endpoint: Endpoint }

        Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "Configuring automated security fixes" in the GitHub Help documentation.

          • (params?: RequestOptions & Octokit.ReposDisableAutomatedSecurityFixesParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposDisableAutomatedSecurityFixesParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • disablePagesSite: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ReposDisablePagesSiteParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposDisablePagesSiteParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • disableVulnerabilityAlerts: { endpoint: Endpoint }

        Disables vulnerability alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "About security alerts for vulnerable dependencies" in the GitHub Help documentation.

          • (params?: RequestOptions & Octokit.ReposDisableVulnerabilityAlertsParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposDisableVulnerabilityAlertsParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • enableAutomatedSecurityFixes: { endpoint: Endpoint }

        Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "Configuring automated security fixes" in the GitHub Help documentation.

          • (params?: RequestOptions & Octokit.ReposEnableAutomatedSecurityFixesParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposEnableAutomatedSecurityFixesParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • enablePagesSite: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ReposEnablePagesSiteParams): Promise<Response<Octokit.ReposEnablePagesSiteResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposEnablePagesSiteParams

            Returns Promise<Response<Octokit.ReposEnablePagesSiteResponse>>

        • endpoint: Endpoint
      • enableVulnerabilityAlerts: { endpoint: Endpoint }

        Enables vulnerability alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "About security alerts for vulnerable dependencies" in the GitHub Help documentation.

          • (params?: RequestOptions & Octokit.ReposEnableVulnerabilityAlertsParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposEnableVulnerabilityAlertsParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • get: { endpoint: Endpoint }

        The parent and source objects are present when the repository is a fork. parent is the repository this repository was forked from, source is the ultimate source for the network.

      • getAppsWithAccessToProtectedBranch: { endpoint: Endpoint }

        Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

        Lists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

          • (params?: RequestOptions & Octokit.ReposGetAppsWithAccessToProtectedBranchParams): Promise<Response<Octokit.ReposGetAppsWithAccessToProtectedBranchResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposGetAppsWithAccessToProtectedBranchParams

            Returns Promise<Response<Octokit.ReposGetAppsWithAccessToProtectedBranchResponse>>

        • endpoint: Endpoint
      • getArchiveLink: { endpoint: Endpoint }

        Gets a redirect URL to download an archive for a repository. The :archive_format can be either tarball or zipball. The :ref must be a valid Git reference. If you omit :ref, the repository’s default branch (usually master) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use the Location header to make a second GET request.

        Note: For private repositories, these links are temporary and expire after five minutes.

        To follow redirects with curl, use the -L switch:

          • (params?: RequestOptions & Octokit.ReposGetArchiveLinkParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • getBranch: { endpoint: Endpoint }

          • Parameters

            Returns Promise<Response<Octokit.ReposGetBranchResponse>>

        • endpoint: Endpoint
      • getBranchProtection: { endpoint: Endpoint }

        Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

          • (params?: RequestOptions & Octokit.ReposGetBranchProtectionParams): Promise<Response<Octokit.ReposGetBranchProtectionResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposGetBranchProtectionParams

            Returns Promise<Response<Octokit.ReposGetBranchProtectionResponse>>

        • endpoint: Endpoint
      • getClones: { endpoint: Endpoint }

        Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.

          • Parameters

            Returns Promise<Response<Octokit.ReposGetClonesResponse>>

        • endpoint: Endpoint
      • getCodeFrequencyStats: { endpoint: Endpoint }

        Returns a weekly aggregate of the number of additions and deletions pushed to a repository.

          • (params?: RequestOptions & Octokit.ReposGetCodeFrequencyStatsParams): Promise<Response<Octokit.ReposGetCodeFrequencyStatsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposGetCodeFrequencyStatsParams

            Returns Promise<Response<Octokit.ReposGetCodeFrequencyStatsResponse>>

        • endpoint: Endpoint
      • getCollaboratorPermissionLevel: { endpoint: Endpoint }

        Possible values for the permission key: admin, write, read, none.

          • (params?: RequestOptions & Octokit.ReposGetCollaboratorPermissionLevelParams): Promise<Response<Octokit.ReposGetCollaboratorPermissionLevelResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposGetCollaboratorPermissionLevelParams

            Returns Promise<Response<Octokit.ReposGetCollaboratorPermissionLevelResponse>>

        • endpoint: Endpoint
      • getCombinedStatusForRef: { endpoint: Endpoint }

        Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.

        The most recent status for each context is returned, up to 100. This field paginates if there are over 100 contexts.

        Additionally, a combined state is returned. The state is one of:

        • failure if any of the contexts report as error or failure
        • pending if there are no statuses or a context is pending
        • success if the latest status for all contexts is success
          • (params?: RequestOptions & Octokit.ReposGetCombinedStatusForRefParams): Promise<Response<Octokit.ReposGetCombinedStatusForRefResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposGetCombinedStatusForRefParams

            Returns Promise<Response<Octokit.ReposGetCombinedStatusForRefResponse>>

        • endpoint: Endpoint
      • getCommit: { endpoint: Endpoint }

        Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.

        You can pass the appropriate media type to fetch diff and patch formats. Diffs with binary data will have no patch property.

        To return only the SHA-1 hash of the commit reference, you can provide the sha custom media type in the Accept header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.

        Signature verification object

        The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:

        These are the possible values for reason in the verification object:

        Value Description
        expired_key The key that made the signature is expired.
        not_signing_key The "signing" flag is not among the usage flags in the GPG key that made the signature.
        gpgverify_error There was an error communicating with the signature verification service.
        gpgverify_unavailable The signature verification service is currently unavailable.
        unsigned The object does not include a signature.
        unknown_signature_type A non-PGP signature was found in the commit.
        no_user No user was associated with the committer email address in the commit.
        unverified_email The committer email address in the commit was associated with a user, but the email address is not verified on her/his account.
        bad_email The committer email address in the commit is not included in the identities of the PGP key that made the signature.
        unknown_key The key that made the signature has not been registered with any user's account.
        malformed_signature There was an error parsing the signature.
        invalid The signature could not be cryptographically verified using the key whose key-id was found in the signature.
        valid None of the above errors applied, so the signature is considered to be verified.
          • (params?: RequestOptions & Octokit.ReposGetCommitParamsDeprecatedSha): Promise<Response<Octokit.ReposGetCommitResponse>>
          • (params?: RequestOptions & Octokit.ReposGetCommitParamsDeprecatedCommitSha): Promise<Response<Octokit.ReposGetCommitResponse>>
          • (params?: RequestOptions & Octokit.ReposGetCommitParams): Promise<Response<Octokit.ReposGetCommitResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposGetCommitParamsDeprecatedSha

            Returns Promise<Response<Octokit.ReposGetCommitResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposGetCommitParamsDeprecatedCommitSha

            Returns Promise<Response<Octokit.ReposGetCommitResponse>>

          • Parameters

            Returns Promise<Response<Octokit.ReposGetCommitResponse>>

        • endpoint: Endpoint
      • getCommitActivityStats: { endpoint: Endpoint }

        Returns the last year of commit activity grouped by week. The days array is a group of commits per day, starting on Sunday.

          • (params?: RequestOptions & Octokit.ReposGetCommitActivityStatsParams): Promise<Response<Octokit.ReposGetCommitActivityStatsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposGetCommitActivityStatsParams

            Returns Promise<Response<Octokit.ReposGetCommitActivityStatsResponse>>

        • endpoint: Endpoint
      • getCommitComment: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ReposGetCommitCommentParams): Promise<Response<Octokit.ReposGetCommitCommentResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposGetCommitCommentParams

            Returns Promise<Response<Octokit.ReposGetCommitCommentResponse>>

        • endpoint: Endpoint
      • getCommitRefSha: { endpoint: Endpoint }

        Note: To access this endpoint, you must provide a custom media type in the Accept header: 

        application/vnd.github.VERSION.sha

        Returns the SHA-1 of the commit reference. You must have read access for the repository to get the SHA-1 of a commit reference. You can use this endpoint to check if a remote reference's SHA-1 is the same as your local reference's SHA-1 by providing the local SHA-1 reference as the ETag.

        deprecated

        "Get the SHA-1 of a commit reference" will be removed. Use "Get a single commit" instead with media type format set to "sha" instead.

          • (params?: RequestOptions & Octokit.ReposGetCommitRefShaParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposGetCommitRefShaParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • getContents: { endpoint: Endpoint }

        Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit :path, you will receive the contents of all files in the repository.

        Files and symlinks support a custom media type for retrieving the raw content or rendered HTML (when supported). All content types support a custom media type to ensure the content is returned in a consistent object format.

        Note:

        • To get a repository's contents recursively, you can recursively get the tree.
        • This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees API.
        • This API supports files up to 1 megabyte in size.

        The response will be an array of objects, one object for each item in the directory.

        When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value should be "submodule". This behavior exists in API v3 for backwards compatibility purposes. In the next major version of the API, the type will be returned as "submodule".

        If the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the API responds with the content of the file (in the format shown above).

        Otherwise, the API responds with an object describing the symlink itself:

        The submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit.

        If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links["git"]) and the github.com URLs (html_url and _links["html"]) will have null values.

          • (params?: RequestOptions & Octokit.ReposGetContentsParams): Promise<Response<Octokit.ReposGetContentsResponse>>

          • Parameters

            Returns Promise<Response<Octokit.ReposGetContentsResponse>>

        • endpoint: Endpoint
      • getContributorsStats: { endpoint: Endpoint }
        • total - The Total number of commits authored by the contributor.

        Weekly Hash (weeks array):

        • w - Start of the week, given as a Unix timestamp.
        • a - Number of additions
        • d - Number of deletions
        • c - Number of commits
          • (params?: RequestOptions & Octokit.ReposGetContributorsStatsParams): Promise<Response<Octokit.ReposGetContributorsStatsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposGetContributorsStatsParams

            Returns Promise<Response<Octokit.ReposGetContributorsStatsResponse>>

        • endpoint: Endpoint
      • getDeployKey: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ReposGetDeployKeyParams): Promise<Response<Octokit.ReposGetDeployKeyResponse>>

          • Parameters

            Returns Promise<Response<Octokit.ReposGetDeployKeyResponse>>

        • endpoint: Endpoint
      • getDeployment: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ReposGetDeploymentParams): Promise<Response<Octokit.ReposGetDeploymentResponse>>

          • Parameters

            Returns Promise<Response<Octokit.ReposGetDeploymentResponse>>

        • endpoint: Endpoint
      • getDeploymentStatus: { endpoint: Endpoint }

        Users with pull access can view a deployment status for a deployment:

          • (params?: RequestOptions & Octokit.ReposGetDeploymentStatusParams): Promise<Response<Octokit.ReposGetDeploymentStatusResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposGetDeploymentStatusParams

            Returns Promise<Response<Octokit.ReposGetDeploymentStatusResponse>>

        • endpoint: Endpoint
      • getDownload: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ReposGetDownloadParams): Promise<Response<Octokit.ReposGetDownloadResponse>>

          • Parameters

            Returns Promise<Response<Octokit.ReposGetDownloadResponse>>

        • endpoint: Endpoint
      • getHook: { endpoint: Endpoint }
      • getLatestPagesBuild: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ReposGetLatestPagesBuildParams): Promise<Response<Octokit.ReposGetLatestPagesBuildResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposGetLatestPagesBuildParams

            Returns Promise<Response<Octokit.ReposGetLatestPagesBuildResponse>>

        • endpoint: Endpoint
      • getLatestRelease: { endpoint: Endpoint }

        View the latest published full release for the repository.

        The latest release is the most recent non-prerelease, non-draft release, sorted by the created_at attribute. The created_at attribute is the date of the commit used for the release, and not the date when the release was drafted or published.

          • (params?: RequestOptions & Octokit.ReposGetLatestReleaseParams): Promise<Response<Octokit.ReposGetLatestReleaseResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposGetLatestReleaseParams

            Returns Promise<Response<Octokit.ReposGetLatestReleaseResponse>>

        • endpoint: Endpoint
      • getPages: { endpoint: Endpoint }
      • getPagesBuild: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ReposGetPagesBuildParams): Promise<Response<Octokit.ReposGetPagesBuildResponse>>

          • Parameters

            Returns Promise<Response<Octokit.ReposGetPagesBuildResponse>>

        • endpoint: Endpoint
      • getParticipationStats: { endpoint: Endpoint }

        Returns the total commit counts for the owner and total commit counts in all. all is everyone combined, including the owner in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract owner from all.

        The array order is oldest week (index 0) to most recent week.

          • (params?: RequestOptions & Octokit.ReposGetParticipationStatsParams): Promise<Response<Octokit.ReposGetParticipationStatsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposGetParticipationStatsParams

            Returns Promise<Response<Octokit.ReposGetParticipationStatsResponse>>

        • endpoint: Endpoint
      • getProtectedBranchAdminEnforcement: { endpoint: Endpoint }

        Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

          • (params?: RequestOptions & Octokit.ReposGetProtectedBranchAdminEnforcementParams): Promise<Response<Octokit.ReposGetProtectedBranchAdminEnforcementResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposGetProtectedBranchAdminEnforcementParams

            Returns Promise<Response<Octokit.ReposGetProtectedBranchAdminEnforcementResponse>>

        • endpoint: Endpoint
      • getProtectedBranchPullRequestReviewEnforcement: { endpoint: Endpoint }

        Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

          • (params?: RequestOptions & Octokit.ReposGetProtectedBranchPullRequestReviewEnforcementParams): Promise<Response<Octokit.ReposGetProtectedBranchPullRequestReviewEnforcementResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposGetProtectedBranchPullRequestReviewEnforcementParams

            Returns Promise<Response<Octokit.ReposGetProtectedBranchPullRequestReviewEnforcementResponse>>

        • endpoint: Endpoint
      • getProtectedBranchRequiredSignatures: { endpoint: Endpoint }

        Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

        When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of true indicates you must sign commits on this branch. For more information, see Signing commits with GPG in GitHub Help.

        Note: You must enable branch protection to require signed commits.

          • (params?: RequestOptions & Octokit.ReposGetProtectedBranchRequiredSignaturesParams): Promise<Response<Octokit.ReposGetProtectedBranchRequiredSignaturesResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposGetProtectedBranchRequiredSignaturesParams

            Returns Promise<Response<Octokit.ReposGetProtectedBranchRequiredSignaturesResponse>>

        • endpoint: Endpoint
      • getProtectedBranchRequiredStatusChecks: { endpoint: Endpoint }

        Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

          • (params?: RequestOptions & Octokit.ReposGetProtectedBranchRequiredStatusChecksParams): Promise<Response<Octokit.ReposGetProtectedBranchRequiredStatusChecksResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposGetProtectedBranchRequiredStatusChecksParams

            Returns Promise<Response<Octokit.ReposGetProtectedBranchRequiredStatusChecksResponse>>

        • endpoint: Endpoint
      • getProtectedBranchRestrictions: { endpoint: Endpoint }

        Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

        Lists who has access to this protected branch. {{#note}}

        Note: Users, apps, and teams restrictions are only available for organization-owned repositories.

          • (params?: RequestOptions & Octokit.ReposGetProtectedBranchRestrictionsParams): Promise<Response<Octokit.ReposGetProtectedBranchRestrictionsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposGetProtectedBranchRestrictionsParams

            Returns Promise<Response<Octokit.ReposGetProtectedBranchRestrictionsResponse>>

        • endpoint: Endpoint
      • getPunchCardStats: { endpoint: Endpoint }

        Each array contains the day number, hour number, and number of commits:

        • 0-6: Sunday - Saturday
        • 0-23: Hour of day
        • Number of commits

        For example, [2, 14, 25] indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.

          • (params?: RequestOptions & Octokit.ReposGetPunchCardStatsParams): Promise<Response<Octokit.ReposGetPunchCardStatsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposGetPunchCardStatsParams

            Returns Promise<Response<Octokit.ReposGetPunchCardStatsResponse>>

        • endpoint: Endpoint
      • getReadme: { endpoint: Endpoint }

        Gets the preferred README for a repository.

        READMEs support custom media types for retrieving the raw content or rendered HTML.

          • Parameters

            Returns Promise<Response<Octokit.ReposGetReadmeResponse>>

        • endpoint: Endpoint
      • getRelease: { endpoint: Endpoint }

        Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource.

          • (params?: RequestOptions & Octokit.ReposGetReleaseParams): Promise<Response<Octokit.ReposGetReleaseResponse>>

          • Parameters

            Returns Promise<Response<Octokit.ReposGetReleaseResponse>>

        • endpoint: Endpoint
      • getReleaseAsset: { endpoint: Endpoint }

        To download the asset's binary content, set the Accept header of the request to application/octet-stream. The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a 200 or 302 response.

          • (params?: RequestOptions & Octokit.ReposGetReleaseAssetParams): Promise<Response<Octokit.ReposGetReleaseAssetResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposGetReleaseAssetParams

            Returns Promise<Response<Octokit.ReposGetReleaseAssetResponse>>

        • endpoint: Endpoint
      • getReleaseByTag: { endpoint: Endpoint }

        Get a published release with the specified tag.

          • (params?: RequestOptions & Octokit.ReposGetReleaseByTagParams): Promise<Response<Octokit.ReposGetReleaseByTagResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposGetReleaseByTagParams

            Returns Promise<Response<Octokit.ReposGetReleaseByTagResponse>>

        • endpoint: Endpoint
      • getTeamsWithAccessToProtectedBranch: { endpoint: Endpoint }

        Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

        Lists the teams who have push access to this branch. The list includes child teams.

          • (params?: RequestOptions & Octokit.ReposGetTeamsWithAccessToProtectedBranchParams): Promise<Response<Octokit.ReposGetTeamsWithAccessToProtectedBranchResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposGetTeamsWithAccessToProtectedBranchParams

            Returns Promise<Response<Octokit.ReposGetTeamsWithAccessToProtectedBranchResponse>>

        • endpoint: Endpoint
      • getTopPaths: { endpoint: Endpoint }

        Get the top 10 popular contents over the last 14 days.

          • (params?: RequestOptions & Octokit.ReposGetTopPathsParams): Promise<Response<Octokit.ReposGetTopPathsResponse>>

          • Parameters

            Returns Promise<Response<Octokit.ReposGetTopPathsResponse>>

        • endpoint: Endpoint
      • getTopReferrers: { endpoint: Endpoint }

        Get the top 10 referrers over the last 14 days.

          • (params?: RequestOptions & Octokit.ReposGetTopReferrersParams): Promise<Response<Octokit.ReposGetTopReferrersResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposGetTopReferrersParams

            Returns Promise<Response<Octokit.ReposGetTopReferrersResponse>>

        • endpoint: Endpoint
      • getUsersWithAccessToProtectedBranch: { endpoint: Endpoint }

        Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

        Lists the people who have push access to this branch.

          • (params?: RequestOptions & Octokit.ReposGetUsersWithAccessToProtectedBranchParams): Promise<Response<Octokit.ReposGetUsersWithAccessToProtectedBranchResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposGetUsersWithAccessToProtectedBranchParams

            Returns Promise<Response<Octokit.ReposGetUsersWithAccessToProtectedBranchResponse>>

        • endpoint: Endpoint
      • getViews: { endpoint: Endpoint }

        Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.

      • list: { endpoint: Endpoint }

        Lists repositories that the authenticated user has explicit permission (:read, :write, or :admin) to access.

        The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

          • (params?: RequestOptions & Octokit.ReposListParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • listAppsWithAccessToProtectedBranch: { endpoint: Endpoint }

        Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

        Lists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

        deprecated

        octokit.repos.listAppsWithAccessToProtectedBranch() has been renamed to octokit.repos.getAppsWithAccessToProtectedBranch() (2019-09-13)

          • (params?: RequestOptions & Octokit.ReposListAppsWithAccessToProtectedBranchParams): Promise<Response<Octokit.ReposListAppsWithAccessToProtectedBranchResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposListAppsWithAccessToProtectedBranchParams

            Returns Promise<Response<Octokit.ReposListAppsWithAccessToProtectedBranchResponse>>

        • endpoint: Endpoint
      • listAssetsForRelease: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ReposListAssetsForReleaseParams): Promise<Response<Octokit.ReposListAssetsForReleaseResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposListAssetsForReleaseParams

            Returns Promise<Response<Octokit.ReposListAssetsForReleaseResponse>>

        • endpoint: Endpoint
      • listBranches: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ReposListBranchesParams): Promise<Response<Octokit.ReposListBranchesResponse>>

          • Parameters

            Returns Promise<Response<Octokit.ReposListBranchesResponse>>

        • endpoint: Endpoint
      • listBranchesForHeadCommit: { endpoint: Endpoint }

        Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

        Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch.

          • (params?: RequestOptions & Octokit.ReposListBranchesForHeadCommitParams): Promise<Response<Octokit.ReposListBranchesForHeadCommitResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposListBranchesForHeadCommitParams

            Returns Promise<Response<Octokit.ReposListBranchesForHeadCommitResponse>>

        • endpoint: Endpoint
      • listCollaborators: { endpoint: Endpoint }

        For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.

        Team members will include the members of child teams.

          • (params?: RequestOptions & Octokit.ReposListCollaboratorsParams): Promise<Response<Octokit.ReposListCollaboratorsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposListCollaboratorsParams

            Returns Promise<Response<Octokit.ReposListCollaboratorsResponse>>

        • endpoint: Endpoint
      • listCommentsForCommit: { endpoint: Endpoint }

        Use the :commit_sha to specify the commit that will have its comments listed.

          • (params?: RequestOptions & Octokit.ReposListCommentsForCommitParamsDeprecatedRef): Promise<Response<Octokit.ReposListCommentsForCommitResponse>>
          • (params?: RequestOptions & Octokit.ReposListCommentsForCommitParams): Promise<Response<Octokit.ReposListCommentsForCommitResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposListCommentsForCommitParamsDeprecatedRef

            Returns Promise<Response<Octokit.ReposListCommentsForCommitResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposListCommentsForCommitParams

            Returns Promise<Response<Octokit.ReposListCommentsForCommitResponse>>

        • endpoint: Endpoint
      • listCommitComments: { endpoint: Endpoint }

        Commit Comments use these custom media types. You can read more about the use of media types in the API here.

        Comments are ordered by ascending ID.

          • (params?: RequestOptions & Octokit.ReposListCommitCommentsParams): Promise<Response<Octokit.ReposListCommitCommentsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposListCommitCommentsParams

            Returns Promise<Response<Octokit.ReposListCommitCommentsResponse>>

        • endpoint: Endpoint
      • listCommits: { endpoint: Endpoint }

        Signature verification object

        The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:

        These are the possible values for reason in the verification object:

        Value Description
        expired_key The key that made the signature is expired.
        not_signing_key The "signing" flag is not among the usage flags in the GPG key that made the signature.
        gpgverify_error There was an error communicating with the signature verification service.
        gpgverify_unavailable The signature verification service is currently unavailable.
        unsigned The object does not include a signature.
        unknown_signature_type A non-PGP signature was found in the commit.
        no_user No user was associated with the committer email address in the commit.
        unverified_email The committer email address in the commit was associated with a user, but the email address is not verified on her/his account.
        bad_email The committer email address in the commit is not included in the identities of the PGP key that made the signature.
        unknown_key The key that made the signature has not been registered with any user's account.
        malformed_signature There was an error parsing the signature.
        invalid The signature could not be cryptographically verified using the key whose key-id was found in the signature.
        valid None of the above errors applied, so the signature is considered to be verified.
          • (params?: RequestOptions & Octokit.ReposListCommitsParams): Promise<Response<Octokit.ReposListCommitsResponse>>

          • Parameters

            Returns Promise<Response<Octokit.ReposListCommitsResponse>>

        • endpoint: Endpoint
      • listContributors: { endpoint: Endpoint }

        Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.

        GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.

          • (params?: RequestOptions & Octokit.ReposListContributorsParams): Promise<Response<Octokit.ReposListContributorsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposListContributorsParams

            Returns Promise<Response<Octokit.ReposListContributorsResponse>>

        • endpoint: Endpoint
      • listDeployKeys: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ReposListDeployKeysParams): Promise<Response<Octokit.ReposListDeployKeysResponse>>

          • Parameters

            Returns Promise<Response<Octokit.ReposListDeployKeysResponse>>

        • endpoint: Endpoint
      • listDeploymentStatuses: { endpoint: Endpoint }

        Users with pull access can view deployment statuses for a deployment:

          • (params?: RequestOptions & Octokit.ReposListDeploymentStatusesParams): Promise<Response<Octokit.ReposListDeploymentStatusesResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposListDeploymentStatusesParams

            Returns Promise<Response<Octokit.ReposListDeploymentStatusesResponse>>

        • endpoint: Endpoint
      • listDeployments: { endpoint: Endpoint }

        Simple filtering of deployments is available via query parameters:

          • (params?: RequestOptions & Octokit.ReposListDeploymentsParams): Promise<Response<Octokit.ReposListDeploymentsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposListDeploymentsParams

            Returns Promise<Response<Octokit.ReposListDeploymentsResponse>>

        • endpoint: Endpoint
      • listDownloads: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ReposListDownloadsParams): Promise<Response<Octokit.ReposListDownloadsResponse>>

          • Parameters

            Returns Promise<Response<Octokit.ReposListDownloadsResponse>>

        • endpoint: Endpoint
      • listForOrg: { endpoint: Endpoint }

        Lists repositories for the specified organization.

          • (params?: RequestOptions & Octokit.ReposListForOrgParams): Promise<Response<Octokit.ReposListForOrgResponse>>

          • Parameters

            Returns Promise<Response<Octokit.ReposListForOrgResponse>>

        • endpoint: Endpoint
      • listForUser: { endpoint: Endpoint }

        Lists public repositories for the specified user.

          • (params?: RequestOptions & Octokit.ReposListForUserParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • listForks: { endpoint: Endpoint }

          • Parameters

            Returns Promise<Response<Octokit.ReposListForksResponse>>

        • endpoint: Endpoint
      • listHooks: { endpoint: Endpoint }

          • Parameters

            Returns Promise<Response<Octokit.ReposListHooksResponse>>

        • endpoint: Endpoint
      • listInvitations: { endpoint: Endpoint }

        When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.

          • (params?: RequestOptions & Octokit.ReposListInvitationsParams): Promise<Response<Octokit.ReposListInvitationsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposListInvitationsParams

            Returns Promise<Response<Octokit.ReposListInvitationsResponse>>

        • endpoint: Endpoint
      • listInvitationsForAuthenticatedUser: { endpoint: Endpoint }

        When authenticating as a user, this endpoint will list all currently open repository invitations for that user.

          • (params?: RequestOptions & Octokit.ReposListInvitationsForAuthenticatedUserParams): Promise<Response<Octokit.ReposListInvitationsForAuthenticatedUserResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposListInvitationsForAuthenticatedUserParams

            Returns Promise<Response<Octokit.ReposListInvitationsForAuthenticatedUserResponse>>

        • endpoint: Endpoint
      • listLanguages: { endpoint: Endpoint }

        Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.

          • (params?: RequestOptions & Octokit.ReposListLanguagesParams): Promise<Response<Octokit.ReposListLanguagesResponse>>

          • Parameters

            Returns Promise<Response<Octokit.ReposListLanguagesResponse>>

        • endpoint: Endpoint
      • listPagesBuilds: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ReposListPagesBuildsParams): Promise<Response<Octokit.ReposListPagesBuildsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposListPagesBuildsParams

            Returns Promise<Response<Octokit.ReposListPagesBuildsResponse>>

        • endpoint: Endpoint
      • listProtectedBranchRequiredStatusChecksContexts: { endpoint: Endpoint }

        Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

          • (params?: RequestOptions & Octokit.ReposListProtectedBranchRequiredStatusChecksContextsParams): Promise<Response<Octokit.ReposListProtectedBranchRequiredStatusChecksContextsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposListProtectedBranchRequiredStatusChecksContextsParams

            Returns Promise<Response<Octokit.ReposListProtectedBranchRequiredStatusChecksContextsResponse>>

        • endpoint: Endpoint
      • listProtectedBranchTeamRestrictions: { endpoint: Endpoint }

        Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

        Lists the teams who have push access to this branch. The list includes child teams.

        deprecated

        octokit.repos.listProtectedBranchTeamRestrictions() has been renamed to octokit.repos.getTeamsWithAccessToProtectedBranch() (2019-09-09)

          • (params?: RequestOptions & Octokit.ReposListProtectedBranchTeamRestrictionsParams): Promise<Response<Octokit.ReposListProtectedBranchTeamRestrictionsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposListProtectedBranchTeamRestrictionsParams

            Returns Promise<Response<Octokit.ReposListProtectedBranchTeamRestrictionsResponse>>

        • endpoint: Endpoint
      • listProtectedBranchUserRestrictions: { endpoint: Endpoint }

        Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

        Lists the people who have push access to this branch.

        deprecated

        octokit.repos.listProtectedBranchUserRestrictions() has been renamed to octokit.repos.getUsersWithAccessToProtectedBranch() (2019-09-09)

          • (params?: RequestOptions & Octokit.ReposListProtectedBranchUserRestrictionsParams): Promise<Response<Octokit.ReposListProtectedBranchUserRestrictionsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposListProtectedBranchUserRestrictionsParams

            Returns Promise<Response<Octokit.ReposListProtectedBranchUserRestrictionsResponse>>

        • endpoint: Endpoint
      • listPublic: { endpoint: Endpoint }

        Lists all public repositories in the order that they were created.

        Note: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of repositories.

          • (params?: RequestOptions & Octokit.ReposListPublicParams): Promise<Response<Octokit.ReposListPublicResponse>>

          • Parameters

            Returns Promise<Response<Octokit.ReposListPublicResponse>>

        • endpoint: Endpoint
      • listPullRequestsAssociatedWithCommit: { endpoint: Endpoint }

        Lists all pull requests containing the provided commit SHA, which can be from any point in the commit history. The results will include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the List pull requests endpoint.

          • (params?: RequestOptions & Octokit.ReposListPullRequestsAssociatedWithCommitParams): Promise<Response<Octokit.ReposListPullRequestsAssociatedWithCommitResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposListPullRequestsAssociatedWithCommitParams

            Returns Promise<Response<Octokit.ReposListPullRequestsAssociatedWithCommitResponse>>

        • endpoint: Endpoint
      • listReleases: { endpoint: Endpoint }

        This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the Repository Tags API.

        Information about published releases are available to everyone. Only users with push access will receive listings for draft releases.

          • (params?: RequestOptions & Octokit.ReposListReleasesParams): Promise<Response<Octokit.ReposListReleasesResponse>>

          • Parameters

            Returns Promise<Response<Octokit.ReposListReleasesResponse>>

        • endpoint: Endpoint
      • listStatusesForRef: { endpoint: Endpoint }

        Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one.

        This resource is also available via a legacy route: GET /repos/:owner/:repo/statuses/:ref.

          • (params?: RequestOptions & Octokit.ReposListStatusesForRefParams): Promise<Response<Octokit.ReposListStatusesForRefResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposListStatusesForRefParams

            Returns Promise<Response<Octokit.ReposListStatusesForRefResponse>>

        • endpoint: Endpoint
      • listTags: { endpoint: Endpoint }
      • listTeams: { endpoint: Endpoint }

          • Parameters

            Returns Promise<Response<Octokit.ReposListTeamsResponse>>

        • endpoint: Endpoint
      • listTeamsWithAccessToProtectedBranch: { endpoint: Endpoint }

        Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

        Lists the teams who have push access to this branch. The list includes child teams.

        deprecated

        octokit.repos.listTeamsWithAccessToProtectedBranch() has been renamed to octokit.repos.getTeamsWithAccessToProtectedBranch() (2019-09-13)

          • (params?: RequestOptions & Octokit.ReposListTeamsWithAccessToProtectedBranchParams): Promise<Response<Octokit.ReposListTeamsWithAccessToProtectedBranchResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposListTeamsWithAccessToProtectedBranchParams

            Returns Promise<Response<Octokit.ReposListTeamsWithAccessToProtectedBranchResponse>>

        • endpoint: Endpoint
      • listTopics: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ReposListTopicsParams): Promise<Response<Octokit.ReposListTopicsResponse>>

          • Parameters

            Returns Promise<Response<Octokit.ReposListTopicsResponse>>

        • endpoint: Endpoint
      • listUsersWithAccessToProtectedBranch: { endpoint: Endpoint }

        Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

        Lists the people who have push access to this branch.

        deprecated

        octokit.repos.listUsersWithAccessToProtectedBranch() has been renamed to octokit.repos.getUsersWithAccessToProtectedBranch() (2019-09-13)

          • (params?: RequestOptions & Octokit.ReposListUsersWithAccessToProtectedBranchParams): Promise<Response<Octokit.ReposListUsersWithAccessToProtectedBranchResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposListUsersWithAccessToProtectedBranchParams

            Returns Promise<Response<Octokit.ReposListUsersWithAccessToProtectedBranchResponse>>

        • endpoint: Endpoint
      • merge: { endpoint: Endpoint }
      • pingHook: { endpoint: Endpoint }

        This will trigger a ping event to be sent to the hook.

          • (params?: RequestOptions & Octokit.ReposPingHookParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • removeBranchProtection: { endpoint: Endpoint }

        Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

          • (params?: RequestOptions & Octokit.ReposRemoveBranchProtectionParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposRemoveBranchProtectionParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • removeCollaborator: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ReposRemoveCollaboratorParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposRemoveCollaboratorParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • removeDeployKey: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ReposRemoveDeployKeyParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposRemoveDeployKeyParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • removeProtectedBranchAdminEnforcement: { endpoint: Endpoint }

        Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

        Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.

          • (params?: RequestOptions & Octokit.ReposRemoveProtectedBranchAdminEnforcementParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposRemoveProtectedBranchAdminEnforcementParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • removeProtectedBranchAppRestrictions: { endpoint: Endpoint }

        Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

        Removes the ability of an app to push to this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

        Type Description
        array The GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
          • (params?: RequestOptions & Octokit.ReposRemoveProtectedBranchAppRestrictionsParams): Promise<Response<Octokit.ReposRemoveProtectedBranchAppRestrictionsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposRemoveProtectedBranchAppRestrictionsParams

            Returns Promise<Response<Octokit.ReposRemoveProtectedBranchAppRestrictionsResponse>>

        • endpoint: Endpoint
      • removeProtectedBranchPullRequestReviewEnforcement: { endpoint: Endpoint }

        Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

          • (params?: RequestOptions & Octokit.ReposRemoveProtectedBranchPullRequestReviewEnforcementParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposRemoveProtectedBranchPullRequestReviewEnforcementParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • removeProtectedBranchRequiredSignatures: { endpoint: Endpoint }

        Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

        When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.

          • (params?: RequestOptions & Octokit.ReposRemoveProtectedBranchRequiredSignaturesParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposRemoveProtectedBranchRequiredSignaturesParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • removeProtectedBranchRequiredStatusChecks: { endpoint: Endpoint }

        Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

          • (params?: RequestOptions & Octokit.ReposRemoveProtectedBranchRequiredStatusChecksParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposRemoveProtectedBranchRequiredStatusChecksParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • removeProtectedBranchRequiredStatusChecksContexts: { endpoint: Endpoint }

        Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

          • (params?: RequestOptions & Octokit.ReposRemoveProtectedBranchRequiredStatusChecksContextsParams): Promise<Response<Octokit.ReposRemoveProtectedBranchRequiredStatusChecksContextsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposRemoveProtectedBranchRequiredStatusChecksContextsParams

            Returns Promise<Response<Octokit.ReposRemoveProtectedBranchRequiredStatusChecksContextsResponse>>

        • endpoint: Endpoint
      • removeProtectedBranchRestrictions: { endpoint: Endpoint }

        Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

        Disables the ability to restrict who can push to this branch.

          • (params?: RequestOptions & Octokit.ReposRemoveProtectedBranchRestrictionsParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposRemoveProtectedBranchRestrictionsParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • removeProtectedBranchTeamRestrictions: { endpoint: Endpoint }

        Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

        Removes the ability of a team to push to this branch. You can also remove push access for child teams.

        Type Description
        array Teams that should no longer have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
          • (params?: RequestOptions & Octokit.ReposRemoveProtectedBranchTeamRestrictionsParams): Promise<Response<Octokit.ReposRemoveProtectedBranchTeamRestrictionsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposRemoveProtectedBranchTeamRestrictionsParams

            Returns Promise<Response<Octokit.ReposRemoveProtectedBranchTeamRestrictionsResponse>>

        • endpoint: Endpoint
      • removeProtectedBranchUserRestrictions: { endpoint: Endpoint }

        Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

        Removes the ability of a user to push to this branch.

        Type Description
        array Usernames of the people who should no longer have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
          • (params?: RequestOptions & Octokit.ReposRemoveProtectedBranchUserRestrictionsParams): Promise<Response<Octokit.ReposRemoveProtectedBranchUserRestrictionsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposRemoveProtectedBranchUserRestrictionsParams

            Returns Promise<Response<Octokit.ReposRemoveProtectedBranchUserRestrictionsResponse>>

        • endpoint: Endpoint
      • replaceProtectedBranchAppRestrictions: { endpoint: Endpoint }

        Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

        Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

        Type Description
        array The GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
          • (params?: RequestOptions & Octokit.ReposReplaceProtectedBranchAppRestrictionsParams): Promise<Response<Octokit.ReposReplaceProtectedBranchAppRestrictionsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposReplaceProtectedBranchAppRestrictionsParams

            Returns Promise<Response<Octokit.ReposReplaceProtectedBranchAppRestrictionsResponse>>

        • endpoint: Endpoint
      • replaceProtectedBranchRequiredStatusChecksContexts: { endpoint: Endpoint }

        Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

          • (params?: RequestOptions & Octokit.ReposReplaceProtectedBranchRequiredStatusChecksContextsParams): Promise<Response<Octokit.ReposReplaceProtectedBranchRequiredStatusChecksContextsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposReplaceProtectedBranchRequiredStatusChecksContextsParams

            Returns Promise<Response<Octokit.ReposReplaceProtectedBranchRequiredStatusChecksContextsResponse>>

        • endpoint: Endpoint
      • replaceProtectedBranchTeamRestrictions: { endpoint: Endpoint }

        Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

        Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.

        Type Description
        array The teams that can have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
          • (params?: RequestOptions & Octokit.ReposReplaceProtectedBranchTeamRestrictionsParams): Promise<Response<Octokit.ReposReplaceProtectedBranchTeamRestrictionsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposReplaceProtectedBranchTeamRestrictionsParams

            Returns Promise<Response<Octokit.ReposReplaceProtectedBranchTeamRestrictionsResponse>>

        • endpoint: Endpoint
      • replaceProtectedBranchUserRestrictions: { endpoint: Endpoint }

        Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

        Replaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.

        Type Description
        array Usernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
          • (params?: RequestOptions & Octokit.ReposReplaceProtectedBranchUserRestrictionsParams): Promise<Response<Octokit.ReposReplaceProtectedBranchUserRestrictionsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposReplaceProtectedBranchUserRestrictionsParams

            Returns Promise<Response<Octokit.ReposReplaceProtectedBranchUserRestrictionsResponse>>

        • endpoint: Endpoint
      • replaceTopics: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ReposReplaceTopicsParams): Promise<Response<Octokit.ReposReplaceTopicsResponse>>

          • Parameters

            Returns Promise<Response<Octokit.ReposReplaceTopicsResponse>>

        • endpoint: Endpoint
      • requestPageBuild: { endpoint: Endpoint }

        You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.

        Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.

          • (params?: RequestOptions & Octokit.ReposRequestPageBuildParams): Promise<Response<Octokit.ReposRequestPageBuildResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposRequestPageBuildParams

            Returns Promise<Response<Octokit.ReposRequestPageBuildResponse>>

        • endpoint: Endpoint
      • retrieveCommunityProfileMetrics: { endpoint: Endpoint }

        This endpoint will return all community profile metrics, including an overall health score, repository description, the presence of documentation, detected code of conduct, detected license, and the presence of ISSUE_TEMPLATE, PULL_REQUEST_TEMPLATE, README, and CONTRIBUTING files.

          • (params?: RequestOptions & Octokit.ReposRetrieveCommunityProfileMetricsParams): Promise<Response<Octokit.ReposRetrieveCommunityProfileMetricsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposRetrieveCommunityProfileMetricsParams

            Returns Promise<Response<Octokit.ReposRetrieveCommunityProfileMetricsResponse>>

        • endpoint: Endpoint
      • testPushHook: { endpoint: Endpoint }

        This will trigger the hook with the latest push to the current repository if the hook is subscribed to push events. If the hook is not subscribed to push events, the server will respond with 204 but no test POST will be generated.

        Note: Previously /repos/:owner/:repo/hooks/:hook_id/test

          • (params?: RequestOptions & Octokit.ReposTestPushHookParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • transfer: { endpoint: Endpoint }

        A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original owner, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see about repository transfers.

      • update: { endpoint: Endpoint }

        Note: To edit a repository's topics, use the topics endpoint.

      • updateBranchProtection: { endpoint: Endpoint }

        Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

        Protecting a branch requires admin or owner permissions to the repository.

        Note: Passing new arrays of users and teams replaces their previous values.

        Note: The list of users, apps, and teams in total is limited to 100 items.

          • (params?: RequestOptions & Octokit.ReposUpdateBranchProtectionParams): Promise<Response<Octokit.ReposUpdateBranchProtectionResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposUpdateBranchProtectionParams

            Returns Promise<Response<Octokit.ReposUpdateBranchProtectionResponse>>

        • endpoint: Endpoint
      • updateCommitComment: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ReposUpdateCommitCommentParams): Promise<Response<Octokit.ReposUpdateCommitCommentResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposUpdateCommitCommentParams

            Returns Promise<Response<Octokit.ReposUpdateCommitCommentResponse>>

        • endpoint: Endpoint
      • updateFile: { endpoint: Endpoint }

        Creates a new file or updates an existing file in a repository.

        deprecated

        octokit.repos.updateFile() has been renamed to octokit.repos.createOrUpdateFile() (2019-06-07)

          • (params?: RequestOptions & Octokit.ReposUpdateFileParams): Promise<Response<Octokit.ReposUpdateFileResponse>>

          • Parameters

            Returns Promise<Response<Octokit.ReposUpdateFileResponse>>

        • endpoint: Endpoint
      • updateHook: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ReposUpdateHookParams): Promise<Response<Octokit.ReposUpdateHookResponse>>

          • Parameters

            Returns Promise<Response<Octokit.ReposUpdateHookResponse>>

        • endpoint: Endpoint
      • updateInformationAboutPagesSite: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ReposUpdateInformationAboutPagesSiteParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposUpdateInformationAboutPagesSiteParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • updateInvitation: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.ReposUpdateInvitationParams): Promise<Response<Octokit.ReposUpdateInvitationResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposUpdateInvitationParams

            Returns Promise<Response<Octokit.ReposUpdateInvitationResponse>>

        • endpoint: Endpoint
      • updateProtectedBranchPullRequestReviewEnforcement: { endpoint: Endpoint }

        Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

        Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.

        Note: Passing new arrays of users and teams replaces their previous values.

          • (params?: RequestOptions & Octokit.ReposUpdateProtectedBranchPullRequestReviewEnforcementParams): Promise<Response<Octokit.ReposUpdateProtectedBranchPullRequestReviewEnforcementResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposUpdateProtectedBranchPullRequestReviewEnforcementParams

            Returns Promise<Response<Octokit.ReposUpdateProtectedBranchPullRequestReviewEnforcementResponse>>

        • endpoint: Endpoint
      • updateProtectedBranchRequiredStatusChecks: { endpoint: Endpoint }

        Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

        Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.

          • (params?: RequestOptions & Octokit.ReposUpdateProtectedBranchRequiredStatusChecksParams): Promise<Response<Octokit.ReposUpdateProtectedBranchRequiredStatusChecksResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposUpdateProtectedBranchRequiredStatusChecksParams

            Returns Promise<Response<Octokit.ReposUpdateProtectedBranchRequiredStatusChecksResponse>>

        • endpoint: Endpoint
      • updateRelease: { endpoint: Endpoint }

        Users with push access to the repository can edit a release.

          • (params?: RequestOptions & Octokit.ReposUpdateReleaseParams): Promise<Response<Octokit.ReposUpdateReleaseResponse>>

          • Parameters

            Returns Promise<Response<Octokit.ReposUpdateReleaseResponse>>

        • endpoint: Endpoint
      • updateReleaseAsset: { endpoint: Endpoint }

        Users with push access to the repository can edit a release asset.

          • (params?: RequestOptions & Octokit.ReposUpdateReleaseAssetParams): Promise<Response<Octokit.ReposUpdateReleaseAssetResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposUpdateReleaseAssetParams

            Returns Promise<Response<Octokit.ReposUpdateReleaseAssetResponse>>

        • endpoint: Endpoint
      • uploadReleaseAsset: { endpoint: Endpoint }

        This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in the response of the Create a release endpoint to upload a release asset.

        You need to use an HTTP client which supports SNI to make calls to this endpoint.

        Most libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:

        application/zip

        GitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example, you'll still need to pass your authentication to be able to upload an asset.

          • (params?: RequestOptions & Octokit.ReposUploadReleaseAssetParamsDeprecatedFile): Promise<Response<Octokit.ReposUploadReleaseAssetResponse>>
          • (params?: RequestOptions & Octokit.ReposUploadReleaseAssetParams): Promise<Response<Octokit.ReposUploadReleaseAssetResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposUploadReleaseAssetParamsDeprecatedFile

            Returns Promise<Response<Octokit.ReposUploadReleaseAssetResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.ReposUploadReleaseAssetParams

            Returns Promise<Response<Octokit.ReposUploadReleaseAssetResponse>>

        • endpoint: Endpoint

      request

      request: Request

      search

      search: { code: { endpoint: Endpoint }; commits: { endpoint: Endpoint }; emailLegacy: { endpoint: Endpoint }; issues: { endpoint: Endpoint }; issuesAndPullRequests: { endpoint: Endpoint }; issuesLegacy: { endpoint: Endpoint }; labels: { endpoint: Endpoint }; repos: { endpoint: Endpoint }; reposLegacy: { endpoint: Endpoint }; topics: { endpoint: Endpoint }; users: { endpoint: Endpoint }; usersLegacy: { endpoint: Endpoint } }

      Type declaration

      • code: { endpoint: Endpoint }

        Find file contents via various criteria. This method returns up to 100 results per page.

        When searching for code, you can get text match metadata for the file content and file path fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

        Note: You must authenticate to search for code across all public repositories.

        Considerations for code search

        Due to the complexity of searching code, there are a few restrictions on how searches are performed:

        • Only the default branch is considered. In most cases, this will be the master branch.
        • Only files smaller than 384 KB are searchable.
        • You must always include at least one search term when searching source code. For example, searching for language:go is not valid, while amazing language:go is.

        Suppose you want to find the definition of the addClass function inside jQuery. Your query would look something like this:

        Here, we're searching for the keyword addClass within a file's contents. We're making sure that we're only looking in files where the language is JavaScript. And we're scoping the search to the repo:jquery/jquery repository.

      • commits: { endpoint: Endpoint }

        Find commits via various criteria. This method returns up to 100 results per page.

        When searching for commits, you can get text match metadata for the message field when you provide the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

        Considerations for commit search

        Only the default branch is considered. In most cases, this will be the master branch.

        Suppose you want to find commits related to CSS in the octocat/Spoon-Knife repository. Your query would look something like this:

      • emailLegacy: { endpoint: Endpoint }

        This API call is added for compatibility reasons only. There's no guarantee that full email searches will always be available. The @ character in the address must be left unencoded. Searches only against public email addresses (as configured on the user's GitHub profile).

        deprecated

        octokit.search.emailLegacy() is deprecated, see https://developer.github.com/v3/search/legacy/#email-search

          • (params?: RequestOptions & Octokit.SearchEmailLegacyParams): Promise<Response<Octokit.SearchEmailLegacyResponse>>

          • Parameters

            Returns Promise<Response<Octokit.SearchEmailLegacyResponse>>

        • endpoint: Endpoint
      • issues: { endpoint: Endpoint }

        Find issues by state and keyword. This method returns up to 100 results per page.

        When searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

        Let's say you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.

        In this query, we're searching for the keyword windows, within any open issue that's labeled as bug. The search runs across repositories whose primary language is Python. We’re sorting by creation date in ascending order, so that the oldest issues appear first in the search results.

        deprecated

        octokit.search.issues() has been renamed to octokit.search.issuesAndPullRequests() (2018-12-27)

      • issuesAndPullRequests: { endpoint: Endpoint }

        Find issues by state and keyword. This method returns up to 100 results per page.

        When searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

        Let's say you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.

        In this query, we're searching for the keyword windows, within any open issue that's labeled as bug. The search runs across repositories whose primary language is Python. We’re sorting by creation date in ascending order, so that the oldest issues appear first in the search results.

          • (params?: RequestOptions & Octokit.SearchIssuesAndPullRequestsParams): Promise<Response<Octokit.SearchIssuesAndPullRequestsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.SearchIssuesAndPullRequestsParams

            Returns Promise<Response<Octokit.SearchIssuesAndPullRequestsResponse>>

        • endpoint: Endpoint
      • issuesLegacy: { endpoint: Endpoint }

        Find issues by state and keyword.

        deprecated

        octokit.search.issuesLegacy() is deprecated, see https://developer.github.com/v3/search/legacy/#search-issues

          • (params?: RequestOptions & Octokit.SearchIssuesLegacyParams): Promise<Response<Octokit.SearchIssuesLegacyResponse>>

          • Parameters

            Returns Promise<Response<Octokit.SearchIssuesLegacyResponse>>

        • endpoint: Endpoint
      • labels: { endpoint: Endpoint }

        Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results per page.

        When searching for labels, you can get text match metadata for the label name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

        Suppose you want to find labels in the linguist repository that match bug, defect, or enhancement. Your query might look like this:

        The labels that best match for the query appear first in the search results.

      • repos: { endpoint: Endpoint }

        Find repositories via various criteria. This method returns up to 100 results per page.

        When searching for repositories, you can get text match metadata for the name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

        Suppose you want to search for popular Tetris repositories written in Assembly. Your query might look like this.

        You can search for multiple topics by adding more topic: instances, and including the mercy-preview header. For example:

        In this request, we're searching for repositories with the word tetris in the name, the description, or the README. We're limiting the results to only find repositories where the primary language is Assembly. We're sorting by stars in descending order, so that the most popular repositories appear first in the search results.

      • reposLegacy: { endpoint: Endpoint }

        Find repositories by keyword. Note, this legacy method does not follow the v3 pagination pattern. This method returns up to 100 results per page and pages can be fetched using the start_page parameter.

        deprecated

        octokit.search.reposLegacy() is deprecated, see https://developer.github.com/v3/search/legacy/#search-repositories

          • (params?: RequestOptions & Octokit.SearchReposLegacyParams): Promise<Response<Octokit.SearchReposLegacyResponse>>

          • Parameters

            Returns Promise<Response<Octokit.SearchReposLegacyResponse>>

        • endpoint: Endpoint
      • topics: { endpoint: Endpoint }

        Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results per page.

        When searching for topics, you can get text match metadata for the topic's short_description, description, name, or display_name field when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

        See "Searching topics" for a detailed list of qualifiers.

        Suppose you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:

        In this request, we're searching for topics with the keyword ruby, and we're limiting the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.

        Note: A search for featured Ruby topics only has 6 total results, so a Link header indicating pagination is not included in the response.

      • users: { endpoint: Endpoint }

        Find users via various criteria. This method returns up to 100 results per page.

        When searching for users, you can get text match metadata for the issue login, email, and name fields when you pass the text-match media type. For more details about highlighting search results, see Text match metadata. For more details about how to receive highlighted search results, see Text match metadata.

        Imagine you're looking for a list of popular users. You might try out this query:

        Here, we're looking at users with the name Tom. We're only interested in those with more than 42 repositories, and only if they have over 1,000 followers.

      • usersLegacy: { endpoint: Endpoint }

        Find users by keyword.

        deprecated

        octokit.search.usersLegacy() is deprecated, see https://developer.github.com/v3/search/legacy/#search-users

          • (params?: RequestOptions & Octokit.SearchUsersLegacyParams): Promise<Response<Octokit.SearchUsersLegacyResponse>>

          • Parameters

            Returns Promise<Response<Octokit.SearchUsersLegacyResponse>>

        • endpoint: Endpoint

      teams

      teams: { addMember: { endpoint: Endpoint }; addMemberLegacy: { endpoint: Endpoint }; addOrUpdateMembership: { endpoint: Endpoint }; addOrUpdateMembershipInOrg: { endpoint: Endpoint }; addOrUpdateMembershipLegacy: { endpoint: Endpoint }; addOrUpdateProject: { endpoint: Endpoint }; addOrUpdateProjectInOrg: { endpoint: Endpoint }; addOrUpdateProjectLegacy: { endpoint: Endpoint }; addOrUpdateRepo: { endpoint: Endpoint }; addOrUpdateRepoInOrg: { endpoint: Endpoint }; addOrUpdateRepoLegacy: { endpoint: Endpoint }; checkManagesRepo: { endpoint: Endpoint }; checkManagesRepoInOrg: { endpoint: Endpoint }; checkManagesRepoLegacy: { endpoint: Endpoint }; create: { endpoint: Endpoint }; createDiscussion: { endpoint: Endpoint }; createDiscussionComment: { endpoint: Endpoint }; createDiscussionCommentInOrg: { endpoint: Endpoint }; createDiscussionCommentLegacy: { endpoint: Endpoint }; createDiscussionInOrg: { endpoint: Endpoint }; createDiscussionLegacy: { endpoint: Endpoint }; delete: { endpoint: Endpoint }; deleteDiscussion: { endpoint: Endpoint }; deleteDiscussionComment: { endpoint: Endpoint }; deleteDiscussionCommentInOrg: { endpoint: Endpoint }; deleteDiscussionCommentLegacy: { endpoint: Endpoint }; deleteDiscussionInOrg: { endpoint: Endpoint }; deleteDiscussionLegacy: { endpoint: Endpoint }; deleteInOrg: { endpoint: Endpoint }; deleteLegacy: { endpoint: Endpoint }; get: { endpoint: Endpoint }; getByName: { endpoint: Endpoint }; getDiscussion: { endpoint: Endpoint }; getDiscussionComment: { endpoint: Endpoint }; getDiscussionCommentInOrg: { endpoint: Endpoint }; getDiscussionCommentLegacy: { endpoint: Endpoint }; getDiscussionInOrg: { endpoint: Endpoint }; getDiscussionLegacy: { endpoint: Endpoint }; getLegacy: { endpoint: Endpoint }; getMember: { endpoint: Endpoint }; getMemberLegacy: { endpoint: Endpoint }; getMembership: { endpoint: Endpoint }; getMembershipInOrg: { endpoint: Endpoint }; getMembershipLegacy: { endpoint: Endpoint }; list: { endpoint: Endpoint }; listChild: { endpoint: Endpoint }; listChildInOrg: { endpoint: Endpoint }; listChildLegacy: { endpoint: Endpoint }; listDiscussionComments: { endpoint: Endpoint }; listDiscussionCommentsInOrg: { endpoint: Endpoint }; listDiscussionCommentsLegacy: { endpoint: Endpoint }; listDiscussions: { endpoint: Endpoint }; listDiscussionsInOrg: { endpoint: Endpoint }; listDiscussionsLegacy: { endpoint: Endpoint }; listForAuthenticatedUser: { endpoint: Endpoint }; listMembers: { endpoint: Endpoint }; listMembersInOrg: { endpoint: Endpoint }; listMembersLegacy: { endpoint: Endpoint }; listPendingInvitations: { endpoint: Endpoint }; listPendingInvitationsInOrg: { endpoint: Endpoint }; listPendingInvitationsLegacy: { endpoint: Endpoint }; listProjects: { endpoint: Endpoint }; listProjectsInOrg: { endpoint: Endpoint }; listProjectsLegacy: { endpoint: Endpoint }; listRepos: { endpoint: Endpoint }; listReposInOrg: { endpoint: Endpoint }; listReposLegacy: { endpoint: Endpoint }; removeMember: { endpoint: Endpoint }; removeMemberLegacy: { endpoint: Endpoint }; removeMembership: { endpoint: Endpoint }; removeMembershipInOrg: { endpoint: Endpoint }; removeMembershipLegacy: { endpoint: Endpoint }; removeProject: { endpoint: Endpoint }; removeProjectInOrg: { endpoint: Endpoint }; removeProjectLegacy: { endpoint: Endpoint }; removeRepo: { endpoint: Endpoint }; removeRepoInOrg: { endpoint: Endpoint }; removeRepoLegacy: { endpoint: Endpoint }; reviewProject: { endpoint: Endpoint }; reviewProjectInOrg: { endpoint: Endpoint }; reviewProjectLegacy: { endpoint: Endpoint }; update: { endpoint: Endpoint }; updateDiscussion: { endpoint: Endpoint }; updateDiscussionComment: { endpoint: Endpoint }; updateDiscussionCommentInOrg: { endpoint: Endpoint }; updateDiscussionCommentLegacy: { endpoint: Endpoint }; updateDiscussionInOrg: { endpoint: Endpoint }; updateDiscussionLegacy: { endpoint: Endpoint }; updateInOrg: { endpoint: Endpoint }; updateLegacy: { endpoint: Endpoint } }

      Type declaration

      • addMember: { endpoint: Endpoint }

        The "Add team member" endpoint (described below) is deprecated.

        We recommend using the Add team membership endpoint instead. It allows you to invite new organization members to your teams.

        Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

        To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.

        Note: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "Synchronizing teams between your identity provider and GitHub."

        Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."

        deprecated

        octokit.teams.addMember() is deprecated, see https://developer.github.com/v3/teams/members/#add-team-member-legacy

          • Parameters

            Returns Promise<Response<Octokit.TeamsAddMemberResponse>>

        • endpoint: Endpoint
      • addMemberLegacy: { endpoint: Endpoint }

        The "Add team member" endpoint (described below) is deprecated.

        We recommend using the Add team membership endpoint instead. It allows you to invite new organization members to your teams.

        Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

        To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.

        Note: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "Synchronizing teams between your identity provider and GitHub."

        Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."

        deprecated

        octokit.teams.addMemberLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#add-team-member-legacy

          • (params?: RequestOptions & Octokit.TeamsAddMemberLegacyParams): Promise<Response<Octokit.TeamsAddMemberLegacyResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsAddMemberLegacyParams

            Returns Promise<Response<Octokit.TeamsAddMemberLegacyResponse>>

        • endpoint: Endpoint
      • addOrUpdateMembership: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team membership endpoint.

        Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

        If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.

        Note: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "Synchronizing teams between your identity provider and GitHub."

        If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.

        If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.

        deprecated

        octokit.teams.addOrUpdateMembership() is deprecated, see https://developer.github.com/v3/teams/members/#add-or-update-team-membership-legacy

          • (params?: RequestOptions & Octokit.TeamsAddOrUpdateMembershipParams): Promise<Response<Octokit.TeamsAddOrUpdateMembershipResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsAddOrUpdateMembershipParams

            Returns Promise<Response<Octokit.TeamsAddOrUpdateMembershipResponse>>

        • endpoint: Endpoint
      • addOrUpdateMembershipInOrg: { endpoint: Endpoint }

        Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

        Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.

        Note: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "Synchronizing teams between your identity provider and GitHub."

        An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team.

        If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.

        Note: You can also specify a team by org_id and team_id using the route PUT /organizations/:org_id/team/:team_id/memberships/:username.

          • (params?: RequestOptions & Octokit.TeamsAddOrUpdateMembershipInOrgParams): Promise<Response<Octokit.TeamsAddOrUpdateMembershipInOrgResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsAddOrUpdateMembershipInOrgParams

            Returns Promise<Response<Octokit.TeamsAddOrUpdateMembershipInOrgResponse>>

        • endpoint: Endpoint
      • addOrUpdateMembershipLegacy: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team membership endpoint.

        Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

        If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.

        Note: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "Synchronizing teams between your identity provider and GitHub."

        If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.

        If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.

        deprecated

        octokit.teams.addOrUpdateMembershipLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#add-or-update-team-membership-legacy

          • (params?: RequestOptions & Octokit.TeamsAddOrUpdateMembershipLegacyParams): Promise<Response<Octokit.TeamsAddOrUpdateMembershipLegacyResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsAddOrUpdateMembershipLegacyParams

            Returns Promise<Response<Octokit.TeamsAddOrUpdateMembershipLegacyResponse>>

        • endpoint: Endpoint
      • addOrUpdateProject: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team project endpoint.

        Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have admin permissions for the project. The project and team must be part of the same organization.

        deprecated

        octokit.teams.addOrUpdateProject() is deprecated, see https://developer.github.com/v3/teams/#add-or-update-team-project-legacy

          • (params?: RequestOptions & Octokit.TeamsAddOrUpdateProjectParams): Promise<Response<Octokit.TeamsAddOrUpdateProjectResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsAddOrUpdateProjectParams

            Returns Promise<Response<Octokit.TeamsAddOrUpdateProjectResponse>>

        • endpoint: Endpoint
      • addOrUpdateProjectInOrg: { endpoint: Endpoint }

        Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have admin permissions for the project. The project and team must be part of the same organization.

        Note: You can also specify a team by org_id and team_id using the route PUT /organizations/:org_id/team/:team_id/projects/:project_id.

          • (params?: RequestOptions & Octokit.TeamsAddOrUpdateProjectInOrgParams): Promise<Response<Octokit.TeamsAddOrUpdateProjectInOrgResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsAddOrUpdateProjectInOrgParams

            Returns Promise<Response<Octokit.TeamsAddOrUpdateProjectInOrgResponse>>

        • endpoint: Endpoint
      • addOrUpdateProjectLegacy: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team project endpoint.

        Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have admin permissions for the project. The project and team must be part of the same organization.

        deprecated

        octokit.teams.addOrUpdateProjectLegacy() is deprecated, see https://developer.github.com/v3/teams/#add-or-update-team-project-legacy

          • (params?: RequestOptions & Octokit.TeamsAddOrUpdateProjectLegacyParams): Promise<Response<Octokit.TeamsAddOrUpdateProjectLegacyResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsAddOrUpdateProjectLegacyParams

            Returns Promise<Response<Octokit.TeamsAddOrUpdateProjectLegacyResponse>>

        • endpoint: Endpoint
      • addOrUpdateRepo: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team repository endpoint.

        To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization.

        Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."

        deprecated

        octokit.teams.addOrUpdateRepo() is deprecated, see https://developer.github.com/v3/teams/#add-or-update-team-repository-legacy

          • (params?: RequestOptions & Octokit.TeamsAddOrUpdateRepoParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsAddOrUpdateRepoParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • addOrUpdateRepoInOrg: { endpoint: Endpoint }

        To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."

        Note: You can also specify a team by org_id and team_id using the route PUT /organizations/:org_id/team/:team_id/repos/:owner/:repo.

          • (params?: RequestOptions & Octokit.TeamsAddOrUpdateRepoInOrgParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsAddOrUpdateRepoInOrgParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • addOrUpdateRepoLegacy: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team repository endpoint.

        To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization.

        Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."

        deprecated

        octokit.teams.addOrUpdateRepoLegacy() is deprecated, see https://developer.github.com/v3/teams/#add-or-update-team-repository-legacy

          • (params?: RequestOptions & Octokit.TeamsAddOrUpdateRepoLegacyParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsAddOrUpdateRepoLegacyParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • checkManagesRepo: { endpoint: Endpoint }

        Note: Repositories inherited through a parent team will also be checked.

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Check if a team manages a repository endpoint.

        You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the Accept header:

        deprecated

        octokit.teams.checkManagesRepo() is deprecated, see https://developer.github.com/v3/teams/#check-if-a-team-manages-a-repository-legacy

          • (params?: RequestOptions & Octokit.TeamsCheckManagesRepoParams): Promise<Response<Octokit.TeamsCheckManagesRepoResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsCheckManagesRepoParams

            Returns Promise<Response<Octokit.TeamsCheckManagesRepoResponse>>

        • endpoint: Endpoint
      • checkManagesRepoInOrg: { endpoint: Endpoint }

        Checks whether a team has admin, push, or pull permission for a repository. Repositories inherited through a parent team will also be checked.

        Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/repos/:owner/:repo.

        You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the Accept header:

          • (params?: RequestOptions & Octokit.TeamsCheckManagesRepoInOrgParams): Promise<Response<Octokit.TeamsCheckManagesRepoInOrgResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsCheckManagesRepoInOrgParams

            Returns Promise<Response<Octokit.TeamsCheckManagesRepoInOrgResponse>>

        • endpoint: Endpoint
      • checkManagesRepoLegacy: { endpoint: Endpoint }

        Note: Repositories inherited through a parent team will also be checked.

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Check if a team manages a repository endpoint.

        You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the Accept header:

        deprecated

        octokit.teams.checkManagesRepoLegacy() is deprecated, see https://developer.github.com/v3/teams/#check-if-a-team-manages-a-repository-legacy

          • (params?: RequestOptions & Octokit.TeamsCheckManagesRepoLegacyParams): Promise<Response<Octokit.TeamsCheckManagesRepoLegacyResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsCheckManagesRepoLegacyParams

            Returns Promise<Response<Octokit.TeamsCheckManagesRepoLegacyResponse>>

        • endpoint: Endpoint
      • create: { endpoint: Endpoint }

        To create a team, the authenticated user must be a member or owner of :org. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "Setting team creation permissions."

        When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of maintainers. For more information, see "About teams" in the GitHub Help documentation.

          • (params?: RequestOptions & Octokit.TeamsCreateParamsDeprecatedPermission): Promise<Response<Octokit.TeamsCreateResponse>>
          • (params?: RequestOptions & Octokit.TeamsCreateParams): Promise<Response<Octokit.TeamsCreateResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsCreateParamsDeprecatedPermission

            Returns Promise<Response<Octokit.TeamsCreateResponse>>

          • Parameters

            Returns Promise<Response<Octokit.TeamsCreateResponse>>

        • endpoint: Endpoint
      • createDiscussion: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion endpoint.

        Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.

        This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

        deprecated

        octokit.teams.createDiscussion() is deprecated, see https://developer.github.com/v3/teams/discussions/#create-a-discussion-legacy

          • (params?: RequestOptions & Octokit.TeamsCreateDiscussionParams): Promise<Response<Octokit.TeamsCreateDiscussionResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsCreateDiscussionParams

            Returns Promise<Response<Octokit.TeamsCreateDiscussionResponse>>

        • endpoint: Endpoint
      • createDiscussionComment: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a comment endpoint.

        Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.

        This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

        deprecated

        octokit.teams.createDiscussionComment() is deprecated, see https://developer.github.com/v3/teams/discussion_comments/#create-a-comment-legacy

          • (params?: RequestOptions & Octokit.TeamsCreateDiscussionCommentParams): Promise<Response<Octokit.TeamsCreateDiscussionCommentResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsCreateDiscussionCommentParams

            Returns Promise<Response<Octokit.TeamsCreateDiscussionCommentResponse>>

        • endpoint: Endpoint
      • createDiscussionCommentInOrg: { endpoint: Endpoint }

        Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.

        This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

        Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments.

          • (params?: RequestOptions & Octokit.TeamsCreateDiscussionCommentInOrgParams): Promise<Response<Octokit.TeamsCreateDiscussionCommentInOrgResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsCreateDiscussionCommentInOrgParams

            Returns Promise<Response<Octokit.TeamsCreateDiscussionCommentInOrgResponse>>

        • endpoint: Endpoint
      • createDiscussionCommentLegacy: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a comment endpoint.

        Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.

        This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

        deprecated

        octokit.teams.createDiscussionCommentLegacy() is deprecated, see https://developer.github.com/v3/teams/discussion_comments/#create-a-comment-legacy

          • (params?: RequestOptions & Octokit.TeamsCreateDiscussionCommentLegacyParams): Promise<Response<Octokit.TeamsCreateDiscussionCommentLegacyResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsCreateDiscussionCommentLegacyParams

            Returns Promise<Response<Octokit.TeamsCreateDiscussionCommentLegacyResponse>>

        • endpoint: Endpoint
      • createDiscussionInOrg: { endpoint: Endpoint }

        Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.

        This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

        Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions.

          • (params?: RequestOptions & Octokit.TeamsCreateDiscussionInOrgParams): Promise<Response<Octokit.TeamsCreateDiscussionInOrgResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsCreateDiscussionInOrgParams

            Returns Promise<Response<Octokit.TeamsCreateDiscussionInOrgResponse>>

        • endpoint: Endpoint
      • createDiscussionLegacy: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion endpoint.

        Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.

        This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

        deprecated

        octokit.teams.createDiscussionLegacy() is deprecated, see https://developer.github.com/v3/teams/discussions/#create-a-discussion-legacy

          • (params?: RequestOptions & Octokit.TeamsCreateDiscussionLegacyParams): Promise<Response<Octokit.TeamsCreateDiscussionLegacyResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsCreateDiscussionLegacyParams

            Returns Promise<Response<Octokit.TeamsCreateDiscussionLegacyResponse>>

        • endpoint: Endpoint
      • delete: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete team endpoint.

        To delete a team, the authenticated user must be an organization owner or team maintainer.

        If you are an organization owner, deleting a parent team will delete all of its child teams as well.

        deprecated

        octokit.teams.delete() is deprecated, see https://developer.github.com/v3/teams/#delete-team-legacy

          • (params?: RequestOptions & Octokit.TeamsDeleteParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • deleteDiscussion: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion endpoint.

        Delete a discussion from a team's page. OAuth access tokens require the write:discussion scope.

        deprecated

        octokit.teams.deleteDiscussion() is deprecated, see https://developer.github.com/v3/teams/discussions/#delete-a-discussion-legacy

          • (params?: RequestOptions & Octokit.TeamsDeleteDiscussionParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsDeleteDiscussionParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • deleteDiscussionComment: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a comment endpoint.

        Deletes a comment on a team discussion. OAuth access tokens require the write:discussion scope.

        deprecated

        octokit.teams.deleteDiscussionComment() is deprecated, see https://developer.github.com/v3/teams/discussion_comments/#delete-a-comment-legacy

          • (params?: RequestOptions & Octokit.TeamsDeleteDiscussionCommentParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsDeleteDiscussionCommentParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • deleteDiscussionCommentInOrg: { endpoint: Endpoint }

        Deletes a comment on a team discussion. OAuth access tokens require the write:discussion scope.

        Note: You can also specify a team by org_id and team_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number.

          • (params?: RequestOptions & Octokit.TeamsDeleteDiscussionCommentInOrgParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsDeleteDiscussionCommentInOrgParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • deleteDiscussionCommentLegacy: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a comment endpoint.

        Deletes a comment on a team discussion. OAuth access tokens require the write:discussion scope.

        deprecated

        octokit.teams.deleteDiscussionCommentLegacy() is deprecated, see https://developer.github.com/v3/teams/discussion_comments/#delete-a-comment-legacy

          • (params?: RequestOptions & Octokit.TeamsDeleteDiscussionCommentLegacyParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsDeleteDiscussionCommentLegacyParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • deleteDiscussionInOrg: { endpoint: Endpoint }

        Delete a discussion from a team's page. OAuth access tokens require the write:discussion scope.

        Note: You can also specify a team by org_id and team_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number.

          • (params?: RequestOptions & Octokit.TeamsDeleteDiscussionInOrgParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsDeleteDiscussionInOrgParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • deleteDiscussionLegacy: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion endpoint.

        Delete a discussion from a team's page. OAuth access tokens require the write:discussion scope.

        deprecated

        octokit.teams.deleteDiscussionLegacy() is deprecated, see https://developer.github.com/v3/teams/discussions/#delete-a-discussion-legacy

          • (params?: RequestOptions & Octokit.TeamsDeleteDiscussionLegacyParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsDeleteDiscussionLegacyParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • deleteInOrg: { endpoint: Endpoint }

        To delete a team, the authenticated user must be an organization owner or team maintainer.

        Note: You can also specify a team by org_id and team_id using the route DELETE /organizations/:org_id/team/:team_id.

        If you are an organization owner, deleting a parent team will delete all of its child teams as well.

          • (params?: RequestOptions & Octokit.TeamsDeleteInOrgParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • deleteLegacy: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete team endpoint.

        To delete a team, the authenticated user must be an organization owner or team maintainer.

        If you are an organization owner, deleting a parent team will delete all of its child teams as well.

        deprecated

        octokit.teams.deleteLegacy() is deprecated, see https://developer.github.com/v3/teams/#delete-team-legacy

          • (params?: RequestOptions & Octokit.TeamsDeleteLegacyParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • get: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the Get team by name endpoint.

        deprecated

        octokit.teams.get() is deprecated, see https://developer.github.com/v3/teams/#get-team-legacy

      • getByName: { endpoint: Endpoint }

        Gets a team using the team's slug. GitHub generates the slug from the team name.

        Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id.

          • Parameters

            Returns Promise<Response<Octokit.TeamsGetByNameResponse>>

        • endpoint: Endpoint
      • getDiscussion: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a single discussion endpoint.

        Get a specific discussion on a team's page. OAuth access tokens require the read:discussion scope.

        deprecated

        octokit.teams.getDiscussion() is deprecated, see https://developer.github.com/v3/teams/discussions/#get-a-single-discussion-legacy

          • (params?: RequestOptions & Octokit.TeamsGetDiscussionParams): Promise<Response<Octokit.TeamsGetDiscussionResponse>>

          • Parameters

            Returns Promise<Response<Octokit.TeamsGetDiscussionResponse>>

        • endpoint: Endpoint
      • getDiscussionComment: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a single comment endpoint.

        Get a specific comment on a team discussion. OAuth access tokens require the read:discussion scope.

        deprecated

        octokit.teams.getDiscussionComment() is deprecated, see https://developer.github.com/v3/teams/discussion_comments/#get-a-single-comment-legacy

          • (params?: RequestOptions & Octokit.TeamsGetDiscussionCommentParams): Promise<Response<Octokit.TeamsGetDiscussionCommentResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsGetDiscussionCommentParams

            Returns Promise<Response<Octokit.TeamsGetDiscussionCommentResponse>>

        • endpoint: Endpoint
      • getDiscussionCommentInOrg: { endpoint: Endpoint }

        Get a specific comment on a team discussion. OAuth access tokens require the read:discussion scope.

        Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number.

          • (params?: RequestOptions & Octokit.TeamsGetDiscussionCommentInOrgParams): Promise<Response<Octokit.TeamsGetDiscussionCommentInOrgResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsGetDiscussionCommentInOrgParams

            Returns Promise<Response<Octokit.TeamsGetDiscussionCommentInOrgResponse>>

        • endpoint: Endpoint
      • getDiscussionCommentLegacy: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a single comment endpoint.

        Get a specific comment on a team discussion. OAuth access tokens require the read:discussion scope.

        deprecated

        octokit.teams.getDiscussionCommentLegacy() is deprecated, see https://developer.github.com/v3/teams/discussion_comments/#get-a-single-comment-legacy

          • (params?: RequestOptions & Octokit.TeamsGetDiscussionCommentLegacyParams): Promise<Response<Octokit.TeamsGetDiscussionCommentLegacyResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsGetDiscussionCommentLegacyParams

            Returns Promise<Response<Octokit.TeamsGetDiscussionCommentLegacyResponse>>

        • endpoint: Endpoint
      • getDiscussionInOrg: { endpoint: Endpoint }

        Get a specific discussion on a team's page. OAuth access tokens require the read:discussion scope.

        Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number.

          • (params?: RequestOptions & Octokit.TeamsGetDiscussionInOrgParams): Promise<Response<Octokit.TeamsGetDiscussionInOrgResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsGetDiscussionInOrgParams

            Returns Promise<Response<Octokit.TeamsGetDiscussionInOrgResponse>>

        • endpoint: Endpoint
      • getDiscussionLegacy: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a single discussion endpoint.

        Get a specific discussion on a team's page. OAuth access tokens require the read:discussion scope.

        deprecated

        octokit.teams.getDiscussionLegacy() is deprecated, see https://developer.github.com/v3/teams/discussions/#get-a-single-discussion-legacy

          • (params?: RequestOptions & Octokit.TeamsGetDiscussionLegacyParams): Promise<Response<Octokit.TeamsGetDiscussionLegacyResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsGetDiscussionLegacyParams

            Returns Promise<Response<Octokit.TeamsGetDiscussionLegacyResponse>>

        • endpoint: Endpoint
      • getLegacy: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the Get team by name endpoint.

        deprecated

        octokit.teams.getLegacy() is deprecated, see https://developer.github.com/v3/teams/#get-team-legacy

          • Parameters

            Returns Promise<Response<Octokit.TeamsGetLegacyResponse>>

        • endpoint: Endpoint
      • getMember: { endpoint: Endpoint }

        The "Get team member" endpoint (described below) is deprecated.

        We recommend using the Get team membership endpoint instead. It allows you to get both active and pending memberships.

        To list members in a team, the team must be visible to the authenticated user.

        deprecated

        octokit.teams.getMember() is deprecated, see https://developer.github.com/v3/teams/members/#get-team-member-legacy

          • (params?: RequestOptions & Octokit.TeamsGetMemberParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • getMemberLegacy: { endpoint: Endpoint }

        The "Get team member" endpoint (described below) is deprecated.

        We recommend using the Get team membership endpoint instead. It allows you to get both active and pending memberships.

        To list members in a team, the team must be visible to the authenticated user.

        deprecated

        octokit.teams.getMemberLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#get-team-member-legacy

          • (params?: RequestOptions & Octokit.TeamsGetMemberLegacyParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsGetMemberLegacyParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • getMembership: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Get team membership endpoint.

        Team members will include the members of child teams.

        To get a user's membership with a team, the team must be visible to the authenticated user.

        Note: The role for organization owners returns as maintainer. For more information about maintainer roles, see Create team.

        deprecated

        octokit.teams.getMembership() is deprecated, see https://developer.github.com/v3/teams/members/#get-team-membership-legacy

          • (params?: RequestOptions & Octokit.TeamsGetMembershipParams): Promise<Response<Octokit.TeamsGetMembershipResponse>>

          • Parameters

            Returns Promise<Response<Octokit.TeamsGetMembershipResponse>>

        • endpoint: Endpoint
      • getMembershipInOrg: { endpoint: Endpoint }

        Team members will include the members of child teams.

        To get a user's membership with a team, the team must be visible to the authenticated user.

        Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/memberships/:username.

        Note: The role for organization owners returns as maintainer. For more information about maintainer roles, see Create team.

          • (params?: RequestOptions & Octokit.TeamsGetMembershipInOrgParams): Promise<Response<Octokit.TeamsGetMembershipInOrgResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsGetMembershipInOrgParams

            Returns Promise<Response<Octokit.TeamsGetMembershipInOrgResponse>>

        • endpoint: Endpoint
      • getMembershipLegacy: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Get team membership endpoint.

        Team members will include the members of child teams.

        To get a user's membership with a team, the team must be visible to the authenticated user.

        Note: The role for organization owners returns as maintainer. For more information about maintainer roles, see Create team.

        deprecated

        octokit.teams.getMembershipLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#get-team-membership-legacy

          • (params?: RequestOptions & Octokit.TeamsGetMembershipLegacyParams): Promise<Response<Octokit.TeamsGetMembershipLegacyResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsGetMembershipLegacyParams

            Returns Promise<Response<Octokit.TeamsGetMembershipLegacyResponse>>

        • endpoint: Endpoint
      • list: { endpoint: Endpoint }

        Lists all teams in an organization that are visible to the authenticated user.

      • listChild: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List child teams endpoint.

        deprecated

        octokit.teams.listChild() is deprecated, see https://developer.github.com/v3/teams/#list-child-teams-legacy

          • Parameters

            Returns Promise<Response<Octokit.TeamsListChildResponse>>

        • endpoint: Endpoint
      • listChildInOrg: { endpoint: Endpoint }

        Lists the child teams of the team requested by :team_slug.

        Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/teams.

          • (params?: RequestOptions & Octokit.TeamsListChildInOrgParams): Promise<Response<Octokit.TeamsListChildInOrgResponse>>

          • Parameters

            Returns Promise<Response<Octokit.TeamsListChildInOrgResponse>>

        • endpoint: Endpoint
      • listChildLegacy: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List child teams endpoint.

        deprecated

        octokit.teams.listChildLegacy() is deprecated, see https://developer.github.com/v3/teams/#list-child-teams-legacy

          • (params?: RequestOptions & Octokit.TeamsListChildLegacyParams): Promise<Response<Octokit.TeamsListChildLegacyResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsListChildLegacyParams

            Returns Promise<Response<Octokit.TeamsListChildLegacyResponse>>

        • endpoint: Endpoint
      • listDiscussionComments: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List comments endpoint.

        List all comments on a team discussion. OAuth access tokens require the read:discussion scope.

        deprecated

        octokit.teams.listDiscussionComments() is deprecated, see https://developer.github.com/v3/teams/discussion_comments/#list-comments-legacy

          • (params?: RequestOptions & Octokit.TeamsListDiscussionCommentsParams): Promise<Response<Octokit.TeamsListDiscussionCommentsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsListDiscussionCommentsParams

            Returns Promise<Response<Octokit.TeamsListDiscussionCommentsResponse>>

        • endpoint: Endpoint
      • listDiscussionCommentsInOrg: { endpoint: Endpoint }

        List all comments on a team discussion. OAuth access tokens require the read:discussion scope.

        Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments.

          • (params?: RequestOptions & Octokit.TeamsListDiscussionCommentsInOrgParams): Promise<Response<Octokit.TeamsListDiscussionCommentsInOrgResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsListDiscussionCommentsInOrgParams

            Returns Promise<Response<Octokit.TeamsListDiscussionCommentsInOrgResponse>>

        • endpoint: Endpoint
      • listDiscussionCommentsLegacy: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List comments endpoint.

        List all comments on a team discussion. OAuth access tokens require the read:discussion scope.

        deprecated

        octokit.teams.listDiscussionCommentsLegacy() is deprecated, see https://developer.github.com/v3/teams/discussion_comments/#list-comments-legacy

          • (params?: RequestOptions & Octokit.TeamsListDiscussionCommentsLegacyParams): Promise<Response<Octokit.TeamsListDiscussionCommentsLegacyResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsListDiscussionCommentsLegacyParams

            Returns Promise<Response<Octokit.TeamsListDiscussionCommentsLegacyResponse>>

        • endpoint: Endpoint
      • listDiscussions: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussions endpoint.

        List all discussions on a team's page. OAuth access tokens require the read:discussion scope.

        deprecated

        octokit.teams.listDiscussions() is deprecated, see https://developer.github.com/v3/teams/discussions/#list-discussions-legacy

          • (params?: RequestOptions & Octokit.TeamsListDiscussionsParams): Promise<Response<Octokit.TeamsListDiscussionsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsListDiscussionsParams

            Returns Promise<Response<Octokit.TeamsListDiscussionsResponse>>

        • endpoint: Endpoint
      • listDiscussionsInOrg: { endpoint: Endpoint }

        List all discussions on a team's page. OAuth access tokens require the read:discussion scope.

        Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions.

          • (params?: RequestOptions & Octokit.TeamsListDiscussionsInOrgParams): Promise<Response<Octokit.TeamsListDiscussionsInOrgResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsListDiscussionsInOrgParams

            Returns Promise<Response<Octokit.TeamsListDiscussionsInOrgResponse>>

        • endpoint: Endpoint
      • listDiscussionsLegacy: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussions endpoint.

        List all discussions on a team's page. OAuth access tokens require the read:discussion scope.

        deprecated

        octokit.teams.listDiscussionsLegacy() is deprecated, see https://developer.github.com/v3/teams/discussions/#list-discussions-legacy

          • (params?: RequestOptions & Octokit.TeamsListDiscussionsLegacyParams): Promise<Response<Octokit.TeamsListDiscussionsLegacyResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsListDiscussionsLegacyParams

            Returns Promise<Response<Octokit.TeamsListDiscussionsLegacyResponse>>

        • endpoint: Endpoint
      • listForAuthenticatedUser: { endpoint: Endpoint }

        List all of the teams across all of the organizations to which the authenticated user belongs. This method requires user, repo, or read:org scope when authenticating via OAuth.

          • (params?: RequestOptions & Octokit.TeamsListForAuthenticatedUserParams): Promise<Response<Octokit.TeamsListForAuthenticatedUserResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsListForAuthenticatedUserParams

            Returns Promise<Response<Octokit.TeamsListForAuthenticatedUserResponse>>

        • endpoint: Endpoint
      • listMembers: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List team members endpoint.

        Team members will include the members of child teams.

        deprecated

        octokit.teams.listMembers() is deprecated, see https://developer.github.com/v3/teams/members/#list-team-members-legacy

          • (params?: RequestOptions & Octokit.TeamsListMembersParams): Promise<Response<Octokit.TeamsListMembersResponse>>

          • Parameters

            Returns Promise<Response<Octokit.TeamsListMembersResponse>>

        • endpoint: Endpoint
      • listMembersInOrg: { endpoint: Endpoint }

        Team members will include the members of child teams.

        To list members in a team, the team must be visible to the authenticated user.

          • (params?: RequestOptions & Octokit.TeamsListMembersInOrgParams): Promise<Response<Octokit.TeamsListMembersInOrgResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsListMembersInOrgParams

            Returns Promise<Response<Octokit.TeamsListMembersInOrgResponse>>

        • endpoint: Endpoint
      • listMembersLegacy: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List team members endpoint.

        Team members will include the members of child teams.

        deprecated

        octokit.teams.listMembersLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#list-team-members-legacy

          • (params?: RequestOptions & Octokit.TeamsListMembersLegacyParams): Promise<Response<Octokit.TeamsListMembersLegacyResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsListMembersLegacyParams

            Returns Promise<Response<Octokit.TeamsListMembersLegacyResponse>>

        • endpoint: Endpoint
      • listPendingInvitations: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List pending team invitations endpoint.

        The return hash contains a role field which refers to the Organization Invitation role and will be one of the following values: direct_member, admin, billing_manager, hiring_manager, or reinstate. If the invitee is not a GitHub member, the login field in the return hash will be null.

        deprecated

        octokit.teams.listPendingInvitations() is deprecated, see https://developer.github.com/v3/teams/members/#list-pending-team-invitations-legacy

          • (params?: RequestOptions & Octokit.TeamsListPendingInvitationsParams): Promise<Response<Octokit.TeamsListPendingInvitationsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsListPendingInvitationsParams

            Returns Promise<Response<Octokit.TeamsListPendingInvitationsResponse>>

        • endpoint: Endpoint
      • listPendingInvitationsInOrg: { endpoint: Endpoint }

        The return hash contains a role field which refers to the Organization Invitation role and will be one of the following values: direct_member, admin, billing_manager, hiring_manager, or reinstate. If the invitee is not a GitHub member, the login field in the return hash will be null.

        Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/invitations.

          • (params?: RequestOptions & Octokit.TeamsListPendingInvitationsInOrgParams): Promise<Response<Octokit.TeamsListPendingInvitationsInOrgResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsListPendingInvitationsInOrgParams

            Returns Promise<Response<Octokit.TeamsListPendingInvitationsInOrgResponse>>

        • endpoint: Endpoint
      • listPendingInvitationsLegacy: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List pending team invitations endpoint.

        The return hash contains a role field which refers to the Organization Invitation role and will be one of the following values: direct_member, admin, billing_manager, hiring_manager, or reinstate. If the invitee is not a GitHub member, the login field in the return hash will be null.

        deprecated

        octokit.teams.listPendingInvitationsLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#list-pending-team-invitations-legacy

          • (params?: RequestOptions & Octokit.TeamsListPendingInvitationsLegacyParams): Promise<Response<Octokit.TeamsListPendingInvitationsLegacyResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsListPendingInvitationsLegacyParams

            Returns Promise<Response<Octokit.TeamsListPendingInvitationsLegacyResponse>>

        • endpoint: Endpoint
      • listProjects: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List team projects endpoint.

        Lists the organization projects for a team.

        deprecated

        octokit.teams.listProjects() is deprecated, see https://developer.github.com/v3/teams/#list-team-projects-legacy

          • (params?: RequestOptions & Octokit.TeamsListProjectsParams): Promise<Response<Octokit.TeamsListProjectsResponse>>

          • Parameters

            Returns Promise<Response<Octokit.TeamsListProjectsResponse>>

        • endpoint: Endpoint
      • listProjectsInOrg: { endpoint: Endpoint }

        Lists the organization projects for a team.

        Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/projects.

          • (params?: RequestOptions & Octokit.TeamsListProjectsInOrgParams): Promise<Response<Octokit.TeamsListProjectsInOrgResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsListProjectsInOrgParams

            Returns Promise<Response<Octokit.TeamsListProjectsInOrgResponse>>

        • endpoint: Endpoint
      • listProjectsLegacy: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List team projects endpoint.

        Lists the organization projects for a team.

        deprecated

        octokit.teams.listProjectsLegacy() is deprecated, see https://developer.github.com/v3/teams/#list-team-projects-legacy

          • (params?: RequestOptions & Octokit.TeamsListProjectsLegacyParams): Promise<Response<Octokit.TeamsListProjectsLegacyResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsListProjectsLegacyParams

            Returns Promise<Response<Octokit.TeamsListProjectsLegacyResponse>>

        • endpoint: Endpoint
      • listRepos: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List team repos endpoint.

        deprecated

        octokit.teams.listRepos() is deprecated, see https://developer.github.com/v3/teams/#list-team-repos-legacy

          • Parameters

            Returns Promise<Response<Octokit.TeamsListReposResponse>>

        • endpoint: Endpoint
      • listReposInOrg: { endpoint: Endpoint }

        Lists a team's repositories visible to the authenticated user.

        Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/repos.

          • (params?: RequestOptions & Octokit.TeamsListReposInOrgParams): Promise<Response<Octokit.TeamsListReposInOrgResponse>>

          • Parameters

            Returns Promise<Response<Octokit.TeamsListReposInOrgResponse>>

        • endpoint: Endpoint
      • listReposLegacy: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List team repos endpoint.

        deprecated

        octokit.teams.listReposLegacy() is deprecated, see https://developer.github.com/v3/teams/#list-team-repos-legacy

          • (params?: RequestOptions & Octokit.TeamsListReposLegacyParams): Promise<Response<Octokit.TeamsListReposLegacyResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsListReposLegacyParams

            Returns Promise<Response<Octokit.TeamsListReposLegacyResponse>>

        • endpoint: Endpoint
      • removeMember: { endpoint: Endpoint }

        The "Remove team member" endpoint (described below) is deprecated.

        We recommend using the Remove team membership endpoint instead. It allows you to remove both active and pending memberships.

        Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

        To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.

        Note: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "Synchronizing teams between your identity provider and GitHub."

        deprecated

        octokit.teams.removeMember() is deprecated, see https://developer.github.com/v3/teams/members/#remove-team-member-legacy

          • (params?: RequestOptions & Octokit.TeamsRemoveMemberParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • removeMemberLegacy: { endpoint: Endpoint }

        The "Remove team member" endpoint (described below) is deprecated.

        We recommend using the Remove team membership endpoint instead. It allows you to remove both active and pending memberships.

        Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

        To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.

        Note: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "Synchronizing teams between your identity provider and GitHub."

        deprecated

        octokit.teams.removeMemberLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#remove-team-member-legacy

          • (params?: RequestOptions & Octokit.TeamsRemoveMemberLegacyParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsRemoveMemberLegacyParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • removeMembership: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove team membership endpoint.

        Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

        To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.

        Note: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "Synchronizing teams between your identity provider and GitHub."

        deprecated

        octokit.teams.removeMembership() is deprecated, see https://developer.github.com/v3/teams/members/#remove-team-membership-legacy

          • (params?: RequestOptions & Octokit.TeamsRemoveMembershipParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsRemoveMembershipParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • removeMembershipInOrg: { endpoint: Endpoint }

        Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

        To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.

        Note: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "Synchronizing teams between your identity provider and GitHub."

        Note: You can also specify a team by org_id and team_id using the route DELETE /organizations/:org_id/team/:team_id/memberships/:username.

          • (params?: RequestOptions & Octokit.TeamsRemoveMembershipInOrgParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsRemoveMembershipInOrgParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • removeMembershipLegacy: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove team membership endpoint.

        Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

        To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.

        Note: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "Synchronizing teams between your identity provider and GitHub."

        deprecated

        octokit.teams.removeMembershipLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#remove-team-membership-legacy

          • (params?: RequestOptions & Octokit.TeamsRemoveMembershipLegacyParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsRemoveMembershipLegacyParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • removeProject: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove team project endpoint.

        Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have read access to both the team and project, or admin access to the team or project. Note: This endpoint removes the project from the team, but does not delete it.

        deprecated

        octokit.teams.removeProject() is deprecated, see https://developer.github.com/v3/teams/#remove-team-project-legacy

          • (params?: RequestOptions & Octokit.TeamsRemoveProjectParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • removeProjectInOrg: { endpoint: Endpoint }

        Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have read access to both the team and project, or admin access to the team or project. This endpoint removes the project from the team, but does not delete the project.

        Note: You can also specify a team by org_id and team_id using the route DELETE /organizations/:org_id/team/:team_id/projects/:project_id.

          • (params?: RequestOptions & Octokit.TeamsRemoveProjectInOrgParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsRemoveProjectInOrgParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • removeProjectLegacy: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove team project endpoint.

        Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have read access to both the team and project, or admin access to the team or project. Note: This endpoint removes the project from the team, but does not delete it.

        deprecated

        octokit.teams.removeProjectLegacy() is deprecated, see https://developer.github.com/v3/teams/#remove-team-project-legacy

          • (params?: RequestOptions & Octokit.TeamsRemoveProjectLegacyParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsRemoveProjectLegacyParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • removeRepo: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove team repository endpoint.

        If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.

        deprecated

        octokit.teams.removeRepo() is deprecated, see https://developer.github.com/v3/teams/#remove-team-repository-legacy

          • (params?: RequestOptions & Octokit.TeamsRemoveRepoParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • removeRepoInOrg: { endpoint: Endpoint }

        If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.

        Note: You can also specify a team by org_id and team_id using the route DELETE /organizations/:org_id/team/:team_id/repos/:owner/:repo.

          • (params?: RequestOptions & Octokit.TeamsRemoveRepoInOrgParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsRemoveRepoInOrgParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • removeRepoLegacy: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove team repository endpoint.

        If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.

        deprecated

        octokit.teams.removeRepoLegacy() is deprecated, see https://developer.github.com/v3/teams/#remove-team-repository-legacy

          • (params?: RequestOptions & Octokit.TeamsRemoveRepoLegacyParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsRemoveRepoLegacyParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • reviewProject: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Review a team project endpoint.

        Checks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.

        deprecated

        octokit.teams.reviewProject() is deprecated, see https://developer.github.com/v3/teams/#review-a-team-project-legacy

          • (params?: RequestOptions & Octokit.TeamsReviewProjectParams): Promise<Response<Octokit.TeamsReviewProjectResponse>>

          • Parameters

            Returns Promise<Response<Octokit.TeamsReviewProjectResponse>>

        • endpoint: Endpoint
      • reviewProjectInOrg: { endpoint: Endpoint }

        Checks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.

        Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/projects/:project_id.

          • (params?: RequestOptions & Octokit.TeamsReviewProjectInOrgParams): Promise<Response<Octokit.TeamsReviewProjectInOrgResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsReviewProjectInOrgParams

            Returns Promise<Response<Octokit.TeamsReviewProjectInOrgResponse>>

        • endpoint: Endpoint
      • reviewProjectLegacy: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Review a team project endpoint.

        Checks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.

        deprecated

        octokit.teams.reviewProjectLegacy() is deprecated, see https://developer.github.com/v3/teams/#review-a-team-project-legacy

          • (params?: RequestOptions & Octokit.TeamsReviewProjectLegacyParams): Promise<Response<Octokit.TeamsReviewProjectLegacyResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsReviewProjectLegacyParams

            Returns Promise<Response<Octokit.TeamsReviewProjectLegacyResponse>>

        • endpoint: Endpoint
      • update: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Edit team endpoint.

        To edit a team, the authenticated user must either be an organization owner or a team maintainer.

        Note: With nested teams, the privacy for parent teams cannot be secret.

        deprecated

        octokit.teams.update() is deprecated, see https://developer.github.com/v3/teams/#edit-team-legacy

          • (params?: RequestOptions & Octokit.TeamsUpdateParamsDeprecatedPermission): Promise<Response<Octokit.TeamsUpdateResponse>>
          • (params?: RequestOptions & Octokit.TeamsUpdateParams): Promise<Response<Octokit.TeamsUpdateResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsUpdateParamsDeprecatedPermission

            Returns Promise<Response<Octokit.TeamsUpdateResponse>>

          • Parameters

            Returns Promise<Response<Octokit.TeamsUpdateResponse>>

        • endpoint: Endpoint
      • updateDiscussion: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Edit a discussion endpoint.

        Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the write:discussion scope.

        deprecated

        octokit.teams.updateDiscussion() is deprecated, see https://developer.github.com/v3/teams/discussions/#edit-a-discussion-legacy

          • (params?: RequestOptions & Octokit.TeamsUpdateDiscussionParams): Promise<Response<Octokit.TeamsUpdateDiscussionResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsUpdateDiscussionParams

            Returns Promise<Response<Octokit.TeamsUpdateDiscussionResponse>>

        • endpoint: Endpoint
      • updateDiscussionComment: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Edit a comment endpoint.

        Edits the body text of a discussion comment. OAuth access tokens require the write:discussion scope.

        deprecated

        octokit.teams.updateDiscussionComment() is deprecated, see https://developer.github.com/v3/teams/discussion_comments/#edit-a-comment-legacy

          • (params?: RequestOptions & Octokit.TeamsUpdateDiscussionCommentParams): Promise<Response<Octokit.TeamsUpdateDiscussionCommentResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsUpdateDiscussionCommentParams

            Returns Promise<Response<Octokit.TeamsUpdateDiscussionCommentResponse>>

        • endpoint: Endpoint
      • updateDiscussionCommentInOrg: { endpoint: Endpoint }

        Edits the body text of a discussion comment. OAuth access tokens require the write:discussion scope.

        Note: You can also specify a team by org_id and team_id using the route PATCH /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number.

          • (params?: RequestOptions & Octokit.TeamsUpdateDiscussionCommentInOrgParams): Promise<Response<Octokit.TeamsUpdateDiscussionCommentInOrgResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsUpdateDiscussionCommentInOrgParams

            Returns Promise<Response<Octokit.TeamsUpdateDiscussionCommentInOrgResponse>>

        • endpoint: Endpoint
      • updateDiscussionCommentLegacy: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Edit a comment endpoint.

        Edits the body text of a discussion comment. OAuth access tokens require the write:discussion scope.

        deprecated

        octokit.teams.updateDiscussionCommentLegacy() is deprecated, see https://developer.github.com/v3/teams/discussion_comments/#edit-a-comment-legacy

          • (params?: RequestOptions & Octokit.TeamsUpdateDiscussionCommentLegacyParams): Promise<Response<Octokit.TeamsUpdateDiscussionCommentLegacyResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsUpdateDiscussionCommentLegacyParams

            Returns Promise<Response<Octokit.TeamsUpdateDiscussionCommentLegacyResponse>>

        • endpoint: Endpoint
      • updateDiscussionInOrg: { endpoint: Endpoint }

        Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the write:discussion scope.

        Note: You can also specify a team by org_id and team_id using the route PATCH /organizations/:org_id/team/:team_id/discussions/:discussion_number.

          • (params?: RequestOptions & Octokit.TeamsUpdateDiscussionInOrgParams): Promise<Response<Octokit.TeamsUpdateDiscussionInOrgResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsUpdateDiscussionInOrgParams

            Returns Promise<Response<Octokit.TeamsUpdateDiscussionInOrgResponse>>

        • endpoint: Endpoint
      • updateDiscussionLegacy: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Edit a discussion endpoint.

        Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the write:discussion scope.

        deprecated

        octokit.teams.updateDiscussionLegacy() is deprecated, see https://developer.github.com/v3/teams/discussions/#edit-a-discussion-legacy

          • (params?: RequestOptions & Octokit.TeamsUpdateDiscussionLegacyParams): Promise<Response<Octokit.TeamsUpdateDiscussionLegacyResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsUpdateDiscussionLegacyParams

            Returns Promise<Response<Octokit.TeamsUpdateDiscussionLegacyResponse>>

        • endpoint: Endpoint
      • updateInOrg: { endpoint: Endpoint }

        To edit a team, the authenticated user must either be an organization owner or a team maintainer.

        Note: You can also specify a team by org_id and team_id using the route PATCH /organizations/:org_id/team/:team_id.

          • (params?: RequestOptions & Octokit.TeamsUpdateInOrgParamsDeprecatedPermission): Promise<Response<Octokit.TeamsUpdateInOrgResponse>>
          • (params?: RequestOptions & Octokit.TeamsUpdateInOrgParams): Promise<Response<Octokit.TeamsUpdateInOrgResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsUpdateInOrgParamsDeprecatedPermission

            Returns Promise<Response<Octokit.TeamsUpdateInOrgResponse>>

          • Parameters

            Returns Promise<Response<Octokit.TeamsUpdateInOrgResponse>>

        • endpoint: Endpoint
      • updateLegacy: { endpoint: Endpoint }

        Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Edit team endpoint.

        To edit a team, the authenticated user must either be an organization owner or a team maintainer.

        Note: With nested teams, the privacy for parent teams cannot be secret.

        deprecated

        octokit.teams.updateLegacy() is deprecated, see https://developer.github.com/v3/teams/#edit-team-legacy

          • (params?: RequestOptions & Octokit.TeamsUpdateLegacyParamsDeprecatedPermission): Promise<Response<Octokit.TeamsUpdateLegacyResponse>>
          • (params?: RequestOptions & Octokit.TeamsUpdateLegacyParams): Promise<Response<Octokit.TeamsUpdateLegacyResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.TeamsUpdateLegacyParamsDeprecatedPermission

            Returns Promise<Response<Octokit.TeamsUpdateLegacyResponse>>

          • Parameters

            Returns Promise<Response<Octokit.TeamsUpdateLegacyResponse>>

        • endpoint: Endpoint

      users

      users: { addEmails: { endpoint: Endpoint }; block: { endpoint: Endpoint }; checkBlocked: { endpoint: Endpoint }; checkFollowing: { endpoint: Endpoint }; checkFollowingForUser: { endpoint: Endpoint }; createGpgKey: { endpoint: Endpoint }; createPublicKey: { endpoint: Endpoint }; deleteEmails: { endpoint: Endpoint }; deleteGpgKey: { endpoint: Endpoint }; deletePublicKey: { endpoint: Endpoint }; follow: { endpoint: Endpoint }; getAuthenticated: { endpoint: Endpoint }; getByUsername: { endpoint: Endpoint }; getContextForUser: { endpoint: Endpoint }; getGpgKey: { endpoint: Endpoint }; getPublicKey: { endpoint: Endpoint }; list: { endpoint: Endpoint }; listBlocked: { endpoint: Endpoint }; listEmails: { endpoint: Endpoint }; listFollowersForAuthenticatedUser: { endpoint: Endpoint }; listFollowersForUser: { endpoint: Endpoint }; listFollowingForAuthenticatedUser: { endpoint: Endpoint }; listFollowingForUser: { endpoint: Endpoint }; listGpgKeys: { endpoint: Endpoint }; listGpgKeysForUser: { endpoint: Endpoint }; listPublicEmails: { endpoint: Endpoint }; listPublicKeys: { endpoint: Endpoint }; listPublicKeysForUser: { endpoint: Endpoint }; togglePrimaryEmailVisibility: { endpoint: Endpoint }; unblock: { endpoint: Endpoint }; unfollow: { endpoint: Endpoint }; updateAuthenticated: { endpoint: Endpoint } }

      Type declaration

      • addEmails: { endpoint: Endpoint }

        This endpoint is accessible with the user scope.

          • Parameters

            Returns Promise<Response<Octokit.UsersAddEmailsResponse>>

        • endpoint: Endpoint
      • block: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.UsersBlockParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • checkBlocked: { endpoint: Endpoint }

        If the user is blocked:

        If the user is not blocked:

          • (params?: RequestOptions & Octokit.UsersCheckBlockedParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • checkFollowing: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.UsersCheckFollowingParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • checkFollowingForUser: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.UsersCheckFollowingForUserParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.UsersCheckFollowingForUserParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • createGpgKey: { endpoint: Endpoint }

        Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least write:gpg_key scope.

          • (params?: RequestOptions & Octokit.UsersCreateGpgKeyParams): Promise<Response<Octokit.UsersCreateGpgKeyResponse>>

          • Parameters

            Returns Promise<Response<Octokit.UsersCreateGpgKeyResponse>>

        • endpoint: Endpoint
      • createPublicKey: { endpoint: Endpoint }

        Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least write:public_key scope.

          • (params?: RequestOptions & Octokit.UsersCreatePublicKeyParams): Promise<Response<Octokit.UsersCreatePublicKeyResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.UsersCreatePublicKeyParams

            Returns Promise<Response<Octokit.UsersCreatePublicKeyResponse>>

        • endpoint: Endpoint
      • deleteEmails: { endpoint: Endpoint }

        This endpoint is accessible with the user scope.

          • (params?: RequestOptions & Octokit.UsersDeleteEmailsParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • deleteGpgKey: { endpoint: Endpoint }

        Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least admin:gpg_key scope.

          • (params?: RequestOptions & Octokit.UsersDeleteGpgKeyParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • deletePublicKey: { endpoint: Endpoint }

        Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least admin:public_key scope.

          • (params?: RequestOptions & Octokit.UsersDeletePublicKeyParams): Promise<Octokit.AnyResponse>

          • Parameters

            • Optional params: RequestOptions & Octokit.UsersDeletePublicKeyParams

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • follow: { endpoint: Endpoint }

        Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."

        Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the user:follow scope.

          • (params?: RequestOptions & Octokit.UsersFollowParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • getAuthenticated: { endpoint: Endpoint }

        Lists public and private profile information when authenticated through basic auth or OAuth with the user scope.

        Lists public profile information when authenticated through OAuth without the user scope.

      • getByUsername: { endpoint: Endpoint }

        Provides publicly available information about someone with a GitHub account.

        GitHub Apps with the Plan user permission can use this endpoint to retrieve information about a user's GitHub plan. The GitHub App must be authenticated as a user. See "Identifying and authorizing users for GitHub Apps" for details about authentication. For an example response, see "Response with GitHub plan information."

        The email key in the following response is the publicly visible email address from your GitHub profile page. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub. For more information, see Authentication.

        The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "Emails API".

          • (params?: RequestOptions & Octokit.UsersGetByUsernameParams): Promise<Response<Octokit.UsersGetByUsernameResponse>>

          • Parameters

            Returns Promise<Response<Octokit.UsersGetByUsernameResponse>>

        • endpoint: Endpoint
      • getContextForUser: { endpoint: Endpoint }

        Provides hovercard information when authenticated through basic auth or OAuth with the repo scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.

        The subject_type and subject_id parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about octocat who owns the Spoon-Knife repository via cURL, it would look like this:

          • (params?: RequestOptions & Octokit.UsersGetContextForUserParams): Promise<Response<Octokit.UsersGetContextForUserResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.UsersGetContextForUserParams

            Returns Promise<Response<Octokit.UsersGetContextForUserResponse>>

        • endpoint: Endpoint
      • getGpgKey: { endpoint: Endpoint }

        View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least read:gpg_key scope.

          • Parameters

            Returns Promise<Response<Octokit.UsersGetGpgKeyResponse>>

        • endpoint: Endpoint
      • getPublicKey: { endpoint: Endpoint }

        View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least read:public_key scope.

          • (params?: RequestOptions & Octokit.UsersGetPublicKeyParams): Promise<Response<Octokit.UsersGetPublicKeyResponse>>

          • Parameters

            Returns Promise<Response<Octokit.UsersGetPublicKeyResponse>>

        • endpoint: Endpoint
      • list: { endpoint: Endpoint }

        Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts.

        Note: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of users.

      • listBlocked: { endpoint: Endpoint }

        List the users you've blocked on your personal account.

      • listEmails: { endpoint: Endpoint }

        Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the user:email scope.

          • (params?: RequestOptions & Octokit.UsersListEmailsParams): Promise<Response<Octokit.UsersListEmailsResponse>>

          • Parameters

            Returns Promise<Response<Octokit.UsersListEmailsResponse>>

        • endpoint: Endpoint
      • listFollowersForAuthenticatedUser: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.UsersListFollowersForAuthenticatedUserParams): Promise<Response<Octokit.UsersListFollowersForAuthenticatedUserResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.UsersListFollowersForAuthenticatedUserParams

            Returns Promise<Response<Octokit.UsersListFollowersForAuthenticatedUserResponse>>

        • endpoint: Endpoint
      • listFollowersForUser: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.UsersListFollowersForUserParams): Promise<Response<Octokit.UsersListFollowersForUserResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.UsersListFollowersForUserParams

            Returns Promise<Response<Octokit.UsersListFollowersForUserResponse>>

        • endpoint: Endpoint
      • listFollowingForAuthenticatedUser: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.UsersListFollowingForAuthenticatedUserParams): Promise<Response<Octokit.UsersListFollowingForAuthenticatedUserResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.UsersListFollowingForAuthenticatedUserParams

            Returns Promise<Response<Octokit.UsersListFollowingForAuthenticatedUserResponse>>

        • endpoint: Endpoint
      • listFollowingForUser: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.UsersListFollowingForUserParams): Promise<Response<Octokit.UsersListFollowingForUserResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.UsersListFollowingForUserParams

            Returns Promise<Response<Octokit.UsersListFollowingForUserResponse>>

        • endpoint: Endpoint
      • listGpgKeys: { endpoint: Endpoint }

        Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least read:gpg_key scope.

          • (params?: RequestOptions & Octokit.UsersListGpgKeysParams): Promise<Response<Octokit.UsersListGpgKeysResponse>>

          • Parameters

            Returns Promise<Response<Octokit.UsersListGpgKeysResponse>>

        • endpoint: Endpoint
      • listGpgKeysForUser: { endpoint: Endpoint }

        Lists the GPG keys for a user. This information is accessible by anyone.

          • (params?: RequestOptions & Octokit.UsersListGpgKeysForUserParams): Promise<Response<Octokit.UsersListGpgKeysForUserResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.UsersListGpgKeysForUserParams

            Returns Promise<Response<Octokit.UsersListGpgKeysForUserResponse>>

        • endpoint: Endpoint
      • listPublicEmails: { endpoint: Endpoint }

        Lists your publicly visible email address, which you can set with the Toggle primary email visibility endpoint. This endpoint is accessible with the user:email scope.

          • (params?: RequestOptions & Octokit.UsersListPublicEmailsParams): Promise<Response<Octokit.UsersListPublicEmailsResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.UsersListPublicEmailsParams

            Returns Promise<Response<Octokit.UsersListPublicEmailsResponse>>

        • endpoint: Endpoint
      • listPublicKeys: { endpoint: Endpoint }

        Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least read:public_key scope.

          • (params?: RequestOptions & Octokit.UsersListPublicKeysParams): Promise<Response<Octokit.UsersListPublicKeysResponse>>

          • Parameters

            Returns Promise<Response<Octokit.UsersListPublicKeysResponse>>

        • endpoint: Endpoint
      • listPublicKeysForUser: { endpoint: Endpoint }

        Lists the verified public SSH keys for a user. This is accessible by anyone.

          • (params?: RequestOptions & Octokit.UsersListPublicKeysForUserParams): Promise<Response<Octokit.UsersListPublicKeysForUserResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.UsersListPublicKeysForUserParams

            Returns Promise<Response<Octokit.UsersListPublicKeysForUserResponse>>

        • endpoint: Endpoint
      • togglePrimaryEmailVisibility: { endpoint: Endpoint }

        Sets the visibility for your primary email addresses.

          • (params?: RequestOptions & Octokit.UsersTogglePrimaryEmailVisibilityParams): Promise<Response<Octokit.UsersTogglePrimaryEmailVisibilityResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.UsersTogglePrimaryEmailVisibilityParams

            Returns Promise<Response<Octokit.UsersTogglePrimaryEmailVisibilityResponse>>

        • endpoint: Endpoint
      • unblock: { endpoint: Endpoint }
          • (params?: RequestOptions & Octokit.UsersUnblockParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • unfollow: { endpoint: Endpoint }

        Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the user:follow scope.

          • (params?: RequestOptions & Octokit.UsersUnfollowParams): Promise<Octokit.AnyResponse>

          • Parameters

            Returns Promise<Octokit.AnyResponse>

        • endpoint: Endpoint
      • updateAuthenticated: { endpoint: Endpoint }

        Note: If your email is set to private and you send an email parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API.

          • (params?: RequestOptions & Octokit.UsersUpdateAuthenticatedParams): Promise<Response<Octokit.UsersUpdateAuthenticatedResponse>>

          • Parameters

            • Optional params: RequestOptions & Octokit.UsersUpdateAuthenticatedParams

            Returns Promise<Response<Octokit.UsersUpdateAuthenticatedResponse>>

        • endpoint: Endpoint

      Methods

      authenticate

      registerEndpoints

      • registerEndpoints(endpoints: {}): void

      Static plugin

      • plugin(plugin: Octokit.Plugin | Octokit.Plugin[]): Static

      • Parameters

        • plugin: Octokit.Plugin | Octokit.Plugin[]

        Returns Static

      Legend

      • Module
      • Object literal
      • Variable
      • Function
      • Function with type parameter
      • Index signature
      • Type alias
      • Type alias with type parameter
      • Enumeration
      • Enumeration member
      • Property
      • Method
      • Interface
      • Interface with type parameter
      • Constructor
      • Property
      • Method
      • Index signature
      • Class
      • Class with type parameter
      • Constructor
      • Property
      • Method
      • Accessor
      • Index signature
      • Inherited constructor
      • Inherited property
      • Inherited method
      • Inherited accessor
      • Protected property
      • Protected method
      • Protected accessor
      • Private property
      • Private method
      • Private accessor
      • Static property
      • Static method

      Generated using TypeDoc