@octokit/types - v2.10.0

Index

Interfaces

Type aliases

Variables

Functions

Type aliases

ActionsCancelWorkflowRunEndpoint

ActionsCancelWorkflowRunEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter
run_id: number

run_id parameter

ActionsCancelWorkflowRunRequestOptions

ActionsCancelWorkflowRunRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/actions/runs/:run_id/cancel"

ActionsCreateOrUpdateSecretForRepoEndpoint

ActionsCreateOrUpdateSecretForRepoEndpoint: object

Type declaration

Optional encrypted_value?: string

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get your public key endpoint.
Optional key_id?: string

ID of the key you used to encrypt the secret.
name: string

name parameter
owner: string

owner parameter
repo: string

repo parameter

ActionsCreateOrUpdateSecretForRepoRequestOptions

ActionsCreateOrUpdateSecretForRepoRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PUT"
request: RequestRequestOptions
url: "/repos/:owner/:repo/actions/secrets/:name"

ActionsCreateRegistrationTokenEndpoint

ActionsCreateRegistrationTokenEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter

ActionsCreateRegistrationTokenRequestOptions

ActionsCreateRegistrationTokenRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/actions/runners/registration-token"

ActionsCreateRegistrationTokenResponseData

ActionsCreateRegistrationTokenResponseData: object

Type declaration

expires_at: string
token: string

ActionsCreateRemoveTokenEndpoint

ActionsCreateRemoveTokenEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter

ActionsCreateRemoveTokenRequestOptions

ActionsCreateRemoveTokenRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/actions/runners/remove-token"

ActionsCreateRemoveTokenResponseData

ActionsCreateRemoveTokenResponseData: object

Type declaration

expires_at: string
token: string

ActionsDeleteArtifactEndpoint

ActionsDeleteArtifactEndpoint: object

Type declaration

artifact_id: number

artifact_id parameter
owner: string

owner parameter
repo: string

repo parameter

ActionsDeleteArtifactRequestOptions

ActionsDeleteArtifactRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/repos/:owner/:repo/actions/artifacts/:artifact_id"

ActionsDeleteSecretFromRepoEndpoint

ActionsDeleteSecretFromRepoEndpoint: object

Type declaration

name: string

name parameter
owner: string

owner parameter
repo: string

repo parameter

ActionsDeleteSecretFromRepoRequestOptions

ActionsDeleteSecretFromRepoRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/repos/:owner/:repo/actions/secrets/:name"

ActionsDeleteWorkflowRunLogsEndpoint

ActionsDeleteWorkflowRunLogsEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter
run_id: number

run_id parameter

ActionsDeleteWorkflowRunLogsRequestOptions

ActionsDeleteWorkflowRunLogsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/repos/:owner/:repo/actions/runs/:run_id/logs"

ActionsDownloadArtifactEndpoint

ActionsDownloadArtifactEndpoint: object

Type declaration

archive_format: string

archive_format parameter
artifact_id: number

artifact_id parameter
owner: string

owner parameter
repo: string

repo parameter

ActionsDownloadArtifactRequestOptions

ActionsDownloadArtifactRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/actions/artifacts/:artifact_id/:archive_format"

ActionsGetArtifactEndpoint

ActionsGetArtifactEndpoint: object

Type declaration

artifact_id: number

artifact_id parameter
owner: string

owner parameter
repo: string

repo parameter

ActionsGetArtifactRequestOptions

ActionsGetArtifactRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/actions/artifacts/:artifact_id"

ActionsGetArtifactResponseData

ActionsGetArtifactResponseData: object

Type declaration

archive_download_url: string
created_at: string
expired: boolean
expires_at: string
id: number
name: string
node_id: string
size_in_bytes: number
url: string

ActionsGetPublicKeyEndpoint

ActionsGetPublicKeyEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter

ActionsGetPublicKeyRequestOptions

ActionsGetPublicKeyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/actions/secrets/public-key"

ActionsGetPublicKeyResponseData

ActionsGetPublicKeyResponseData: object

Type declaration

key: string
key_id: string

ActionsGetSecretEndpoint

ActionsGetSecretEndpoint: object

Type declaration

name: string

name parameter
owner: string

owner parameter
repo: string

repo parameter

ActionsGetSecretRequestOptions

ActionsGetSecretRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/actions/secrets/:name"

ActionsGetSecretResponseData

ActionsGetSecretResponseData: object

Type declaration

created_at: string
name: string
updated_at: string

ActionsGetSelfHostedRunnerEndpoint

ActionsGetSelfHostedRunnerEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter
runner_id: number

runner_id parameter

ActionsGetSelfHostedRunnerRequestOptions

ActionsGetSelfHostedRunnerRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/actions/runners/:runner_id"

ActionsGetSelfHostedRunnerResponseData

ActionsGetSelfHostedRunnerResponseData: object

Type declaration

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

ActionsGetWorkflowEndpoint

ActionsGetWorkflowEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter
workflow_id: number

workflow_id parameter

ActionsGetWorkflowJobEndpoint

ActionsGetWorkflowJobEndpoint: object

Type declaration

job_id: number

job_id parameter
owner: string

owner parameter
repo: string

repo parameter

ActionsGetWorkflowJobRequestOptions

ActionsGetWorkflowJobRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/actions/jobs/:job_id"

ActionsGetWorkflowJobResponseData

ActionsGetWorkflowJobResponseData: object

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<ActionsGetWorkflowJobResponseDataStepsItem>
url: string

ActionsGetWorkflowJobResponseDataStepsItem

ActionsGetWorkflowJobResponseDataStepsItem: object

Type declaration

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

ActionsGetWorkflowRequestOptions

ActionsGetWorkflowRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/actions/workflows/:workflow_id"

ActionsGetWorkflowResponseData

ActionsGetWorkflowResponseData: object

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

ActionsGetWorkflowRunEndpoint

ActionsGetWorkflowRunEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter
run_id: number

run_id parameter

ActionsGetWorkflowRunRequestOptions

ActionsGetWorkflowRunRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/actions/runs/:run_id"

ActionsGetWorkflowRunResponseData

ActionsGetWorkflowRunResponseData: object

Type declaration

artifacts_url: string
cancel_url: string
check_suite_url: string
conclusion: null
created_at: string
event: string
head_branch: string
head_commit: ActionsGetWorkflowRunResponseDataHeadCommit
head_repository: ActionsGetWorkflowRunResponseDataHeadRepository
head_sha: string
html_url: string
id: number
jobs_url: string
logs_url: string
node_id: string
pull_requests: Array<any>
repository: ActionsGetWorkflowRunResponseDataRepository
rerun_url: string
run_number: number
status: string
updated_at: string
url: string
workflow_url: string

ActionsGetWorkflowRunResponseDataHeadCommit

ActionsGetWorkflowRunResponseDataHeadCommit: object

Type declaration

author: ActionsGetWorkflowRunResponseDataHeadCommitAuthor
committer: ActionsGetWorkflowRunResponseDataHeadCommitCommitter
id: string
message: string
timestamp: string
tree_id: string

ActionsGetWorkflowRunResponseDataHeadCommitAuthor

ActionsGetWorkflowRunResponseDataHeadCommitAuthor: object

Type declaration

email: string
name: string

ActionsGetWorkflowRunResponseDataHeadCommitCommitter

ActionsGetWorkflowRunResponseDataHeadCommitCommitter: object

Type declaration

email: string
name: string

ActionsGetWorkflowRunResponseDataHeadRepository

ActionsGetWorkflowRunResponseDataHeadRepository: object

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: ActionsGetWorkflowRunResponseDataHeadRepositoryOwner
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

ActionsGetWorkflowRunResponseDataHeadRepositoryOwner

ActionsGetWorkflowRunResponseDataHeadRepositoryOwner: object

Type declaration

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

ActionsGetWorkflowRunResponseDataRepository

ActionsGetWorkflowRunResponseDataRepository: object

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: ActionsGetWorkflowRunResponseDataRepositoryOwner
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

ActionsGetWorkflowRunResponseDataRepositoryOwner

ActionsGetWorkflowRunResponseDataRepositoryOwner: object

Type declaration

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

ActionsListArtifactsForRepoEndpoint

ActionsListArtifactsForRepoEndpoint: object

Type declaration

owner: string

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
repo: string

repo parameter

ActionsListArtifactsForRepoRequestOptions

ActionsListArtifactsForRepoRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/actions/artifacts"

ActionsListArtifactsForRepoResponseData

ActionsListArtifactsForRepoResponseData: object

Type declaration

artifacts: Array<ActionsListArtifactsForRepoResponseDataArtifactsItem>
total_count: number

ActionsListArtifactsForRepoResponseDataArtifactsItem

ActionsListArtifactsForRepoResponseDataArtifactsItem: object

Type declaration

archive_download_url: string
created_at: string
expired: boolean
expires_at: string
id: number
name: string
node_id: string
size_in_bytes: number
url: string

ActionsListDownloadsForSelfHostedRunnerApplicationEndpoint

ActionsListDownloadsForSelfHostedRunnerApplicationEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter

ActionsListDownloadsForSelfHostedRunnerApplicationRequestOptions

ActionsListDownloadsForSelfHostedRunnerApplicationRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/actions/runners/downloads"

ActionsListDownloadsForSelfHostedRunnerApplicationResponseData

ActionsListDownloadsForSelfHostedRunnerApplicationResponseData: Array<ActionsListDownloadsForSelfHostedRunnerApplicationResponseDataItem>

ActionsListDownloadsForSelfHostedRunnerApplicationResponseDataItem

ActionsListDownloadsForSelfHostedRunnerApplicationResponseDataItem: object

Type declaration

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

ActionsListJobsForWorkflowRunEndpoint

ActionsListJobsForWorkflowRunEndpoint: object

Type declaration

Optional filter?: "latest" | "all"

Filters jobs by their completed_at timestamp. Can be one of: * latest: Returns jobs from the most recent execution of the workflow run. * all: Returns all jobs for a workflow run, including from old executions of the workflow run.
owner: string

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
repo: string

repo parameter
run_id: number

run_id parameter

ActionsListJobsForWorkflowRunRequestOptions

ActionsListJobsForWorkflowRunRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/actions/runs/:run_id/jobs"

ActionsListJobsForWorkflowRunResponseData

ActionsListJobsForWorkflowRunResponseData: object

Type declaration

jobs: Array<ActionsListJobsForWorkflowRunResponseDataJobsItem>
total_count: number

ActionsListJobsForWorkflowRunResponseDataJobsItem

ActionsListJobsForWorkflowRunResponseDataJobsItem: object

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<ActionsListJobsForWorkflowRunResponseDataJobsItemStepsItem>
url: string

ActionsListJobsForWorkflowRunResponseDataJobsItemStepsItem

ActionsListJobsForWorkflowRunResponseDataJobsItemStepsItem: object

Type declaration

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

ActionsListRepoWorkflowRunsEndpoint

ActionsListRepoWorkflowRunsEndpoint: object

Type declaration

Optional actor?: 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?: string

Returns workflow runs associated with a branch. Use the name of the branch of the push.
Optional event?: 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

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
repo: string

repo parameter
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."

ActionsListRepoWorkflowRunsRequestOptions

ActionsListRepoWorkflowRunsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/actions/runs"

ActionsListRepoWorkflowRunsResponseData

ActionsListRepoWorkflowRunsResponseData: object

Type declaration

total_count: number
workflow_runs: Array<ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItem>

ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItem

ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItem: object

Type declaration

artifacts_url: string
cancel_url: string
check_suite_url: string
conclusion: null
created_at: string
event: string
head_branch: string
head_commit: ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemHeadCommit
head_repository: ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemHeadRepository
head_sha: string
html_url: string
id: number
jobs_url: string
logs_url: string
node_id: string
pull_requests: Array<any>
repository: ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemRepository
rerun_url: string
run_number: number
status: string
updated_at: string
url: string
workflow_url: string

ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemHeadCommit

ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemHeadCommit: object

Type declaration

author: ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemHeadCommitAuthor
committer: ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemHeadCommitCommitter
id: string
message: string
timestamp: string
tree_id: string

ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemHeadCommitAuthor

ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemHeadCommitAuthor: object

Type declaration

email: string
name: string

ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemHeadCommitCommitter

ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemHeadCommitCommitter: object

Type declaration

email: string
name: string

ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemHeadRepository

ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemHeadRepository: object

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: ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemHeadRepositoryOwner
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

ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemHeadRepositoryOwner

ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemHeadRepositoryOwner: object

Type declaration

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

ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemRepository

ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemRepository: object

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: ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemRepositoryOwner
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

ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemRepositoryOwner

ActionsListRepoWorkflowRunsResponseDataWorkflowRunsItemRepositoryOwner: object

Type declaration

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

ActionsListRepoWorkflowsEndpoint

ActionsListRepoWorkflowsEndpoint: object

Type declaration

owner: string

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
repo: string

repo parameter

ActionsListRepoWorkflowsRequestOptions

ActionsListRepoWorkflowsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/actions/workflows"

ActionsListRepoWorkflowsResponseData

ActionsListRepoWorkflowsResponseData: object

Type declaration

total_count: number
workflows: Array<ActionsListRepoWorkflowsResponseDataWorkflowsItem>

ActionsListRepoWorkflowsResponseDataWorkflowsItem

ActionsListRepoWorkflowsResponseDataWorkflowsItem: object

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

ActionsListSecretsForRepoEndpoint

ActionsListSecretsForRepoEndpoint: object

Type declaration

owner: string

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
repo: string

repo parameter

ActionsListSecretsForRepoRequestOptions

ActionsListSecretsForRepoRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/actions/secrets"

ActionsListSecretsForRepoResponseData

ActionsListSecretsForRepoResponseData: object

Type declaration

secrets: Array<ActionsListSecretsForRepoResponseDataSecretsItem>
total_count: number

ActionsListSecretsForRepoResponseDataSecretsItem

ActionsListSecretsForRepoResponseDataSecretsItem: object

Type declaration

created_at: string
name: string
updated_at: string

ActionsListSelfHostedRunnersForRepoEndpoint

ActionsListSelfHostedRunnersForRepoEndpoint: object

Type declaration

owner: string

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
repo: string

repo parameter

ActionsListSelfHostedRunnersForRepoRequestOptions

ActionsListSelfHostedRunnersForRepoRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/actions/runners"

ActionsListSelfHostedRunnersForRepoResponseData

ActionsListSelfHostedRunnersForRepoResponseData: object

Type declaration

runners: Array<ActionsListSelfHostedRunnersForRepoResponseDataRunnersItem>
total_count: number

ActionsListSelfHostedRunnersForRepoResponseDataRunnersItem

ActionsListSelfHostedRunnersForRepoResponseDataRunnersItem: object

Type declaration

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

ActionsListWorkflowJobLogsEndpoint

ActionsListWorkflowJobLogsEndpoint: object

Type declaration

job_id: number

job_id parameter
owner: string

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
repo: string

repo parameter

ActionsListWorkflowJobLogsRequestOptions

ActionsListWorkflowJobLogsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/actions/jobs/:job_id/logs"

ActionsListWorkflowRunArtifactsEndpoint

ActionsListWorkflowRunArtifactsEndpoint: object

Type declaration

owner: string

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
repo: string

repo parameter
run_id: number

run_id parameter

ActionsListWorkflowRunArtifactsRequestOptions

ActionsListWorkflowRunArtifactsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/actions/runs/:run_id/artifacts"

ActionsListWorkflowRunArtifactsResponseData

ActionsListWorkflowRunArtifactsResponseData: object

Type declaration

artifacts: Array<ActionsListWorkflowRunArtifactsResponseDataArtifactsItem>
total_count: number

ActionsListWorkflowRunArtifactsResponseDataArtifactsItem

ActionsListWorkflowRunArtifactsResponseDataArtifactsItem: object

Type declaration

archive_download_url: string
created_at: string
expired: boolean
expires_at: string
id: number
name: string
node_id: string
size_in_bytes: number
url: string

ActionsListWorkflowRunLogsEndpoint

ActionsListWorkflowRunLogsEndpoint: object

Type declaration

owner: string

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
repo: string

repo parameter
run_id: number

run_id parameter

ActionsListWorkflowRunLogsRequestOptions

ActionsListWorkflowRunLogsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/actions/runs/:run_id/logs"

ActionsListWorkflowRunsEndpoint

ActionsListWorkflowRunsEndpoint: object

Type declaration

Optional actor?: 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?: string

Returns workflow runs associated with a branch. Use the name of the branch of the push.
Optional event?: 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

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
repo: string

repo parameter
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

workflow_id parameter

ActionsListWorkflowRunsRequestOptions

ActionsListWorkflowRunsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/actions/workflows/:workflow_id/runs"

ActionsListWorkflowRunsResponseData

ActionsListWorkflowRunsResponseData: object

Type declaration

total_count: number
workflow_runs: Array<ActionsListWorkflowRunsResponseDataWorkflowRunsItem>

ActionsListWorkflowRunsResponseDataWorkflowRunsItem

ActionsListWorkflowRunsResponseDataWorkflowRunsItem: object

Type declaration

artifacts_url: string
cancel_url: string
check_suite_url: string
conclusion: null
created_at: string
event: string
head_branch: string
head_commit: ActionsListWorkflowRunsResponseDataWorkflowRunsItemHeadCommit
head_repository: ActionsListWorkflowRunsResponseDataWorkflowRunsItemHeadRepository
head_sha: string
html_url: string
id: number
jobs_url: string
logs_url: string
node_id: string
pull_requests: Array<any>
repository: ActionsListWorkflowRunsResponseDataWorkflowRunsItemRepository
rerun_url: string
run_number: number
status: string
updated_at: string
url: string
workflow_url: string

ActionsListWorkflowRunsResponseDataWorkflowRunsItemHeadCommit

ActionsListWorkflowRunsResponseDataWorkflowRunsItemHeadCommit: object

Type declaration

author: ActionsListWorkflowRunsResponseDataWorkflowRunsItemHeadCommitAuthor
committer: ActionsListWorkflowRunsResponseDataWorkflowRunsItemHeadCommitCommitter
id: string
message: string
timestamp: string
tree_id: string

ActionsListWorkflowRunsResponseDataWorkflowRunsItemHeadCommitAuthor

ActionsListWorkflowRunsResponseDataWorkflowRunsItemHeadCommitAuthor: object

Type declaration

email: string
name: string

ActionsListWorkflowRunsResponseDataWorkflowRunsItemHeadCommitCommitter

ActionsListWorkflowRunsResponseDataWorkflowRunsItemHeadCommitCommitter: object

Type declaration

email: string
name: string

ActionsListWorkflowRunsResponseDataWorkflowRunsItemHeadRepository

ActionsListWorkflowRunsResponseDataWorkflowRunsItemHeadRepository: object

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: ActionsListWorkflowRunsResponseDataWorkflowRunsItemHeadRepositoryOwner
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

ActionsListWorkflowRunsResponseDataWorkflowRunsItemHeadRepositoryOwner

ActionsListWorkflowRunsResponseDataWorkflowRunsItemHeadRepositoryOwner: object

Type declaration

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

ActionsListWorkflowRunsResponseDataWorkflowRunsItemRepository

ActionsListWorkflowRunsResponseDataWorkflowRunsItemRepository: object

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: ActionsListWorkflowRunsResponseDataWorkflowRunsItemRepositoryOwner
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

ActionsListWorkflowRunsResponseDataWorkflowRunsItemRepositoryOwner

ActionsListWorkflowRunsResponseDataWorkflowRunsItemRepositoryOwner: object

Type declaration

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

ActionsReRunWorkflowEndpoint

ActionsReRunWorkflowEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter
run_id: number

run_id parameter

ActionsReRunWorkflowRequestOptions

ActionsReRunWorkflowRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/actions/runs/:run_id/rerun"

ActionsRemoveSelfHostedRunnerEndpoint

ActionsRemoveSelfHostedRunnerEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter
runner_id: number

runner_id parameter

ActionsRemoveSelfHostedRunnerRequestOptions

ActionsRemoveSelfHostedRunnerRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/repos/:owner/:repo/actions/runners/:runner_id"

ActivityCheckRepoIsStarredByAuthenticatedUserEndpoint

ActivityCheckRepoIsStarredByAuthenticatedUserEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter

ActivityCheckRepoIsStarredByAuthenticatedUserRequestOptions

ActivityCheckRepoIsStarredByAuthenticatedUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/user/starred/:owner/:repo"

ActivityCheckWatchingRepoLegacyEndpoint

ActivityCheckWatchingRepoLegacyEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter

ActivityCheckWatchingRepoLegacyRequestOptions

ActivityCheckWatchingRepoLegacyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/user/subscriptions/:owner/:repo"

ActivityDeleteRepoSubscriptionEndpoint

ActivityDeleteRepoSubscriptionEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter

ActivityDeleteRepoSubscriptionRequestOptions

ActivityDeleteRepoSubscriptionRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/repos/:owner/:repo/subscription"

ActivityDeleteThreadSubscriptionEndpoint

ActivityDeleteThreadSubscriptionEndpoint: object

Type declaration

thread_id: number

thread_id parameter

ActivityDeleteThreadSubscriptionRequestOptions

ActivityDeleteThreadSubscriptionRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/notifications/threads/:thread_id/subscription"

ActivityGetFeedsEndpoint

ActivityGetFeedsEndpoint: object

Type declaration

ActivityGetFeedsRequestOptions

ActivityGetFeedsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/feeds"

ActivityGetFeedsResponseData

ActivityGetFeedsResponseData: object

Type declaration

_links: ActivityGetFeedsResponseDataLinks
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

ActivityGetFeedsResponseDataLinks

ActivityGetFeedsResponseDataLinks: object

Type declaration

current_user: ActivityGetFeedsResponseDataLinksCurrentUser
current_user_actor: ActivityGetFeedsResponseDataLinksCurrentUserActor
current_user_organization: ActivityGetFeedsResponseDataLinksCurrentUserOrganization
current_user_organizations: Array<ActivityGetFeedsResponseDataLinksCurrentUserOrganizationsItem>
current_user_public: ActivityGetFeedsResponseDataLinksCurrentUserPublic
security_advisories: ActivityGetFeedsResponseDataLinksSecurityAdvisories
timeline: ActivityGetFeedsResponseDataLinksTimeline
user: ActivityGetFeedsResponseDataLinksUser

ActivityGetFeedsResponseDataLinksCurrentUser

ActivityGetFeedsResponseDataLinksCurrentUser: object

Type declaration

href: string
type: string

ActivityGetFeedsResponseDataLinksCurrentUserActor

ActivityGetFeedsResponseDataLinksCurrentUserActor: object

Type declaration

href: string
type: string

ActivityGetFeedsResponseDataLinksCurrentUserOrganization

ActivityGetFeedsResponseDataLinksCurrentUserOrganization: object

Type declaration

href: string
type: string

ActivityGetFeedsResponseDataLinksCurrentUserOrganizationsItem

ActivityGetFeedsResponseDataLinksCurrentUserOrganizationsItem: object

Type declaration

href: string
type: string

ActivityGetFeedsResponseDataLinksCurrentUserPublic

ActivityGetFeedsResponseDataLinksCurrentUserPublic: object

Type declaration

href: string
type: string

ActivityGetFeedsResponseDataLinksSecurityAdvisories

ActivityGetFeedsResponseDataLinksSecurityAdvisories: object

Type declaration

href: string
type: string

ActivityGetFeedsResponseDataLinksTimeline

ActivityGetFeedsResponseDataLinksTimeline: object

Type declaration

href: string
type: string

ActivityGetFeedsResponseDataLinksUser

ActivityGetFeedsResponseDataLinksUser: object

Type declaration

href: string
type: string

ActivityGetRepoSubscriptionEndpoint

ActivityGetRepoSubscriptionEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter

ActivityGetRepoSubscriptionRequestOptions

ActivityGetRepoSubscriptionRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/subscription"

ActivityGetRepoSubscriptionResponseData

ActivityGetRepoSubscriptionResponseData: object

Type declaration

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

ActivityGetThreadEndpoint

ActivityGetThreadEndpoint: object

Type declaration

thread_id: number

thread_id parameter

ActivityGetThreadRequestOptions

ActivityGetThreadRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/notifications/threads/:thread_id"

ActivityGetThreadResponseData

ActivityGetThreadResponseData: object

Type declaration

id: string
last_read_at: string
reason: string
repository: ActivityGetThreadResponseDataRepository
subject: ActivityGetThreadResponseDataSubject
unread: boolean
updated_at: string
url: string

ActivityGetThreadResponseDataRepository

ActivityGetThreadResponseDataRepository: object

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: ActivityGetThreadResponseDataRepositoryOwner
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

ActivityGetThreadResponseDataRepositoryOwner

ActivityGetThreadResponseDataRepositoryOwner: object

Type declaration

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

ActivityGetThreadResponseDataSubject

ActivityGetThreadResponseDataSubject: object

Type declaration

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

ActivityGetThreadSubscriptionForAuthenticatedUserEndpoint

ActivityGetThreadSubscriptionForAuthenticatedUserEndpoint: object

Type declaration

thread_id: number

thread_id parameter

ActivityGetThreadSubscriptionForAuthenticatedUserRequestOptions

ActivityGetThreadSubscriptionForAuthenticatedUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/notifications/threads/:thread_id/subscription"

ActivityGetThreadSubscriptionForAuthenticatedUserResponseData

ActivityGetThreadSubscriptionForAuthenticatedUserResponseData: object

Type declaration

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

ActivityListEventsForAuthenticatedUserEndpoint

ActivityListEventsForAuthenticatedUserEndpoint: object

Type declaration

Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
username: string

username parameter

ActivityListEventsForAuthenticatedUserRequestOptions

ActivityListEventsForAuthenticatedUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/users/:username/events"

ActivityListNotificationsForAuthenticatedUserEndpoint

ActivityListNotificationsForAuthenticatedUserEndpoint: object

Type declaration

Optional all?: boolean

If true, show notifications marked as read.
Optional before?: string

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

Page number of the results to fetch.
Optional participating?: boolean

If true, only shows notifications in which the user is directly participating or mentioned.
Optional per_page?: number

Results per page (max 100)
Optional since?: string

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

ActivityListNotificationsForAuthenticatedUserRequestOptions

ActivityListNotificationsForAuthenticatedUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/notifications"

ActivityListNotificationsForAuthenticatedUserResponseData

ActivityListNotificationsForAuthenticatedUserResponseData: Array<ActivityListNotificationsForAuthenticatedUserResponseDataItem>

ActivityListNotificationsForAuthenticatedUserResponseDataItem

ActivityListNotificationsForAuthenticatedUserResponseDataItem: object

Type declaration

id: string
last_read_at: string
reason: string
repository: ActivityListNotificationsForAuthenticatedUserResponseDataItemRepository
subject: ActivityListNotificationsForAuthenticatedUserResponseDataItemSubject
unread: boolean
updated_at: string
url: string

ActivityListNotificationsForAuthenticatedUserResponseDataItemRepository

ActivityListNotificationsForAuthenticatedUserResponseDataItemRepository: object

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: ActivityListNotificationsForAuthenticatedUserResponseDataItemRepositoryOwner
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

ActivityListNotificationsForAuthenticatedUserResponseDataItemRepositoryOwner

ActivityListNotificationsForAuthenticatedUserResponseDataItemRepositoryOwner: object

Type declaration

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

ActivityListNotificationsForAuthenticatedUserResponseDataItemSubject

ActivityListNotificationsForAuthenticatedUserResponseDataItemSubject: object

Type declaration

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

ActivityListOrgEventsForAuthenticatedUserEndpoint

ActivityListOrgEventsForAuthenticatedUserEndpoint: object

Type declaration

org: string

org parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
username: string

username parameter

ActivityListOrgEventsForAuthenticatedUserRequestOptions

ActivityListOrgEventsForAuthenticatedUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/users/:username/events/orgs/:org"

ActivityListPublicEventsEndpoint

ActivityListPublicEventsEndpoint: object

Type declaration

Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)

ActivityListPublicEventsForRepoNetworkEndpoint

ActivityListPublicEventsForRepoNetworkEndpoint: object

Type declaration

owner: string

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
repo: string

repo parameter

ActivityListPublicEventsForRepoNetworkRequestOptions

ActivityListPublicEventsForRepoNetworkRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/networks/:owner/:repo/events"

ActivityListPublicEventsForUserEndpoint

ActivityListPublicEventsForUserEndpoint: object

Type declaration

Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
username: string

username parameter

ActivityListPublicEventsForUserRequestOptions

ActivityListPublicEventsForUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/users/:username/events/public"

ActivityListPublicEventsRequestOptions

ActivityListPublicEventsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/events"

ActivityListPublicOrgEventsEndpoint

ActivityListPublicOrgEventsEndpoint: object

Type declaration

org: string

org parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)

ActivityListPublicOrgEventsRequestOptions

ActivityListPublicOrgEventsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/orgs/:org/events"

ActivityListReceivedEventsForUserEndpoint

ActivityListReceivedEventsForUserEndpoint: object

Type declaration

Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
username: string

username parameter

ActivityListReceivedEventsForUserRequestOptions

ActivityListReceivedEventsForUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/users/:username/received_events"

ActivityListReceivedPublicEventsForUserEndpoint

ActivityListReceivedPublicEventsForUserEndpoint: object

Type declaration

Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
username: string

username parameter

ActivityListReceivedPublicEventsForUserRequestOptions

ActivityListReceivedPublicEventsForUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/users/:username/received_events/public"

ActivityListRepoEventsEndpoint

ActivityListRepoEventsEndpoint: object

Type declaration

owner: string

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
repo: string

repo parameter

ActivityListRepoEventsRequestOptions

ActivityListRepoEventsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/events"

ActivityListRepoNotificationsForAuthenticatedUserEndpoint

ActivityListRepoNotificationsForAuthenticatedUserEndpoint: object

Type declaration

Optional all?: boolean

If true, show notifications marked as read.
Optional before?: string

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

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional participating?: boolean

If true, only shows notifications in which the user is directly participating or mentioned.
Optional per_page?: number

Results per page (max 100)
repo: string

repo parameter
Optional since?: string

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

ActivityListRepoNotificationsForAuthenticatedUserRequestOptions

ActivityListRepoNotificationsForAuthenticatedUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/notifications"

ActivityListRepoNotificationsForAuthenticatedUserResponseData

ActivityListRepoNotificationsForAuthenticatedUserResponseData: Array<ActivityListRepoNotificationsForAuthenticatedUserResponseDataItem>

ActivityListRepoNotificationsForAuthenticatedUserResponseDataItem

ActivityListRepoNotificationsForAuthenticatedUserResponseDataItem: object

Type declaration

id: string
last_read_at: string
reason: string
repository: ActivityListRepoNotificationsForAuthenticatedUserResponseDataItemRepository
subject: ActivityListRepoNotificationsForAuthenticatedUserResponseDataItemSubject
unread: boolean
updated_at: string
url: string

ActivityListRepoNotificationsForAuthenticatedUserResponseDataItemRepository

ActivityListRepoNotificationsForAuthenticatedUserResponseDataItemRepository: object

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: ActivityListRepoNotificationsForAuthenticatedUserResponseDataItemRepositoryOwner
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

ActivityListRepoNotificationsForAuthenticatedUserResponseDataItemRepositoryOwner

ActivityListRepoNotificationsForAuthenticatedUserResponseDataItemRepositoryOwner: object

Type declaration

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

ActivityListRepoNotificationsForAuthenticatedUserResponseDataItemSubject

ActivityListRepoNotificationsForAuthenticatedUserResponseDataItemSubject: object

Type declaration

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

ActivityListReposStarredByAuthenticatedUserEndpoint

ActivityListReposStarredByAuthenticatedUserEndpoint: object

Type declaration

Optional direction?: "asc" | "desc"

One of asc (ascending) or desc (descending).
Optional page?: number

Page number of the results to fetch.
Optional per_page?: 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).

ActivityListReposStarredByAuthenticatedUserRequestOptions

ActivityListReposStarredByAuthenticatedUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/user/starred"

ActivityListReposStarredByAuthenticatedUserResponseData

ActivityListReposStarredByAuthenticatedUserResponseData: Array<ActivityListReposStarredByAuthenticatedUserResponseDataItem>

ActivityListReposStarredByAuthenticatedUserResponseDataItem

ActivityListReposStarredByAuthenticatedUserResponseDataItem: object

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: ActivityListReposStarredByAuthenticatedUserResponseDataItemOwner
permissions: ActivityListReposStarredByAuthenticatedUserResponseDataItemPermissions
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

ActivityListReposStarredByAuthenticatedUserResponseDataItemOwner

ActivityListReposStarredByAuthenticatedUserResponseDataItemOwner: object

Type declaration

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

ActivityListReposStarredByAuthenticatedUserResponseDataItemPermissions

ActivityListReposStarredByAuthenticatedUserResponseDataItemPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

ActivityListReposStarredByUserEndpoint

ActivityListReposStarredByUserEndpoint: object

Type declaration

Optional direction?: "asc" | "desc"

One of asc (ascending) or desc (descending).
Optional page?: number

Page number of the results to fetch.
Optional per_page?: 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

username parameter

ActivityListReposStarredByUserRequestOptions

ActivityListReposStarredByUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/users/:username/starred"

ActivityListReposStarredByUserResponseData

ActivityListReposStarredByUserResponseData: Array<ActivityListReposStarredByUserResponseDataItem>

ActivityListReposStarredByUserResponseDataItem

ActivityListReposStarredByUserResponseDataItem: object

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: ActivityListReposStarredByUserResponseDataItemOwner
permissions: ActivityListReposStarredByUserResponseDataItemPermissions
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

ActivityListReposStarredByUserResponseDataItemOwner

ActivityListReposStarredByUserResponseDataItemOwner: object

Type declaration

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

ActivityListReposStarredByUserResponseDataItemPermissions

ActivityListReposStarredByUserResponseDataItemPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

ActivityListReposWatchedByUserEndpoint

ActivityListReposWatchedByUserEndpoint: object

Type declaration

Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
username: string

username parameter

ActivityListReposWatchedByUserRequestOptions

ActivityListReposWatchedByUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/users/:username/subscriptions"

ActivityListReposWatchedByUserResponseData

ActivityListReposWatchedByUserResponseData: Array<ActivityListReposWatchedByUserResponseDataItem>

ActivityListReposWatchedByUserResponseDataItem

ActivityListReposWatchedByUserResponseDataItem: object

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: ActivityListReposWatchedByUserResponseDataItemLicense
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: ActivityListReposWatchedByUserResponseDataItemOwner
permissions: ActivityListReposWatchedByUserResponseDataItemPermissions
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

ActivityListReposWatchedByUserResponseDataItemLicense

ActivityListReposWatchedByUserResponseDataItemLicense: object

Type declaration

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

ActivityListReposWatchedByUserResponseDataItemOwner

ActivityListReposWatchedByUserResponseDataItemOwner: object

Type declaration

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

ActivityListReposWatchedByUserResponseDataItemPermissions

ActivityListReposWatchedByUserResponseDataItemPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

ActivityListStargazersForRepoEndpoint

ActivityListStargazersForRepoEndpoint: object

Type declaration

owner: string

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
repo: string

repo parameter

ActivityListStargazersForRepoRequestOptions

ActivityListStargazersForRepoRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/stargazers"

ActivityListStargazersForRepoResponseData

ActivityListStargazersForRepoResponseData: Array<ActivityListStargazersForRepoResponseDataItem>

ActivityListStargazersForRepoResponseDataItem

ActivityListStargazersForRepoResponseDataItem: object

Type declaration

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

ActivityListWatchedReposForAuthenticatedUserEndpoint

ActivityListWatchedReposForAuthenticatedUserEndpoint: object

Type declaration

Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)

ActivityListWatchedReposForAuthenticatedUserRequestOptions

ActivityListWatchedReposForAuthenticatedUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/user/subscriptions"

ActivityListWatchedReposForAuthenticatedUserResponseData

ActivityListWatchedReposForAuthenticatedUserResponseData: Array<ActivityListWatchedReposForAuthenticatedUserResponseDataItem>

ActivityListWatchedReposForAuthenticatedUserResponseDataItem

ActivityListWatchedReposForAuthenticatedUserResponseDataItem: object

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: ActivityListWatchedReposForAuthenticatedUserResponseDataItemLicense
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: ActivityListWatchedReposForAuthenticatedUserResponseDataItemOwner
permissions: ActivityListWatchedReposForAuthenticatedUserResponseDataItemPermissions
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

ActivityListWatchedReposForAuthenticatedUserResponseDataItemLicense

ActivityListWatchedReposForAuthenticatedUserResponseDataItemLicense: object

Type declaration

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

ActivityListWatchedReposForAuthenticatedUserResponseDataItemOwner

ActivityListWatchedReposForAuthenticatedUserResponseDataItemOwner: object

Type declaration

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

ActivityListWatchedReposForAuthenticatedUserResponseDataItemPermissions

ActivityListWatchedReposForAuthenticatedUserResponseDataItemPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

ActivityListWatchersForRepoEndpoint

ActivityListWatchersForRepoEndpoint: object

Type declaration

owner: string

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
repo: string

repo parameter

ActivityListWatchersForRepoRequestOptions

ActivityListWatchersForRepoRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/subscribers"

ActivityListWatchersForRepoResponseData

ActivityListWatchersForRepoResponseData: Array<ActivityListWatchersForRepoResponseDataItem>

ActivityListWatchersForRepoResponseDataItem

ActivityListWatchersForRepoResponseDataItem: object

Type declaration

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

ActivityMarkNotificationsAsReadEndpoint

ActivityMarkNotificationsAsReadEndpoint: object

Type declaration

Optional last_read_at?: string

Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

ActivityMarkNotificationsAsReadRequestOptions

ActivityMarkNotificationsAsReadRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PUT"
request: RequestRequestOptions
url: "/notifications"

ActivityMarkRepoNotificationsAsReadEndpoint

ActivityMarkRepoNotificationsAsReadEndpoint: object

Type declaration

Optional last_read_at?: string

Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.
owner: string

owner parameter
repo: string

repo parameter

ActivityMarkRepoNotificationsAsReadRequestOptions

ActivityMarkRepoNotificationsAsReadRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PUT"
request: RequestRequestOptions
url: "/repos/:owner/:repo/notifications"

ActivityMarkThreadAsReadEndpoint

ActivityMarkThreadAsReadEndpoint: object

Type declaration

thread_id: number

thread_id parameter

ActivityMarkThreadAsReadRequestOptions

ActivityMarkThreadAsReadRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PATCH"
request: RequestRequestOptions
url: "/notifications/threads/:thread_id"

ActivitySetRepoSubscriptionEndpoint

ActivitySetRepoSubscriptionEndpoint: object

Type declaration

Optional ignored?: boolean

Determines if all notifications should be blocked from this repository.
owner: string

owner parameter
repo: string

repo parameter
Optional subscribed?: boolean

Determines if notifications should be received from this repository.

ActivitySetRepoSubscriptionRequestOptions

ActivitySetRepoSubscriptionRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PUT"
request: RequestRequestOptions
url: "/repos/:owner/:repo/subscription"

ActivitySetRepoSubscriptionResponseData

ActivitySetRepoSubscriptionResponseData: object

Type declaration

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

ActivitySetThreadSubscriptionEndpoint

ActivitySetThreadSubscriptionEndpoint: object

Type declaration

Optional ignored?: boolean

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

thread_id parameter

ActivitySetThreadSubscriptionRequestOptions

ActivitySetThreadSubscriptionRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PUT"
request: RequestRequestOptions
url: "/notifications/threads/:thread_id/subscription"

ActivitySetThreadSubscriptionResponseData

ActivitySetThreadSubscriptionResponseData: object

Type declaration

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

ActivityStarRepoForAuthenticatedUserEndpoint

ActivityStarRepoForAuthenticatedUserEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter

ActivityStarRepoForAuthenticatedUserRequestOptions

ActivityStarRepoForAuthenticatedUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PUT"
request: RequestRequestOptions
url: "/user/starred/:owner/:repo"

ActivityStopWatchingRepoLegacyEndpoint

ActivityStopWatchingRepoLegacyEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter

ActivityStopWatchingRepoLegacyRequestOptions

ActivityStopWatchingRepoLegacyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/user/subscriptions/:owner/:repo"

ActivityUnstarRepoForAuthenticatedUserEndpoint

ActivityUnstarRepoForAuthenticatedUserEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter

ActivityUnstarRepoForAuthenticatedUserRequestOptions

ActivityUnstarRepoForAuthenticatedUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/user/starred/:owner/:repo"

ActivityWatchRepoLegacyEndpoint

ActivityWatchRepoLegacyEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter

ActivityWatchRepoLegacyRequestOptions

ActivityWatchRepoLegacyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PUT"
request: RequestRequestOptions
url: "/user/subscriptions/:owner/:repo"

AnyFunction

AnyFunction: function

Type declaration

- (...args: any[]): any
- Parameters
  - Rest ...args: any[]
  Returns any

AppsAddRepoToInstallationEndpoint

AppsAddRepoToInstallationEndpoint: object & RequiredPreview<"machine-man">

AppsAddRepoToInstallationRequestOptions

AppsAddRepoToInstallationRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PUT"
request: RequestRequestOptions
url: "/user/installations/:installation_id/repositories/:repository_id"

AppsCheckAuthorizationEndpoint

AppsCheckAuthorizationEndpoint: object

Type declaration

access_token: string

access_token parameter
client_id: string

client_id parameter

AppsCheckAuthorizationRequestOptions

AppsCheckAuthorizationRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/applications/:client_id/tokens/:access_token"

AppsCheckAuthorizationResponseData

AppsCheckAuthorizationResponseData: object

Type declaration

app: AppsCheckAuthorizationResponseDataApp
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: AppsCheckAuthorizationResponseDataUser

AppsCheckAuthorizationResponseDataApp

AppsCheckAuthorizationResponseDataApp: object

Type declaration

client_id: string
name: string
url: string

AppsCheckAuthorizationResponseDataUser

AppsCheckAuthorizationResponseDataUser: object

Type declaration

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

AppsCheckTokenEndpoint

AppsCheckTokenEndpoint: object

Type declaration

Optional access_token?: string

The OAuth access token used to authenticate to the GitHub API.
client_id: string

client_id parameter

AppsCheckTokenRequestOptions

AppsCheckTokenRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/applications/:client_id/token"

AppsCheckTokenResponseData

AppsCheckTokenResponseData: object

Type declaration

app: AppsCheckTokenResponseDataApp
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: AppsCheckTokenResponseDataUser

AppsCheckTokenResponseDataApp

AppsCheckTokenResponseDataApp: object

Type declaration

client_id: string
name: string
url: string

AppsCheckTokenResponseDataUser

AppsCheckTokenResponseDataUser: object

Type declaration

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

AppsCreateContentAttachmentEndpoint

AppsCreateContentAttachmentEndpoint: object & RequiredPreview<"corsair">

AppsCreateContentAttachmentRequestOptions

AppsCreateContentAttachmentRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/content_references/:content_reference_id/attachments"

AppsCreateContentAttachmentResponseData

AppsCreateContentAttachmentResponseData: object

Type declaration

body: string
id: number
title: string

AppsCreateFromManifestEndpoint

AppsCreateFromManifestEndpoint: object

Type declaration

code: string

code parameter

AppsCreateFromManifestRequestOptions

AppsCreateFromManifestRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/app-manifests/:code/conversions"

AppsCreateFromManifestResponseData

AppsCreateFromManifestResponseData: object

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: AppsCreateFromManifestResponseDataOwner
pem: string
updated_at: string
webhook_secret: string

AppsCreateFromManifestResponseDataOwner

AppsCreateFromManifestResponseDataOwner: object

Type declaration

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

AppsCreateInstallationTokenEndpoint

AppsCreateInstallationTokenEndpoint: object & RequiredPreview<"machine-man">

AppsCreateInstallationTokenParamsPermissions

AppsCreateInstallationTokenParamsPermissions: object

Type declaration

AppsCreateInstallationTokenRequestOptions

AppsCreateInstallationTokenRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/app/installations/:installation_id/access_tokens"

AppsCreateInstallationTokenResponseData

AppsCreateInstallationTokenResponseData: object

Type declaration

expires_at: string
permissions: AppsCreateInstallationTokenResponseDataPermissions
repositories: Array<AppsCreateInstallationTokenResponseDataRepositoriesItem>
token: string

AppsCreateInstallationTokenResponseDataPermissions

AppsCreateInstallationTokenResponseDataPermissions: object

Type declaration

contents: string
issues: string

AppsCreateInstallationTokenResponseDataRepositoriesItem

AppsCreateInstallationTokenResponseDataRepositoriesItem: object

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: AppsCreateInstallationTokenResponseDataRepositoriesItemOwner
permissions: AppsCreateInstallationTokenResponseDataRepositoriesItemPermissions
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

AppsCreateInstallationTokenResponseDataRepositoriesItemOwner

AppsCreateInstallationTokenResponseDataRepositoriesItemOwner: object

Type declaration

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

AppsCreateInstallationTokenResponseDataRepositoriesItemPermissions

AppsCreateInstallationTokenResponseDataRepositoriesItemPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

AppsDeleteAuthorizationEndpoint

AppsDeleteAuthorizationEndpoint: object

Type declaration

Optional access_token?: string

The OAuth access token used to authenticate to the GitHub API.
client_id: string

client_id parameter

AppsDeleteAuthorizationRequestOptions

AppsDeleteAuthorizationRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/applications/:client_id/grant"

AppsDeleteInstallationEndpoint

AppsDeleteInstallationEndpoint: object & RequiredPreview<"machine-man">

AppsDeleteInstallationRequestOptions

AppsDeleteInstallationRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/app/installations/:installation_id"

AppsDeleteTokenEndpoint

AppsDeleteTokenEndpoint: object

Type declaration

Optional access_token?: string

The OAuth access token used to authenticate to the GitHub API.
client_id: string

client_id parameter

AppsDeleteTokenRequestOptions

AppsDeleteTokenRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/applications/:client_id/token"

AppsGetAuthenticatedEndpoint

AppsGetAuthenticatedEndpoint: __type & RequiredPreview<"machine-man">

AppsGetAuthenticatedRequestOptions

AppsGetAuthenticatedRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/app"

AppsGetAuthenticatedResponseData

AppsGetAuthenticatedResponseData: object

Type declaration

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: AppsGetAuthenticatedResponseDataOwner
permissions: AppsGetAuthenticatedResponseDataPermissions
slug: string
updated_at: string

AppsGetAuthenticatedResponseDataOwner

AppsGetAuthenticatedResponseDataOwner: object

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

AppsGetAuthenticatedResponseDataPermissions

AppsGetAuthenticatedResponseDataPermissions: object

Type declaration

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

AppsGetBySlugEndpoint

AppsGetBySlugEndpoint: object & RequiredPreview<"machine-man">

AppsGetBySlugRequestOptions

AppsGetBySlugRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/apps/:app_slug"

AppsGetBySlugResponseData

AppsGetBySlugResponseData: object

Type declaration

created_at: string
description: string
events: Array<string>
external_url: string
html_url: string
id: number
name: string
node_id: string
owner: AppsGetBySlugResponseDataOwner
permissions: AppsGetBySlugResponseDataPermissions
slug: string
updated_at: string

AppsGetBySlugResponseDataOwner

AppsGetBySlugResponseDataOwner: object

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

AppsGetBySlugResponseDataPermissions

AppsGetBySlugResponseDataPermissions: object

Type declaration

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

AppsGetInstallationEndpoint

AppsGetInstallationEndpoint: object & RequiredPreview<"machine-man">

AppsGetInstallationRequestOptions

AppsGetInstallationRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/app/installations/:installation_id"

AppsGetInstallationResponseData

AppsGetInstallationResponseData: object

Type declaration

access_tokens_url: string
account: AppsGetInstallationResponseDataAccount
app_id: number
events: Array<string>
html_url: string
id: number
permissions: AppsGetInstallationResponseDataPermissions
repositories_url: string
repository_selection: string
single_file_name: string
target_id: number
target_type: string

AppsGetInstallationResponseDataAccount

AppsGetInstallationResponseDataAccount: object

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

AppsGetInstallationResponseDataPermissions

AppsGetInstallationResponseDataPermissions: object

Type declaration

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

AppsGetOrgInstallationEndpoint

AppsGetOrgInstallationEndpoint: object & RequiredPreview<"machine-man">

AppsGetOrgInstallationRequestOptions

AppsGetOrgInstallationRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/orgs/:org/installation"

AppsGetOrgInstallationResponseData

AppsGetOrgInstallationResponseData: object

Type declaration

access_tokens_url: string
account: AppsGetOrgInstallationResponseDataAccount
app_id: number
created_at: string
events: Array<string>
html_url: string
id: number
permissions: AppsGetOrgInstallationResponseDataPermissions
repositories_url: string
repository_selection: string
single_file_name: null
target_id: number
target_type: string
updated_at: string

AppsGetOrgInstallationResponseDataAccount

AppsGetOrgInstallationResponseDataAccount: object

Type declaration

avatar_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

AppsGetOrgInstallationResponseDataPermissions

AppsGetOrgInstallationResponseDataPermissions: object

Type declaration

checks: string
contents: string
metadata: string

AppsGetRepoInstallationEndpoint

AppsGetRepoInstallationEndpoint: object & RequiredPreview<"machine-man">

AppsGetRepoInstallationRequestOptions

AppsGetRepoInstallationRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/installation"

AppsGetRepoInstallationResponseData

AppsGetRepoInstallationResponseData: object

Type declaration

access_tokens_url: string
account: AppsGetRepoInstallationResponseDataAccount
app_id: number
created_at: string
events: Array<string>
html_url: string
id: number
permissions: AppsGetRepoInstallationResponseDataPermissions
repositories_url: string
repository_selection: string
single_file_name: null
target_id: number
target_type: string
updated_at: string

AppsGetRepoInstallationResponseDataAccount

AppsGetRepoInstallationResponseDataAccount: object

Type declaration

avatar_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

AppsGetRepoInstallationResponseDataPermissions

AppsGetRepoInstallationResponseDataPermissions: object

Type declaration

checks: string
contents: string
metadata: string

AppsGetSubscriptionPlanForAccountEndpoint

AppsGetSubscriptionPlanForAccountEndpoint: object

Type declaration

account_id: number

account_id parameter

AppsGetSubscriptionPlanForAccountRequestOptions

AppsGetSubscriptionPlanForAccountRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/marketplace_listing/accounts/:account_id"

AppsGetSubscriptionPlanForAccountResponseData

AppsGetSubscriptionPlanForAccountResponseData: object

Type declaration

email: null
id: number
login: string
marketplace_pending_change: AppsGetSubscriptionPlanForAccountResponseDataMarketplacePendingChange
marketplace_purchase: AppsGetSubscriptionPlanForAccountResponseDataMarketplacePurchase
organization_billing_email: string
type: string
url: string

AppsGetSubscriptionPlanForAccountResponseDataMarketplacePendingChange

AppsGetSubscriptionPlanForAccountResponseDataMarketplacePendingChange: object

Type declaration

effective_date: string
id: number
plan: AppsGetSubscriptionPlanForAccountResponseDataMarketplacePendingChangePlan
unit_count: null

AppsGetSubscriptionPlanForAccountResponseDataMarketplacePendingChangePlan

AppsGetSubscriptionPlanForAccountResponseDataMarketplacePendingChangePlan: object

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

AppsGetSubscriptionPlanForAccountResponseDataMarketplacePurchase

AppsGetSubscriptionPlanForAccountResponseDataMarketplacePurchase: object

Type declaration

billing_cycle: string
free_trial_ends_on: string
next_billing_date: string
on_free_trial: boolean
plan: AppsGetSubscriptionPlanForAccountResponseDataMarketplacePurchasePlan
unit_count: null
updated_at: string

AppsGetSubscriptionPlanForAccountResponseDataMarketplacePurchasePlan

AppsGetSubscriptionPlanForAccountResponseDataMarketplacePurchasePlan: object

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

AppsGetSubscriptionPlanForAccountStubbedEndpoint

AppsGetSubscriptionPlanForAccountStubbedEndpoint: object

Type declaration

account_id: number

account_id parameter

AppsGetSubscriptionPlanForAccountStubbedRequestOptions

AppsGetSubscriptionPlanForAccountStubbedRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/marketplace_listing/stubbed/accounts/:account_id"

AppsGetSubscriptionPlanForAccountStubbedResponseData

AppsGetSubscriptionPlanForAccountStubbedResponseData: object

Type declaration

email: null
id: number
login: string
marketplace_pending_change: AppsGetSubscriptionPlanForAccountStubbedResponseDataMarketplacePendingChange
marketplace_purchase: AppsGetSubscriptionPlanForAccountStubbedResponseDataMarketplacePurchase
organization_billing_email: string
type: string
url: string

AppsGetSubscriptionPlanForAccountStubbedResponseDataMarketplacePendingChange

AppsGetSubscriptionPlanForAccountStubbedResponseDataMarketplacePendingChange: object

Type declaration

effective_date: string
id: number
plan: AppsGetSubscriptionPlanForAccountStubbedResponseDataMarketplacePendingChangePlan
unit_count: null

AppsGetSubscriptionPlanForAccountStubbedResponseDataMarketplacePendingChangePlan

AppsGetSubscriptionPlanForAccountStubbedResponseDataMarketplacePendingChangePlan: object

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

AppsGetSubscriptionPlanForAccountStubbedResponseDataMarketplacePurchase

AppsGetSubscriptionPlanForAccountStubbedResponseDataMarketplacePurchase: object

Type declaration

billing_cycle: string
free_trial_ends_on: string
next_billing_date: string
on_free_trial: boolean
plan: AppsGetSubscriptionPlanForAccountStubbedResponseDataMarketplacePurchasePlan
unit_count: null
updated_at: string

AppsGetSubscriptionPlanForAccountStubbedResponseDataMarketplacePurchasePlan

AppsGetSubscriptionPlanForAccountStubbedResponseDataMarketplacePurchasePlan: object

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

AppsGetUserInstallationEndpoint

AppsGetUserInstallationEndpoint: object & RequiredPreview<"machine-man">

AppsGetUserInstallationRequestOptions

AppsGetUserInstallationRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/users/:username/installation"

AppsGetUserInstallationResponseData

AppsGetUserInstallationResponseData: object

Type declaration

access_tokens_url: string
account: AppsGetUserInstallationResponseDataAccount
app_id: number
created_at: string
events: Array<string>
html_url: string
id: number
permissions: AppsGetUserInstallationResponseDataPermissions
repositories_url: string
repository_selection: string
single_file_name: null
target_id: number
target_type: string
updated_at: string

AppsGetUserInstallationResponseDataAccount

AppsGetUserInstallationResponseDataAccount: object

Type declaration

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

AppsGetUserInstallationResponseDataPermissions

AppsGetUserInstallationResponseDataPermissions: object

Type declaration

checks: string
contents: string
metadata: string

AppsListAccountsForPlanEndpoint

AppsListAccountsForPlanEndpoint: object

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?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
plan_id: number

plan_id parameter
Optional sort?: "created" | "updated"

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

AppsListAccountsForPlanRequestOptions

AppsListAccountsForPlanRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/marketplace_listing/plans/:plan_id/accounts"

AppsListAccountsForPlanResponseData

AppsListAccountsForPlanResponseData: Array<AppsListAccountsForPlanResponseDataItem>

AppsListAccountsForPlanResponseDataItem

AppsListAccountsForPlanResponseDataItem: object

Type declaration

email: null
id: number
login: string
marketplace_pending_change: AppsListAccountsForPlanResponseDataItemMarketplacePendingChange
marketplace_purchase: AppsListAccountsForPlanResponseDataItemMarketplacePurchase
organization_billing_email: string
type: string
url: string

AppsListAccountsForPlanResponseDataItemMarketplacePendingChange

AppsListAccountsForPlanResponseDataItemMarketplacePendingChange: object

Type declaration

effective_date: string
id: number
plan: AppsListAccountsForPlanResponseDataItemMarketplacePendingChangePlan
unit_count: null

AppsListAccountsForPlanResponseDataItemMarketplacePendingChangePlan

AppsListAccountsForPlanResponseDataItemMarketplacePendingChangePlan: object

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

AppsListAccountsForPlanResponseDataItemMarketplacePurchase

AppsListAccountsForPlanResponseDataItemMarketplacePurchase: object

Type declaration

billing_cycle: string
free_trial_ends_on: string
next_billing_date: string
on_free_trial: boolean
plan: AppsListAccountsForPlanResponseDataItemMarketplacePurchasePlan
unit_count: null
updated_at: string

AppsListAccountsForPlanResponseDataItemMarketplacePurchasePlan

AppsListAccountsForPlanResponseDataItemMarketplacePurchasePlan: object

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

AppsListAccountsForPlanStubbedEndpoint

AppsListAccountsForPlanStubbedEndpoint: object

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?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
plan_id: number

plan_id parameter
Optional sort?: "created" | "updated"

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

AppsListAccountsForPlanStubbedRequestOptions

AppsListAccountsForPlanStubbedRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/marketplace_listing/stubbed/plans/:plan_id/accounts"

AppsListAccountsForPlanStubbedResponseData

AppsListAccountsForPlanStubbedResponseData: Array<AppsListAccountsForPlanStubbedResponseDataItem>

AppsListAccountsForPlanStubbedResponseDataItem

AppsListAccountsForPlanStubbedResponseDataItem: object

Type declaration

email: null
id: number
login: string
marketplace_pending_change: AppsListAccountsForPlanStubbedResponseDataItemMarketplacePendingChange
marketplace_purchase: AppsListAccountsForPlanStubbedResponseDataItemMarketplacePurchase
organization_billing_email: string
type: string
url: string

AppsListAccountsForPlanStubbedResponseDataItemMarketplacePendingChange

AppsListAccountsForPlanStubbedResponseDataItemMarketplacePendingChange: object

Type declaration

effective_date: string
id: number
plan: AppsListAccountsForPlanStubbedResponseDataItemMarketplacePendingChangePlan
unit_count: null

AppsListAccountsForPlanStubbedResponseDataItemMarketplacePendingChangePlan

AppsListAccountsForPlanStubbedResponseDataItemMarketplacePendingChangePlan: object

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

AppsListAccountsForPlanStubbedResponseDataItemMarketplacePurchase

AppsListAccountsForPlanStubbedResponseDataItemMarketplacePurchase: object

Type declaration

billing_cycle: string
free_trial_ends_on: string
next_billing_date: string
on_free_trial: boolean
plan: AppsListAccountsForPlanStubbedResponseDataItemMarketplacePurchasePlan
unit_count: null
updated_at: string

AppsListAccountsForPlanStubbedResponseDataItemMarketplacePurchasePlan

AppsListAccountsForPlanStubbedResponseDataItemMarketplacePurchasePlan: object

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

AppsListInstallationReposForAuthenticatedUserEndpoint

AppsListInstallationReposForAuthenticatedUserEndpoint: object & RequiredPreview<"machine-man">

AppsListInstallationReposForAuthenticatedUserRequestOptions

AppsListInstallationReposForAuthenticatedUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/user/installations/:installation_id/repositories"

AppsListInstallationReposForAuthenticatedUserResponseData

AppsListInstallationReposForAuthenticatedUserResponseData: object

Type declaration

repositories: Array<AppsListInstallationReposForAuthenticatedUserResponseDataRepositoriesItem>
total_count: number

AppsListInstallationReposForAuthenticatedUserResponseDataRepositoriesItem

AppsListInstallationReposForAuthenticatedUserResponseDataRepositoriesItem: object

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: AppsListInstallationReposForAuthenticatedUserResponseDataRepositoriesItemOwner
permissions: AppsListInstallationReposForAuthenticatedUserResponseDataRepositoriesItemPermissions
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

AppsListInstallationReposForAuthenticatedUserResponseDataRepositoriesItemOwner

AppsListInstallationReposForAuthenticatedUserResponseDataRepositoriesItemOwner: object

Type declaration

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

AppsListInstallationReposForAuthenticatedUserResponseDataRepositoriesItemPermissions

AppsListInstallationReposForAuthenticatedUserResponseDataRepositoriesItemPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

AppsListInstallationsEndpoint

AppsListInstallationsEndpoint: object & RequiredPreview<"machine-man">

AppsListInstallationsForAuthenticatedUserEndpoint

AppsListInstallationsForAuthenticatedUserEndpoint: object & RequiredPreview<"machine-man">

AppsListInstallationsForAuthenticatedUserRequestOptions

AppsListInstallationsForAuthenticatedUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/user/installations"

AppsListInstallationsForAuthenticatedUserResponseData

AppsListInstallationsForAuthenticatedUserResponseData: object

Type declaration

installations: Array<AppsListInstallationsForAuthenticatedUserResponseDataInstallationsItem>
total_count: number

AppsListInstallationsForAuthenticatedUserResponseDataInstallationsItem

AppsListInstallationsForAuthenticatedUserResponseDataInstallationsItem: object

Type declaration

access_tokens_url: string
account: AppsListInstallationsForAuthenticatedUserResponseDataInstallationsItemAccount
app_id: number
events: Array<string>
html_url: string
id: number
permissions: AppsListInstallationsForAuthenticatedUserResponseDataInstallationsItemPermissions
repositories_url: string
single_file_name: string
target_id: number
target_type: string

AppsListInstallationsForAuthenticatedUserResponseDataInstallationsItemAccount

AppsListInstallationsForAuthenticatedUserResponseDataInstallationsItemAccount: object

Type declaration

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

AppsListInstallationsForAuthenticatedUserResponseDataInstallationsItemPermissions

AppsListInstallationsForAuthenticatedUserResponseDataInstallationsItemPermissions: object

Type declaration

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

AppsListInstallationsRequestOptions

AppsListInstallationsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/app/installations"

AppsListInstallationsResponseData

AppsListInstallationsResponseData: Array<AppsListInstallationsResponseDataItem>

AppsListInstallationsResponseDataItem

AppsListInstallationsResponseDataItem: object

Type declaration

access_tokens_url: string
account: AppsListInstallationsResponseDataItemAccount
app_id: number
events: Array<string>
html_url: string
id: number
permissions: AppsListInstallationsResponseDataItemPermissions
repositories_url: string
repository_selection: string
single_file_name: string
target_id: number
target_type: string

AppsListInstallationsResponseDataItemAccount

AppsListInstallationsResponseDataItemAccount: object

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

AppsListInstallationsResponseDataItemPermissions

AppsListInstallationsResponseDataItemPermissions: object

Type declaration

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

AppsListPlansEndpoint

AppsListPlansEndpoint: object

Type declaration

Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)

AppsListPlansRequestOptions

AppsListPlansRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/marketplace_listing/plans"

AppsListPlansResponseData

AppsListPlansResponseData: Array<AppsListPlansResponseDataItem>

AppsListPlansResponseDataItem

AppsListPlansResponseDataItem: object

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

AppsListPlansStubbedEndpoint

AppsListPlansStubbedEndpoint: object

Type declaration

Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)

AppsListPlansStubbedRequestOptions

AppsListPlansStubbedRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/marketplace_listing/stubbed/plans"

AppsListPlansStubbedResponseData

AppsListPlansStubbedResponseData: Array<AppsListPlansStubbedResponseDataItem>

AppsListPlansStubbedResponseDataItem

AppsListPlansStubbedResponseDataItem: object

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

AppsListReposEndpoint

AppsListReposEndpoint: object & RequiredPreview<"machine-man">

AppsListReposRequestOptions

AppsListReposRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/installation/repositories"

AppsListReposResponseData

AppsListReposResponseData: object

Type declaration

repositories: Array<AppsListReposResponseDataRepositoriesItem>
total_count: number

AppsListReposResponseDataRepositoriesItem

AppsListReposResponseDataRepositoriesItem: object

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: AppsListReposResponseDataRepositoriesItemOwner
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

AppsListReposResponseDataRepositoriesItemOwner

AppsListReposResponseDataRepositoriesItemOwner: object

Type declaration

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

AppsListSubscriptionsForAuthenticatedUserEndpoint

AppsListSubscriptionsForAuthenticatedUserEndpoint: object

Type declaration

Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)

AppsListSubscriptionsForAuthenticatedUserRequestOptions

AppsListSubscriptionsForAuthenticatedUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/user/marketplace_purchases"

AppsListSubscriptionsForAuthenticatedUserResponseData

AppsListSubscriptionsForAuthenticatedUserResponseData: Array<AppsListSubscriptionsForAuthenticatedUserResponseDataItem>

AppsListSubscriptionsForAuthenticatedUserResponseDataItem

AppsListSubscriptionsForAuthenticatedUserResponseDataItem: object

Type declaration

account: AppsListSubscriptionsForAuthenticatedUserResponseDataItemAccount
billing_cycle: string
free_trial_ends_on: string
next_billing_date: string
on_free_trial: boolean
plan: AppsListSubscriptionsForAuthenticatedUserResponseDataItemPlan
unit_count: null
updated_at: string

AppsListSubscriptionsForAuthenticatedUserResponseDataItemAccount

AppsListSubscriptionsForAuthenticatedUserResponseDataItemAccount: object

Type declaration

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

AppsListSubscriptionsForAuthenticatedUserResponseDataItemPlan

AppsListSubscriptionsForAuthenticatedUserResponseDataItemPlan: object

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

AppsListSubscriptionsForAuthenticatedUserStubbedEndpoint

AppsListSubscriptionsForAuthenticatedUserStubbedEndpoint: object

Type declaration

Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)

AppsListSubscriptionsForAuthenticatedUserStubbedRequestOptions

AppsListSubscriptionsForAuthenticatedUserStubbedRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/user/marketplace_purchases/stubbed"

AppsListSubscriptionsForAuthenticatedUserStubbedResponseData

AppsListSubscriptionsForAuthenticatedUserStubbedResponseData: Array<AppsListSubscriptionsForAuthenticatedUserStubbedResponseDataItem>

AppsListSubscriptionsForAuthenticatedUserStubbedResponseDataItem

AppsListSubscriptionsForAuthenticatedUserStubbedResponseDataItem: object

Type declaration

account: AppsListSubscriptionsForAuthenticatedUserStubbedResponseDataItemAccount
billing_cycle: string
free_trial_ends_on: string
next_billing_date: string
on_free_trial: boolean
plan: AppsListSubscriptionsForAuthenticatedUserStubbedResponseDataItemPlan
unit_count: null
updated_at: string

AppsListSubscriptionsForAuthenticatedUserStubbedResponseDataItemAccount

AppsListSubscriptionsForAuthenticatedUserStubbedResponseDataItemAccount: object

Type declaration

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

AppsListSubscriptionsForAuthenticatedUserStubbedResponseDataItemPlan

AppsListSubscriptionsForAuthenticatedUserStubbedResponseDataItemPlan: object

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

AppsRemoveRepoFromInstallationEndpoint

AppsRemoveRepoFromInstallationEndpoint: object & RequiredPreview<"machine-man">

AppsRemoveRepoFromInstallationRequestOptions

AppsRemoveRepoFromInstallationRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/user/installations/:installation_id/repositories/:repository_id"

AppsResetAuthorizationEndpoint

AppsResetAuthorizationEndpoint: object

Type declaration

access_token: string

access_token parameter
client_id: string

client_id parameter

AppsResetAuthorizationRequestOptions

AppsResetAuthorizationRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/applications/:client_id/tokens/:access_token"

AppsResetAuthorizationResponseData

AppsResetAuthorizationResponseData: object

Type declaration

app: AppsResetAuthorizationResponseDataApp
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: AppsResetAuthorizationResponseDataUser

AppsResetAuthorizationResponseDataApp

AppsResetAuthorizationResponseDataApp: object

Type declaration

client_id: string
name: string
url: string

AppsResetAuthorizationResponseDataUser

AppsResetAuthorizationResponseDataUser: object

Type declaration

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

AppsResetTokenEndpoint

AppsResetTokenEndpoint: object

Type declaration

Optional access_token?: string

The OAuth access token used to authenticate to the GitHub API.
client_id: string

client_id parameter

AppsResetTokenRequestOptions

AppsResetTokenRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PATCH"
request: RequestRequestOptions
url: "/applications/:client_id/token"

AppsResetTokenResponseData

AppsResetTokenResponseData: object

Type declaration

app: AppsResetTokenResponseDataApp
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: AppsResetTokenResponseDataUser

AppsResetTokenResponseDataApp

AppsResetTokenResponseDataApp: object

Type declaration

client_id: string
name: string
url: string

AppsResetTokenResponseDataUser

AppsResetTokenResponseDataUser: object

Type declaration

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

AppsRevokeAuthorizationForApplicationEndpoint

AppsRevokeAuthorizationForApplicationEndpoint: object

Type declaration

access_token: string

access_token parameter
client_id: string

client_id parameter

AppsRevokeAuthorizationForApplicationRequestOptions

AppsRevokeAuthorizationForApplicationRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/applications/:client_id/tokens/:access_token"

AppsRevokeGrantForApplicationEndpoint

AppsRevokeGrantForApplicationEndpoint: object

Type declaration

access_token: string

access_token parameter
client_id: string

client_id parameter

AppsRevokeGrantForApplicationRequestOptions

AppsRevokeGrantForApplicationRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/applications/:client_id/grants/:access_token"

AppsRevokeInstallationTokenEndpoint

AppsRevokeInstallationTokenEndpoint: object

Type declaration

AppsRevokeInstallationTokenRequestOptions

AppsRevokeInstallationTokenRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/installation/token"

ChecksCreateEndpoint

ChecksCreateEndpoint: object & RequiredPreview<"antiope">

ChecksCreateParamsActions

ChecksCreateParamsActions: object

Type declaration

description: string
identifier: string
label: string

ChecksCreateParamsOutput

ChecksCreateParamsOutput: object

Type declaration

Optional annotations?: ChecksCreateParamsOutputAnnotations[]
Optional images?: ChecksCreateParamsOutputImages[]
summary: string
Optional text?: string
title: string

ChecksCreateParamsOutputAnnotations

ChecksCreateParamsOutputAnnotations: object

Type declaration

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

ChecksCreateParamsOutputImages

ChecksCreateParamsOutputImages: object

Type declaration

alt: string
Optional caption?: string
image_url: string

ChecksCreateRequestOptions

ChecksCreateRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/check-runs"

ChecksCreateResponseData

ChecksCreateResponseData: object

Type declaration

app: ChecksCreateResponseDataApp
check_suite: ChecksCreateResponseDataCheckSuite
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: ChecksCreateResponseDataOutput
pull_requests: Array<ChecksCreateResponseDataPullRequestsItem>
started_at: string
status: string
url: string

ChecksCreateResponseDataApp

ChecksCreateResponseDataApp: object

Type declaration

created_at: string
description: string
events: Array<string>
external_url: string
html_url: string
id: number
name: string
node_id: string
owner: ChecksCreateResponseDataAppOwner
permissions: ChecksCreateResponseDataAppPermissions
slug: string
updated_at: string

ChecksCreateResponseDataAppOwner

ChecksCreateResponseDataAppOwner: object

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

ChecksCreateResponseDataAppPermissions

ChecksCreateResponseDataAppPermissions: object

Type declaration

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

ChecksCreateResponseDataCheckSuite

ChecksCreateResponseDataCheckSuite: object

Type declaration

id: number

ChecksCreateResponseDataOutput

ChecksCreateResponseDataOutput: object

Type declaration

Optional annotations_count?: number
Optional annotations_url?: string
summary: string
text: string
title: string

ChecksCreateResponseDataPullRequestsItem

ChecksCreateResponseDataPullRequestsItem: object

Type declaration

base: ChecksCreateResponseDataPullRequestsItemBase
head: ChecksCreateResponseDataPullRequestsItemHead
id: number
number: number
url: string

ChecksCreateResponseDataPullRequestsItemBase

ChecksCreateResponseDataPullRequestsItemBase: object

Type declaration

ref: string
repo: ChecksCreateResponseDataPullRequestsItemBaseRepo
sha: string

ChecksCreateResponseDataPullRequestsItemBaseRepo

ChecksCreateResponseDataPullRequestsItemBaseRepo: object

Type declaration

id: number
name: string
url: string

ChecksCreateResponseDataPullRequestsItemHead

ChecksCreateResponseDataPullRequestsItemHead: object

Type declaration

ref: string
repo: ChecksCreateResponseDataPullRequestsItemHeadRepo
sha: string

ChecksCreateResponseDataPullRequestsItemHeadRepo

ChecksCreateResponseDataPullRequestsItemHeadRepo: object

Type declaration

id: number
name: string
url: string

ChecksCreateSuiteEndpoint

ChecksCreateSuiteEndpoint: object & RequiredPreview<"antiope">

ChecksCreateSuiteRequestOptions

ChecksCreateSuiteRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/check-suites"

ChecksCreateSuiteResponseData

ChecksCreateSuiteResponseData: object

Type declaration

after: string
app: ChecksCreateSuiteResponseDataApp
before: string
conclusion: string
head_branch: string
head_sha: string
id: number
node_id: string
pull_requests: Array<any>
repository: ChecksCreateSuiteResponseDataRepository
status: string
url: string

ChecksCreateSuiteResponseDataApp

ChecksCreateSuiteResponseDataApp: object

Type declaration

created_at: string
description: string
events: Array<string>
external_url: string
html_url: string
id: number
name: string
node_id: string
owner: ChecksCreateSuiteResponseDataAppOwner
permissions: ChecksCreateSuiteResponseDataAppPermissions
slug: string
updated_at: string

ChecksCreateSuiteResponseDataAppOwner

ChecksCreateSuiteResponseDataAppOwner: object

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

ChecksCreateSuiteResponseDataAppPermissions

ChecksCreateSuiteResponseDataAppPermissions: object

Type declaration

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

ChecksCreateSuiteResponseDataRepository

ChecksCreateSuiteResponseDataRepository: object

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: ChecksCreateSuiteResponseDataRepositoryOwner
permissions: ChecksCreateSuiteResponseDataRepositoryPermissions
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

ChecksCreateSuiteResponseDataRepositoryOwner

ChecksCreateSuiteResponseDataRepositoryOwner: object

Type declaration

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

ChecksCreateSuiteResponseDataRepositoryPermissions

ChecksCreateSuiteResponseDataRepositoryPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

ChecksGetEndpoint

ChecksGetEndpoint: object & RequiredPreview<"antiope">

ChecksGetRequestOptions

ChecksGetRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/check-runs/:check_run_id"

ChecksGetResponseData

ChecksGetResponseData: object

Type declaration

app: ChecksGetResponseDataApp
check_suite: ChecksGetResponseDataCheckSuite
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: ChecksGetResponseDataOutput
pull_requests: Array<ChecksGetResponseDataPullRequestsItem>
started_at: string
status: string
url: string

ChecksGetResponseDataApp

ChecksGetResponseDataApp: object

Type declaration

created_at: string
description: string
events: Array<string>
external_url: string
html_url: string
id: number
name: string
node_id: string
owner: ChecksGetResponseDataAppOwner
permissions: ChecksGetResponseDataAppPermissions
slug: string
updated_at: string

ChecksGetResponseDataAppOwner

ChecksGetResponseDataAppOwner: object

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

ChecksGetResponseDataAppPermissions

ChecksGetResponseDataAppPermissions: object

Type declaration

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

ChecksGetResponseDataCheckSuite

ChecksGetResponseDataCheckSuite: object

Type declaration

id: number

ChecksGetResponseDataOutput

ChecksGetResponseDataOutput: object

Type declaration

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

ChecksGetResponseDataPullRequestsItem

ChecksGetResponseDataPullRequestsItem: object

Type declaration

base: ChecksGetResponseDataPullRequestsItemBase
head: ChecksGetResponseDataPullRequestsItemHead
id: number
number: number
url: string

ChecksGetResponseDataPullRequestsItemBase

ChecksGetResponseDataPullRequestsItemBase: object

Type declaration

ref: string
repo: ChecksGetResponseDataPullRequestsItemBaseRepo
sha: string

ChecksGetResponseDataPullRequestsItemBaseRepo

ChecksGetResponseDataPullRequestsItemBaseRepo: object

Type declaration

id: number
name: string
url: string

ChecksGetResponseDataPullRequestsItemHead

ChecksGetResponseDataPullRequestsItemHead: object

Type declaration

ref: string
repo: ChecksGetResponseDataPullRequestsItemHeadRepo
sha: string

ChecksGetResponseDataPullRequestsItemHeadRepo

ChecksGetResponseDataPullRequestsItemHeadRepo: object

Type declaration

id: number
name: string
url: string

ChecksGetSuiteEndpoint

ChecksGetSuiteEndpoint: object & RequiredPreview<"antiope">

ChecksGetSuiteRequestOptions

ChecksGetSuiteRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/check-suites/:check_suite_id"

ChecksGetSuiteResponseData

ChecksGetSuiteResponseData: object

Type declaration

after: string
app: ChecksGetSuiteResponseDataApp
before: string
conclusion: string
head_branch: string
head_sha: string
id: number
node_id: string
pull_requests: Array<any>
repository: ChecksGetSuiteResponseDataRepository
status: string
url: string

ChecksGetSuiteResponseDataApp

ChecksGetSuiteResponseDataApp: object

Type declaration

created_at: string
description: string
events: Array<string>
external_url: string
html_url: string
id: number
name: string
node_id: string
owner: ChecksGetSuiteResponseDataAppOwner
permissions: ChecksGetSuiteResponseDataAppPermissions
slug: string
updated_at: string

ChecksGetSuiteResponseDataAppOwner

ChecksGetSuiteResponseDataAppOwner: object

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

ChecksGetSuiteResponseDataAppPermissions

ChecksGetSuiteResponseDataAppPermissions: object

Type declaration

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

ChecksGetSuiteResponseDataRepository

ChecksGetSuiteResponseDataRepository: object

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: ChecksGetSuiteResponseDataRepositoryOwner
permissions: ChecksGetSuiteResponseDataRepositoryPermissions
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

ChecksGetSuiteResponseDataRepositoryOwner

ChecksGetSuiteResponseDataRepositoryOwner: object

Type declaration

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

ChecksGetSuiteResponseDataRepositoryPermissions

ChecksGetSuiteResponseDataRepositoryPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

ChecksListAnnotationsEndpoint

ChecksListAnnotationsEndpoint: object & RequiredPreview<"antiope">

ChecksListAnnotationsRequestOptions

ChecksListAnnotationsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/check-runs/:check_run_id/annotations"

ChecksListAnnotationsResponseData

ChecksListAnnotationsResponseData: Array<ChecksListAnnotationsResponseDataItem>

ChecksListAnnotationsResponseDataItem

ChecksListAnnotationsResponseDataItem: object

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

ChecksListForRefEndpoint

ChecksListForRefEndpoint: object & RequiredPreview<"antiope">

ChecksListForRefRequestOptions

ChecksListForRefRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/commits/:ref/check-runs"

ChecksListForRefResponseData

ChecksListForRefResponseData: object

Type declaration

check_runs: Array<ChecksListForRefResponseDataCheckRunsItem>
total_count: number

ChecksListForRefResponseDataCheckRunsItem

ChecksListForRefResponseDataCheckRunsItem: object

Type declaration

app: ChecksListForRefResponseDataCheckRunsItemApp
check_suite: ChecksListForRefResponseDataCheckRunsItemCheckSuite
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: ChecksListForRefResponseDataCheckRunsItemOutput
pull_requests: Array<ChecksListForRefResponseDataCheckRunsItemPullRequestsItem>
started_at: string
status: string
url: string

ChecksListForRefResponseDataCheckRunsItemApp

ChecksListForRefResponseDataCheckRunsItemApp: object

Type declaration

created_at: string
description: string
events: Array<string>
external_url: string
html_url: string
id: number
name: string
node_id: string
owner: ChecksListForRefResponseDataCheckRunsItemAppOwner
permissions: ChecksListForRefResponseDataCheckRunsItemAppPermissions
slug: string
updated_at: string

ChecksListForRefResponseDataCheckRunsItemAppOwner

ChecksListForRefResponseDataCheckRunsItemAppOwner: object

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

ChecksListForRefResponseDataCheckRunsItemAppPermissions

ChecksListForRefResponseDataCheckRunsItemAppPermissions: object

Type declaration

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

ChecksListForRefResponseDataCheckRunsItemCheckSuite

ChecksListForRefResponseDataCheckRunsItemCheckSuite: object

Type declaration

id: number

ChecksListForRefResponseDataCheckRunsItemOutput

ChecksListForRefResponseDataCheckRunsItemOutput: object

Type declaration

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

ChecksListForRefResponseDataCheckRunsItemPullRequestsItem

ChecksListForRefResponseDataCheckRunsItemPullRequestsItem: object

Type declaration

base: ChecksListForRefResponseDataCheckRunsItemPullRequestsItemBase
head: ChecksListForRefResponseDataCheckRunsItemPullRequestsItemHead
id: number
number: number
url: string

ChecksListForRefResponseDataCheckRunsItemPullRequestsItemBase

ChecksListForRefResponseDataCheckRunsItemPullRequestsItemBase: object

Type declaration

ref: string
repo: ChecksListForRefResponseDataCheckRunsItemPullRequestsItemBaseRepo
sha: string

ChecksListForRefResponseDataCheckRunsItemPullRequestsItemBaseRepo

ChecksListForRefResponseDataCheckRunsItemPullRequestsItemBaseRepo: object

Type declaration

id: number
name: string
url: string

ChecksListForRefResponseDataCheckRunsItemPullRequestsItemHead

ChecksListForRefResponseDataCheckRunsItemPullRequestsItemHead: object

Type declaration

ref: string
repo: ChecksListForRefResponseDataCheckRunsItemPullRequestsItemHeadRepo
sha: string

ChecksListForRefResponseDataCheckRunsItemPullRequestsItemHeadRepo

ChecksListForRefResponseDataCheckRunsItemPullRequestsItemHeadRepo: object

Type declaration

id: number
name: string
url: string

ChecksListForSuiteEndpoint

ChecksListForSuiteEndpoint: object & RequiredPreview<"antiope">

ChecksListForSuiteRequestOptions

ChecksListForSuiteRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/check-suites/:check_suite_id/check-runs"

ChecksListForSuiteResponseData

ChecksListForSuiteResponseData: object

Type declaration

check_runs: Array<ChecksListForSuiteResponseDataCheckRunsItem>
total_count: number

ChecksListForSuiteResponseDataCheckRunsItem

ChecksListForSuiteResponseDataCheckRunsItem: object

Type declaration

app: ChecksListForSuiteResponseDataCheckRunsItemApp
check_suite: ChecksListForSuiteResponseDataCheckRunsItemCheckSuite
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: ChecksListForSuiteResponseDataCheckRunsItemOutput
pull_requests: Array<ChecksListForSuiteResponseDataCheckRunsItemPullRequestsItem>
started_at: string
status: string
url: string

ChecksListForSuiteResponseDataCheckRunsItemApp

ChecksListForSuiteResponseDataCheckRunsItemApp: object

Type declaration

created_at: string
description: string
events: Array<string>
external_url: string
html_url: string
id: number
name: string
node_id: string
owner: ChecksListForSuiteResponseDataCheckRunsItemAppOwner
permissions: ChecksListForSuiteResponseDataCheckRunsItemAppPermissions
slug: string
updated_at: string

ChecksListForSuiteResponseDataCheckRunsItemAppOwner

ChecksListForSuiteResponseDataCheckRunsItemAppOwner: object

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

ChecksListForSuiteResponseDataCheckRunsItemAppPermissions

ChecksListForSuiteResponseDataCheckRunsItemAppPermissions: object

Type declaration

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

ChecksListForSuiteResponseDataCheckRunsItemCheckSuite

ChecksListForSuiteResponseDataCheckRunsItemCheckSuite: object

Type declaration

id: number

ChecksListForSuiteResponseDataCheckRunsItemOutput

ChecksListForSuiteResponseDataCheckRunsItemOutput: object

Type declaration

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

ChecksListForSuiteResponseDataCheckRunsItemPullRequestsItem

ChecksListForSuiteResponseDataCheckRunsItemPullRequestsItem: object

Type declaration

base: ChecksListForSuiteResponseDataCheckRunsItemPullRequestsItemBase
head: ChecksListForSuiteResponseDataCheckRunsItemPullRequestsItemHead
id: number
number: number
url: string

ChecksListForSuiteResponseDataCheckRunsItemPullRequestsItemBase

ChecksListForSuiteResponseDataCheckRunsItemPullRequestsItemBase: object

Type declaration

ref: string
repo: ChecksListForSuiteResponseDataCheckRunsItemPullRequestsItemBaseRepo
sha: string

ChecksListForSuiteResponseDataCheckRunsItemPullRequestsItemBaseRepo

ChecksListForSuiteResponseDataCheckRunsItemPullRequestsItemBaseRepo: object

Type declaration

id: number
name: string
url: string

ChecksListForSuiteResponseDataCheckRunsItemPullRequestsItemHead

ChecksListForSuiteResponseDataCheckRunsItemPullRequestsItemHead: object

Type declaration

ref: string
repo: ChecksListForSuiteResponseDataCheckRunsItemPullRequestsItemHeadRepo
sha: string

ChecksListForSuiteResponseDataCheckRunsItemPullRequestsItemHeadRepo

ChecksListForSuiteResponseDataCheckRunsItemPullRequestsItemHeadRepo: object

Type declaration

id: number
name: string
url: string

ChecksListSuitesForRefEndpoint

ChecksListSuitesForRefEndpoint: object & RequiredPreview<"antiope">

ChecksListSuitesForRefRequestOptions

ChecksListSuitesForRefRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/commits/:ref/check-suites"

ChecksListSuitesForRefResponseData

ChecksListSuitesForRefResponseData: object

Type declaration

check_suites: Array<ChecksListSuitesForRefResponseDataCheckSuitesItem>
total_count: number

ChecksListSuitesForRefResponseDataCheckSuitesItem

ChecksListSuitesForRefResponseDataCheckSuitesItem: object

Type declaration

after: string
app: ChecksListSuitesForRefResponseDataCheckSuitesItemApp
before: string
conclusion: string
head_branch: string
head_sha: string
id: number
node_id: string
pull_requests: Array<any>
repository: ChecksListSuitesForRefResponseDataCheckSuitesItemRepository
status: string
url: string

ChecksListSuitesForRefResponseDataCheckSuitesItemApp

ChecksListSuitesForRefResponseDataCheckSuitesItemApp: object

Type declaration

created_at: string
description: string
events: Array<string>
external_url: string
html_url: string
id: number
name: string
node_id: string
owner: ChecksListSuitesForRefResponseDataCheckSuitesItemAppOwner
permissions: ChecksListSuitesForRefResponseDataCheckSuitesItemAppPermissions
slug: string
updated_at: string

ChecksListSuitesForRefResponseDataCheckSuitesItemAppOwner

ChecksListSuitesForRefResponseDataCheckSuitesItemAppOwner: object

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

ChecksListSuitesForRefResponseDataCheckSuitesItemAppPermissions

ChecksListSuitesForRefResponseDataCheckSuitesItemAppPermissions: object

Type declaration

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

ChecksListSuitesForRefResponseDataCheckSuitesItemRepository

ChecksListSuitesForRefResponseDataCheckSuitesItemRepository: object

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: ChecksListSuitesForRefResponseDataCheckSuitesItemRepositoryOwner
permissions: ChecksListSuitesForRefResponseDataCheckSuitesItemRepositoryPermissions
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

ChecksListSuitesForRefResponseDataCheckSuitesItemRepositoryOwner

ChecksListSuitesForRefResponseDataCheckSuitesItemRepositoryOwner: object

Type declaration

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

ChecksListSuitesForRefResponseDataCheckSuitesItemRepositoryPermissions

ChecksListSuitesForRefResponseDataCheckSuitesItemRepositoryPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

ChecksRerequestSuiteEndpoint

ChecksRerequestSuiteEndpoint: object & RequiredPreview<"antiope">

ChecksRerequestSuiteRequestOptions

ChecksRerequestSuiteRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/check-suites/:check_suite_id/rerequest"

ChecksSetSuitesPreferencesEndpoint

ChecksSetSuitesPreferencesEndpoint: object & RequiredPreview<"antiope">

ChecksSetSuitesPreferencesParamsAutoTriggerChecks

ChecksSetSuitesPreferencesParamsAutoTriggerChecks: object

Type declaration

app_id: number
setting: boolean

ChecksSetSuitesPreferencesRequestOptions

ChecksSetSuitesPreferencesRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PATCH"
request: RequestRequestOptions
url: "/repos/:owner/:repo/check-suites/preferences"

ChecksSetSuitesPreferencesResponseData

ChecksSetSuitesPreferencesResponseData: object

Type declaration

preferences: ChecksSetSuitesPreferencesResponseDataPreferences
repository: ChecksSetSuitesPreferencesResponseDataRepository

ChecksSetSuitesPreferencesResponseDataPreferences

ChecksSetSuitesPreferencesResponseDataPreferences: object

Type declaration

auto_trigger_checks: Array<ChecksSetSuitesPreferencesResponseDataPreferencesAutoTriggerChecksItem>

ChecksSetSuitesPreferencesResponseDataPreferencesAutoTriggerChecksItem

ChecksSetSuitesPreferencesResponseDataPreferencesAutoTriggerChecksItem: object

Type declaration

app_id: number
setting: boolean

ChecksSetSuitesPreferencesResponseDataRepository

ChecksSetSuitesPreferencesResponseDataRepository: object

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: ChecksSetSuitesPreferencesResponseDataRepositoryOwner
permissions: ChecksSetSuitesPreferencesResponseDataRepositoryPermissions
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

ChecksSetSuitesPreferencesResponseDataRepositoryOwner

ChecksSetSuitesPreferencesResponseDataRepositoryOwner: object

Type declaration

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

ChecksSetSuitesPreferencesResponseDataRepositoryPermissions

ChecksSetSuitesPreferencesResponseDataRepositoryPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

ChecksUpdateEndpoint

ChecksUpdateEndpoint: object & RequiredPreview<"antiope">

ChecksUpdateParamsActions

ChecksUpdateParamsActions: object

Type declaration

description: string
identifier: string
label: string

ChecksUpdateParamsOutput

ChecksUpdateParamsOutput: object

Type declaration

Optional annotations?: ChecksUpdateParamsOutputAnnotations[]
Optional images?: ChecksUpdateParamsOutputImages[]
summary: string
Optional text?: string
Optional title?: string

ChecksUpdateParamsOutputAnnotations

ChecksUpdateParamsOutputAnnotations: object

Type declaration

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

ChecksUpdateParamsOutputImages

ChecksUpdateParamsOutputImages: object

Type declaration

alt: string
Optional caption?: string
image_url: string

ChecksUpdateRequestOptions

ChecksUpdateRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PATCH"
request: RequestRequestOptions
url: "/repos/:owner/:repo/check-runs/:check_run_id"

ChecksUpdateResponseData

ChecksUpdateResponseData: object

Type declaration

app: ChecksUpdateResponseDataApp
check_suite: ChecksUpdateResponseDataCheckSuite
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: ChecksUpdateResponseDataOutput
pull_requests: Array<ChecksUpdateResponseDataPullRequestsItem>
started_at: string
status: string
url: string

ChecksUpdateResponseDataApp

ChecksUpdateResponseDataApp: object

Type declaration

created_at: string
description: string
events: Array<string>
external_url: string
html_url: string
id: number
name: string
node_id: string
owner: ChecksUpdateResponseDataAppOwner
permissions: ChecksUpdateResponseDataAppPermissions
slug: string
updated_at: string

ChecksUpdateResponseDataAppOwner

ChecksUpdateResponseDataAppOwner: object

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

ChecksUpdateResponseDataAppPermissions

ChecksUpdateResponseDataAppPermissions: object

Type declaration

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

ChecksUpdateResponseDataCheckSuite

ChecksUpdateResponseDataCheckSuite: object

Type declaration

id: number

ChecksUpdateResponseDataOutput

ChecksUpdateResponseDataOutput: object

Type declaration

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

ChecksUpdateResponseDataPullRequestsItem

ChecksUpdateResponseDataPullRequestsItem: object

Type declaration

base: ChecksUpdateResponseDataPullRequestsItemBase
head: ChecksUpdateResponseDataPullRequestsItemHead
id: number
number: number
url: string

ChecksUpdateResponseDataPullRequestsItemBase

ChecksUpdateResponseDataPullRequestsItemBase: object

Type declaration

ref: string
repo: ChecksUpdateResponseDataPullRequestsItemBaseRepo
sha: string

ChecksUpdateResponseDataPullRequestsItemBaseRepo

ChecksUpdateResponseDataPullRequestsItemBaseRepo: object

Type declaration

id: number
name: string
url: string

ChecksUpdateResponseDataPullRequestsItemHead

ChecksUpdateResponseDataPullRequestsItemHead: object

Type declaration

ref: string
repo: ChecksUpdateResponseDataPullRequestsItemHeadRepo
sha: string

ChecksUpdateResponseDataPullRequestsItemHeadRepo

ChecksUpdateResponseDataPullRequestsItemHeadRepo: object

Type declaration

id: number
name: string
url: string

CodesOfConductGetAllCodesOfConductEndpoint

CodesOfConductGetAllCodesOfConductEndpoint: __type & RequiredPreview<"scarlet-witch">

CodesOfConductGetAllCodesOfConductRequestOptions

CodesOfConductGetAllCodesOfConductRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/codes_of_conduct"

CodesOfConductGetAllCodesOfConductResponseData

CodesOfConductGetAllCodesOfConductResponseData: Array<CodesOfConductGetAllCodesOfConductResponseDataItem>

CodesOfConductGetAllCodesOfConductResponseDataItem

CodesOfConductGetAllCodesOfConductResponseDataItem: object

Type declaration

key: string
name: string
url: string

CodesOfConductGetConductCodeEndpoint

CodesOfConductGetConductCodeEndpoint: object & RequiredPreview<"scarlet-witch">

CodesOfConductGetConductCodeRequestOptions

CodesOfConductGetConductCodeRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/codes_of_conduct/:key"

CodesOfConductGetConductCodeResponseData

CodesOfConductGetConductCodeResponseData: object

Type declaration

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

CodesOfConductGetForRepoEndpoint

CodesOfConductGetForRepoEndpoint: object & RequiredPreview<"scarlet-witch">

CodesOfConductGetForRepoRequestOptions

CodesOfConductGetForRepoRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/community/code_of_conduct"

CodesOfConductGetForRepoResponseData

CodesOfConductGetForRepoResponseData: object

Type declaration

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

EmojisGetEndpoint

EmojisGetEndpoint: object

Type declaration

EmojisGetRequestOptions

EmojisGetRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/emojis"

EndpointDefaults

EndpointDefaults: RequestParameters & object

The .endpoint() method is guaranteed to set all keys defined by RequestParameters as well as the method property.

EndpointOptions

EndpointOptions: RequestParameters & object

Fetch

Fetch: any

Browser's fetch method (or compatible such as fetch-mock)

GetResponseDataTypeFromEndpointMethod

GetResponseDataTypeFromEndpointMethod<T>: Unwrap<ReturnType<T>>["data"]

Type parameters

T: AnyFunction

GetResponseTypeFromEndpointMethod

GetResponseTypeFromEndpointMethod<T>: Unwrap<ReturnType<T>>

Type parameters

T: AnyFunction

GistsCheckIsStarredEndpoint

GistsCheckIsStarredEndpoint: object

Type declaration

gist_id: string

gist_id parameter

GistsCheckIsStarredRequestOptions

GistsCheckIsStarredRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/gists/:gist_id/star"

GistsCreateCommentEndpoint

GistsCreateCommentEndpoint: object

Type declaration

body: string

The comment text.
gist_id: string

gist_id parameter

GistsCreateCommentRequestOptions

GistsCreateCommentRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/gists/:gist_id/comments"

GistsCreateCommentResponseData

GistsCreateCommentResponseData: object

Type declaration

body: string
created_at: string
id: number
node_id: string
updated_at: string
url: string
user: GistsCreateCommentResponseDataUser

GistsCreateCommentResponseDataUser

GistsCreateCommentResponseDataUser: object

Type declaration

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

GistsCreateEndpoint

GistsCreateEndpoint: object

Type declaration

Optional description?: 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?: boolean

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

GistsCreateParamsFiles

GistsCreateParamsFiles: object

Type declaration

Optional content?: string

GistsCreateRequestOptions

GistsCreateRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/gists"

GistsCreateResponseData

GistsCreateResponseData: object

Type declaration

comments: number
comments_url: string
commits_url: string
created_at: string
description: string
files: GistsCreateResponseDataFiles
forks: Array<GistsCreateResponseDataForksItem>
forks_url: string
git_pull_url: string
git_push_url: string
history: Array<GistsCreateResponseDataHistoryItem>
html_url: string
id: string
node_id: string
owner: GistsCreateResponseDataOwner
public: boolean
truncated: boolean
updated_at: string
url: string
user: null

GistsCreateResponseDataFiles

GistsCreateResponseDataFiles: object

Type declaration

hello_world.py: GistsCreateResponseDataFilesHelloWorldPy
hello_world.rb: GistsCreateResponseDataFilesHelloWorldRb
hello_world_python.txt: GistsCreateResponseDataFilesHelloWorldPythonTxt
hello_world_ruby.txt: GistsCreateResponseDataFilesHelloWorldRubyTxt

GistsCreateResponseDataFilesHelloWorldPy

GistsCreateResponseDataFilesHelloWorldPy: object

Type declaration

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

GistsCreateResponseDataFilesHelloWorldPythonTxt

GistsCreateResponseDataFilesHelloWorldPythonTxt: object

Type declaration

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

GistsCreateResponseDataFilesHelloWorldRb

GistsCreateResponseDataFilesHelloWorldRb: object

Type declaration

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

GistsCreateResponseDataFilesHelloWorldRubyTxt

GistsCreateResponseDataFilesHelloWorldRubyTxt: object

Type declaration

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

GistsCreateResponseDataForksItem

GistsCreateResponseDataForksItem: object

Type declaration

created_at: string
id: string
updated_at: string
url: string
user: GistsCreateResponseDataForksItemUser

GistsCreateResponseDataForksItemUser

GistsCreateResponseDataForksItemUser: object

Type declaration

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

GistsCreateResponseDataHistoryItem

GistsCreateResponseDataHistoryItem: object

Type declaration

change_status: GistsCreateResponseDataHistoryItemChangeStatus
committed_at: string
url: string
user: GistsCreateResponseDataHistoryItemUser
version: string

GistsCreateResponseDataHistoryItemChangeStatus

GistsCreateResponseDataHistoryItemChangeStatus: object

Type declaration

additions: number
deletions: number
total: number

GistsCreateResponseDataHistoryItemUser

GistsCreateResponseDataHistoryItemUser: object

Type declaration

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

GistsCreateResponseDataOwner

GistsCreateResponseDataOwner: object

Type declaration

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

GistsDeleteCommentEndpoint

GistsDeleteCommentEndpoint: object

Type declaration

comment_id: number

comment_id parameter
gist_id: string

gist_id parameter

GistsDeleteCommentRequestOptions

GistsDeleteCommentRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/gists/:gist_id/comments/:comment_id"

GistsDeleteEndpoint

GistsDeleteEndpoint: object

Type declaration

gist_id: string

gist_id parameter

GistsDeleteRequestOptions

GistsDeleteRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/gists/:gist_id"

GistsForkEndpoint

GistsForkEndpoint: object

Type declaration

gist_id: string

gist_id parameter

GistsForkRequestOptions

GistsForkRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/gists/:gist_id/forks"

GistsForkResponseData

GistsForkResponseData: object

Type declaration

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

GistsForkResponseDataFiles

GistsForkResponseDataFiles: object

Type declaration

hello_world.rb: GistsForkResponseDataFilesHelloWorldRb

GistsForkResponseDataFilesHelloWorldRb

GistsForkResponseDataFilesHelloWorldRb: object

Type declaration

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

GistsForkResponseDataOwner

GistsForkResponseDataOwner: object

Type declaration

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

GistsGetCommentEndpoint

GistsGetCommentEndpoint: object

Type declaration

comment_id: number

comment_id parameter
gist_id: string

gist_id parameter

GistsGetCommentRequestOptions

GistsGetCommentRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/gists/:gist_id/comments/:comment_id"

GistsGetCommentResponseData

GistsGetCommentResponseData: object

Type declaration

body: string
created_at: string
id: number
node_id: string
updated_at: string
url: string
user: GistsGetCommentResponseDataUser

GistsGetCommentResponseDataUser

GistsGetCommentResponseDataUser: object

Type declaration

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

GistsGetEndpoint

GistsGetEndpoint: object

Type declaration

gist_id: string

gist_id parameter

GistsGetRequestOptions

GistsGetRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/gists/:gist_id"

GistsGetResponseData

GistsGetResponseData: object

Type declaration

comments: number
comments_url: string
commits_url: string
created_at: string
description: string
files: GistsGetResponseDataFiles
forks: Array<GistsGetResponseDataForksItem>
forks_url: string
git_pull_url: string
git_push_url: string
history: Array<GistsGetResponseDataHistoryItem>
html_url: string
id: string
node_id: string
owner: GistsGetResponseDataOwner
public: boolean
truncated: boolean
updated_at: string
url: string
user: null

GistsGetResponseDataFiles

GistsGetResponseDataFiles: object

Type declaration

hello_world.py: GistsGetResponseDataFilesHelloWorldPy
hello_world.rb: GistsGetResponseDataFilesHelloWorldRb
hello_world_python.txt: GistsGetResponseDataFilesHelloWorldPythonTxt
hello_world_ruby.txt: GistsGetResponseDataFilesHelloWorldRubyTxt

GistsGetResponseDataFilesHelloWorldPy

GistsGetResponseDataFilesHelloWorldPy: object

Type declaration

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

GistsGetResponseDataFilesHelloWorldPythonTxt

GistsGetResponseDataFilesHelloWorldPythonTxt: object

Type declaration

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

GistsGetResponseDataFilesHelloWorldRb

GistsGetResponseDataFilesHelloWorldRb: object

Type declaration

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

GistsGetResponseDataFilesHelloWorldRubyTxt

GistsGetResponseDataFilesHelloWorldRubyTxt: object

Type declaration

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

GistsGetResponseDataForksItem

GistsGetResponseDataForksItem: object

Type declaration

created_at: string
id: string
updated_at: string
url: string
user: GistsGetResponseDataForksItemUser

GistsGetResponseDataForksItemUser

GistsGetResponseDataForksItemUser: object

Type declaration

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

GistsGetResponseDataHistoryItem

GistsGetResponseDataHistoryItem: object

Type declaration

change_status: GistsGetResponseDataHistoryItemChangeStatus
committed_at: string
url: string
user: GistsGetResponseDataHistoryItemUser
version: string

GistsGetResponseDataHistoryItemChangeStatus

GistsGetResponseDataHistoryItemChangeStatus: object

Type declaration

additions: number
deletions: number
total: number

GistsGetResponseDataHistoryItemUser

GistsGetResponseDataHistoryItemUser: object

Type declaration

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

GistsGetResponseDataOwner

GistsGetResponseDataOwner: object

Type declaration

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

GistsGetRevisionEndpoint

GistsGetRevisionEndpoint: object

Type declaration

gist_id: string

gist_id parameter
sha: string

sha parameter

GistsGetRevisionRequestOptions

GistsGetRevisionRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/gists/:gist_id/:sha"

GistsGetRevisionResponseData

GistsGetRevisionResponseData: object

Type declaration

comments: number
comments_url: string
commits_url: string
created_at: string
description: string
files: GistsGetRevisionResponseDataFiles
forks: Array<GistsGetRevisionResponseDataForksItem>
forks_url: string
git_pull_url: string
git_push_url: string
history: Array<GistsGetRevisionResponseDataHistoryItem>
html_url: string
id: string
node_id: string
owner: GistsGetRevisionResponseDataOwner
public: boolean
truncated: boolean
updated_at: string
url: string
user: null

GistsGetRevisionResponseDataFiles

GistsGetRevisionResponseDataFiles: object

Type declaration

hello_world.py: GistsGetRevisionResponseDataFilesHelloWorldPy
hello_world.rb: GistsGetRevisionResponseDataFilesHelloWorldRb
hello_world_python.txt: GistsGetRevisionResponseDataFilesHelloWorldPythonTxt
hello_world_ruby.txt: GistsGetRevisionResponseDataFilesHelloWorldRubyTxt

GistsGetRevisionResponseDataFilesHelloWorldPy

GistsGetRevisionResponseDataFilesHelloWorldPy: object

Type declaration

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

GistsGetRevisionResponseDataFilesHelloWorldPythonTxt

GistsGetRevisionResponseDataFilesHelloWorldPythonTxt: object

Type declaration

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

GistsGetRevisionResponseDataFilesHelloWorldRb

GistsGetRevisionResponseDataFilesHelloWorldRb: object

Type declaration

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

GistsGetRevisionResponseDataFilesHelloWorldRubyTxt

GistsGetRevisionResponseDataFilesHelloWorldRubyTxt: object

Type declaration

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

GistsGetRevisionResponseDataForksItem

GistsGetRevisionResponseDataForksItem: object

Type declaration

created_at: string
id: string
updated_at: string
url: string
user: GistsGetRevisionResponseDataForksItemUser

GistsGetRevisionResponseDataForksItemUser

GistsGetRevisionResponseDataForksItemUser: object

Type declaration

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

GistsGetRevisionResponseDataHistoryItem

GistsGetRevisionResponseDataHistoryItem: object

Type declaration

change_status: GistsGetRevisionResponseDataHistoryItemChangeStatus
committed_at: string
url: string
user: GistsGetRevisionResponseDataHistoryItemUser
version: string

GistsGetRevisionResponseDataHistoryItemChangeStatus

GistsGetRevisionResponseDataHistoryItemChangeStatus: object

Type declaration

additions: number
deletions: number
total: number

GistsGetRevisionResponseDataHistoryItemUser

GistsGetRevisionResponseDataHistoryItemUser: object

Type declaration

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

GistsGetRevisionResponseDataOwner

GistsGetRevisionResponseDataOwner: object

Type declaration

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

GistsListCommentsEndpoint

GistsListCommentsEndpoint: object

Type declaration

gist_id: string

gist_id parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)

GistsListCommentsRequestOptions

GistsListCommentsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/gists/:gist_id/comments"

GistsListCommentsResponseData

GistsListCommentsResponseData: Array<GistsListCommentsResponseDataItem>

GistsListCommentsResponseDataItem

GistsListCommentsResponseDataItem: object

Type declaration

body: string
created_at: string
id: number
node_id: string
updated_at: string
url: string
user: GistsListCommentsResponseDataItemUser

GistsListCommentsResponseDataItemUser

GistsListCommentsResponseDataItemUser: object

Type declaration

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

GistsListCommitsEndpoint

GistsListCommitsEndpoint: object

Type declaration

gist_id: string

gist_id parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)

GistsListCommitsRequestOptions

GistsListCommitsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/gists/:gist_id/commits"

GistsListCommitsResponseData

GistsListCommitsResponseData: Array<GistsListCommitsResponseDataItem>

GistsListCommitsResponseDataItem

GistsListCommitsResponseDataItem: object

Type declaration

change_status: GistsListCommitsResponseDataItemChangeStatus
committed_at: string
url: string
user: GistsListCommitsResponseDataItemUser
version: string

GistsListCommitsResponseDataItemChangeStatus

GistsListCommitsResponseDataItemChangeStatus: object

Type declaration

additions: number
deletions: number
total: number

GistsListCommitsResponseDataItemUser

GistsListCommitsResponseDataItemUser: object

Type declaration

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

GistsListEndpoint

GistsListEndpoint: object

Type declaration

Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
Optional since?: string

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

GistsListForUserEndpoint

GistsListForUserEndpoint: object

Type declaration

Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
Optional since?: 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

username parameter

GistsListForUserRequestOptions

GistsListForUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/users/:username/gists"

GistsListForUserResponseData

GistsListForUserResponseData: Array<GistsListForUserResponseDataItem>

GistsListForUserResponseDataItem

GistsListForUserResponseDataItem: object

Type declaration

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

GistsListForUserResponseDataItemFiles

GistsListForUserResponseDataItemFiles: object

Type declaration

hello_world.rb: GistsListForUserResponseDataItemFilesHelloWorldRb

GistsListForUserResponseDataItemFilesHelloWorldRb

GistsListForUserResponseDataItemFilesHelloWorldRb: object

Type declaration

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

GistsListForUserResponseDataItemOwner

GistsListForUserResponseDataItemOwner: object

Type declaration

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

GistsListForksEndpoint

GistsListForksEndpoint: object

Type declaration

gist_id: string

gist_id parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)

GistsListForksRequestOptions

GistsListForksRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/gists/:gist_id/forks"

GistsListForksResponseData

GistsListForksResponseData: Array<GistsListForksResponseDataItem>

GistsListForksResponseDataItem

GistsListForksResponseDataItem: object

Type declaration

created_at: string
id: string
updated_at: string
url: string
user: GistsListForksResponseDataItemUser

GistsListForksResponseDataItemUser

GistsListForksResponseDataItemUser: object

Type declaration

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

GistsListPublicEndpoint

GistsListPublicEndpoint: object

Type declaration

Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
Optional since?: string

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

GistsListPublicRequestOptions

GistsListPublicRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/gists/public"

GistsListPublicResponseData

GistsListPublicResponseData: Array<GistsListPublicResponseDataItem>

GistsListPublicResponseDataItem

GistsListPublicResponseDataItem: object

Type declaration

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

GistsListPublicResponseDataItemFiles

GistsListPublicResponseDataItemFiles: object

Type declaration

hello_world.rb: GistsListPublicResponseDataItemFilesHelloWorldRb

GistsListPublicResponseDataItemFilesHelloWorldRb

GistsListPublicResponseDataItemFilesHelloWorldRb: object

Type declaration

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

GistsListPublicResponseDataItemOwner

GistsListPublicResponseDataItemOwner: object

Type declaration

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

GistsListRequestOptions

GistsListRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/gists"

GistsListResponseData

GistsListResponseData: Array<GistsListResponseDataItem>

GistsListResponseDataItem

GistsListResponseDataItem: object

Type declaration

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

GistsListResponseDataItemFiles

GistsListResponseDataItemFiles: object

Type declaration

hello_world.rb: GistsListResponseDataItemFilesHelloWorldRb

GistsListResponseDataItemFilesHelloWorldRb

GistsListResponseDataItemFilesHelloWorldRb: object

Type declaration

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

GistsListResponseDataItemOwner

GistsListResponseDataItemOwner: object

Type declaration

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

GistsListStarredEndpoint

GistsListStarredEndpoint: object

Type declaration

Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
Optional since?: string

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

GistsListStarredRequestOptions

GistsListStarredRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/gists/starred"

GistsListStarredResponseData

GistsListStarredResponseData: Array<GistsListStarredResponseDataItem>

GistsListStarredResponseDataItem

GistsListStarredResponseDataItem: object

Type declaration

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

GistsListStarredResponseDataItemFiles

GistsListStarredResponseDataItemFiles: object

Type declaration

hello_world.rb: GistsListStarredResponseDataItemFilesHelloWorldRb

GistsListStarredResponseDataItemFilesHelloWorldRb

GistsListStarredResponseDataItemFilesHelloWorldRb: object

Type declaration

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

GistsListStarredResponseDataItemOwner

GistsListStarredResponseDataItemOwner: object

Type declaration

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

GistsStarEndpoint

GistsStarEndpoint: object

Type declaration

gist_id: string

gist_id parameter

GistsStarRequestOptions

GistsStarRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PUT"
request: RequestRequestOptions
url: "/gists/:gist_id/star"

GistsUnstarEndpoint

GistsUnstarEndpoint: object

Type declaration

gist_id: string

gist_id parameter

GistsUnstarRequestOptions

GistsUnstarRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/gists/:gist_id/star"

GistsUpdateCommentEndpoint

GistsUpdateCommentEndpoint: object

Type declaration

body: string

The comment text.
comment_id: number

comment_id parameter
gist_id: string

gist_id parameter

GistsUpdateCommentRequestOptions

GistsUpdateCommentRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PATCH"
request: RequestRequestOptions
url: "/gists/:gist_id/comments/:comment_id"

GistsUpdateCommentResponseData

GistsUpdateCommentResponseData: object

Type declaration

body: string
created_at: string
id: number
node_id: string
updated_at: string
url: string
user: GistsUpdateCommentResponseDataUser

GistsUpdateCommentResponseDataUser

GistsUpdateCommentResponseDataUser: object

Type declaration

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

GistsUpdateEndpoint

GistsUpdateEndpoint: object

Type declaration

Optional description?: string

A descriptive name for this gist.
Optional files?: GistsUpdateParamsFiles

The filenames and content that make up this gist.
gist_id: string

gist_id parameter

GistsUpdateParamsFiles

GistsUpdateParamsFiles: object

Type declaration

Optional content?: string
Optional filename?: string

GistsUpdateRequestOptions

GistsUpdateRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PATCH"
request: RequestRequestOptions
url: "/gists/:gist_id"

GistsUpdateResponseData

GistsUpdateResponseData: object

Type declaration

comments: number
comments_url: string
commits_url: string
created_at: string
description: string
files: GistsUpdateResponseDataFiles
forks: Array<GistsUpdateResponseDataForksItem>
forks_url: string
git_pull_url: string
git_push_url: string
history: Array<GistsUpdateResponseDataHistoryItem>
html_url: string
id: string
node_id: string
owner: GistsUpdateResponseDataOwner
public: boolean
truncated: boolean
updated_at: string
url: string
user: null

GistsUpdateResponseDataFiles

GistsUpdateResponseDataFiles: object

Type declaration

hello_world.md: GistsUpdateResponseDataFilesHelloWorldMd
hello_world.py: GistsUpdateResponseDataFilesHelloWorldPy
hello_world.rb: GistsUpdateResponseDataFilesHelloWorldRb
new_file.txt: GistsUpdateResponseDataFilesNewFileTxt

GistsUpdateResponseDataFilesHelloWorldMd

GistsUpdateResponseDataFilesHelloWorldMd: object

Type declaration

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

GistsUpdateResponseDataFilesHelloWorldPy

GistsUpdateResponseDataFilesHelloWorldPy: object

Type declaration

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

GistsUpdateResponseDataFilesHelloWorldRb

GistsUpdateResponseDataFilesHelloWorldRb: object

Type declaration

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

GistsUpdateResponseDataFilesNewFileTxt

GistsUpdateResponseDataFilesNewFileTxt: object

Type declaration

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

GistsUpdateResponseDataForksItem

GistsUpdateResponseDataForksItem: object

Type declaration

created_at: string
id: string
updated_at: string
url: string
user: GistsUpdateResponseDataForksItemUser

GistsUpdateResponseDataForksItemUser

GistsUpdateResponseDataForksItemUser: object

Type declaration

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

GistsUpdateResponseDataHistoryItem

GistsUpdateResponseDataHistoryItem: object

Type declaration

change_status: GistsUpdateResponseDataHistoryItemChangeStatus
committed_at: string
url: string
user: GistsUpdateResponseDataHistoryItemUser
version: string

GistsUpdateResponseDataHistoryItemChangeStatus

GistsUpdateResponseDataHistoryItemChangeStatus: object

Type declaration

additions: number
deletions: number
total: number

GistsUpdateResponseDataHistoryItemUser

GistsUpdateResponseDataHistoryItemUser: object

Type declaration

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

GistsUpdateResponseDataOwner

GistsUpdateResponseDataOwner: object

Type declaration

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

GitCreateBlobEndpoint

GitCreateBlobEndpoint: object

Type declaration

content: string

The new blob's content.
Optional encoding?: string

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

owner parameter
repo: string

repo parameter

GitCreateBlobRequestOptions

GitCreateBlobRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/git/blobs"

GitCreateBlobResponseData

GitCreateBlobResponseData: object

Type declaration

sha: string
url: string

GitCreateCommitEndpoint

GitCreateCommitEndpoint: object

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

owner parameter
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

repo parameter
Optional signature?: 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: object

Type declaration

Optional date?: string
Optional email?: string
Optional name?: string

GitCreateCommitParamsCommitter

GitCreateCommitParamsCommitter: object

Type declaration

Optional date?: string
Optional email?: string
Optional name?: string

GitCreateCommitRequestOptions

GitCreateCommitRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/git/commits"

GitCreateCommitResponseData

GitCreateCommitResponseData: object

Type declaration

author: GitCreateCommitResponseDataAuthor
committer: GitCreateCommitResponseDataCommitter
message: string
node_id: string
parents: Array<GitCreateCommitResponseDataParentsItem>
sha: string
tree: GitCreateCommitResponseDataTree
url: string
verification: GitCreateCommitResponseDataVerification

GitCreateCommitResponseDataAuthor

GitCreateCommitResponseDataAuthor: object

Type declaration

date: string
email: string
name: string

GitCreateCommitResponseDataCommitter

GitCreateCommitResponseDataCommitter: object

Type declaration

date: string
email: string
name: string

GitCreateCommitResponseDataParentsItem

GitCreateCommitResponseDataParentsItem: object

Type declaration

sha: string
url: string

GitCreateCommitResponseDataTree

GitCreateCommitResponseDataTree: object

Type declaration

sha: string
url: string

GitCreateCommitResponseDataVerification

GitCreateCommitResponseDataVerification: object

Type declaration

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

GitCreateRefEndpoint

GitCreateRefEndpoint: object

Type declaration

owner: string

owner parameter
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

repo parameter
sha: string

The SHA1 value for this reference.

GitCreateRefRequestOptions

GitCreateRefRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/git/refs"

GitCreateRefResponseData

GitCreateRefResponseData: object

Type declaration

node_id: string
object: GitCreateRefResponseDataObject
ref: string
url: string

GitCreateRefResponseDataObject

GitCreateRefResponseDataObject: object

Type declaration

sha: string
type: string
url: string

GitCreateTagEndpoint

GitCreateTagEndpoint: object

Type declaration

message: string

The tag message.
object: string

The SHA of the git object this is tagging.
owner: string

owner parameter
repo: string

repo parameter
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: object

Type declaration

Optional date?: string
Optional email?: string
Optional name?: string

GitCreateTagRequestOptions

GitCreateTagRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/git/tags"

GitCreateTagResponseData

GitCreateTagResponseData: object

Type declaration

message: string
node_id: string
object: GitCreateTagResponseDataObject
sha: string
tag: string
tagger: GitCreateTagResponseDataTagger
url: string
verification: GitCreateTagResponseDataVerification

GitCreateTagResponseDataObject

GitCreateTagResponseDataObject: object

Type declaration

sha: string
type: string
url: string

GitCreateTagResponseDataTagger

GitCreateTagResponseDataTagger: object

Type declaration

date: string
email: string
name: string

GitCreateTagResponseDataVerification

GitCreateTagResponseDataVerification: object

Type declaration

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

GitCreateTreeEndpoint

GitCreateTreeEndpoint: object

Type declaration

Optional base_tree?: 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

owner parameter
repo: string

repo parameter
tree: GitCreateTreeParamsTree[]

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

GitCreateTreeParamsTree

GitCreateTreeParamsTree: object

Type declaration

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

GitCreateTreeRequestOptions

GitCreateTreeRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/git/trees"

GitCreateTreeResponseData

GitCreateTreeResponseData: object

Type declaration

sha: string
tree: Array<GitCreateTreeResponseDataTreeItem>
url: string

GitCreateTreeResponseDataTreeItem

GitCreateTreeResponseDataTreeItem: object

Type declaration

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

GitDeleteRefEndpoint

GitDeleteRefEndpoint: object

Type declaration

owner: string

owner parameter
ref: string

ref parameter
repo: string

repo parameter

GitDeleteRefRequestOptions

GitDeleteRefRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/repos/:owner/:repo/git/refs/:ref"

GitGetBlobEndpoint

GitGetBlobEndpoint: object

Type declaration

file_sha: string

file_sha parameter
owner: string

owner parameter
repo: string

repo parameter

GitGetBlobRequestOptions

GitGetBlobRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/git/blobs/:file_sha"

GitGetBlobResponseData

GitGetBlobResponseData: object

Type declaration

content: string
encoding: string
sha: string
size: number
url: string

GitGetCommitEndpoint

GitGetCommitEndpoint: object

Type declaration

commit_sha: string

commit_sha parameter
owner: string

owner parameter
repo: string

repo parameter

GitGetCommitRequestOptions

GitGetCommitRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/git/commits/:commit_sha"

GitGetCommitResponseData

GitGetCommitResponseData: object

Type declaration

author: GitGetCommitResponseDataAuthor
committer: GitGetCommitResponseDataCommitter
message: string
parents: Array<GitGetCommitResponseDataParentsItem>
sha: string
tree: GitGetCommitResponseDataTree
url: string
verification: GitGetCommitResponseDataVerification

GitGetCommitResponseDataAuthor

GitGetCommitResponseDataAuthor: object

Type declaration

date: string
email: string
name: string

GitGetCommitResponseDataCommitter

GitGetCommitResponseDataCommitter: object

Type declaration

date: string
email: string
name: string

GitGetCommitResponseDataParentsItem

GitGetCommitResponseDataParentsItem: object

Type declaration

sha: string
url: string

GitGetCommitResponseDataTree

GitGetCommitResponseDataTree: object

Type declaration

sha: string
url: string

GitGetCommitResponseDataVerification

GitGetCommitResponseDataVerification: object

Type declaration

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

GitGetRefEndpoint

GitGetRefEndpoint: object

Type declaration

owner: string

owner parameter
ref: string

ref parameter
repo: string

repo parameter

GitGetRefRequestOptions

GitGetRefRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/git/ref/:ref"

GitGetRefResponseData

GitGetRefResponseData: object

Type declaration

node_id: string
object: GitGetRefResponseDataObject
ref: string
url: string

GitGetRefResponseDataObject

GitGetRefResponseDataObject: object

Type declaration

sha: string
type: string
url: string

GitGetTagEndpoint

GitGetTagEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter
tag_sha: string

tag_sha parameter

GitGetTagRequestOptions

GitGetTagRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/git/tags/:tag_sha"

GitGetTagResponseData

GitGetTagResponseData: object

Type declaration

message: string
node_id: string
object: GitGetTagResponseDataObject
sha: string
tag: string
tagger: GitGetTagResponseDataTagger
url: string
verification: GitGetTagResponseDataVerification

GitGetTagResponseDataObject

GitGetTagResponseDataObject: object

Type declaration

sha: string
type: string
url: string

GitGetTagResponseDataTagger

GitGetTagResponseDataTagger: object

Type declaration

date: string
email: string
name: string

GitGetTagResponseDataVerification

GitGetTagResponseDataVerification: object

Type declaration

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

GitGetTreeEndpoint

GitGetTreeEndpoint: object

Type declaration

owner: string

owner parameter
Optional recursive?: "1"

recursive parameter
repo: string

repo parameter
tree_sha: string

tree_sha parameter

GitGetTreeRequestOptions

GitGetTreeRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/git/trees/:tree_sha"

GitGetTreeResponseData

GitGetTreeResponseData: object

Type declaration

sha: string
tree: Array<GitGetTreeResponseDataTreeItem>
truncated: boolean
url: string

GitGetTreeResponseDataTreeItem

GitGetTreeResponseDataTreeItem: object

Type declaration

mode: string
path: string
sha: string
Optional size?: number
type: string
url: string

GitListMatchingRefsEndpoint

GitListMatchingRefsEndpoint: object

Type declaration

owner: string

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
ref: string

ref parameter
repo: string

repo parameter

GitListMatchingRefsRequestOptions

GitListMatchingRefsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/git/matching-refs/:ref"

GitListMatchingRefsResponseData

GitListMatchingRefsResponseData: Array<GitListMatchingRefsResponseDataItem>

GitListMatchingRefsResponseDataItem

GitListMatchingRefsResponseDataItem: object

Type declaration

node_id: string
object: GitListMatchingRefsResponseDataItemObject
ref: string
url: string

GitListMatchingRefsResponseDataItemObject

GitListMatchingRefsResponseDataItemObject: object

Type declaration

sha: string
type: string
url: string

GitUpdateRefEndpoint

GitUpdateRefEndpoint: object

Type declaration

Optional force?: boolean

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

owner parameter
ref: string

ref parameter
repo: string

repo parameter
sha: string

The SHA1 value to set this reference to

GitUpdateRefRequestOptions

GitUpdateRefRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PATCH"
request: RequestRequestOptions
url: "/repos/:owner/:repo/git/refs/:ref"

GitUpdateRefResponseData

GitUpdateRefResponseData: object

Type declaration

node_id: string
object: GitUpdateRefResponseDataObject
ref: string
url: string

GitUpdateRefResponseDataObject

GitUpdateRefResponseDataObject: object

Type declaration

sha: string
type: string
url: string

GitignoreGetTemplateEndpoint

GitignoreGetTemplateEndpoint: object

Type declaration

name: string

name parameter

GitignoreGetTemplateRequestOptions

GitignoreGetTemplateRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/gitignore/templates/:name"

GitignoreGetTemplateResponseData

GitignoreGetTemplateResponseData: object

Type declaration

name: string
source: string

GitignoreListTemplatesEndpoint

GitignoreListTemplatesEndpoint: object

Type declaration

GitignoreListTemplatesRequestOptions

GitignoreListTemplatesRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/gitignore/templates"

GitignoreListTemplatesResponseData

GitignoreListTemplatesResponseData: Array<string>

InteractionsAddOrUpdateRestrictionsForOrgEndpoint

InteractionsAddOrUpdateRestrictionsForOrgEndpoint: object & RequiredPreview<"sombra">

InteractionsAddOrUpdateRestrictionsForOrgRequestOptions

InteractionsAddOrUpdateRestrictionsForOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PUT"
request: RequestRequestOptions
url: "/orgs/:org/interaction-limits"

InteractionsAddOrUpdateRestrictionsForOrgResponseData

InteractionsAddOrUpdateRestrictionsForOrgResponseData: object

Type declaration

expires_at: string
limit: string
origin: string

InteractionsAddOrUpdateRestrictionsForRepoEndpoint

InteractionsAddOrUpdateRestrictionsForRepoEndpoint: object & RequiredPreview<"sombra">

InteractionsAddOrUpdateRestrictionsForRepoRequestOptions

InteractionsAddOrUpdateRestrictionsForRepoRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PUT"
request: RequestRequestOptions
url: "/repos/:owner/:repo/interaction-limits"

InteractionsAddOrUpdateRestrictionsForRepoResponseData

InteractionsAddOrUpdateRestrictionsForRepoResponseData: object

Type declaration

expires_at: string
limit: string
origin: string

InteractionsGetRestrictionsForOrgEndpoint

InteractionsGetRestrictionsForOrgEndpoint: object & RequiredPreview<"sombra">

InteractionsGetRestrictionsForOrgRequestOptions

InteractionsGetRestrictionsForOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/orgs/:org/interaction-limits"

InteractionsGetRestrictionsForOrgResponseData

InteractionsGetRestrictionsForOrgResponseData: object

Type declaration

expires_at: string
limit: string
origin: string

InteractionsGetRestrictionsForRepoEndpoint

InteractionsGetRestrictionsForRepoEndpoint: object & RequiredPreview<"sombra">

InteractionsGetRestrictionsForRepoRequestOptions

InteractionsGetRestrictionsForRepoRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/interaction-limits"

InteractionsGetRestrictionsForRepoResponseData

InteractionsGetRestrictionsForRepoResponseData: object

Type declaration

expires_at: string
limit: string
origin: string

InteractionsRemoveRestrictionsForOrgEndpoint

InteractionsRemoveRestrictionsForOrgEndpoint: object & RequiredPreview<"sombra">

InteractionsRemoveRestrictionsForOrgRequestOptions

InteractionsRemoveRestrictionsForOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/orgs/:org/interaction-limits"

InteractionsRemoveRestrictionsForRepoEndpoint

InteractionsRemoveRestrictionsForRepoEndpoint: object & RequiredPreview<"sombra">

InteractionsRemoveRestrictionsForRepoRequestOptions

InteractionsRemoveRestrictionsForRepoRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/repos/:owner/:repo/interaction-limits"

IssuesAddAssigneesEndpoint

IssuesAddAssigneesEndpoint: object

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

issue_number parameter
owner: string

owner parameter
repo: string

repo parameter

IssuesAddAssigneesRequestOptions

IssuesAddAssigneesRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/issues/:issue_number/assignees"

IssuesAddAssigneesResponseData

IssuesAddAssigneesResponseData: object

Type declaration

active_lock_reason: string
assignee: IssuesAddAssigneesResponseDataAssignee
assignees: Array<IssuesAddAssigneesResponseDataAssigneesItem>
body: string
closed_at: null
comments: number
comments_url: string
created_at: string
events_url: string
html_url: string
id: number
labels: Array<IssuesAddAssigneesResponseDataLabelsItem>
labels_url: string
locked: boolean
milestone: IssuesAddAssigneesResponseDataMilestone
node_id: string
number: number
pull_request: IssuesAddAssigneesResponseDataPullRequest
repository_url: string
state: string
title: string
updated_at: string
url: string
user: IssuesAddAssigneesResponseDataUser

IssuesAddAssigneesResponseDataAssignee

IssuesAddAssigneesResponseDataAssignee: object

Type declaration

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

IssuesAddAssigneesResponseDataAssigneesItem

IssuesAddAssigneesResponseDataAssigneesItem: object

Type declaration

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

IssuesAddAssigneesResponseDataLabelsItem

IssuesAddAssigneesResponseDataLabelsItem: object

Type declaration

color: string
default: boolean
description: string
id: number
name: string
node_id: string
url: string

IssuesAddAssigneesResponseDataMilestone

IssuesAddAssigneesResponseDataMilestone: object

Type declaration

closed_at: string
closed_issues: number
created_at: string
creator: IssuesAddAssigneesResponseDataMilestoneCreator
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

IssuesAddAssigneesResponseDataMilestoneCreator

IssuesAddAssigneesResponseDataMilestoneCreator: object

Type declaration

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

IssuesAddAssigneesResponseDataPullRequest

IssuesAddAssigneesResponseDataPullRequest: object

Type declaration

diff_url: string
html_url: string
patch_url: string
url: string

IssuesAddAssigneesResponseDataUser

IssuesAddAssigneesResponseDataUser: object

Type declaration

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

IssuesAddLabelsEndpoint

IssuesAddLabelsEndpoint: object

Type declaration

issue_number: number

issue_number parameter
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

owner parameter
repo: string

repo parameter

IssuesAddLabelsRequestOptions

IssuesAddLabelsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/issues/:issue_number/labels"

IssuesAddLabelsResponseData

IssuesAddLabelsResponseData: Array<IssuesAddLabelsResponseDataItem>

IssuesAddLabelsResponseDataItem

IssuesAddLabelsResponseDataItem: object

Type declaration

color: string
default: boolean
description: string
id: number
name: string
node_id: string
url: string

IssuesCheckAssigneeEndpoint

IssuesCheckAssigneeEndpoint: object

Type declaration

assignee: string

assignee parameter
owner: string

owner parameter
repo: string

repo parameter

IssuesCheckAssigneeRequestOptions

IssuesCheckAssigneeRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/assignees/:assignee"

IssuesCreateCommentEndpoint

IssuesCreateCommentEndpoint: object

Type declaration

body: string

The contents of the comment.
issue_number: number

issue_number parameter
owner: string

owner parameter
repo: string

repo parameter

IssuesCreateCommentRequestOptions

IssuesCreateCommentRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/issues/:issue_number/comments"

IssuesCreateCommentResponseData

IssuesCreateCommentResponseData: object

Type declaration

body: string
created_at: string
html_url: string
id: number
node_id: string
updated_at: string
url: string
user: IssuesCreateCommentResponseDataUser

IssuesCreateCommentResponseDataUser

IssuesCreateCommentResponseDataUser: object

Type declaration

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

IssuesCreateEndpoint

IssuesCreateEndpoint: object

Type declaration

Optional assignee?: 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.
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?: 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?: 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

owner parameter
repo: string

repo parameter
title: string

The title of the issue.

IssuesCreateLabelEndpoint

IssuesCreateLabelEndpoint: object

Type declaration

color: string

The hexadecimal color code for the label, without the leading #.
Optional description?: 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 . For a full list of available emoji and codes, see emoji-cheat-sheet.com.
owner: string

owner parameter
repo: string

repo parameter

IssuesCreateLabelRequestOptions

IssuesCreateLabelRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/labels"

IssuesCreateLabelResponseData

IssuesCreateLabelResponseData: object

Type declaration

color: string
default: boolean
description: string
id: number
name: string
node_id: string
url: string

IssuesCreateMilestoneEndpoint

IssuesCreateMilestoneEndpoint: object

Type declaration

Optional description?: string

A description of the milestone.
Optional due_on?: string

The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
owner: string

owner parameter
repo: string

repo parameter
Optional state?: "open" | "closed"

The state of the milestone. Either open or closed.
title: string

The title of the milestone.

IssuesCreateMilestoneRequestOptions

IssuesCreateMilestoneRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/milestones"

IssuesCreateMilestoneResponseData

IssuesCreateMilestoneResponseData: object

Type declaration

closed_at: string
closed_issues: number
created_at: string
creator: IssuesCreateMilestoneResponseDataCreator
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

IssuesCreateMilestoneResponseDataCreator

IssuesCreateMilestoneResponseDataCreator: object

Type declaration

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

IssuesCreateRequestOptions

IssuesCreateRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/issues"

IssuesCreateResponseData

IssuesCreateResponseData: object

Type declaration

active_lock_reason: string
assignee: IssuesCreateResponseDataAssignee
assignees: Array<IssuesCreateResponseDataAssigneesItem>
body: string
closed_at: null
closed_by: IssuesCreateResponseDataClosedBy
comments: number
comments_url: string
created_at: string
events_url: string
html_url: string
id: number
labels: Array<IssuesCreateResponseDataLabelsItem>
labels_url: string
locked: boolean
milestone: IssuesCreateResponseDataMilestone
node_id: string
number: number
pull_request: IssuesCreateResponseDataPullRequest
repository_url: string
state: string
title: string
updated_at: string
url: string
user: IssuesCreateResponseDataUser

IssuesCreateResponseDataAssignee

IssuesCreateResponseDataAssignee: object

Type declaration

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

IssuesCreateResponseDataAssigneesItem

IssuesCreateResponseDataAssigneesItem: object

Type declaration

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

IssuesCreateResponseDataClosedBy

IssuesCreateResponseDataClosedBy: object

Type declaration

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

IssuesCreateResponseDataLabelsItem

IssuesCreateResponseDataLabelsItem: object

Type declaration

color: string
default: boolean
description: string
id: number
name: string
node_id: string
url: string

IssuesCreateResponseDataMilestone

IssuesCreateResponseDataMilestone: object

Type declaration

closed_at: string
closed_issues: number
created_at: string
creator: IssuesCreateResponseDataMilestoneCreator
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

IssuesCreateResponseDataMilestoneCreator

IssuesCreateResponseDataMilestoneCreator: object

Type declaration

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

IssuesCreateResponseDataPullRequest

IssuesCreateResponseDataPullRequest: object

Type declaration

diff_url: string
html_url: string
patch_url: string
url: string

IssuesCreateResponseDataUser

IssuesCreateResponseDataUser: object

Type declaration

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

IssuesDeleteCommentEndpoint

IssuesDeleteCommentEndpoint: object

Type declaration

comment_id: number

comment_id parameter
owner: string

owner parameter
repo: string

repo parameter

IssuesDeleteCommentRequestOptions

IssuesDeleteCommentRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/repos/:owner/:repo/issues/comments/:comment_id"

IssuesDeleteLabelEndpoint

IssuesDeleteLabelEndpoint: object

Type declaration

name: string

name parameter
owner: string

owner parameter
repo: string

repo parameter

IssuesDeleteLabelRequestOptions

IssuesDeleteLabelRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/repos/:owner/:repo/labels/:name"

IssuesDeleteMilestoneEndpoint

IssuesDeleteMilestoneEndpoint: object

Type declaration

milestone_number: number

milestone_number parameter
owner: string

owner parameter
repo: string

repo parameter

IssuesDeleteMilestoneRequestOptions

IssuesDeleteMilestoneRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/repos/:owner/:repo/milestones/:milestone_number"

IssuesGetCommentEndpoint

IssuesGetCommentEndpoint: object

Type declaration

comment_id: number

comment_id parameter
owner: string

owner parameter
repo: string

repo parameter

IssuesGetCommentRequestOptions

IssuesGetCommentRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/issues/comments/:comment_id"

IssuesGetCommentResponseData

IssuesGetCommentResponseData: object

Type declaration

body: string
created_at: string
html_url: string
id: number
node_id: string
updated_at: string
url: string
user: IssuesGetCommentResponseDataUser

IssuesGetCommentResponseDataUser

IssuesGetCommentResponseDataUser: object

Type declaration

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

IssuesGetEndpoint

IssuesGetEndpoint: object

Type declaration

issue_number: number

issue_number parameter
owner: string

owner parameter
repo: string

repo parameter

IssuesGetEventEndpoint

IssuesGetEventEndpoint: object

Type declaration

event_id: number

event_id parameter
owner: string

owner parameter
repo: string

repo parameter

IssuesGetEventRequestOptions

IssuesGetEventRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/issues/events/:event_id"

IssuesGetEventResponseData

IssuesGetEventResponseData: object

Type declaration

actor: IssuesGetEventResponseDataActor
commit_id: string
commit_url: string
created_at: string
event: string
id: number
issue: IssuesGetEventResponseDataIssue
node_id: string
url: string

IssuesGetEventResponseDataActor

IssuesGetEventResponseDataActor: object

Type declaration

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

IssuesGetEventResponseDataIssue

IssuesGetEventResponseDataIssue: object

Type declaration

active_lock_reason: string
assignee: IssuesGetEventResponseDataIssueAssignee
assignees: Array<IssuesGetEventResponseDataIssueAssigneesItem>
body: string
closed_at: null
comments: number
comments_url: string
created_at: string
events_url: string
html_url: string
id: number
labels: Array<IssuesGetEventResponseDataIssueLabelsItem>
labels_url: string
locked: boolean
milestone: IssuesGetEventResponseDataIssueMilestone
node_id: string
number: number
pull_request: IssuesGetEventResponseDataIssuePullRequest
repository_url: string
state: string
title: string
updated_at: string
url: string
user: IssuesGetEventResponseDataIssueUser

IssuesGetEventResponseDataIssueAssignee

IssuesGetEventResponseDataIssueAssignee: object

Type declaration

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

IssuesGetEventResponseDataIssueAssigneesItem

IssuesGetEventResponseDataIssueAssigneesItem: object

Type declaration

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

IssuesGetEventResponseDataIssueLabelsItem

IssuesGetEventResponseDataIssueLabelsItem: object

Type declaration

color: string
default: boolean
description: string
id: number
name: string
node_id: string
url: string

IssuesGetEventResponseDataIssueMilestone

IssuesGetEventResponseDataIssueMilestone: object

Type declaration

closed_at: string
closed_issues: number
created_at: string
creator: IssuesGetEventResponseDataIssueMilestoneCreator
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

IssuesGetEventResponseDataIssueMilestoneCreator

IssuesGetEventResponseDataIssueMilestoneCreator: object

Type declaration

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

IssuesGetEventResponseDataIssuePullRequest

IssuesGetEventResponseDataIssuePullRequest: object

Type declaration

diff_url: string
html_url: string
patch_url: string
url: string

IssuesGetEventResponseDataIssueUser

IssuesGetEventResponseDataIssueUser: object

Type declaration

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

IssuesGetLabelEndpoint

IssuesGetLabelEndpoint: object

Type declaration

name: string

name parameter
owner: string

owner parameter
repo: string

repo parameter

IssuesGetLabelRequestOptions

IssuesGetLabelRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/labels/:name"

IssuesGetLabelResponseData

IssuesGetLabelResponseData: object

Type declaration

color: string
default: boolean
description: string
id: number
name: string
node_id: string
url: string

IssuesGetMilestoneEndpoint

IssuesGetMilestoneEndpoint: object

Type declaration

milestone_number: number

milestone_number parameter
owner: string

owner parameter
repo: string

repo parameter

IssuesGetMilestoneRequestOptions

IssuesGetMilestoneRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/milestones/:milestone_number"

IssuesGetMilestoneResponseData

IssuesGetMilestoneResponseData: object

Type declaration

closed_at: string
closed_issues: number
created_at: string
creator: IssuesGetMilestoneResponseDataCreator
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

IssuesGetMilestoneResponseDataCreator

IssuesGetMilestoneResponseDataCreator: object

Type declaration

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

IssuesGetRequestOptions

IssuesGetRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/issues/:issue_number"

IssuesGetResponseData

IssuesGetResponseData: object

Type declaration

active_lock_reason: string
assignee: IssuesGetResponseDataAssignee
assignees: Array<IssuesGetResponseDataAssigneesItem>
body: string
closed_at: null
closed_by: IssuesGetResponseDataClosedBy
comments: number
comments_url: string
created_at: string
events_url: string
html_url: string
id: number
labels: Array<IssuesGetResponseDataLabelsItem>
labels_url: string
locked: boolean
milestone: IssuesGetResponseDataMilestone
node_id: string
number: number
pull_request: IssuesGetResponseDataPullRequest
repository_url: string
state: string
title: string
updated_at: string
url: string
user: IssuesGetResponseDataUser

IssuesGetResponseDataAssignee

IssuesGetResponseDataAssignee: object

Type declaration

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

IssuesGetResponseDataAssigneesItem

IssuesGetResponseDataAssigneesItem: object

Type declaration

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

IssuesGetResponseDataClosedBy

IssuesGetResponseDataClosedBy: object

Type declaration

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

IssuesGetResponseDataLabelsItem

IssuesGetResponseDataLabelsItem: object

Type declaration

color: string
default: boolean
description: string
id: number
name: string
node_id: string
url: string

IssuesGetResponseDataMilestone

IssuesGetResponseDataMilestone: object

Type declaration

closed_at: string
closed_issues: number
created_at: string
creator: IssuesGetResponseDataMilestoneCreator
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

IssuesGetResponseDataMilestoneCreator

IssuesGetResponseDataMilestoneCreator: object

Type declaration

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

IssuesGetResponseDataPullRequest

IssuesGetResponseDataPullRequest: object

Type declaration

diff_url: string
html_url: string
patch_url: string
url: string

IssuesGetResponseDataUser

IssuesGetResponseDataUser: object

Type declaration

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

IssuesListAssigneesEndpoint

IssuesListAssigneesEndpoint: object

Type declaration

owner: string

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
repo: string

repo parameter

IssuesListAssigneesRequestOptions

IssuesListAssigneesRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/assignees"

IssuesListAssigneesResponseData

IssuesListAssigneesResponseData: Array<IssuesListAssigneesResponseDataItem>

IssuesListAssigneesResponseDataItem

IssuesListAssigneesResponseDataItem: object

Type declaration

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

IssuesListCommentsEndpoint

IssuesListCommentsEndpoint: object

Type declaration

issue_number: number

issue_number parameter
owner: string

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
repo: string

repo parameter
Optional since?: string

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

IssuesListCommentsForRepoEndpoint

IssuesListCommentsForRepoEndpoint: object

Type declaration

Optional direction?: "asc" | "desc"

Either asc or desc. Ignored without the sort parameter.
owner: string

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
repo: string

repo parameter
Optional since?: 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.

IssuesListCommentsForRepoRequestOptions

IssuesListCommentsForRepoRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/issues/comments"

IssuesListCommentsForRepoResponseData

IssuesListCommentsForRepoResponseData: Array<IssuesListCommentsForRepoResponseDataItem>

IssuesListCommentsForRepoResponseDataItem

IssuesListCommentsForRepoResponseDataItem: object

Type declaration

body: string
created_at: string
html_url: string
id: number
node_id: string
updated_at: string
url: string
user: IssuesListCommentsForRepoResponseDataItemUser

IssuesListCommentsForRepoResponseDataItemUser

IssuesListCommentsForRepoResponseDataItemUser: object

Type declaration

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

IssuesListCommentsRequestOptions

IssuesListCommentsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/issues/:issue_number/comments"

IssuesListCommentsResponseData

IssuesListCommentsResponseData: Array<IssuesListCommentsResponseDataItem>

IssuesListCommentsResponseDataItem

IssuesListCommentsResponseDataItem: object

Type declaration

body: string
created_at: string
html_url: string
id: number
node_id: string
updated_at: string
url: string
user: IssuesListCommentsResponseDataItemUser

IssuesListCommentsResponseDataItemUser

IssuesListCommentsResponseDataItemUser: object

Type declaration

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

IssuesListEndpoint

IssuesListEndpoint: object

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?: string

A list of comma separated label names. Example: bug,ui,@high
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
Optional since?: 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.

IssuesListEventsEndpoint

IssuesListEventsEndpoint: object

Type declaration

issue_number: number

issue_number parameter
owner: string

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
repo: string

repo parameter

IssuesListEventsForRepoEndpoint

IssuesListEventsForRepoEndpoint: object

Type declaration

owner: string

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
repo: string

repo parameter

IssuesListEventsForRepoRequestOptions

IssuesListEventsForRepoRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/issues/events"

IssuesListEventsForRepoResponseData

IssuesListEventsForRepoResponseData: Array<IssuesListEventsForRepoResponseDataItem>

IssuesListEventsForRepoResponseDataItem

IssuesListEventsForRepoResponseDataItem: object

Type declaration

actor: IssuesListEventsForRepoResponseDataItemActor
commit_id: string
commit_url: string
created_at: string
event: string
id: number
issue: IssuesListEventsForRepoResponseDataItemIssue
node_id: string
url: string

IssuesListEventsForRepoResponseDataItemActor

IssuesListEventsForRepoResponseDataItemActor: object

Type declaration

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

IssuesListEventsForRepoResponseDataItemIssue

IssuesListEventsForRepoResponseDataItemIssue: object

Type declaration

active_lock_reason: string
assignee: IssuesListEventsForRepoResponseDataItemIssueAssignee
assignees: Array<IssuesListEventsForRepoResponseDataItemIssueAssigneesItem>
body: string
closed_at: null
comments: number
comments_url: string
created_at: string
events_url: string
html_url: string
id: number
labels: Array<IssuesListEventsForRepoResponseDataItemIssueLabelsItem>
labels_url: string
locked: boolean
milestone: IssuesListEventsForRepoResponseDataItemIssueMilestone
node_id: string
number: number
pull_request: IssuesListEventsForRepoResponseDataItemIssuePullRequest
repository_url: string
state: string
title: string
updated_at: string
url: string
user: IssuesListEventsForRepoResponseDataItemIssueUser

IssuesListEventsForRepoResponseDataItemIssueAssignee

IssuesListEventsForRepoResponseDataItemIssueAssignee: object

Type declaration

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

IssuesListEventsForRepoResponseDataItemIssueAssigneesItem

IssuesListEventsForRepoResponseDataItemIssueAssigneesItem: object

Type declaration

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

IssuesListEventsForRepoResponseDataItemIssueLabelsItem

IssuesListEventsForRepoResponseDataItemIssueLabelsItem: object

Type declaration

color: string
default: boolean
description: string
id: number
name: string
node_id: string
url: string

IssuesListEventsForRepoResponseDataItemIssueMilestone

IssuesListEventsForRepoResponseDataItemIssueMilestone: object

Type declaration

closed_at: string
closed_issues: number
created_at: string
creator: IssuesListEventsForRepoResponseDataItemIssueMilestoneCreator
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

IssuesListEventsForRepoResponseDataItemIssueMilestoneCreator

IssuesListEventsForRepoResponseDataItemIssueMilestoneCreator: object

Type declaration

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

IssuesListEventsForRepoResponseDataItemIssuePullRequest

IssuesListEventsForRepoResponseDataItemIssuePullRequest: object

Type declaration

diff_url: string
html_url: string
patch_url: string
url: string

IssuesListEventsForRepoResponseDataItemIssueUser

IssuesListEventsForRepoResponseDataItemIssueUser: object

Type declaration

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

IssuesListEventsForTimelineEndpoint

IssuesListEventsForTimelineEndpoint: object & RequiredPreview<"mockingbird">

IssuesListEventsForTimelineRequestOptions

IssuesListEventsForTimelineRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/issues/:issue_number/timeline"

IssuesListEventsForTimelineResponseData

IssuesListEventsForTimelineResponseData: Array<IssuesListEventsForTimelineResponseDataItem>

IssuesListEventsForTimelineResponseDataItem

IssuesListEventsForTimelineResponseDataItem: object

Type declaration

actor: IssuesListEventsForTimelineResponseDataItemActor
commit_id: string
commit_url: string
created_at: string
event: string
id: number
node_id: string
url: string

IssuesListEventsForTimelineResponseDataItemActor

IssuesListEventsForTimelineResponseDataItemActor: object

Type declaration

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

IssuesListEventsRequestOptions

IssuesListEventsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/issues/:issue_number/events"

IssuesListEventsResponseData

IssuesListEventsResponseData: Array<IssuesListEventsResponseDataItem>

IssuesListEventsResponseDataItem

IssuesListEventsResponseDataItem: object

Type declaration

actor: IssuesListEventsResponseDataItemActor
commit_id: string
commit_url: string
created_at: string
event: string
id: number
node_id: string
url: string

IssuesListEventsResponseDataItemActor

IssuesListEventsResponseDataItemActor: object

Type declaration

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

IssuesListForAuthenticatedUserEndpoint

IssuesListForAuthenticatedUserEndpoint: object

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?: string

A list of comma separated label names. Example: bug,ui,@high
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
Optional since?: 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.

IssuesListForAuthenticatedUserRequestOptions

IssuesListForAuthenticatedUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/user/issues"

IssuesListForAuthenticatedUserResponseData

IssuesListForAuthenticatedUserResponseData: Array<IssuesListForAuthenticatedUserResponseDataItem>

IssuesListForAuthenticatedUserResponseDataItem

IssuesListForAuthenticatedUserResponseDataItem: object

Type declaration

active_lock_reason: string
assignee: IssuesListForAuthenticatedUserResponseDataItemAssignee
assignees: Array<IssuesListForAuthenticatedUserResponseDataItemAssigneesItem>
body: string
closed_at: null
comments: number
comments_url: string
created_at: string
events_url: string
html_url: string
id: number
labels: Array<IssuesListForAuthenticatedUserResponseDataItemLabelsItem>
labels_url: string
locked: boolean
milestone: IssuesListForAuthenticatedUserResponseDataItemMilestone
node_id: string
number: number
pull_request: IssuesListForAuthenticatedUserResponseDataItemPullRequest
repository: IssuesListForAuthenticatedUserResponseDataItemRepository
repository_url: string
state: string
title: string
updated_at: string
url: string
user: IssuesListForAuthenticatedUserResponseDataItemUser

IssuesListForAuthenticatedUserResponseDataItemAssignee

IssuesListForAuthenticatedUserResponseDataItemAssignee: object

Type declaration

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

IssuesListForAuthenticatedUserResponseDataItemAssigneesItem

IssuesListForAuthenticatedUserResponseDataItemAssigneesItem: object

Type declaration

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

IssuesListForAuthenticatedUserResponseDataItemLabelsItem

IssuesListForAuthenticatedUserResponseDataItemLabelsItem: object

Type declaration

color: string
default: boolean
description: string
id: number
name: string
node_id: string
url: string

IssuesListForAuthenticatedUserResponseDataItemMilestone

IssuesListForAuthenticatedUserResponseDataItemMilestone: object

Type declaration

closed_at: string
closed_issues: number
created_at: string
creator: IssuesListForAuthenticatedUserResponseDataItemMilestoneCreator
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

IssuesListForAuthenticatedUserResponseDataItemMilestoneCreator

IssuesListForAuthenticatedUserResponseDataItemMilestoneCreator: object

Type declaration

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

IssuesListForAuthenticatedUserResponseDataItemPullRequest

IssuesListForAuthenticatedUserResponseDataItemPullRequest: object

Type declaration

diff_url: string
html_url: string
patch_url: string
url: string

IssuesListForAuthenticatedUserResponseDataItemRepository

IssuesListForAuthenticatedUserResponseDataItemRepository: object

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: IssuesListForAuthenticatedUserResponseDataItemRepositoryOwner
permissions: IssuesListForAuthenticatedUserResponseDataItemRepositoryPermissions
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

IssuesListForAuthenticatedUserResponseDataItemRepositoryOwner

IssuesListForAuthenticatedUserResponseDataItemRepositoryOwner: object

Type declaration

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

IssuesListForAuthenticatedUserResponseDataItemRepositoryPermissions

IssuesListForAuthenticatedUserResponseDataItemRepositoryPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

IssuesListForAuthenticatedUserResponseDataItemUser

IssuesListForAuthenticatedUserResponseDataItemUser: object

Type declaration

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

IssuesListForOrgEndpoint

IssuesListForOrgEndpoint: object

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?: string

A list of comma separated label names. Example: bug,ui,@high
org: string

org parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
Optional since?: 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.

IssuesListForOrgRequestOptions

IssuesListForOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/orgs/:org/issues"

IssuesListForOrgResponseData

IssuesListForOrgResponseData: Array<IssuesListForOrgResponseDataItem>

IssuesListForOrgResponseDataItem

IssuesListForOrgResponseDataItem: object

Type declaration

active_lock_reason: string
assignee: IssuesListForOrgResponseDataItemAssignee
assignees: Array<IssuesListForOrgResponseDataItemAssigneesItem>
body: string
closed_at: null
comments: number
comments_url: string
created_at: string
events_url: string
html_url: string
id: number
labels: Array<IssuesListForOrgResponseDataItemLabelsItem>
labels_url: string
locked: boolean
milestone: IssuesListForOrgResponseDataItemMilestone
node_id: string
number: number
pull_request: IssuesListForOrgResponseDataItemPullRequest
repository: IssuesListForOrgResponseDataItemRepository
repository_url: string
state: string
title: string
updated_at: string
url: string
user: IssuesListForOrgResponseDataItemUser

IssuesListForOrgResponseDataItemAssignee

IssuesListForOrgResponseDataItemAssignee: object

Type declaration

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

IssuesListForOrgResponseDataItemAssigneesItem

IssuesListForOrgResponseDataItemAssigneesItem: object

Type declaration

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

IssuesListForOrgResponseDataItemLabelsItem

IssuesListForOrgResponseDataItemLabelsItem: object

Type declaration

color: string
default: boolean
description: string
id: number
name: string
node_id: string
url: string

IssuesListForOrgResponseDataItemMilestone

IssuesListForOrgResponseDataItemMilestone: object

Type declaration

closed_at: string
closed_issues: number
created_at: string
creator: IssuesListForOrgResponseDataItemMilestoneCreator
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

IssuesListForOrgResponseDataItemMilestoneCreator

IssuesListForOrgResponseDataItemMilestoneCreator: object

Type declaration

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

IssuesListForOrgResponseDataItemPullRequest

IssuesListForOrgResponseDataItemPullRequest: object

Type declaration

diff_url: string
html_url: string
patch_url: string
url: string

IssuesListForOrgResponseDataItemRepository

IssuesListForOrgResponseDataItemRepository: object

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: IssuesListForOrgResponseDataItemRepositoryOwner
permissions: IssuesListForOrgResponseDataItemRepositoryPermissions
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

IssuesListForOrgResponseDataItemRepositoryOwner

IssuesListForOrgResponseDataItemRepositoryOwner: object

Type declaration

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

IssuesListForOrgResponseDataItemRepositoryPermissions

IssuesListForOrgResponseDataItemRepositoryPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

IssuesListForOrgResponseDataItemUser

IssuesListForOrgResponseDataItemUser: object

Type declaration

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

IssuesListForRepoEndpoint

IssuesListForRepoEndpoint: object

Type declaration

Optional assignee?: 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?: string

The user that created the issue.
Optional direction?: "asc" | "desc"

The direction of the sort. Can be either asc or desc.
Optional labels?: string

A list of comma separated label names. Example: bug,ui,@high
Optional mentioned?: string

A user that's mentioned in the issue.
Optional milestone?: 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

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
repo: string

repo parameter
Optional since?: 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.

IssuesListForRepoRequestOptions

IssuesListForRepoRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/issues"

IssuesListForRepoResponseData

IssuesListForRepoResponseData: Array<IssuesListForRepoResponseDataItem>

IssuesListForRepoResponseDataItem

IssuesListForRepoResponseDataItem: object

Type declaration

active_lock_reason: string
assignee: IssuesListForRepoResponseDataItemAssignee
assignees: Array<IssuesListForRepoResponseDataItemAssigneesItem>
body: string
closed_at: null
comments: number
comments_url: string
created_at: string
events_url: string
html_url: string
id: number
labels: Array<IssuesListForRepoResponseDataItemLabelsItem>
labels_url: string
locked: boolean
milestone: IssuesListForRepoResponseDataItemMilestone
node_id: string
number: number
pull_request: IssuesListForRepoResponseDataItemPullRequest
repository_url: string
state: string
title: string
updated_at: string
url: string
user: IssuesListForRepoResponseDataItemUser

IssuesListForRepoResponseDataItemAssignee

IssuesListForRepoResponseDataItemAssignee: object

Type declaration

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

IssuesListForRepoResponseDataItemAssigneesItem

IssuesListForRepoResponseDataItemAssigneesItem: object

Type declaration

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

IssuesListForRepoResponseDataItemLabelsItem

IssuesListForRepoResponseDataItemLabelsItem: object

Type declaration

color: string
default: boolean
description: string
id: number
name: string
node_id: string
url: string

IssuesListForRepoResponseDataItemMilestone

IssuesListForRepoResponseDataItemMilestone: object

Type declaration

closed_at: string
closed_issues: number
created_at: string
creator: IssuesListForRepoResponseDataItemMilestoneCreator
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

IssuesListForRepoResponseDataItemMilestoneCreator

IssuesListForRepoResponseDataItemMilestoneCreator: object

Type declaration

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

IssuesListForRepoResponseDataItemPullRequest

IssuesListForRepoResponseDataItemPullRequest: object

Type declaration

diff_url: string
html_url: string
patch_url: string
url: string

IssuesListForRepoResponseDataItemUser

IssuesListForRepoResponseDataItemUser: object

Type declaration

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

IssuesListLabelsForMilestoneEndpoint

IssuesListLabelsForMilestoneEndpoint: object

Type declaration

milestone_number: number

milestone_number parameter
owner: string

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
repo: string

repo parameter

IssuesListLabelsForMilestoneRequestOptions

IssuesListLabelsForMilestoneRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/milestones/:milestone_number/labels"

IssuesListLabelsForMilestoneResponseData

IssuesListLabelsForMilestoneResponseData: Array<IssuesListLabelsForMilestoneResponseDataItem>

IssuesListLabelsForMilestoneResponseDataItem

IssuesListLabelsForMilestoneResponseDataItem: object

Type declaration

color: string
default: boolean
description: string
id: number
name: string
node_id: string
url: string

IssuesListLabelsForRepoEndpoint

IssuesListLabelsForRepoEndpoint: object

Type declaration

owner: string

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
repo: string

repo parameter

IssuesListLabelsForRepoRequestOptions

IssuesListLabelsForRepoRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/labels"

IssuesListLabelsForRepoResponseData

IssuesListLabelsForRepoResponseData: Array<IssuesListLabelsForRepoResponseDataItem>

IssuesListLabelsForRepoResponseDataItem

IssuesListLabelsForRepoResponseDataItem: object

Type declaration

color: string
default: boolean
description: string
id: number
name: string
node_id: string
url: string

IssuesListLabelsOnIssueEndpoint

IssuesListLabelsOnIssueEndpoint: object

Type declaration

issue_number: number

issue_number parameter
owner: string

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
repo: string

repo parameter

IssuesListLabelsOnIssueRequestOptions

IssuesListLabelsOnIssueRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/issues/:issue_number/labels"

IssuesListLabelsOnIssueResponseData

IssuesListLabelsOnIssueResponseData: Array<IssuesListLabelsOnIssueResponseDataItem>

IssuesListLabelsOnIssueResponseDataItem

IssuesListLabelsOnIssueResponseDataItem: object

Type declaration

color: string
default: boolean
description: string
id: number
name: string
node_id: string
url: string

IssuesListMilestonesForRepoEndpoint

IssuesListMilestonesForRepoEndpoint: object

Type declaration

Optional direction?: "asc" | "desc"

The direction of the sort. Either asc or desc.
owner: string

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
repo: string

repo parameter
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.

IssuesListMilestonesForRepoRequestOptions

IssuesListMilestonesForRepoRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/milestones"

IssuesListMilestonesForRepoResponseData

IssuesListMilestonesForRepoResponseData: Array<IssuesListMilestonesForRepoResponseDataItem>

IssuesListMilestonesForRepoResponseDataItem

IssuesListMilestonesForRepoResponseDataItem: object

Type declaration

closed_at: string
closed_issues: number
created_at: string
creator: IssuesListMilestonesForRepoResponseDataItemCreator
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

IssuesListMilestonesForRepoResponseDataItemCreator

IssuesListMilestonesForRepoResponseDataItemCreator: object

Type declaration

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

IssuesListRequestOptions

IssuesListRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/issues"

IssuesListResponseData

IssuesListResponseData: Array<IssuesListResponseDataItem>

IssuesListResponseDataItem

IssuesListResponseDataItem: object

Type declaration

active_lock_reason: string
assignee: IssuesListResponseDataItemAssignee
assignees: Array<IssuesListResponseDataItemAssigneesItem>
body: string
closed_at: null
comments: number
comments_url: string
created_at: string
events_url: string
html_url: string
id: number
labels: Array<IssuesListResponseDataItemLabelsItem>
labels_url: string
locked: boolean
milestone: IssuesListResponseDataItemMilestone
node_id: string
number: number
pull_request: IssuesListResponseDataItemPullRequest
repository: IssuesListResponseDataItemRepository
repository_url: string
state: string
title: string
updated_at: string
url: string
user: IssuesListResponseDataItemUser

IssuesListResponseDataItemAssignee

IssuesListResponseDataItemAssignee: object

Type declaration

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

IssuesListResponseDataItemAssigneesItem

IssuesListResponseDataItemAssigneesItem: object

Type declaration

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

IssuesListResponseDataItemLabelsItem

IssuesListResponseDataItemLabelsItem: object

Type declaration

color: string
default: boolean
description: string
id: number
name: string
node_id: string
url: string

IssuesListResponseDataItemMilestone

IssuesListResponseDataItemMilestone: object

Type declaration

closed_at: string
closed_issues: number
created_at: string
creator: IssuesListResponseDataItemMilestoneCreator
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

IssuesListResponseDataItemMilestoneCreator

IssuesListResponseDataItemMilestoneCreator: object

Type declaration

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

IssuesListResponseDataItemPullRequest

IssuesListResponseDataItemPullRequest: object

Type declaration

diff_url: string
html_url: string
patch_url: string
url: string

IssuesListResponseDataItemRepository

IssuesListResponseDataItemRepository: object

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: IssuesListResponseDataItemRepositoryOwner
permissions: IssuesListResponseDataItemRepositoryPermissions
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

IssuesListResponseDataItemRepositoryOwner

IssuesListResponseDataItemRepositoryOwner: object

Type declaration

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

IssuesListResponseDataItemRepositoryPermissions

IssuesListResponseDataItemRepositoryPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

IssuesListResponseDataItemUser

IssuesListResponseDataItemUser: object

Type declaration

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

IssuesLockEndpoint

IssuesLockEndpoint: object

Type declaration

issue_number: number

issue_number parameter
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

owner parameter
repo: string

repo parameter

IssuesLockRequestOptions

IssuesLockRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PUT"
request: RequestRequestOptions
url: "/repos/:owner/:repo/issues/:issue_number/lock"

IssuesRemoveAllLabelsEndpoint

IssuesRemoveAllLabelsEndpoint: object

Type declaration

issue_number: number

issue_number parameter
owner: string

owner parameter
repo: string

repo parameter

IssuesRemoveAllLabelsRequestOptions

IssuesRemoveAllLabelsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/repos/:owner/:repo/issues/:issue_number/labels"

IssuesRemoveAssigneesEndpoint

IssuesRemoveAssigneesEndpoint: object

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

issue_number parameter
owner: string

owner parameter
repo: string

repo parameter

IssuesRemoveAssigneesRequestOptions

IssuesRemoveAssigneesRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/repos/:owner/:repo/issues/:issue_number/assignees"

IssuesRemoveAssigneesResponseData

IssuesRemoveAssigneesResponseData: object

Type declaration

active_lock_reason: string
assignee: IssuesRemoveAssigneesResponseDataAssignee
assignees: Array<IssuesRemoveAssigneesResponseDataAssigneesItem>
body: string
closed_at: null
comments: number
comments_url: string
created_at: string
events_url: string
html_url: string
id: number
labels: Array<IssuesRemoveAssigneesResponseDataLabelsItem>
labels_url: string
locked: boolean
milestone: IssuesRemoveAssigneesResponseDataMilestone
node_id: string
number: number
pull_request: IssuesRemoveAssigneesResponseDataPullRequest
repository_url: string
state: string
title: string
updated_at: string
url: string
user: IssuesRemoveAssigneesResponseDataUser

IssuesRemoveAssigneesResponseDataAssignee

IssuesRemoveAssigneesResponseDataAssignee: object

Type declaration

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

IssuesRemoveAssigneesResponseDataAssigneesItem

IssuesRemoveAssigneesResponseDataAssigneesItem: object

Type declaration

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

IssuesRemoveAssigneesResponseDataLabelsItem

IssuesRemoveAssigneesResponseDataLabelsItem: object

Type declaration

color: string
default: boolean
description: string
id: number
name: string
node_id: string
url: string

IssuesRemoveAssigneesResponseDataMilestone

IssuesRemoveAssigneesResponseDataMilestone: object

Type declaration

closed_at: string
closed_issues: number
created_at: string
creator: IssuesRemoveAssigneesResponseDataMilestoneCreator
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

IssuesRemoveAssigneesResponseDataMilestoneCreator

IssuesRemoveAssigneesResponseDataMilestoneCreator: object

Type declaration

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

IssuesRemoveAssigneesResponseDataPullRequest

IssuesRemoveAssigneesResponseDataPullRequest: object

Type declaration

diff_url: string
html_url: string
patch_url: string
url: string

IssuesRemoveAssigneesResponseDataUser

IssuesRemoveAssigneesResponseDataUser: object

Type declaration

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

IssuesRemoveLabelEndpoint

IssuesRemoveLabelEndpoint: object

Type declaration

issue_number: number

issue_number parameter
name: string

name parameter
owner: string

owner parameter
repo: string

repo parameter

IssuesRemoveLabelRequestOptions

IssuesRemoveLabelRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/repos/:owner/:repo/issues/:issue_number/labels/:name"

IssuesRemoveLabelResponseData

IssuesRemoveLabelResponseData: Array<IssuesRemoveLabelResponseDataItem>

IssuesRemoveLabelResponseDataItem

IssuesRemoveLabelResponseDataItem: object

Type declaration

color: string
default: boolean
description: string
id: number
name: string
node_id: string
url: string

IssuesReplaceAllLabelsEndpoint

IssuesReplaceAllLabelsEndpoint: object

Type declaration

issue_number: number

issue_number parameter
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

owner parameter
repo: string

repo parameter

IssuesReplaceAllLabelsRequestOptions

IssuesReplaceAllLabelsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PUT"
request: RequestRequestOptions
url: "/repos/:owner/:repo/issues/:issue_number/labels"

IssuesReplaceAllLabelsResponseData

IssuesReplaceAllLabelsResponseData: Array<IssuesReplaceAllLabelsResponseDataItem>

IssuesReplaceAllLabelsResponseDataItem

IssuesReplaceAllLabelsResponseDataItem: object

Type declaration

color: string
default: boolean
description: string
id: number
name: string
node_id: string
url: string

IssuesUnlockEndpoint

IssuesUnlockEndpoint: object

Type declaration

issue_number: number

issue_number parameter
owner: string

owner parameter
repo: string

repo parameter

IssuesUnlockRequestOptions

IssuesUnlockRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/repos/:owner/:repo/issues/:issue_number/lock"

IssuesUpdateCommentEndpoint

IssuesUpdateCommentEndpoint: object

Type declaration

body: string

The contents of the comment.
comment_id: number

comment_id parameter
owner: string

owner parameter
repo: string

repo parameter

IssuesUpdateCommentRequestOptions

IssuesUpdateCommentRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PATCH"
request: RequestRequestOptions
url: "/repos/:owner/:repo/issues/comments/:comment_id"

IssuesUpdateCommentResponseData

IssuesUpdateCommentResponseData: object

Type declaration

body: string
created_at: string
html_url: string
id: number
node_id: string
updated_at: string
url: string
user: IssuesUpdateCommentResponseDataUser

IssuesUpdateCommentResponseDataUser

IssuesUpdateCommentResponseDataUser: object

Type declaration

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

IssuesUpdateEndpoint

IssuesUpdateEndpoint: object

Type declaration

Optional assignee?: string

Login for the user that this issue should be assigned to. This field is deprecated.
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?: string

The contents of the issue.
issue_number: number

issue_number parameter
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

owner parameter
repo: string

repo parameter
Optional state?: "open" | "closed"

State of the issue. Either open or closed.
Optional title?: string

The title of the issue.

IssuesUpdateLabelEndpoint

IssuesUpdateLabelEndpoint: object

Type declaration

Optional color?: string

The hexadecimal color code for the label, without the leading #.
Optional description?: string

A short description of the label.
name: string

name parameter
Optional new_name?: 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 . For a full list of available emoji and codes, see emoji-cheat-sheet.com.
owner: string

owner parameter
repo: string

repo parameter

IssuesUpdateLabelRequestOptions

IssuesUpdateLabelRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PATCH"
request: RequestRequestOptions
url: "/repos/:owner/:repo/labels/:name"

IssuesUpdateLabelResponseData

IssuesUpdateLabelResponseData: object

Type declaration

color: string
default: boolean
description: string
id: number
name: string
node_id: string
url: string

IssuesUpdateMilestoneEndpoint

IssuesUpdateMilestoneEndpoint: object

Type declaration

Optional description?: string

A description of the milestone.
Optional due_on?: string

The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
milestone_number: number

milestone_number parameter
owner: string

owner parameter
repo: string

repo parameter
Optional state?: "open" | "closed"

The state of the milestone. Either open or closed.
Optional title?: string

The title of the milestone.

IssuesUpdateMilestoneRequestOptions

IssuesUpdateMilestoneRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PATCH"
request: RequestRequestOptions
url: "/repos/:owner/:repo/milestones/:milestone_number"

IssuesUpdateMilestoneResponseData

IssuesUpdateMilestoneResponseData: object

Type declaration

closed_at: string
closed_issues: number
created_at: string
creator: IssuesUpdateMilestoneResponseDataCreator
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

IssuesUpdateMilestoneResponseDataCreator

IssuesUpdateMilestoneResponseDataCreator: object

Type declaration

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

IssuesUpdateRequestOptions

IssuesUpdateRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PATCH"
request: RequestRequestOptions
url: "/repos/:owner/:repo/issues/:issue_number"

IssuesUpdateResponseData

IssuesUpdateResponseData: object

Type declaration

active_lock_reason: string
assignee: IssuesUpdateResponseDataAssignee
assignees: Array<IssuesUpdateResponseDataAssigneesItem>
body: string
closed_at: null
closed_by: IssuesUpdateResponseDataClosedBy
comments: number
comments_url: string
created_at: string
events_url: string
html_url: string
id: number
labels: Array<IssuesUpdateResponseDataLabelsItem>
labels_url: string
locked: boolean
milestone: IssuesUpdateResponseDataMilestone
node_id: string
number: number
pull_request: IssuesUpdateResponseDataPullRequest
repository_url: string
state: string
title: string
updated_at: string
url: string
user: IssuesUpdateResponseDataUser

IssuesUpdateResponseDataAssignee

IssuesUpdateResponseDataAssignee: object

Type declaration

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

IssuesUpdateResponseDataAssigneesItem

IssuesUpdateResponseDataAssigneesItem: object

Type declaration

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

IssuesUpdateResponseDataClosedBy

IssuesUpdateResponseDataClosedBy: object

Type declaration

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

IssuesUpdateResponseDataLabelsItem

IssuesUpdateResponseDataLabelsItem: object

Type declaration

color: string
default: boolean
description: string
id: number
name: string
node_id: string
url: string

IssuesUpdateResponseDataMilestone

IssuesUpdateResponseDataMilestone: object

Type declaration

closed_at: string
closed_issues: number
created_at: string
creator: IssuesUpdateResponseDataMilestoneCreator
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

IssuesUpdateResponseDataMilestoneCreator

IssuesUpdateResponseDataMilestoneCreator: object

Type declaration

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

IssuesUpdateResponseDataPullRequest

IssuesUpdateResponseDataPullRequest: object

Type declaration

diff_url: string
html_url: string
patch_url: string
url: string

IssuesUpdateResponseDataUser

IssuesUpdateResponseDataUser: object

Type declaration

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

LicensesGetEndpoint

LicensesGetEndpoint: object

Type declaration

license: string

license parameter

LicensesGetForRepoEndpoint

LicensesGetForRepoEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter

LicensesGetForRepoRequestOptions

LicensesGetForRepoRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/license"

LicensesGetForRepoResponseData

LicensesGetForRepoResponseData: object

Type declaration

_links: LicensesGetForRepoResponseDataLinks
content: string
download_url: string
encoding: string
git_url: string
html_url: string
license: LicensesGetForRepoResponseDataLicense
name: string
path: string
sha: string
size: number
type: string
url: string

LicensesGetForRepoResponseDataLicense

LicensesGetForRepoResponseDataLicense: object

Type declaration

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

LicensesGetForRepoResponseDataLinks

LicensesGetForRepoResponseDataLinks: object

Type declaration

git: string
html: string
self: string

LicensesGetRequestOptions

LicensesGetRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/licenses/:license"

LicensesGetResponseData

LicensesGetResponseData: object

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

LicensesListCommonlyUsedEndpoint

LicensesListCommonlyUsedEndpoint: object

Type declaration

LicensesListCommonlyUsedRequestOptions

LicensesListCommonlyUsedRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/licenses"

LicensesListCommonlyUsedResponseData

LicensesListCommonlyUsedResponseData: Array<LicensesListCommonlyUsedResponseDataItem>

LicensesListCommonlyUsedResponseDataItem

LicensesListCommonlyUsedResponseDataItem: object

Type declaration

key: string
name: string
Optional node_id?: string
spdx_id: string
url: string

MarkdownRenderEndpoint

MarkdownRenderEndpoint: object

Type declaration

Optional context?: 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.

MarkdownRenderRawEndpoint

MarkdownRenderRawEndpoint: object & object

MarkdownRenderRawRequestOptions

MarkdownRenderRawRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/markdown/raw"

MarkdownRenderRequestOptions

MarkdownRenderRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/markdown"

MetaGetEndpoint

MetaGetEndpoint: object

Type declaration

MetaGetRequestOptions

MetaGetRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/meta"

MetaGetResponseData

MetaGetResponseData: object

Type declaration

api: Array<string>
git: Array<string>
hooks: Array<string>
importer: Array<string>
pages: Array<string>
ssh_key_fingerprints: MetaGetResponseDataSshKeyFingerprints
verifiable_password_authentication: boolean
web: Array<string>

MetaGetResponseDataSshKeyFingerprints

MetaGetResponseDataSshKeyFingerprints: object

Type declaration

MD5_DSA: string
MD5_RSA: string
SHA256_DSA: string
SHA256_RSA: string

MigrationsCancelImportEndpoint

MigrationsCancelImportEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter

MigrationsCancelImportRequestOptions

MigrationsCancelImportRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/repos/:owner/:repo/import"

MigrationsDeleteArchiveForAuthenticatedUserEndpoint

MigrationsDeleteArchiveForAuthenticatedUserEndpoint: object & RequiredPreview<"wyandotte">

MigrationsDeleteArchiveForAuthenticatedUserRequestOptions

MigrationsDeleteArchiveForAuthenticatedUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/user/migrations/:migration_id/archive"

MigrationsDeleteArchiveForOrgEndpoint

MigrationsDeleteArchiveForOrgEndpoint: object & RequiredPreview<"wyandotte">

MigrationsDeleteArchiveForOrgRequestOptions

MigrationsDeleteArchiveForOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/orgs/:org/migrations/:migration_id/archive"

MigrationsDownloadArchiveForOrgEndpoint

MigrationsDownloadArchiveForOrgEndpoint: object & RequiredPreview<"wyandotte">

MigrationsDownloadArchiveForOrgRequestOptions

MigrationsDownloadArchiveForOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/orgs/:org/migrations/:migration_id/archive"

MigrationsGetArchiveForAuthenticatedUserEndpoint

MigrationsGetArchiveForAuthenticatedUserEndpoint: object & RequiredPreview<"wyandotte">

MigrationsGetArchiveForAuthenticatedUserRequestOptions

MigrationsGetArchiveForAuthenticatedUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/user/migrations/:migration_id/archive"

MigrationsGetCommitAuthorsEndpoint

MigrationsGetCommitAuthorsEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter
Optional since?: 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.

MigrationsGetCommitAuthorsRequestOptions

MigrationsGetCommitAuthorsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/import/authors"

MigrationsGetCommitAuthorsResponseData

MigrationsGetCommitAuthorsResponseData: Array<MigrationsGetCommitAuthorsResponseDataItem>

MigrationsGetCommitAuthorsResponseDataItem

MigrationsGetCommitAuthorsResponseDataItem: object

Type declaration

email: string
id: number
import_url: string
name: string
remote_id: string
remote_name: string
url: string

MigrationsGetImportProgressEndpoint

MigrationsGetImportProgressEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter

MigrationsGetImportProgressRequestOptions

MigrationsGetImportProgressRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/import"

MigrationsGetImportProgressResponseData

MigrationsGetImportProgressResponseData: object

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

MigrationsGetLargeFilesEndpoint

MigrationsGetLargeFilesEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter

MigrationsGetLargeFilesRequestOptions

MigrationsGetLargeFilesRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/import/large_files"

MigrationsGetLargeFilesResponseData

MigrationsGetLargeFilesResponseData: Array<MigrationsGetLargeFilesResponseDataItem>

MigrationsGetLargeFilesResponseDataItem

MigrationsGetLargeFilesResponseDataItem: object

Type declaration

oid: string
path: string
ref_name: string
size: number

MigrationsGetStatusForAuthenticatedUserEndpoint

MigrationsGetStatusForAuthenticatedUserEndpoint: object & RequiredPreview<"wyandotte">

MigrationsGetStatusForAuthenticatedUserRequestOptions

MigrationsGetStatusForAuthenticatedUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/user/migrations/:migration_id"

MigrationsGetStatusForAuthenticatedUserResponseData

MigrationsGetStatusForAuthenticatedUserResponseData: object

Type declaration

created_at: string
exclude_attachments: boolean
guid: string
id: number
lock_repositories: boolean
owner: MigrationsGetStatusForAuthenticatedUserResponseDataOwner
repositories: Array<MigrationsGetStatusForAuthenticatedUserResponseDataRepositoriesItem>
state: string
updated_at: string
url: string

MigrationsGetStatusForAuthenticatedUserResponseDataOwner

MigrationsGetStatusForAuthenticatedUserResponseDataOwner: object

Type declaration

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

MigrationsGetStatusForAuthenticatedUserResponseDataRepositoriesItem

MigrationsGetStatusForAuthenticatedUserResponseDataRepositoriesItem: object

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: MigrationsGetStatusForAuthenticatedUserResponseDataRepositoriesItemOwner
permissions: MigrationsGetStatusForAuthenticatedUserResponseDataRepositoriesItemPermissions
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

MigrationsGetStatusForAuthenticatedUserResponseDataRepositoriesItemOwner

MigrationsGetStatusForAuthenticatedUserResponseDataRepositoriesItemOwner: object

Type declaration

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

MigrationsGetStatusForAuthenticatedUserResponseDataRepositoriesItemPermissions

MigrationsGetStatusForAuthenticatedUserResponseDataRepositoriesItemPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

MigrationsGetStatusForOrgEndpoint

MigrationsGetStatusForOrgEndpoint: object & RequiredPreview<"wyandotte">

MigrationsGetStatusForOrgRequestOptions

MigrationsGetStatusForOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/orgs/:org/migrations/:migration_id"

MigrationsGetStatusForOrgResponseData

MigrationsGetStatusForOrgResponseData: object

Type declaration

created_at: string
exclude_attachments: boolean
guid: string
id: number
lock_repositories: boolean
owner: MigrationsGetStatusForOrgResponseDataOwner
repositories: Array<MigrationsGetStatusForOrgResponseDataRepositoriesItem>
state: string
updated_at: string
url: string

MigrationsGetStatusForOrgResponseDataOwner

MigrationsGetStatusForOrgResponseDataOwner: object

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

MigrationsGetStatusForOrgResponseDataRepositoriesItem

MigrationsGetStatusForOrgResponseDataRepositoriesItem: object

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: MigrationsGetStatusForOrgResponseDataRepositoriesItemOwner
permissions: MigrationsGetStatusForOrgResponseDataRepositoriesItemPermissions
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

MigrationsGetStatusForOrgResponseDataRepositoriesItemOwner

MigrationsGetStatusForOrgResponseDataRepositoriesItemOwner: object

Type declaration

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

MigrationsGetStatusForOrgResponseDataRepositoriesItemPermissions

MigrationsGetStatusForOrgResponseDataRepositoriesItemPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

MigrationsListForAuthenticatedUserEndpoint

MigrationsListForAuthenticatedUserEndpoint: object & RequiredPreview<"wyandotte">

MigrationsListForAuthenticatedUserRequestOptions

MigrationsListForAuthenticatedUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/user/migrations"

MigrationsListForAuthenticatedUserResponseData

MigrationsListForAuthenticatedUserResponseData: Array<MigrationsListForAuthenticatedUserResponseDataItem>

MigrationsListForAuthenticatedUserResponseDataItem

MigrationsListForAuthenticatedUserResponseDataItem: object

Type declaration

created_at: string
exclude_attachments: boolean
guid: string
id: number
lock_repositories: boolean
owner: MigrationsListForAuthenticatedUserResponseDataItemOwner
repositories: Array<MigrationsListForAuthenticatedUserResponseDataItemRepositoriesItem>
state: string
updated_at: string
url: string

MigrationsListForAuthenticatedUserResponseDataItemOwner

MigrationsListForAuthenticatedUserResponseDataItemOwner: object

Type declaration

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

MigrationsListForAuthenticatedUserResponseDataItemRepositoriesItem

MigrationsListForAuthenticatedUserResponseDataItemRepositoriesItem: object

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: MigrationsListForAuthenticatedUserResponseDataItemRepositoriesItemOwner
permissions: MigrationsListForAuthenticatedUserResponseDataItemRepositoriesItemPermissions
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

MigrationsListForAuthenticatedUserResponseDataItemRepositoriesItemOwner

MigrationsListForAuthenticatedUserResponseDataItemRepositoriesItemOwner: object

Type declaration

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

MigrationsListForAuthenticatedUserResponseDataItemRepositoriesItemPermissions

MigrationsListForAuthenticatedUserResponseDataItemRepositoriesItemPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

MigrationsListForOrgEndpoint

MigrationsListForOrgEndpoint: object & RequiredPreview<"wyandotte">

MigrationsListForOrgRequestOptions

MigrationsListForOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/orgs/:org/migrations"

MigrationsListForOrgResponseData

MigrationsListForOrgResponseData: Array<MigrationsListForOrgResponseDataItem>

MigrationsListForOrgResponseDataItem

MigrationsListForOrgResponseDataItem: object

Type declaration

created_at: string
exclude_attachments: boolean
guid: string
id: number
lock_repositories: boolean
owner: MigrationsListForOrgResponseDataItemOwner
repositories: Array<MigrationsListForOrgResponseDataItemRepositoriesItem>
state: string
updated_at: string
url: string

MigrationsListForOrgResponseDataItemOwner

MigrationsListForOrgResponseDataItemOwner: object

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

MigrationsListForOrgResponseDataItemRepositoriesItem

MigrationsListForOrgResponseDataItemRepositoriesItem: object

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: MigrationsListForOrgResponseDataItemRepositoriesItemOwner
permissions: MigrationsListForOrgResponseDataItemRepositoriesItemPermissions
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

MigrationsListForOrgResponseDataItemRepositoriesItemOwner

MigrationsListForOrgResponseDataItemRepositoriesItemOwner: object

Type declaration

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

MigrationsListForOrgResponseDataItemRepositoriesItemPermissions

MigrationsListForOrgResponseDataItemRepositoriesItemPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

MigrationsListReposForOrgEndpoint

MigrationsListReposForOrgEndpoint: object & RequiredPreview<"wyandotte">

MigrationsListReposForOrgRequestOptions

MigrationsListReposForOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/orgs/:org/migrations/:migration_id/repositories"

MigrationsListReposForOrgResponseData

MigrationsListReposForOrgResponseData: Array<MigrationsListReposForOrgResponseDataItem>

MigrationsListReposForOrgResponseDataItem

MigrationsListReposForOrgResponseDataItem: object

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: MigrationsListReposForOrgResponseDataItemLicense
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: MigrationsListReposForOrgResponseDataItemOwner
permissions: MigrationsListReposForOrgResponseDataItemPermissions
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

MigrationsListReposForOrgResponseDataItemLicense

MigrationsListReposForOrgResponseDataItemLicense: object

Type declaration

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

MigrationsListReposForOrgResponseDataItemOwner

MigrationsListReposForOrgResponseDataItemOwner: object

Type declaration

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

MigrationsListReposForOrgResponseDataItemPermissions

MigrationsListReposForOrgResponseDataItemPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

MigrationsListReposForUserEndpoint

MigrationsListReposForUserEndpoint: object & RequiredPreview<"wyandotte">

MigrationsListReposForUserRequestOptions

MigrationsListReposForUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/user/:migration_id/repositories"

MigrationsListReposForUserResponseData

MigrationsListReposForUserResponseData: Array<MigrationsListReposForUserResponseDataItem>

MigrationsListReposForUserResponseDataItem

MigrationsListReposForUserResponseDataItem: object

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: MigrationsListReposForUserResponseDataItemLicense
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: MigrationsListReposForUserResponseDataItemOwner
permissions: MigrationsListReposForUserResponseDataItemPermissions
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

MigrationsListReposForUserResponseDataItemLicense

MigrationsListReposForUserResponseDataItemLicense: object

Type declaration

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

MigrationsListReposForUserResponseDataItemOwner

MigrationsListReposForUserResponseDataItemOwner: object

Type declaration

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

MigrationsListReposForUserResponseDataItemPermissions

MigrationsListReposForUserResponseDataItemPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

MigrationsMapCommitAuthorEndpoint

MigrationsMapCommitAuthorEndpoint: object

Type declaration

author_id: number

author_id parameter
Optional email?: string

The new Git author email.
Optional name?: string

The new Git author name.
owner: string

owner parameter
repo: string

repo parameter

MigrationsMapCommitAuthorRequestOptions

MigrationsMapCommitAuthorRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PATCH"
request: RequestRequestOptions
url: "/repos/:owner/:repo/import/authors/:author_id"

MigrationsMapCommitAuthorResponseData

MigrationsMapCommitAuthorResponseData: object

Type declaration

email: string
id: number
import_url: string
name: string
remote_id: string
remote_name: string
url: string

MigrationsSetLfsPreferenceEndpoint

MigrationsSetLfsPreferenceEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter
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).

MigrationsSetLfsPreferenceRequestOptions

MigrationsSetLfsPreferenceRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PATCH"
request: RequestRequestOptions
url: "/repos/:owner/:repo/import/lfs"

MigrationsSetLfsPreferenceResponseData

MigrationsSetLfsPreferenceResponseData: object

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

MigrationsStartForAuthenticatedUserEndpoint

MigrationsStartForAuthenticatedUserEndpoint: object

Type declaration

Optional exclude_attachments?: boolean

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?: boolean

Locks the repositories to prevent changes during the migration when set to true.
repositories: string[]

An array of repositories to include in the migration.

MigrationsStartForAuthenticatedUserRequestOptions

MigrationsStartForAuthenticatedUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/user/migrations"

MigrationsStartForAuthenticatedUserResponseData

MigrationsStartForAuthenticatedUserResponseData: object

Type declaration

created_at: string
exclude_attachments: boolean
guid: string
id: number
lock_repositories: boolean
owner: MigrationsStartForAuthenticatedUserResponseDataOwner
repositories: Array<MigrationsStartForAuthenticatedUserResponseDataRepositoriesItem>
state: string
updated_at: string
url: string

MigrationsStartForAuthenticatedUserResponseDataOwner

MigrationsStartForAuthenticatedUserResponseDataOwner: object

Type declaration

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

MigrationsStartForAuthenticatedUserResponseDataRepositoriesItem

MigrationsStartForAuthenticatedUserResponseDataRepositoriesItem: object

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: MigrationsStartForAuthenticatedUserResponseDataRepositoriesItemOwner
permissions: MigrationsStartForAuthenticatedUserResponseDataRepositoriesItemPermissions
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

MigrationsStartForAuthenticatedUserResponseDataRepositoriesItemOwner

MigrationsStartForAuthenticatedUserResponseDataRepositoriesItemOwner: object

Type declaration

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

MigrationsStartForAuthenticatedUserResponseDataRepositoriesItemPermissions

MigrationsStartForAuthenticatedUserResponseDataRepositoriesItemPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

MigrationsStartForOrgEndpoint

MigrationsStartForOrgEndpoint: object

Type declaration

Optional exclude_attachments?: boolean

Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).
Optional lock_repositories?: boolean

Indicates whether repositories should be locked (to prevent manipulation) while migrating data.
org: string

org parameter
repositories: string[]

A list of arrays indicating which repositories should be migrated.

MigrationsStartForOrgRequestOptions

MigrationsStartForOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/orgs/:org/migrations"

MigrationsStartForOrgResponseData

MigrationsStartForOrgResponseData: object

Type declaration

created_at: string
exclude_attachments: boolean
guid: string
id: number
lock_repositories: boolean
owner: MigrationsStartForOrgResponseDataOwner
repositories: Array<MigrationsStartForOrgResponseDataRepositoriesItem>
state: string
updated_at: string
url: string

MigrationsStartForOrgResponseDataOwner

MigrationsStartForOrgResponseDataOwner: object

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

MigrationsStartForOrgResponseDataRepositoriesItem

MigrationsStartForOrgResponseDataRepositoriesItem: object

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: MigrationsStartForOrgResponseDataRepositoriesItemOwner
permissions: MigrationsStartForOrgResponseDataRepositoriesItemPermissions
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

MigrationsStartForOrgResponseDataRepositoriesItemOwner

MigrationsStartForOrgResponseDataRepositoriesItemOwner: object

Type declaration

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

MigrationsStartForOrgResponseDataRepositoriesItemPermissions

MigrationsStartForOrgResponseDataRepositoriesItemPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

MigrationsStartImportEndpoint

MigrationsStartImportEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter
Optional tfvc_project?: 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?: string

If authentication is required, the password to provide to vcs_url.
vcs_url: string

The URL of the originating repository.
Optional vcs_username?: string

If authentication is required, the username to provide to vcs_url.

MigrationsStartImportRequestOptions

MigrationsStartImportRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PUT"
request: RequestRequestOptions
url: "/repos/:owner/:repo/import"

MigrationsStartImportResponseData

MigrationsStartImportResponseData: object

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

MigrationsUnlockRepoForAuthenticatedUserEndpoint

MigrationsUnlockRepoForAuthenticatedUserEndpoint: object & RequiredPreview<"wyandotte">

MigrationsUnlockRepoForAuthenticatedUserRequestOptions

MigrationsUnlockRepoForAuthenticatedUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/user/migrations/:migration_id/repos/:repo_name/lock"

MigrationsUnlockRepoForOrgEndpoint

MigrationsUnlockRepoForOrgEndpoint: object & RequiredPreview<"wyandotte">

MigrationsUnlockRepoForOrgRequestOptions

MigrationsUnlockRepoForOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/orgs/:org/migrations/:migration_id/repos/:repo_name/lock"

MigrationsUpdateImportEndpoint

MigrationsUpdateImportEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter
Optional vcs_password?: string

The password to provide to the originating repository.
Optional vcs_username?: string

The username to provide to the originating repository.

MigrationsUpdateImportRequestOptions

MigrationsUpdateImportRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PATCH"
request: RequestRequestOptions
url: "/repos/:owner/:repo/import"

MigrationsUpdateImportResponseData

MigrationsUpdateImportResponseData: object

Type declaration

Optional authors_count?: number
authors_url: string
Optional commit_count?: number
Optional has_large_files?: boolean
html_url: string
Optional large_files_count?: number
Optional large_files_size?: number
Optional percent?: number
repository_url: string
status: string
Optional status_text?: string
Optional tfvc_project?: string
url: string
use_lfs: string
vcs: string
vcs_url: string

OauthAuthorizationsCreateAuthorizationEndpoint

OauthAuthorizationsCreateAuthorizationEndpoint: object

Type declaration

Optional client_id?: string

The 20 character OAuth app client key for which to create the token.
Optional client_secret?: string

The 40 character OAuth app client secret for which to create the token.
Optional fingerprint?: 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?: 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.

OauthAuthorizationsCreateAuthorizationRequestOptions

OauthAuthorizationsCreateAuthorizationRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/authorizations"

OauthAuthorizationsCreateAuthorizationResponseData

OauthAuthorizationsCreateAuthorizationResponseData: object

Type declaration

app: OauthAuthorizationsCreateAuthorizationResponseDataApp
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

OauthAuthorizationsCreateAuthorizationResponseDataApp

OauthAuthorizationsCreateAuthorizationResponseDataApp: object

Type declaration

client_id: string
name: string
url: string

OauthAuthorizationsDeleteAuthorizationEndpoint

OauthAuthorizationsDeleteAuthorizationEndpoint: object

Type declaration

authorization_id: number

authorization_id parameter

OauthAuthorizationsDeleteAuthorizationRequestOptions

OauthAuthorizationsDeleteAuthorizationRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/authorizations/:authorization_id"

OauthAuthorizationsDeleteGrantEndpoint

OauthAuthorizationsDeleteGrantEndpoint: object

Type declaration

grant_id: number

grant_id parameter

OauthAuthorizationsDeleteGrantRequestOptions

OauthAuthorizationsDeleteGrantRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/applications/grants/:grant_id"

OauthAuthorizationsGetAuthorizationEndpoint

OauthAuthorizationsGetAuthorizationEndpoint: object

Type declaration

authorization_id: number

authorization_id parameter

OauthAuthorizationsGetAuthorizationRequestOptions

OauthAuthorizationsGetAuthorizationRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/authorizations/:authorization_id"

OauthAuthorizationsGetAuthorizationResponseData

OauthAuthorizationsGetAuthorizationResponseData: object

Type declaration

app: OauthAuthorizationsGetAuthorizationResponseDataApp
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

OauthAuthorizationsGetAuthorizationResponseDataApp

OauthAuthorizationsGetAuthorizationResponseDataApp: object

Type declaration

client_id: string
name: string
url: string

OauthAuthorizationsGetGrantEndpoint

OauthAuthorizationsGetGrantEndpoint: object

Type declaration

grant_id: number

grant_id parameter

OauthAuthorizationsGetGrantRequestOptions

OauthAuthorizationsGetGrantRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/applications/grants/:grant_id"

OauthAuthorizationsGetGrantResponseData

OauthAuthorizationsGetGrantResponseData: object

Type declaration

app: OauthAuthorizationsGetGrantResponseDataApp
created_at: string
id: number
scopes: Array<string>
updated_at: string
url: string

OauthAuthorizationsGetGrantResponseDataApp

OauthAuthorizationsGetGrantResponseDataApp: object

Type declaration

client_id: string
name: string
url: string

OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintEndpoint

OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintEndpoint: object

Type declaration

client_id: string

client_id parameter
client_secret: string

The 40 character OAuth app client secret associated with the client ID specified in the URL.
fingerprint: string

fingerprint parameter
Optional note?: string

A note to remind you what the OAuth token is for.
Optional note_url?: 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.

OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintRequestOptions

OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PUT"
request: RequestRequestOptions
url: "/authorizations/clients/:client_id/:fingerprint"

OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintResponseData

OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintResponseData: object

Type declaration

app: OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintResponseDataApp
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

OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintResponseDataApp

OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintResponseDataApp: object

Type declaration

client_id: string
name: string
url: string

OauthAuthorizationsGetOrCreateAuthorizationForAppEndpoint

OauthAuthorizationsGetOrCreateAuthorizationForAppEndpoint: object

Type declaration

client_id: string

client_id parameter
client_secret: string

The 40 character OAuth app client secret associated with the client ID specified in the URL.
Optional fingerprint?: 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?: string

A note to remind you what the OAuth token is for.
Optional note_url?: 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.

OauthAuthorizationsGetOrCreateAuthorizationForAppRequestOptions

OauthAuthorizationsGetOrCreateAuthorizationForAppRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PUT"
request: RequestRequestOptions
url: "/authorizations/clients/:client_id"

OauthAuthorizationsGetOrCreateAuthorizationForAppResponseData

OauthAuthorizationsGetOrCreateAuthorizationForAppResponseData: object

Type declaration

app: OauthAuthorizationsGetOrCreateAuthorizationForAppResponseDataApp
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

OauthAuthorizationsGetOrCreateAuthorizationForAppResponseDataApp

OauthAuthorizationsGetOrCreateAuthorizationForAppResponseDataApp: object

Type declaration

client_id: string
name: string
url: string

OauthAuthorizationsListAuthorizationsEndpoint

OauthAuthorizationsListAuthorizationsEndpoint: object

Type declaration

Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)

OauthAuthorizationsListAuthorizationsRequestOptions

OauthAuthorizationsListAuthorizationsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/authorizations"

OauthAuthorizationsListAuthorizationsResponseData

OauthAuthorizationsListAuthorizationsResponseData: Array<OauthAuthorizationsListAuthorizationsResponseDataItem>

OauthAuthorizationsListAuthorizationsResponseDataItem

OauthAuthorizationsListAuthorizationsResponseDataItem: object

Type declaration

app: OauthAuthorizationsListAuthorizationsResponseDataItemApp
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

OauthAuthorizationsListAuthorizationsResponseDataItemApp

OauthAuthorizationsListAuthorizationsResponseDataItemApp: object

Type declaration

client_id: string
name: string
url: string

OauthAuthorizationsListGrantsEndpoint

OauthAuthorizationsListGrantsEndpoint: object

Type declaration

Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)

OauthAuthorizationsListGrantsRequestOptions

OauthAuthorizationsListGrantsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/applications/grants"

OauthAuthorizationsListGrantsResponseData

OauthAuthorizationsListGrantsResponseData: Array<OauthAuthorizationsListGrantsResponseDataItem>

OauthAuthorizationsListGrantsResponseDataItem

OauthAuthorizationsListGrantsResponseDataItem: object

Type declaration

app: OauthAuthorizationsListGrantsResponseDataItemApp
created_at: string
id: number
scopes: Array<string>
updated_at: string
url: string

OauthAuthorizationsListGrantsResponseDataItemApp

OauthAuthorizationsListGrantsResponseDataItemApp: object

Type declaration

client_id: string
name: string
url: string

OauthAuthorizationsUpdateAuthorizationEndpoint

OauthAuthorizationsUpdateAuthorizationEndpoint: object

Type declaration

Optional add_scopes?: string[]

A list of scopes to add to this authorization.
authorization_id: number

authorization_id parameter
Optional fingerprint?: string

A unique string to distinguish an authorization from others created for the same client ID and user.
Optional 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?: 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.

OauthAuthorizationsUpdateAuthorizationRequestOptions

OauthAuthorizationsUpdateAuthorizationRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PATCH"
request: RequestRequestOptions
url: "/authorizations/:authorization_id"

OauthAuthorizationsUpdateAuthorizationResponseData

OauthAuthorizationsUpdateAuthorizationResponseData: object

Type declaration

app: OauthAuthorizationsUpdateAuthorizationResponseDataApp
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

OauthAuthorizationsUpdateAuthorizationResponseDataApp

OauthAuthorizationsUpdateAuthorizationResponseDataApp: object

Type declaration

client_id: string
name: string
url: string

OctokitResponse

OctokitResponse<T>: object

Type parameters

Type declaration

data: T

This is the data you would see in https://developer.Octokit.com/v3/
headers: ResponseHeaders
status: number

http response code
url: Url

URL of response after all redirects

OrgsAddOrUpdateMembershipEndpoint

OrgsAddOrUpdateMembershipEndpoint: object

Type declaration

org: string

org parameter
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

username parameter

OrgsAddOrUpdateMembershipRequestOptions

OrgsAddOrUpdateMembershipRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PUT"
request: RequestRequestOptions
url: "/orgs/:org/memberships/:username"

OrgsAddOrUpdateMembershipResponseData

OrgsAddOrUpdateMembershipResponseData: object

Type declaration

organization: OrgsAddOrUpdateMembershipResponseDataOrganization
organization_url: string
role: string
state: string
url: string
user: OrgsAddOrUpdateMembershipResponseDataUser

OrgsAddOrUpdateMembershipResponseDataOrganization

OrgsAddOrUpdateMembershipResponseDataOrganization: object

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

OrgsAddOrUpdateMembershipResponseDataUser

OrgsAddOrUpdateMembershipResponseDataUser: object

Type declaration

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

OrgsBlockUserEndpoint

OrgsBlockUserEndpoint: object

Type declaration

org: string

org parameter
username: string

username parameter

OrgsBlockUserRequestOptions

OrgsBlockUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PUT"
request: RequestRequestOptions
url: "/orgs/:org/blocks/:username"

OrgsCheckBlockedUserEndpoint

OrgsCheckBlockedUserEndpoint: object

Type declaration

org: string

org parameter
username: string

username parameter

OrgsCheckBlockedUserRequestOptions

OrgsCheckBlockedUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/orgs/:org/blocks/:username"

OrgsCheckMembershipEndpoint

OrgsCheckMembershipEndpoint: object

Type declaration

org: string

org parameter
username: string

username parameter

OrgsCheckMembershipRequestOptions

OrgsCheckMembershipRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/orgs/:org/members/:username"

OrgsCheckPublicMembershipEndpoint

OrgsCheckPublicMembershipEndpoint: object

Type declaration

org: string

org parameter
username: string

username parameter

OrgsCheckPublicMembershipRequestOptions

OrgsCheckPublicMembershipRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/orgs/:org/public_members/:username"

OrgsConcealMembershipEndpoint

OrgsConcealMembershipEndpoint: object

Type declaration

org: string

org parameter
username: string

username parameter

OrgsConcealMembershipRequestOptions

OrgsConcealMembershipRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/orgs/:org/public_members/:username"

OrgsConvertMemberToOutsideCollaboratorEndpoint

OrgsConvertMemberToOutsideCollaboratorEndpoint: object

Type declaration

org: string

org parameter
username: string

username parameter

OrgsConvertMemberToOutsideCollaboratorRequestOptions

OrgsConvertMemberToOutsideCollaboratorRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PUT"
request: RequestRequestOptions
url: "/orgs/:org/outside_collaborators/:username"

OrgsConvertMemberToOutsideCollaboratorResponseData

OrgsConvertMemberToOutsideCollaboratorResponseData: object

Type declaration

documentation_url: string
message: string

OrgsCreateHookEndpoint

OrgsCreateHookEndpoint: object

Type declaration

Optional active?: boolean

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

org parameter

OrgsCreateHookParamsConfig

OrgsCreateHookParamsConfig: object

Type declaration

Optional content_type?: string
Optional insecure_ssl?: string
Optional secret?: string
url: string

OrgsCreateHookRequestOptions

OrgsCreateHookRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/orgs/:org/hooks"

OrgsCreateHookResponseData

OrgsCreateHookResponseData: object

Type declaration

active: boolean
config: OrgsCreateHookResponseDataConfig
created_at: string
events: Array<string>
id: number
name: string
ping_url: string
updated_at: string
url: string

OrgsCreateHookResponseDataConfig

OrgsCreateHookResponseDataConfig: object

Type declaration

content_type: string
url: string

OrgsCreateInvitationEndpoint

OrgsCreateInvitationEndpoint: object

Type declaration

Optional email?: 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?: number

Required unless you provide email. GitHub user ID for the person you are inviting.
org: string

org parameter
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.

OrgsCreateInvitationRequestOptions

OrgsCreateInvitationRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/orgs/:org/invitations"

OrgsCreateInvitationResponseData

OrgsCreateInvitationResponseData: object

Type declaration

created_at: string
email: string
id: number
invitation_team_url: string
inviter: OrgsCreateInvitationResponseDataInviter
login: string
role: string
team_count: number

OrgsCreateInvitationResponseDataInviter

OrgsCreateInvitationResponseDataInviter: object

Type declaration

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

OrgsDeleteHookEndpoint

OrgsDeleteHookEndpoint: object

Type declaration

hook_id: number

hook_id parameter
org: string

org parameter

OrgsDeleteHookRequestOptions

OrgsDeleteHookRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/orgs/:org/hooks/:hook_id"

OrgsGetEndpoint

OrgsGetEndpoint: object

Type declaration

org: string

org parameter

OrgsGetHookEndpoint

OrgsGetHookEndpoint: object

Type declaration

hook_id: number

hook_id parameter
org: string

org parameter

OrgsGetHookRequestOptions

OrgsGetHookRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/orgs/:org/hooks/:hook_id"

OrgsGetHookResponseData

OrgsGetHookResponseData: object

Type declaration

active: boolean
config: OrgsGetHookResponseDataConfig
created_at: string
events: Array<string>
id: number
name: string
ping_url: string
updated_at: string
url: string

OrgsGetHookResponseDataConfig

OrgsGetHookResponseDataConfig: object

Type declaration

content_type: string
url: string

OrgsGetMembershipEndpoint

OrgsGetMembershipEndpoint: object

Type declaration

org: string

org parameter
username: string

username parameter

OrgsGetMembershipForAuthenticatedUserEndpoint

OrgsGetMembershipForAuthenticatedUserEndpoint: object

Type declaration

org: string

org parameter

OrgsGetMembershipForAuthenticatedUserRequestOptions

OrgsGetMembershipForAuthenticatedUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/user/memberships/orgs/:org"

OrgsGetMembershipForAuthenticatedUserResponseData

OrgsGetMembershipForAuthenticatedUserResponseData: object

Type declaration

organization: OrgsGetMembershipForAuthenticatedUserResponseDataOrganization
organization_url: string
role: string
state: string
url: string
user: OrgsGetMembershipForAuthenticatedUserResponseDataUser

OrgsGetMembershipForAuthenticatedUserResponseDataOrganization

OrgsGetMembershipForAuthenticatedUserResponseDataOrganization: object

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

OrgsGetMembershipForAuthenticatedUserResponseDataUser

OrgsGetMembershipForAuthenticatedUserResponseDataUser: object

Type declaration

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

OrgsGetMembershipRequestOptions

OrgsGetMembershipRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/orgs/:org/memberships/:username"

OrgsGetMembershipResponseData

OrgsGetMembershipResponseData: object

Type declaration

organization: OrgsGetMembershipResponseDataOrganization
organization_url: string
role: string
state: string
url: string
user: OrgsGetMembershipResponseDataUser

OrgsGetMembershipResponseDataOrganization

OrgsGetMembershipResponseDataOrganization: object

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

OrgsGetMembershipResponseDataUser

OrgsGetMembershipResponseDataUser: object

Type declaration

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

OrgsGetRequestOptions

OrgsGetRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/orgs/:org"

OrgsGetResponseData

OrgsGetResponseData: object

Type declaration

avatar_url: string
Optional billing_email?: string
blog: string
Optional collaborators?: number
company: string
created_at: string
Optional default_repository_permission?: string
description: string
Optional 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
Optional members_allowed_repository_creation_type?: string
Optional members_can_create_internal_repositories?: boolean
Optional members_can_create_private_repositories?: boolean
Optional members_can_create_public_repositories?: boolean
Optional members_can_create_repositories?: boolean
members_url: string
name: string
node_id: string
Optional owned_private_repos?: number
plan: OrgsGetResponseDataPlan
Optional private_gists?: number
public_gists: number
public_members_url: string
public_repos: number
repos_url: string
Optional total_private_repos?: number
Optional two_factor_requirement_enabled?: boolean
type: string
url: string

OrgsGetResponseDataPlan

OrgsGetResponseDataPlan: object

Type declaration

Optional filled_seats?: number
name: string
private_repos: number
Optional seats?: number
space: number

OrgsListBlockedUsersEndpoint

OrgsListBlockedUsersEndpoint: object

Type declaration

org: string

org parameter

OrgsListBlockedUsersRequestOptions

OrgsListBlockedUsersRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/orgs/:org/blocks"

OrgsListBlockedUsersResponseData

OrgsListBlockedUsersResponseData: Array<OrgsListBlockedUsersResponseDataItem>

OrgsListBlockedUsersResponseDataItem

OrgsListBlockedUsersResponseDataItem: object

Type declaration

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

OrgsListCredentialAuthorizationsEndpoint

OrgsListCredentialAuthorizationsEndpoint: object

Type declaration

org: string

org parameter

OrgsListCredentialAuthorizationsRequestOptions

OrgsListCredentialAuthorizationsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/orgs/:org/credential-authorizations"

OrgsListCredentialAuthorizationsResponseData

OrgsListCredentialAuthorizationsResponseData: Array<OrgsListCredentialAuthorizationsResponseDataItem>

OrgsListCredentialAuthorizationsResponseDataItem

OrgsListCredentialAuthorizationsResponseDataItem: object

Type declaration

credential_authorized_at: string
credential_id: string
credential_type: string
login: string
scopes: Array<string>
token_last_eight: string

OrgsListEndpoint

OrgsListEndpoint: object

Type declaration

Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
Optional since?: number

The integer ID of the last organization that you've seen.

OrgsListForAuthenticatedUserEndpoint

OrgsListForAuthenticatedUserEndpoint: object

Type declaration

Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)

OrgsListForAuthenticatedUserRequestOptions

OrgsListForAuthenticatedUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/user/orgs"

OrgsListForAuthenticatedUserResponseData

OrgsListForAuthenticatedUserResponseData: Array<OrgsListForAuthenticatedUserResponseDataItem>

OrgsListForAuthenticatedUserResponseDataItem

OrgsListForAuthenticatedUserResponseDataItem: object

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

OrgsListForUserEndpoint

OrgsListForUserEndpoint: object

Type declaration

Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
username: string

username parameter

OrgsListForUserRequestOptions

OrgsListForUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/users/:username/orgs"

OrgsListForUserResponseData

OrgsListForUserResponseData: Array<OrgsListForUserResponseDataItem>

OrgsListForUserResponseDataItem

OrgsListForUserResponseDataItem: object

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

OrgsListHooksEndpoint

OrgsListHooksEndpoint: object

Type declaration

org: string

org parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)

OrgsListHooksRequestOptions

OrgsListHooksRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/orgs/:org/hooks"

OrgsListHooksResponseData

OrgsListHooksResponseData: Array<OrgsListHooksResponseDataItem>

OrgsListHooksResponseDataItem

OrgsListHooksResponseDataItem: object

Type declaration

active: boolean
config: OrgsListHooksResponseDataItemConfig
created_at: string
events: Array<string>
id: number
name: string
ping_url: string
updated_at: string
url: string

OrgsListHooksResponseDataItemConfig

OrgsListHooksResponseDataItemConfig: object

Type declaration

content_type: string
url: string

OrgsListInstallationsEndpoint

OrgsListInstallationsEndpoint: object & RequiredPreview<"machine-man">

OrgsListInstallationsRequestOptions

OrgsListInstallationsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/orgs/:org/installations"

OrgsListInstallationsResponseData

OrgsListInstallationsResponseData: object

Type declaration

installations: Array<OrgsListInstallationsResponseDataInstallationsItem>
total_count: number

OrgsListInstallationsResponseDataInstallationsItem

OrgsListInstallationsResponseDataInstallationsItem: object

Type declaration

access_tokens_url: string
account: OrgsListInstallationsResponseDataInstallationsItemAccount
app_id: number
created_at: string
events: Array<string>
html_url: string
id: number
permissions: OrgsListInstallationsResponseDataInstallationsItemPermissions
repositories_url: string
repository_selection: string
single_file_name: null
target_id: number
target_type: string
updated_at: string

OrgsListInstallationsResponseDataInstallationsItemAccount

OrgsListInstallationsResponseDataInstallationsItemAccount: object

Type declaration

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

OrgsListInstallationsResponseDataInstallationsItemPermissions

OrgsListInstallationsResponseDataInstallationsItemPermissions: object

Type declaration

deployments: string
metadata: string
pull_requests: string
statuses: string

OrgsListInvitationTeamsEndpoint

OrgsListInvitationTeamsEndpoint: object

Type declaration

invitation_id: number

invitation_id parameter
org: string

org parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)

OrgsListInvitationTeamsRequestOptions

OrgsListInvitationTeamsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/orgs/:org/invitations/:invitation_id/teams"

OrgsListInvitationTeamsResponseData

OrgsListInvitationTeamsResponseData: Array<OrgsListInvitationTeamsResponseDataItem>

OrgsListInvitationTeamsResponseDataItem

OrgsListInvitationTeamsResponseDataItem: object

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

OrgsListMembersEndpoint

OrgsListMembersEndpoint: object

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

org parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: 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.

OrgsListMembersRequestOptions

OrgsListMembersRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/orgs/:org/members"

OrgsListMembersResponseData

OrgsListMembersResponseData: Array<OrgsListMembersResponseDataItem>

OrgsListMembersResponseDataItem

OrgsListMembersResponseDataItem: object

Type declaration

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

OrgsListMembershipsEndpoint

OrgsListMembershipsEndpoint: object

Type declaration

Optional page?: number

Page number of the results to fetch.
Optional per_page?: 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.

OrgsListMembershipsRequestOptions

OrgsListMembershipsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/user/memberships/orgs"

OrgsListMembershipsResponseData

OrgsListMembershipsResponseData: Array<OrgsListMembershipsResponseDataItem>

OrgsListMembershipsResponseDataItem

OrgsListMembershipsResponseDataItem: object

Type declaration

organization: OrgsListMembershipsResponseDataItemOrganization
organization_url: string
role: string
state: string
url: string
user: OrgsListMembershipsResponseDataItemUser

OrgsListMembershipsResponseDataItemOrganization

OrgsListMembershipsResponseDataItemOrganization: object

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

OrgsListMembershipsResponseDataItemUser

OrgsListMembershipsResponseDataItemUser: object

Type declaration

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

OrgsListOutsideCollaboratorsEndpoint

OrgsListOutsideCollaboratorsEndpoint: object

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

org parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)

OrgsListOutsideCollaboratorsRequestOptions

OrgsListOutsideCollaboratorsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/orgs/:org/outside_collaborators"

OrgsListOutsideCollaboratorsResponseData

OrgsListOutsideCollaboratorsResponseData: Array<OrgsListOutsideCollaboratorsResponseDataItem>

OrgsListOutsideCollaboratorsResponseDataItem

OrgsListOutsideCollaboratorsResponseDataItem: object

Type declaration

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

OrgsListPendingInvitationsEndpoint

OrgsListPendingInvitationsEndpoint: object

Type declaration

org: string

org parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)

OrgsListPendingInvitationsRequestOptions

OrgsListPendingInvitationsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/orgs/:org/invitations"

OrgsListPendingInvitationsResponseData

OrgsListPendingInvitationsResponseData: Array<OrgsListPendingInvitationsResponseDataItem>

OrgsListPendingInvitationsResponseDataItem

OrgsListPendingInvitationsResponseDataItem: object

Type declaration

created_at: string
email: string
id: number
invitation_team_url: string
inviter: OrgsListPendingInvitationsResponseDataItemInviter
login: string
role: string
team_count: number

OrgsListPendingInvitationsResponseDataItemInviter

OrgsListPendingInvitationsResponseDataItemInviter: object

Type declaration

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

OrgsListPublicMembersEndpoint

OrgsListPublicMembersEndpoint: object

Type declaration

org: string

org parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)

OrgsListPublicMembersRequestOptions

OrgsListPublicMembersRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/orgs/:org/public_members"

OrgsListPublicMembersResponseData

OrgsListPublicMembersResponseData: Array<OrgsListPublicMembersResponseDataItem>

OrgsListPublicMembersResponseDataItem

OrgsListPublicMembersResponseDataItem: object

Type declaration

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

OrgsListRequestOptions

OrgsListRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/organizations"

OrgsListResponseData

OrgsListResponseData: Array<OrgsListResponseDataItem>

OrgsListResponseDataItem

OrgsListResponseDataItem: object

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

OrgsPingHookEndpoint

OrgsPingHookEndpoint: object

Type declaration

hook_id: number

hook_id parameter
org: string

org parameter

OrgsPingHookRequestOptions

OrgsPingHookRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/orgs/:org/hooks/:hook_id/pings"

OrgsPublicizeMembershipEndpoint

OrgsPublicizeMembershipEndpoint: object

Type declaration

org: string

org parameter
username: string

username parameter

OrgsPublicizeMembershipRequestOptions

OrgsPublicizeMembershipRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PUT"
request: RequestRequestOptions
url: "/orgs/:org/public_members/:username"

OrgsRemoveCredentialAuthorizationEndpoint

OrgsRemoveCredentialAuthorizationEndpoint: object

Type declaration

credential_id: number

credential_id parameter
org: string

org parameter

OrgsRemoveCredentialAuthorizationRequestOptions

OrgsRemoveCredentialAuthorizationRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/orgs/:org/credential-authorizations/:credential_id"

OrgsRemoveMemberEndpoint

OrgsRemoveMemberEndpoint: object

Type declaration

org: string

org parameter
username: string

username parameter

OrgsRemoveMemberRequestOptions

OrgsRemoveMemberRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/orgs/:org/members/:username"

OrgsRemoveMembershipEndpoint

OrgsRemoveMembershipEndpoint: object

Type declaration

org: string

org parameter
username: string

username parameter

OrgsRemoveMembershipRequestOptions

OrgsRemoveMembershipRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/orgs/:org/memberships/:username"

OrgsRemoveOutsideCollaboratorEndpoint

OrgsRemoveOutsideCollaboratorEndpoint: object

Type declaration

org: string

org parameter
username: string

username parameter

OrgsRemoveOutsideCollaboratorRequestOptions

OrgsRemoveOutsideCollaboratorRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/orgs/:org/outside_collaborators/:username"

OrgsRemoveOutsideCollaboratorResponseData

OrgsRemoveOutsideCollaboratorResponseData: object

Type declaration

documentation_url: string
message: string

OrgsUnblockUserEndpoint

OrgsUnblockUserEndpoint: object

Type declaration

org: string

org parameter
username: string

username parameter

OrgsUnblockUserRequestOptions

OrgsUnblockUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/orgs/:org/blocks/:username"

OrgsUpdateEndpoint

OrgsUpdateEndpoint: object

Type declaration

Optional billing_email?: string

Billing email address. This address is not publicized.
Optional company?: 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?: string

The description of the company.
Optional email?: string

The publicly visible email address.
Optional has_organization_projects?: boolean

Toggles whether an organization can use organization projects.
Optional has_repository_projects?: boolean

Toggles whether repositories that belong to the organization can use repository projects.
Optional location?: string

The location.
Optional members_allowed_repository_creation_type?: "all" | "private" | "none"

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.
Optional members_can_create_internal_repositories?: boolean

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 or GitHub Enterprise Server 2.20+. 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?: boolean

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?: boolean

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?: boolean

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?: string

The shorthand name of the company.
org: string

org parameter

OrgsUpdateHookEndpoint

OrgsUpdateHookEndpoint: object

Type declaration

Optional active?: boolean

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

hook_id parameter
org: string

org parameter

OrgsUpdateHookParamsConfig

OrgsUpdateHookParamsConfig: object

Type declaration

Optional content_type?: string
Optional insecure_ssl?: string
Optional secret?: string
url: string

OrgsUpdateHookRequestOptions

OrgsUpdateHookRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PATCH"
request: RequestRequestOptions
url: "/orgs/:org/hooks/:hook_id"

OrgsUpdateHookResponseData

OrgsUpdateHookResponseData: object

Type declaration

active: boolean
config: OrgsUpdateHookResponseDataConfig
created_at: string
events: Array<string>
id: number
name: string
ping_url: string
updated_at: string
url: string

OrgsUpdateHookResponseDataConfig

OrgsUpdateHookResponseDataConfig: object

Type declaration

content_type: string
url: string

OrgsUpdateMembershipEndpoint

OrgsUpdateMembershipEndpoint: object

Type declaration

org: string

org parameter
state: "active"

The state that the membership should be in. Only "active" will be accepted.

OrgsUpdateMembershipRequestOptions

OrgsUpdateMembershipRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PATCH"
request: RequestRequestOptions
url: "/user/memberships/orgs/:org"

OrgsUpdateMembershipResponseData

OrgsUpdateMembershipResponseData: object

Type declaration

organization: OrgsUpdateMembershipResponseDataOrganization
organization_url: string
role: string
state: string
url: string
user: OrgsUpdateMembershipResponseDataUser

OrgsUpdateMembershipResponseDataOrganization

OrgsUpdateMembershipResponseDataOrganization: object

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

OrgsUpdateMembershipResponseDataUser

OrgsUpdateMembershipResponseDataUser: object

Type declaration

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

OrgsUpdateRequestOptions

OrgsUpdateRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PATCH"
request: RequestRequestOptions
url: "/orgs/:org"

OrgsUpdateResponseData

OrgsUpdateResponseData: object

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: OrgsUpdateResponseDataPlan
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

OrgsUpdateResponseDataPlan

OrgsUpdateResponseDataPlan: object

Type declaration

name: string
private_repos: number
space: number

ProjectsAddCollaboratorEndpoint

ProjectsAddCollaboratorEndpoint: object & RequiredPreview<"inertia">

ProjectsAddCollaboratorRequestOptions

ProjectsAddCollaboratorRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PUT"
request: RequestRequestOptions
url: "/projects/:project_id/collaborators/:username"

ProjectsCreateCardEndpoint

ProjectsCreateCardEndpoint: object & RequiredPreview<"inertia">

ProjectsCreateCardRequestOptions

ProjectsCreateCardRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/projects/columns/:column_id/cards"

ProjectsCreateCardResponseData

ProjectsCreateCardResponseData: object

Type declaration

archived: boolean
column_url: string
content_url: string
created_at: string
creator: ProjectsCreateCardResponseDataCreator
id: number
node_id: string
note: string
project_url: string
updated_at: string
url: string

ProjectsCreateCardResponseDataCreator

ProjectsCreateCardResponseDataCreator: object

Type declaration

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

ProjectsCreateColumnEndpoint

ProjectsCreateColumnEndpoint: object & RequiredPreview<"inertia">

ProjectsCreateColumnRequestOptions

ProjectsCreateColumnRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/projects/:project_id/columns"

ProjectsCreateColumnResponseData

ProjectsCreateColumnResponseData: object

Type declaration

cards_url: string
created_at: string
id: number
name: string
node_id: string
project_url: string
updated_at: string
url: string

ProjectsCreateForAuthenticatedUserEndpoint

ProjectsCreateForAuthenticatedUserEndpoint: object & RequiredPreview<"inertia">

ProjectsCreateForAuthenticatedUserRequestOptions

ProjectsCreateForAuthenticatedUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/user/projects"

ProjectsCreateForAuthenticatedUserResponseData

ProjectsCreateForAuthenticatedUserResponseData: object

Type declaration

body: string
columns_url: string
created_at: string
creator: ProjectsCreateForAuthenticatedUserResponseDataCreator
html_url: string
id: number
name: string
node_id: string
number: number
owner_url: string
state: string
updated_at: string
url: string

ProjectsCreateForAuthenticatedUserResponseDataCreator

ProjectsCreateForAuthenticatedUserResponseDataCreator: object

Type declaration

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

ProjectsCreateForOrgEndpoint

ProjectsCreateForOrgEndpoint: object & RequiredPreview<"inertia">

ProjectsCreateForOrgRequestOptions

ProjectsCreateForOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/orgs/:org/projects"

ProjectsCreateForOrgResponseData

ProjectsCreateForOrgResponseData: object

Type declaration

body: string
columns_url: string
created_at: string
creator: ProjectsCreateForOrgResponseDataCreator
html_url: string
id: number
name: string
node_id: string
number: number
owner_url: string
state: string
updated_at: string
url: string

ProjectsCreateForOrgResponseDataCreator

ProjectsCreateForOrgResponseDataCreator: object

Type declaration

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

ProjectsCreateForRepoEndpoint

ProjectsCreateForRepoEndpoint: object & RequiredPreview<"inertia">

ProjectsCreateForRepoRequestOptions

ProjectsCreateForRepoRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/projects"

ProjectsCreateForRepoResponseData

ProjectsCreateForRepoResponseData: object

Type declaration

body: string
columns_url: string
created_at: string
creator: ProjectsCreateForRepoResponseDataCreator
html_url: string
id: number
name: string
node_id: string
number: number
owner_url: string
state: string
updated_at: string
url: string

ProjectsCreateForRepoResponseDataCreator

ProjectsCreateForRepoResponseDataCreator: object

Type declaration

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

ProjectsDeleteCardEndpoint

ProjectsDeleteCardEndpoint: object & RequiredPreview<"inertia">

ProjectsDeleteCardRequestOptions

ProjectsDeleteCardRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/projects/columns/cards/:card_id"

ProjectsDeleteColumnEndpoint

ProjectsDeleteColumnEndpoint: object & RequiredPreview<"inertia">

ProjectsDeleteColumnRequestOptions

ProjectsDeleteColumnRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/projects/columns/:column_id"

ProjectsDeleteEndpoint

ProjectsDeleteEndpoint: object & RequiredPreview<"inertia">

ProjectsDeleteRequestOptions

ProjectsDeleteRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/projects/:project_id"

ProjectsGetCardEndpoint

ProjectsGetCardEndpoint: object & RequiredPreview<"inertia">

ProjectsGetCardRequestOptions

ProjectsGetCardRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/projects/columns/cards/:card_id"

ProjectsGetCardResponseData

ProjectsGetCardResponseData: object

Type declaration

archived: boolean
column_url: string
content_url: string
created_at: string
creator: ProjectsGetCardResponseDataCreator
id: number
node_id: string
note: string
project_url: string
updated_at: string
url: string

ProjectsGetCardResponseDataCreator

ProjectsGetCardResponseDataCreator: object

Type declaration

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

ProjectsGetColumnEndpoint

ProjectsGetColumnEndpoint: object & RequiredPreview<"inertia">

ProjectsGetColumnRequestOptions

ProjectsGetColumnRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/projects/columns/:column_id"

ProjectsGetColumnResponseData

ProjectsGetColumnResponseData: object

Type declaration

cards_url: string
created_at: string
id: number
name: string
node_id: string
project_url: string
updated_at: string
url: string

ProjectsGetEndpoint

ProjectsGetEndpoint: object & RequiredPreview<"inertia">

ProjectsGetRequestOptions

ProjectsGetRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/projects/:project_id"

ProjectsGetResponseData

ProjectsGetResponseData: object

Type declaration

body: string
columns_url: string
created_at: string
creator: ProjectsGetResponseDataCreator
html_url: string
id: number
name: string
node_id: string
number: number
owner_url: string
state: string
updated_at: string
url: string

ProjectsGetResponseDataCreator

ProjectsGetResponseDataCreator: object

Type declaration

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

ProjectsListCardsEndpoint

ProjectsListCardsEndpoint: object & RequiredPreview<"inertia">

ProjectsListCardsRequestOptions

ProjectsListCardsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/projects/columns/:column_id/cards"

ProjectsListCardsResponseData

ProjectsListCardsResponseData: Array<ProjectsListCardsResponseDataItem>

ProjectsListCardsResponseDataItem

ProjectsListCardsResponseDataItem: object

Type declaration

archived: boolean
column_url: string
content_url: string
created_at: string
creator: ProjectsListCardsResponseDataItemCreator
id: number
node_id: string
note: string
project_url: string
updated_at: string
url: string

ProjectsListCardsResponseDataItemCreator

ProjectsListCardsResponseDataItemCreator: object

Type declaration

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

ProjectsListCollaboratorsEndpoint

ProjectsListCollaboratorsEndpoint: object & RequiredPreview<"inertia">

ProjectsListCollaboratorsRequestOptions

ProjectsListCollaboratorsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/projects/:project_id/collaborators"

ProjectsListCollaboratorsResponseData

ProjectsListCollaboratorsResponseData: Array<ProjectsListCollaboratorsResponseDataItem>

ProjectsListCollaboratorsResponseDataItem

ProjectsListCollaboratorsResponseDataItem: object

Type declaration

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

ProjectsListColumnsEndpoint

ProjectsListColumnsEndpoint: object & RequiredPreview<"inertia">

ProjectsListColumnsRequestOptions

ProjectsListColumnsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/projects/:project_id/columns"

ProjectsListColumnsResponseData

ProjectsListColumnsResponseData: Array<ProjectsListColumnsResponseDataItem>

ProjectsListColumnsResponseDataItem

ProjectsListColumnsResponseDataItem: object

Type declaration

cards_url: string
created_at: string
id: number
name: string
node_id: string
project_url: string
updated_at: string
url: string

ProjectsListForOrgEndpoint

ProjectsListForOrgEndpoint: object & RequiredPreview<"inertia">

ProjectsListForOrgRequestOptions

ProjectsListForOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/orgs/:org/projects"

ProjectsListForOrgResponseData

ProjectsListForOrgResponseData: Array<ProjectsListForOrgResponseDataItem>

ProjectsListForOrgResponseDataItem

ProjectsListForOrgResponseDataItem: object

Type declaration

body: string
columns_url: string
created_at: string
creator: ProjectsListForOrgResponseDataItemCreator
html_url: string
id: number
name: string
node_id: string
number: number
owner_url: string
state: string
updated_at: string
url: string

ProjectsListForOrgResponseDataItemCreator

ProjectsListForOrgResponseDataItemCreator: object

Type declaration

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

ProjectsListForRepoEndpoint

ProjectsListForRepoEndpoint: object & RequiredPreview<"inertia">

ProjectsListForRepoRequestOptions

ProjectsListForRepoRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/projects"

ProjectsListForRepoResponseData

ProjectsListForRepoResponseData: Array<ProjectsListForRepoResponseDataItem>

ProjectsListForRepoResponseDataItem

ProjectsListForRepoResponseDataItem: object

Type declaration

body: string
columns_url: string
created_at: string
creator: ProjectsListForRepoResponseDataItemCreator
html_url: string
id: number
name: string
node_id: string
number: number
owner_url: string
state: string
updated_at: string
url: string

ProjectsListForRepoResponseDataItemCreator

ProjectsListForRepoResponseDataItemCreator: object

Type declaration

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

ProjectsListForUserEndpoint

ProjectsListForUserEndpoint: object & RequiredPreview<"inertia">

ProjectsListForUserRequestOptions

ProjectsListForUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/users/:username/projects"

ProjectsListForUserResponseData

ProjectsListForUserResponseData: Array<ProjectsListForUserResponseDataItem>

ProjectsListForUserResponseDataItem

ProjectsListForUserResponseDataItem: object

Type declaration

body: string
columns_url: string
created_at: string
creator: ProjectsListForUserResponseDataItemCreator
html_url: string
id: number
name: string
node_id: string
number: number
owner_url: string
state: string
updated_at: string
url: string

ProjectsListForUserResponseDataItemCreator

ProjectsListForUserResponseDataItemCreator: object

Type declaration

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

ProjectsMoveCardEndpoint

ProjectsMoveCardEndpoint: object & RequiredPreview<"inertia">

ProjectsMoveCardRequestOptions

ProjectsMoveCardRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/projects/columns/cards/:card_id/moves"

ProjectsMoveColumnEndpoint

ProjectsMoveColumnEndpoint: object & RequiredPreview<"inertia">

ProjectsMoveColumnRequestOptions

ProjectsMoveColumnRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/projects/columns/:column_id/moves"

ProjectsRemoveCollaboratorEndpoint

ProjectsRemoveCollaboratorEndpoint: object & RequiredPreview<"inertia">

ProjectsRemoveCollaboratorRequestOptions

ProjectsRemoveCollaboratorRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/projects/:project_id/collaborators/:username"

ProjectsReviewUserPermissionLevelEndpoint

ProjectsReviewUserPermissionLevelEndpoint: object & RequiredPreview<"inertia">

ProjectsReviewUserPermissionLevelRequestOptions

ProjectsReviewUserPermissionLevelRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/projects/:project_id/collaborators/:username/permission"

ProjectsReviewUserPermissionLevelResponseData

ProjectsReviewUserPermissionLevelResponseData: object

Type declaration

permission: string
user: ProjectsReviewUserPermissionLevelResponseDataUser

ProjectsReviewUserPermissionLevelResponseDataUser

ProjectsReviewUserPermissionLevelResponseDataUser: object

Type declaration

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

ProjectsUpdateCardEndpoint

ProjectsUpdateCardEndpoint: object & RequiredPreview<"inertia">

ProjectsUpdateCardRequestOptions

ProjectsUpdateCardRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PATCH"
request: RequestRequestOptions
url: "/projects/columns/cards/:card_id"

ProjectsUpdateCardResponseData

ProjectsUpdateCardResponseData: object

Type declaration

archived: boolean
column_url: string
content_url: string
created_at: string
creator: ProjectsUpdateCardResponseDataCreator
id: number
node_id: string
note: string
project_url: string
updated_at: string
url: string

ProjectsUpdateCardResponseDataCreator

ProjectsUpdateCardResponseDataCreator: object

Type declaration

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

ProjectsUpdateColumnEndpoint

ProjectsUpdateColumnEndpoint: object & RequiredPreview<"inertia">

ProjectsUpdateColumnRequestOptions

ProjectsUpdateColumnRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PATCH"
request: RequestRequestOptions
url: "/projects/columns/:column_id"

ProjectsUpdateColumnResponseData

ProjectsUpdateColumnResponseData: object

Type declaration

cards_url: string
created_at: string
id: number
name: string
node_id: string
project_url: string
updated_at: string
url: string

ProjectsUpdateEndpoint

ProjectsUpdateEndpoint: object & RequiredPreview<"inertia">

ProjectsUpdateRequestOptions

ProjectsUpdateRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PATCH"
request: RequestRequestOptions
url: "/projects/:project_id"

ProjectsUpdateResponseData

ProjectsUpdateResponseData: object

Type declaration

body: string
columns_url: string
created_at: string
creator: ProjectsUpdateResponseDataCreator
html_url: string
id: number
name: string
node_id: string
number: number
owner_url: string
state: string
updated_at: string
url: string

ProjectsUpdateResponseDataCreator

ProjectsUpdateResponseDataCreator: object

Type declaration

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

PullsCheckIfMergedEndpoint

PullsCheckIfMergedEndpoint: object

Type declaration

owner: string

owner parameter
pull_number: number

pull_number parameter
repo: string

repo parameter

PullsCheckIfMergedRequestOptions

PullsCheckIfMergedRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/pulls/:pull_number/merge"

PullsCreateCommentEndpoint

PullsCreateCommentEndpoint: object

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?: 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

owner parameter
path: string

The relative path to the file that necessitates a comment.
Optional position?: 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

pull_number parameter
repo: string

repo parameter
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?: 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.

PullsCreateCommentRequestOptions

PullsCreateCommentRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/pulls/:pull_number/comments"

PullsCreateCommentResponseData

PullsCreateCommentResponseData: object

Type declaration

_links: PullsCreateCommentResponseDataLinks
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: PullsCreateCommentResponseDataUser

PullsCreateCommentResponseDataLinks

PullsCreateCommentResponseDataLinks: object

Type declaration

html: PullsCreateCommentResponseDataLinksHtml
pull_request: PullsCreateCommentResponseDataLinksPullRequest
self: PullsCreateCommentResponseDataLinksSelf

PullsCreateCommentResponseDataLinksHtml

PullsCreateCommentResponseDataLinksHtml: object

Type declaration

href: string

PullsCreateCommentResponseDataLinksPullRequest

PullsCreateCommentResponseDataLinksPullRequest: object

Type declaration

href: string

PullsCreateCommentResponseDataLinksSelf

PullsCreateCommentResponseDataLinksSelf: object

Type declaration

href: string

PullsCreateCommentResponseDataUser

PullsCreateCommentResponseDataUser: object

Type declaration

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

PullsCreateEndpoint

PullsCreateEndpoint: object

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?: string

The contents of the pull request.
Optional draft?: boolean

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?: boolean

Indicates whether maintainers can modify the pull request.
owner: string

owner parameter
repo: string

repo parameter
title: string

The title of the new pull request.

PullsCreateRequestOptions

PullsCreateRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/pulls"

PullsCreateResponseData

PullsCreateResponseData: object

Type declaration

_links: PullsCreateResponseDataLinks
active_lock_reason: string
additions: number
assignee: PullsCreateResponseDataAssignee
assignees: Array<PullsCreateResponseDataAssigneesItem>
author_association: string
base: PullsCreateResponseDataBase
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: PullsCreateResponseDataHead
html_url: string
id: number
issue_url: string
labels: Array<PullsCreateResponseDataLabelsItem>
locked: boolean
maintainer_can_modify: boolean
merge_commit_sha: string
mergeable: boolean
mergeable_state: string
merged: boolean
merged_at: string
merged_by: PullsCreateResponseDataMergedBy
milestone: PullsCreateResponseDataMilestone
node_id: string
number: number
patch_url: string
rebaseable: boolean
requested_reviewers: Array<PullsCreateResponseDataRequestedReviewersItem>
requested_teams: Array<PullsCreateResponseDataRequestedTeamsItem>
review_comment_url: string
review_comments: number
review_comments_url: string
state: string
statuses_url: string
title: string
updated_at: string
url: string
user: PullsCreateResponseDataUser

PullsCreateResponseDataAssignee

PullsCreateResponseDataAssignee: object

Type declaration

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

PullsCreateResponseDataAssigneesItem

PullsCreateResponseDataAssigneesItem: object

Type declaration

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

PullsCreateResponseDataBase

PullsCreateResponseDataBase: object

Type declaration

label: string
ref: string
repo: PullsCreateResponseDataBaseRepo
sha: string
user: PullsCreateResponseDataBaseUser

PullsCreateResponseDataBaseRepo

PullsCreateResponseDataBaseRepo: object

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: PullsCreateResponseDataBaseRepoOwner
permissions: PullsCreateResponseDataBaseRepoPermissions
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

PullsCreateResponseDataBaseRepoOwner

PullsCreateResponseDataBaseRepoOwner: object

Type declaration

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

PullsCreateResponseDataBaseRepoPermissions

PullsCreateResponseDataBaseRepoPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

PullsCreateResponseDataBaseUser

PullsCreateResponseDataBaseUser: object

Type declaration

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

PullsCreateResponseDataHead

PullsCreateResponseDataHead: object

Type declaration

label: string
ref: string
repo: PullsCreateResponseDataHeadRepo
sha: string
user: PullsCreateResponseDataHeadUser

PullsCreateResponseDataHeadRepo

PullsCreateResponseDataHeadRepo: object

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: PullsCreateResponseDataHeadRepoOwner
permissions: PullsCreateResponseDataHeadRepoPermissions
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

PullsCreateResponseDataHeadRepoOwner

PullsCreateResponseDataHeadRepoOwner: object

Type declaration

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

PullsCreateResponseDataHeadRepoPermissions

PullsCreateResponseDataHeadRepoPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

PullsCreateResponseDataHeadUser

PullsCreateResponseDataHeadUser: object

Type declaration

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

PullsCreateResponseDataLabelsItem

PullsCreateResponseDataLabelsItem: object

Type declaration

color: string
default: boolean
description: string
id: number
name: string
node_id: string
url: string

PullsCreateResponseDataLinks

PullsCreateResponseDataLinks: object

Type declaration

comments: PullsCreateResponseDataLinksComments
commits: PullsCreateResponseDataLinksCommits
html: PullsCreateResponseDataLinksHtml
issue: PullsCreateResponseDataLinksIssue
review_comment: PullsCreateResponseDataLinksReviewComment
review_comments: PullsCreateResponseDataLinksReviewComments
self: PullsCreateResponseDataLinksSelf
statuses: PullsCreateResponseDataLinksStatuses

PullsCreateResponseDataLinksComments

PullsCreateResponseDataLinksComments: object

Type declaration

href: string

PullsCreateResponseDataLinksCommits

PullsCreateResponseDataLinksCommits: object

Type declaration

href: string

PullsCreateResponseDataLinksHtml

PullsCreateResponseDataLinksHtml: object

Type declaration

href: string

PullsCreateResponseDataLinksIssue

PullsCreateResponseDataLinksIssue: object

Type declaration

href: string

PullsCreateResponseDataLinksReviewComment

PullsCreateResponseDataLinksReviewComment: object

Type declaration

href: string

PullsCreateResponseDataLinksReviewComments

PullsCreateResponseDataLinksReviewComments: object

Type declaration

href: string

PullsCreateResponseDataLinksSelf

PullsCreateResponseDataLinksSelf: object

Type declaration

href: string

PullsCreateResponseDataLinksStatuses

PullsCreateResponseDataLinksStatuses: object

Type declaration

href: string

PullsCreateResponseDataMergedBy

PullsCreateResponseDataMergedBy: object

Type declaration

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

PullsCreateResponseDataMilestone

PullsCreateResponseDataMilestone: object

Type declaration

closed_at: string
closed_issues: number
created_at: string
creator: PullsCreateResponseDataMilestoneCreator
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

PullsCreateResponseDataMilestoneCreator

PullsCreateResponseDataMilestoneCreator: object

Type declaration

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

PullsCreateResponseDataRequestedReviewersItem

PullsCreateResponseDataRequestedReviewersItem: object

Type declaration

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

PullsCreateResponseDataRequestedTeamsItem

PullsCreateResponseDataRequestedTeamsItem: object

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

PullsCreateResponseDataUser

PullsCreateResponseDataUser: object

Type declaration

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

PullsCreateReviewCommentReplyEndpoint

PullsCreateReviewCommentReplyEndpoint: object

Type declaration

body: string

The text of the review comment.
comment_id: number

comment_id parameter
owner: string

owner parameter
pull_number: number

pull_number parameter
repo: string

repo parameter

PullsCreateReviewCommentReplyRequestOptions

PullsCreateReviewCommentReplyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/pulls/:pull_number/comments/:comment_id/replies"

PullsCreateReviewCommentReplyResponseData

PullsCreateReviewCommentReplyResponseData: object

Type declaration

_links: PullsCreateReviewCommentReplyResponseDataLinks
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: PullsCreateReviewCommentReplyResponseDataUser

PullsCreateReviewCommentReplyResponseDataLinks

PullsCreateReviewCommentReplyResponseDataLinks: object

Type declaration

html: PullsCreateReviewCommentReplyResponseDataLinksHtml
pull_request: PullsCreateReviewCommentReplyResponseDataLinksPullRequest
self: PullsCreateReviewCommentReplyResponseDataLinksSelf

PullsCreateReviewCommentReplyResponseDataLinksHtml

PullsCreateReviewCommentReplyResponseDataLinksHtml: object

Type declaration

href: string

PullsCreateReviewCommentReplyResponseDataLinksPullRequest

PullsCreateReviewCommentReplyResponseDataLinksPullRequest: object

Type declaration

href: string

PullsCreateReviewCommentReplyResponseDataLinksSelf

PullsCreateReviewCommentReplyResponseDataLinksSelf: object

Type declaration

href: string

PullsCreateReviewCommentReplyResponseDataUser

PullsCreateReviewCommentReplyResponseDataUser: object

Type declaration

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

PullsCreateReviewEndpoint

PullsCreateReviewEndpoint: object

Type declaration

Optional body?: 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?: 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

owner parameter
pull_number: number

pull_number parameter
repo: string

repo parameter

PullsCreateReviewParamsComments

PullsCreateReviewParamsComments: object

Type declaration

body: string
path: string
position: number

PullsCreateReviewRequestEndpoint

PullsCreateReviewRequestEndpoint: object

Type declaration

owner: string

owner parameter
pull_number: number

pull_number parameter
repo: string

repo parameter
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.

PullsCreateReviewRequestOptions

PullsCreateReviewRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/pulls/:pull_number/reviews"

PullsCreateReviewRequestRequestOptions

PullsCreateReviewRequestRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/pulls/:pull_number/requested_reviewers"

PullsCreateReviewRequestResponseData

PullsCreateReviewRequestResponseData: object

Type declaration

_links: PullsCreateReviewRequestResponseDataLinks
active_lock_reason: string
assignee: PullsCreateReviewRequestResponseDataAssignee
assignees: Array<PullsCreateReviewRequestResponseDataAssigneesItem>
author_association: string
base: PullsCreateReviewRequestResponseDataBase
body: string
closed_at: string
comments_url: string
commits_url: string
created_at: string
diff_url: string
draft: boolean
head: PullsCreateReviewRequestResponseDataHead
html_url: string
id: number
issue_url: string
labels: Array<PullsCreateReviewRequestResponseDataLabelsItem>
locked: boolean
merge_commit_sha: string
merged_at: string
milestone: PullsCreateReviewRequestResponseDataMilestone
node_id: string
number: number
patch_url: string
requested_reviewers: Array<PullsCreateReviewRequestResponseDataRequestedReviewersItem>
requested_teams: Array<PullsCreateReviewRequestResponseDataRequestedTeamsItem>
review_comment_url: string
review_comments_url: string
state: string
statuses_url: string
title: string
updated_at: string
url: string
user: PullsCreateReviewRequestResponseDataUser

PullsCreateReviewRequestResponseDataAssignee

PullsCreateReviewRequestResponseDataAssignee: object

Type declaration

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

PullsCreateReviewRequestResponseDataAssigneesItem

PullsCreateReviewRequestResponseDataAssigneesItem: object

Type declaration

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

PullsCreateReviewRequestResponseDataBase

PullsCreateReviewRequestResponseDataBase: object

Type declaration

label: string
ref: string
repo: PullsCreateReviewRequestResponseDataBaseRepo
sha: string
user: PullsCreateReviewRequestResponseDataBaseUser

PullsCreateReviewRequestResponseDataBaseRepo

PullsCreateReviewRequestResponseDataBaseRepo: object

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: PullsCreateReviewRequestResponseDataBaseRepoOwner
permissions: PullsCreateReviewRequestResponseDataBaseRepoPermissions
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

PullsCreateReviewRequestResponseDataBaseRepoOwner

PullsCreateReviewRequestResponseDataBaseRepoOwner: object

Type declaration

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

PullsCreateReviewRequestResponseDataBaseRepoPermissions

PullsCreateReviewRequestResponseDataBaseRepoPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

PullsCreateReviewRequestResponseDataBaseUser

PullsCreateReviewRequestResponseDataBaseUser: object

Type declaration

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

PullsCreateReviewRequestResponseDataHead

PullsCreateReviewRequestResponseDataHead: object

Type declaration

label: string
ref: string
repo: PullsCreateReviewRequestResponseDataHeadRepo
sha: string
user: PullsCreateReviewRequestResponseDataHeadUser

PullsCreateReviewRequestResponseDataHeadRepo

PullsCreateReviewRequestResponseDataHeadRepo: object

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: PullsCreateReviewRequestResponseDataHeadRepoOwner
permissions: PullsCreateReviewRequestResponseDataHeadRepoPermissions
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

PullsCreateReviewRequestResponseDataHeadRepoOwner

PullsCreateReviewRequestResponseDataHeadRepoOwner: object

Type declaration

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

PullsCreateReviewRequestResponseDataHeadRepoPermissions

PullsCreateReviewRequestResponseDataHeadRepoPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

PullsCreateReviewRequestResponseDataHeadUser

PullsCreateReviewRequestResponseDataHeadUser: object

Type declaration

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

PullsCreateReviewRequestResponseDataLabelsItem

PullsCreateReviewRequestResponseDataLabelsItem: object

Type declaration

color: string
default: boolean
description: string
id: number
name: string
node_id: string
url: string

PullsCreateReviewRequestResponseDataLinks

PullsCreateReviewRequestResponseDataLinks: object

Type declaration

comments: PullsCreateReviewRequestResponseDataLinksComments
commits: PullsCreateReviewRequestResponseDataLinksCommits
html: PullsCreateReviewRequestResponseDataLinksHtml
issue: PullsCreateReviewRequestResponseDataLinksIssue
review_comment: PullsCreateReviewRequestResponseDataLinksReviewComment
review_comments: PullsCreateReviewRequestResponseDataLinksReviewComments
self: PullsCreateReviewRequestResponseDataLinksSelf
statuses: PullsCreateReviewRequestResponseDataLinksStatuses

PullsCreateReviewRequestResponseDataLinksComments

PullsCreateReviewRequestResponseDataLinksComments: object

Type declaration

href: string

PullsCreateReviewRequestResponseDataLinksCommits

PullsCreateReviewRequestResponseDataLinksCommits: object

Type declaration

href: string

PullsCreateReviewRequestResponseDataLinksHtml

PullsCreateReviewRequestResponseDataLinksHtml: object

Type declaration

href: string

PullsCreateReviewRequestResponseDataLinksIssue

PullsCreateReviewRequestResponseDataLinksIssue: object

Type declaration

href: string

PullsCreateReviewRequestResponseDataLinksReviewComment

PullsCreateReviewRequestResponseDataLinksReviewComment: object

Type declaration

href: string

PullsCreateReviewRequestResponseDataLinksReviewComments

PullsCreateReviewRequestResponseDataLinksReviewComments: object

Type declaration

href: string

PullsCreateReviewRequestResponseDataLinksSelf

PullsCreateReviewRequestResponseDataLinksSelf: object

Type declaration

href: string

PullsCreateReviewRequestResponseDataLinksStatuses

PullsCreateReviewRequestResponseDataLinksStatuses: object

Type declaration

href: string

PullsCreateReviewRequestResponseDataMilestone

PullsCreateReviewRequestResponseDataMilestone: object

Type declaration

closed_at: string
closed_issues: number
created_at: string
creator: PullsCreateReviewRequestResponseDataMilestoneCreator
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

PullsCreateReviewRequestResponseDataMilestoneCreator

PullsCreateReviewRequestResponseDataMilestoneCreator: object

Type declaration

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

PullsCreateReviewRequestResponseDataRequestedReviewersItem

PullsCreateReviewRequestResponseDataRequestedReviewersItem: object

Type declaration

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

PullsCreateReviewRequestResponseDataRequestedTeamsItem

PullsCreateReviewRequestResponseDataRequestedTeamsItem: object

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

PullsCreateReviewRequestResponseDataUser

PullsCreateReviewRequestResponseDataUser: object

Type declaration

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

PullsCreateReviewResponseData

PullsCreateReviewResponseData: object

Type declaration

_links: PullsCreateReviewResponseDataLinks
body: string
commit_id: string
html_url: string
id: number
node_id: string
pull_request_url: string
state: string
user: PullsCreateReviewResponseDataUser

PullsCreateReviewResponseDataLinks

PullsCreateReviewResponseDataLinks: object

Type declaration

html: PullsCreateReviewResponseDataLinksHtml
pull_request: PullsCreateReviewResponseDataLinksPullRequest

PullsCreateReviewResponseDataLinksHtml

PullsCreateReviewResponseDataLinksHtml: object

Type declaration

href: string

PullsCreateReviewResponseDataLinksPullRequest

PullsCreateReviewResponseDataLinksPullRequest: object

Type declaration

href: string

PullsCreateReviewResponseDataUser

PullsCreateReviewResponseDataUser: object

Type declaration

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

PullsDeleteCommentEndpoint

PullsDeleteCommentEndpoint: object

Type declaration

comment_id: number

comment_id parameter
owner: string

owner parameter
repo: string

repo parameter

PullsDeleteCommentRequestOptions

PullsDeleteCommentRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/repos/:owner/:repo/pulls/comments/:comment_id"

PullsDeletePendingReviewEndpoint

PullsDeletePendingReviewEndpoint: object

Type declaration

owner: string

owner parameter
pull_number: number

pull_number parameter
repo: string

repo parameter
review_id: number

review_id parameter

PullsDeletePendingReviewRequestOptions

PullsDeletePendingReviewRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id"

PullsDeletePendingReviewResponseData

PullsDeletePendingReviewResponseData: object

Type declaration

_links: PullsDeletePendingReviewResponseDataLinks
body: string
commit_id: string
html_url: string
id: number
node_id: string
pull_request_url: string
state: string
user: PullsDeletePendingReviewResponseDataUser

PullsDeletePendingReviewResponseDataLinks

PullsDeletePendingReviewResponseDataLinks: object

Type declaration

html: PullsDeletePendingReviewResponseDataLinksHtml
pull_request: PullsDeletePendingReviewResponseDataLinksPullRequest

PullsDeletePendingReviewResponseDataLinksHtml

PullsDeletePendingReviewResponseDataLinksHtml: object

Type declaration

href: string

PullsDeletePendingReviewResponseDataLinksPullRequest

PullsDeletePendingReviewResponseDataLinksPullRequest: object

Type declaration

href: string

PullsDeletePendingReviewResponseDataUser

PullsDeletePendingReviewResponseDataUser: object

Type declaration

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

PullsDeleteReviewRequestEndpoint

PullsDeleteReviewRequestEndpoint: object

Type declaration

owner: string

owner parameter
pull_number: number

pull_number parameter
repo: string

repo parameter
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.

PullsDeleteReviewRequestRequestOptions

PullsDeleteReviewRequestRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/repos/:owner/:repo/pulls/:pull_number/requested_reviewers"

PullsDismissReviewEndpoint

PullsDismissReviewEndpoint: object

Type declaration

message: string

The message for the pull request review dismissal
owner: string

owner parameter
pull_number: number

pull_number parameter
repo: string

repo parameter
review_id: number

review_id parameter

PullsDismissReviewRequestOptions

PullsDismissReviewRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PUT"
request: RequestRequestOptions
url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/dismissals"

PullsDismissReviewResponseData

PullsDismissReviewResponseData: object

Type declaration

_links: PullsDismissReviewResponseDataLinks
body: string
commit_id: string
html_url: string
id: number
node_id: string
pull_request_url: string
state: string
user: PullsDismissReviewResponseDataUser

PullsDismissReviewResponseDataLinks

PullsDismissReviewResponseDataLinks: object

Type declaration

html: PullsDismissReviewResponseDataLinksHtml
pull_request: PullsDismissReviewResponseDataLinksPullRequest

PullsDismissReviewResponseDataLinksHtml

PullsDismissReviewResponseDataLinksHtml: object

Type declaration

href: string

PullsDismissReviewResponseDataLinksPullRequest

PullsDismissReviewResponseDataLinksPullRequest: object

Type declaration

href: string

PullsDismissReviewResponseDataUser

PullsDismissReviewResponseDataUser: object

Type declaration

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

PullsGetCommentEndpoint

PullsGetCommentEndpoint: object

Type declaration

comment_id: number

comment_id parameter
owner: string

owner parameter
repo: string

repo parameter

PullsGetCommentRequestOptions

PullsGetCommentRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/pulls/comments/:comment_id"

PullsGetCommentResponseData

PullsGetCommentResponseData: object

Type declaration

_links: PullsGetCommentResponseDataLinks
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: PullsGetCommentResponseDataUser

PullsGetCommentResponseDataLinks

PullsGetCommentResponseDataLinks: object

Type declaration

html: PullsGetCommentResponseDataLinksHtml
pull_request: PullsGetCommentResponseDataLinksPullRequest
self: PullsGetCommentResponseDataLinksSelf

PullsGetCommentResponseDataLinksHtml

PullsGetCommentResponseDataLinksHtml: object

Type declaration

href: string

PullsGetCommentResponseDataLinksPullRequest

PullsGetCommentResponseDataLinksPullRequest: object

Type declaration

href: string

PullsGetCommentResponseDataLinksSelf

PullsGetCommentResponseDataLinksSelf: object

Type declaration

href: string

PullsGetCommentResponseDataUser

PullsGetCommentResponseDataUser: object

Type declaration

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

PullsGetCommentsForReviewEndpoint

PullsGetCommentsForReviewEndpoint: object

Type declaration

owner: string

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
pull_number: number

pull_number parameter
repo: string

repo parameter
review_id: number

review_id parameter

PullsGetCommentsForReviewRequestOptions

PullsGetCommentsForReviewRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/comments"

PullsGetCommentsForReviewResponseData

PullsGetCommentsForReviewResponseData: Array<PullsGetCommentsForReviewResponseDataItem>

PullsGetCommentsForReviewResponseDataItem

PullsGetCommentsForReviewResponseDataItem: object

Type declaration

_links: PullsGetCommentsForReviewResponseDataItemLinks
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: PullsGetCommentsForReviewResponseDataItemUser

PullsGetCommentsForReviewResponseDataItemLinks

PullsGetCommentsForReviewResponseDataItemLinks: object

Type declaration

html: PullsGetCommentsForReviewResponseDataItemLinksHtml
pull_request: PullsGetCommentsForReviewResponseDataItemLinksPullRequest
self: PullsGetCommentsForReviewResponseDataItemLinksSelf

PullsGetCommentsForReviewResponseDataItemLinksHtml

PullsGetCommentsForReviewResponseDataItemLinksHtml: object

Type declaration

href: string

PullsGetCommentsForReviewResponseDataItemLinksPullRequest

PullsGetCommentsForReviewResponseDataItemLinksPullRequest: object

Type declaration

href: string

PullsGetCommentsForReviewResponseDataItemLinksSelf

PullsGetCommentsForReviewResponseDataItemLinksSelf: object

Type declaration

href: string

PullsGetCommentsForReviewResponseDataItemUser

PullsGetCommentsForReviewResponseDataItemUser: object

Type declaration

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

PullsGetEndpoint

PullsGetEndpoint: object

Type declaration

owner: string

owner parameter
pull_number: number

pull_number parameter
repo: string

repo parameter

PullsGetRequestOptions

PullsGetRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/pulls/:pull_number"

PullsGetResponseData

PullsGetResponseData: object

Type declaration

_links: PullsGetResponseDataLinks
active_lock_reason: string
additions: number
assignee: PullsGetResponseDataAssignee
assignees: Array<PullsGetResponseDataAssigneesItem>
author_association: string
base: PullsGetResponseDataBase
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: PullsGetResponseDataHead
html_url: string
id: number
issue_url: string
labels: Array<PullsGetResponseDataLabelsItem>
locked: boolean
maintainer_can_modify: boolean
merge_commit_sha: string
mergeable: boolean
mergeable_state: string
merged: boolean
merged_at: string
merged_by: PullsGetResponseDataMergedBy
milestone: PullsGetResponseDataMilestone
node_id: string
number: number
patch_url: string
rebaseable: boolean
requested_reviewers: Array<PullsGetResponseDataRequestedReviewersItem>
requested_teams: Array<PullsGetResponseDataRequestedTeamsItem>
review_comment_url: string
review_comments: number
review_comments_url: string
state: string
statuses_url: string
title: string
updated_at: string
url: string
user: PullsGetResponseDataUser

PullsGetResponseDataAssignee

PullsGetResponseDataAssignee: object

Type declaration

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

PullsGetResponseDataAssigneesItem

PullsGetResponseDataAssigneesItem: object

Type declaration

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

PullsGetResponseDataBase

PullsGetResponseDataBase: object

Type declaration

label: string
ref: string
repo: PullsGetResponseDataBaseRepo
sha: string
user: PullsGetResponseDataBaseUser

PullsGetResponseDataBaseRepo

PullsGetResponseDataBaseRepo: object

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: PullsGetResponseDataBaseRepoOwner
permissions: PullsGetResponseDataBaseRepoPermissions
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

PullsGetResponseDataBaseRepoOwner

PullsGetResponseDataBaseRepoOwner: object

Type declaration

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

PullsGetResponseDataBaseRepoPermissions

PullsGetResponseDataBaseRepoPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

PullsGetResponseDataBaseUser

PullsGetResponseDataBaseUser: object

Type declaration

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

PullsGetResponseDataHead

PullsGetResponseDataHead: object

Type declaration

label: string
ref: string
repo: PullsGetResponseDataHeadRepo
sha: string
user: PullsGetResponseDataHeadUser

PullsGetResponseDataHeadRepo

PullsGetResponseDataHeadRepo: object

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: PullsGetResponseDataHeadRepoOwner
permissions: PullsGetResponseDataHeadRepoPermissions
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

PullsGetResponseDataHeadRepoOwner

PullsGetResponseDataHeadRepoOwner: object

Type declaration

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

PullsGetResponseDataHeadRepoPermissions

PullsGetResponseDataHeadRepoPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

PullsGetResponseDataHeadUser

PullsGetResponseDataHeadUser: object

Type declaration

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

PullsGetResponseDataLabelsItem

PullsGetResponseDataLabelsItem: object

Type declaration

color: string
default: boolean
description: string
id: number
name: string
node_id: string
url: string

PullsGetResponseDataLinks

PullsGetResponseDataLinks: object

Type declaration

comments: PullsGetResponseDataLinksComments
commits: PullsGetResponseDataLinksCommits
html: PullsGetResponseDataLinksHtml
issue: PullsGetResponseDataLinksIssue
review_comment: PullsGetResponseDataLinksReviewComment
review_comments: PullsGetResponseDataLinksReviewComments
self: PullsGetResponseDataLinksSelf
statuses: PullsGetResponseDataLinksStatuses

PullsGetResponseDataLinksComments

PullsGetResponseDataLinksComments: object

Type declaration

href: string

PullsGetResponseDataLinksCommits

PullsGetResponseDataLinksCommits: object

Type declaration

href: string

PullsGetResponseDataLinksHtml

PullsGetResponseDataLinksHtml: object

Type declaration

href: string

PullsGetResponseDataLinksIssue

PullsGetResponseDataLinksIssue: object

Type declaration

href: string

PullsGetResponseDataLinksReviewComment

PullsGetResponseDataLinksReviewComment: object

Type declaration

href: string

PullsGetResponseDataLinksReviewComments

PullsGetResponseDataLinksReviewComments: object

Type declaration

href: string

PullsGetResponseDataLinksSelf

PullsGetResponseDataLinksSelf: object

Type declaration

href: string

PullsGetResponseDataLinksStatuses

PullsGetResponseDataLinksStatuses: object

Type declaration

href: string

PullsGetResponseDataMergedBy

PullsGetResponseDataMergedBy: object

Type declaration

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

PullsGetResponseDataMilestone

PullsGetResponseDataMilestone: object

Type declaration

closed_at: string
closed_issues: number
created_at: string
creator: PullsGetResponseDataMilestoneCreator
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

PullsGetResponseDataMilestoneCreator

PullsGetResponseDataMilestoneCreator: object

Type declaration

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

PullsGetResponseDataRequestedReviewersItem

PullsGetResponseDataRequestedReviewersItem: object

Type declaration

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

PullsGetResponseDataRequestedTeamsItem

PullsGetResponseDataRequestedTeamsItem: object

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

PullsGetResponseDataUser

PullsGetResponseDataUser: object

Type declaration

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

PullsGetReviewEndpoint

PullsGetReviewEndpoint: object

Type declaration

owner: string

owner parameter
pull_number: number

pull_number parameter
repo: string

repo parameter
review_id: number

review_id parameter

PullsGetReviewRequestOptions

PullsGetReviewRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id"

PullsGetReviewResponseData

PullsGetReviewResponseData: object

Type declaration

_links: PullsGetReviewResponseDataLinks
body: string
commit_id: string
html_url: string
id: number
node_id: string
pull_request_url: string
state: string
submitted_at: string
user: PullsGetReviewResponseDataUser

PullsGetReviewResponseDataLinks

PullsGetReviewResponseDataLinks: object

Type declaration

html: PullsGetReviewResponseDataLinksHtml
pull_request: PullsGetReviewResponseDataLinksPullRequest

PullsGetReviewResponseDataLinksHtml

PullsGetReviewResponseDataLinksHtml: object

Type declaration

href: string

PullsGetReviewResponseDataLinksPullRequest

PullsGetReviewResponseDataLinksPullRequest: object

Type declaration

href: string

PullsGetReviewResponseDataUser

PullsGetReviewResponseDataUser: object

Type declaration

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

PullsListCommentsEndpoint

PullsListCommentsEndpoint: object

Type declaration

Optional direction?: "asc" | "desc"

Can be either asc or desc. Ignored without sort parameter.
owner: string

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
pull_number: number

pull_number parameter
repo: string

repo parameter
Optional since?: 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.

PullsListCommentsForRepoEndpoint

PullsListCommentsForRepoEndpoint: object

Type declaration

Optional direction?: "asc" | "desc"

Can be either asc or desc. Ignored without sort parameter.
owner: string

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
repo: string

repo parameter
Optional since?: 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.

PullsListCommentsForRepoRequestOptions

PullsListCommentsForRepoRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/pulls/comments"

PullsListCommentsForRepoResponseData

PullsListCommentsForRepoResponseData: Array<PullsListCommentsForRepoResponseDataItem>

PullsListCommentsForRepoResponseDataItem

PullsListCommentsForRepoResponseDataItem: object

Type declaration

_links: PullsListCommentsForRepoResponseDataItemLinks
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: PullsListCommentsForRepoResponseDataItemUser

PullsListCommentsForRepoResponseDataItemLinks

PullsListCommentsForRepoResponseDataItemLinks: object

Type declaration

html: PullsListCommentsForRepoResponseDataItemLinksHtml
pull_request: PullsListCommentsForRepoResponseDataItemLinksPullRequest
self: PullsListCommentsForRepoResponseDataItemLinksSelf

PullsListCommentsForRepoResponseDataItemLinksHtml

PullsListCommentsForRepoResponseDataItemLinksHtml: object

Type declaration

href: string

PullsListCommentsForRepoResponseDataItemLinksPullRequest

PullsListCommentsForRepoResponseDataItemLinksPullRequest: object

Type declaration

href: string

PullsListCommentsForRepoResponseDataItemLinksSelf

PullsListCommentsForRepoResponseDataItemLinksSelf: object

Type declaration

href: string

PullsListCommentsForRepoResponseDataItemUser

PullsListCommentsForRepoResponseDataItemUser: object

Type declaration

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

PullsListCommentsRequestOptions

PullsListCommentsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/pulls/:pull_number/comments"

PullsListCommentsResponseData

PullsListCommentsResponseData: Array<PullsListCommentsResponseDataItem>

PullsListCommentsResponseDataItem

PullsListCommentsResponseDataItem: object

Type declaration

_links: PullsListCommentsResponseDataItemLinks
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: PullsListCommentsResponseDataItemUser

PullsListCommentsResponseDataItemLinks

PullsListCommentsResponseDataItemLinks: object

Type declaration

html: PullsListCommentsResponseDataItemLinksHtml
pull_request: PullsListCommentsResponseDataItemLinksPullRequest
self: PullsListCommentsResponseDataItemLinksSelf

PullsListCommentsResponseDataItemLinksHtml

PullsListCommentsResponseDataItemLinksHtml: object

Type declaration

href: string

PullsListCommentsResponseDataItemLinksPullRequest

PullsListCommentsResponseDataItemLinksPullRequest: object

Type declaration

href: string

PullsListCommentsResponseDataItemLinksSelf

PullsListCommentsResponseDataItemLinksSelf: object

Type declaration

href: string

PullsListCommentsResponseDataItemUser

PullsListCommentsResponseDataItemUser: object

Type declaration

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

PullsListCommitsEndpoint

PullsListCommitsEndpoint: object

Type declaration

owner: string

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
pull_number: number

pull_number parameter
repo: string

repo parameter

PullsListCommitsRequestOptions

PullsListCommitsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/pulls/:pull_number/commits"

PullsListCommitsResponseData

PullsListCommitsResponseData: Array<PullsListCommitsResponseDataItem>

PullsListCommitsResponseDataItem

PullsListCommitsResponseDataItem: object

Type declaration

author: PullsListCommitsResponseDataItemAuthor
comments_url: string
commit: PullsListCommitsResponseDataItemCommit
committer: PullsListCommitsResponseDataItemCommitter
html_url: string
node_id: string
parents: Array<PullsListCommitsResponseDataItemParentsItem>
sha: string
url: string

PullsListCommitsResponseDataItemAuthor

PullsListCommitsResponseDataItemAuthor: object

Type declaration

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

PullsListCommitsResponseDataItemCommit

PullsListCommitsResponseDataItemCommit: object

Type declaration

author: PullsListCommitsResponseDataItemCommitAuthor
comment_count: number
committer: PullsListCommitsResponseDataItemCommitCommitter
message: string
tree: PullsListCommitsResponseDataItemCommitTree
url: string
verification: PullsListCommitsResponseDataItemCommitVerification

PullsListCommitsResponseDataItemCommitAuthor

PullsListCommitsResponseDataItemCommitAuthor: object

Type declaration

date: string
email: string
name: string

PullsListCommitsResponseDataItemCommitCommitter

PullsListCommitsResponseDataItemCommitCommitter: object

Type declaration

date: string
email: string
name: string

PullsListCommitsResponseDataItemCommitTree

PullsListCommitsResponseDataItemCommitTree: object

Type declaration

sha: string
url: string

PullsListCommitsResponseDataItemCommitVerification

PullsListCommitsResponseDataItemCommitVerification: object

Type declaration

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

PullsListCommitsResponseDataItemCommitter

PullsListCommitsResponseDataItemCommitter: object

Type declaration

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

PullsListCommitsResponseDataItemParentsItem

PullsListCommitsResponseDataItemParentsItem: object

Type declaration

sha: string
url: string

PullsListEndpoint

PullsListEndpoint: object

Type declaration

Optional base?: 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?: 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

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
repo: string

repo parameter
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.

PullsListFilesEndpoint

PullsListFilesEndpoint: object

Type declaration

owner: string

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
pull_number: number

pull_number parameter
repo: string

repo parameter

PullsListFilesRequestOptions

PullsListFilesRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/pulls/:pull_number/files"

PullsListFilesResponseData

PullsListFilesResponseData: Array<PullsListFilesResponseDataItem>

PullsListFilesResponseDataItem

PullsListFilesResponseDataItem: object

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

PullsListRequestOptions

PullsListRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/pulls"

PullsListResponseData

PullsListResponseData: Array<PullsListResponseDataItem>

PullsListResponseDataItem

PullsListResponseDataItem: object

Type declaration

_links: PullsListResponseDataItemLinks
active_lock_reason: string
assignee: PullsListResponseDataItemAssignee
assignees: Array<PullsListResponseDataItemAssigneesItem>
author_association: string
base: PullsListResponseDataItemBase
body: string
closed_at: string
comments_url: string
commits_url: string
created_at: string
diff_url: string
draft: boolean
head: PullsListResponseDataItemHead
html_url: string
id: number
issue_url: string
labels: Array<PullsListResponseDataItemLabelsItem>
locked: boolean
merge_commit_sha: string
merged_at: string
milestone: PullsListResponseDataItemMilestone
node_id: string
number: number
patch_url: string
requested_reviewers: Array<PullsListResponseDataItemRequestedReviewersItem>
requested_teams: Array<PullsListResponseDataItemRequestedTeamsItem>
review_comment_url: string
review_comments_url: string
state: string
statuses_url: string
title: string
updated_at: string
url: string
user: PullsListResponseDataItemUser

PullsListResponseDataItemAssignee

PullsListResponseDataItemAssignee: object

Type declaration

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

PullsListResponseDataItemAssigneesItem

PullsListResponseDataItemAssigneesItem: object

Type declaration

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

PullsListResponseDataItemBase

PullsListResponseDataItemBase: object

Type declaration

label: string
ref: string
repo: PullsListResponseDataItemBaseRepo
sha: string
user: PullsListResponseDataItemBaseUser

PullsListResponseDataItemBaseRepo

PullsListResponseDataItemBaseRepo: object

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: PullsListResponseDataItemBaseRepoOwner
permissions: PullsListResponseDataItemBaseRepoPermissions
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

PullsListResponseDataItemBaseRepoOwner

PullsListResponseDataItemBaseRepoOwner: object

Type declaration

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

PullsListResponseDataItemBaseRepoPermissions

PullsListResponseDataItemBaseRepoPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

PullsListResponseDataItemBaseUser

PullsListResponseDataItemBaseUser: object

Type declaration

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

PullsListResponseDataItemHead

PullsListResponseDataItemHead: object

Type declaration

label: string
ref: string
repo: PullsListResponseDataItemHeadRepo
sha: string
user: PullsListResponseDataItemHeadUser

PullsListResponseDataItemHeadRepo

PullsListResponseDataItemHeadRepo: object

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: PullsListResponseDataItemHeadRepoOwner
permissions: PullsListResponseDataItemHeadRepoPermissions
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

PullsListResponseDataItemHeadRepoOwner

PullsListResponseDataItemHeadRepoOwner: object

Type declaration

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

PullsListResponseDataItemHeadRepoPermissions

PullsListResponseDataItemHeadRepoPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

PullsListResponseDataItemHeadUser

PullsListResponseDataItemHeadUser: object

Type declaration

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

PullsListResponseDataItemLabelsItem

PullsListResponseDataItemLabelsItem: object

Type declaration

color: string
default: boolean
description: string
id: number
name: string
node_id: string
url: string

PullsListResponseDataItemLinks

PullsListResponseDataItemLinks: object

Type declaration

comments: PullsListResponseDataItemLinksComments
commits: PullsListResponseDataItemLinksCommits
html: PullsListResponseDataItemLinksHtml
issue: PullsListResponseDataItemLinksIssue
review_comment: PullsListResponseDataItemLinksReviewComment
review_comments: PullsListResponseDataItemLinksReviewComments
self: PullsListResponseDataItemLinksSelf
statuses: PullsListResponseDataItemLinksStatuses

PullsListResponseDataItemLinksComments

PullsListResponseDataItemLinksComments: object

Type declaration

href: string

PullsListResponseDataItemLinksCommits

PullsListResponseDataItemLinksCommits: object

Type declaration

href: string

PullsListResponseDataItemLinksHtml

PullsListResponseDataItemLinksHtml: object

Type declaration

href: string

PullsListResponseDataItemLinksIssue

PullsListResponseDataItemLinksIssue: object

Type declaration

href: string

PullsListResponseDataItemLinksReviewComment

PullsListResponseDataItemLinksReviewComment: object

Type declaration

href: string

PullsListResponseDataItemLinksReviewComments

PullsListResponseDataItemLinksReviewComments: object

Type declaration

href: string

PullsListResponseDataItemLinksSelf

PullsListResponseDataItemLinksSelf: object

Type declaration

href: string

PullsListResponseDataItemLinksStatuses

PullsListResponseDataItemLinksStatuses: object

Type declaration

href: string

PullsListResponseDataItemMilestone

PullsListResponseDataItemMilestone: object

Type declaration

closed_at: string
closed_issues: number
created_at: string
creator: PullsListResponseDataItemMilestoneCreator
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

PullsListResponseDataItemMilestoneCreator

PullsListResponseDataItemMilestoneCreator: object

Type declaration

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

PullsListResponseDataItemRequestedReviewersItem

PullsListResponseDataItemRequestedReviewersItem: object

Type declaration

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

PullsListResponseDataItemRequestedTeamsItem

PullsListResponseDataItemRequestedTeamsItem: object

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

PullsListResponseDataItemUser

PullsListResponseDataItemUser: object

Type declaration

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

PullsListReviewRequestsEndpoint

PullsListReviewRequestsEndpoint: object

Type declaration

owner: string

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
pull_number: number

pull_number parameter
repo: string

repo parameter

PullsListReviewRequestsRequestOptions

PullsListReviewRequestsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/pulls/:pull_number/requested_reviewers"

PullsListReviewRequestsResponseData

PullsListReviewRequestsResponseData: object

Type declaration

teams: Array<PullsListReviewRequestsResponseDataTeamsItem>
users: Array<PullsListReviewRequestsResponseDataUsersItem>

PullsListReviewRequestsResponseDataTeamsItem

PullsListReviewRequestsResponseDataTeamsItem: object

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

PullsListReviewRequestsResponseDataUsersItem

PullsListReviewRequestsResponseDataUsersItem: object

Type declaration

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

PullsListReviewsEndpoint

PullsListReviewsEndpoint: object

Type declaration

owner: string

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
pull_number: number

pull_number parameter
repo: string

repo parameter

PullsListReviewsRequestOptions

PullsListReviewsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/pulls/:pull_number/reviews"

PullsListReviewsResponseData

PullsListReviewsResponseData: Array<PullsListReviewsResponseDataItem>

PullsListReviewsResponseDataItem

PullsListReviewsResponseDataItem: object

Type declaration

_links: PullsListReviewsResponseDataItemLinks
body: string
commit_id: string
html_url: string
id: number
node_id: string
pull_request_url: string
state: string
submitted_at: string
user: PullsListReviewsResponseDataItemUser

PullsListReviewsResponseDataItemLinks

PullsListReviewsResponseDataItemLinks: object

Type declaration

html: PullsListReviewsResponseDataItemLinksHtml
pull_request: PullsListReviewsResponseDataItemLinksPullRequest

PullsListReviewsResponseDataItemLinksHtml

PullsListReviewsResponseDataItemLinksHtml: object

Type declaration

href: string

PullsListReviewsResponseDataItemLinksPullRequest

PullsListReviewsResponseDataItemLinksPullRequest: object

Type declaration

href: string

PullsListReviewsResponseDataItemUser

PullsListReviewsResponseDataItemUser: object

Type declaration

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

PullsMergeEndpoint

PullsMergeEndpoint: object

Type declaration

Optional commit_message?: string

Extra detail to append to automatic commit message.
Optional commit_title?: 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

owner parameter
pull_number: number

pull_number parameter
repo: string

repo parameter
Optional sha?: string

SHA that pull request head must match to allow merge.

PullsMergeRequestOptions

PullsMergeRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PUT"
request: RequestRequestOptions
url: "/repos/:owner/:repo/pulls/:pull_number/merge"

PullsMergeResponseData

PullsMergeResponseData: object

Type declaration

merged: boolean
message: string
sha: string

PullsSubmitReviewEndpoint

PullsSubmitReviewEndpoint: object

Type declaration

Optional body?: 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

owner parameter
pull_number: number

pull_number parameter
repo: string

repo parameter
review_id: number

review_id parameter

PullsSubmitReviewRequestOptions

PullsSubmitReviewRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/events"

PullsSubmitReviewResponseData

PullsSubmitReviewResponseData: object

Type declaration

_links: PullsSubmitReviewResponseDataLinks
body: string
commit_id: string
html_url: string
id: number
node_id: string
pull_request_url: string
state: string
submitted_at: string
user: PullsSubmitReviewResponseDataUser

PullsSubmitReviewResponseDataLinks

PullsSubmitReviewResponseDataLinks: object

Type declaration

html: PullsSubmitReviewResponseDataLinksHtml
pull_request: PullsSubmitReviewResponseDataLinksPullRequest

PullsSubmitReviewResponseDataLinksHtml

PullsSubmitReviewResponseDataLinksHtml: object

Type declaration

href: string

PullsSubmitReviewResponseDataLinksPullRequest

PullsSubmitReviewResponseDataLinksPullRequest: object

Type declaration

href: string

PullsSubmitReviewResponseDataUser

PullsSubmitReviewResponseDataUser: object

Type declaration

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

PullsUpdateBranchEndpoint

PullsUpdateBranchEndpoint: object & RequiredPreview<"lydian">

PullsUpdateBranchRequestOptions

PullsUpdateBranchRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PUT"
request: RequestRequestOptions
url: "/repos/:owner/:repo/pulls/:pull_number/update-branch"

PullsUpdateBranchResponseData

PullsUpdateBranchResponseData: object

Type declaration

message: string
url: string

PullsUpdateCommentEndpoint

PullsUpdateCommentEndpoint: object

Type declaration

body: string

The text of the reply to the review comment.
comment_id: number

comment_id parameter
owner: string

owner parameter
repo: string

repo parameter

PullsUpdateCommentRequestOptions

PullsUpdateCommentRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PATCH"
request: RequestRequestOptions
url: "/repos/:owner/:repo/pulls/comments/:comment_id"

PullsUpdateCommentResponseData

PullsUpdateCommentResponseData: object

Type declaration

_links: PullsUpdateCommentResponseDataLinks
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: PullsUpdateCommentResponseDataUser

PullsUpdateCommentResponseDataLinks

PullsUpdateCommentResponseDataLinks: object

Type declaration

html: PullsUpdateCommentResponseDataLinksHtml
pull_request: PullsUpdateCommentResponseDataLinksPullRequest
self: PullsUpdateCommentResponseDataLinksSelf

PullsUpdateCommentResponseDataLinksHtml

PullsUpdateCommentResponseDataLinksHtml: object

Type declaration

href: string

PullsUpdateCommentResponseDataLinksPullRequest

PullsUpdateCommentResponseDataLinksPullRequest: object

Type declaration

href: string

PullsUpdateCommentResponseDataLinksSelf

PullsUpdateCommentResponseDataLinksSelf: object

Type declaration

href: string

PullsUpdateCommentResponseDataUser

PullsUpdateCommentResponseDataUser: object

Type declaration

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

PullsUpdateEndpoint

PullsUpdateEndpoint: object

Type declaration

Optional base?: 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?: string

The contents of the pull request.
Optional maintainer_can_modify?: boolean

Indicates whether maintainers can modify the pull request.
owner: string

owner parameter
pull_number: number

pull_number parameter
repo: string

repo parameter
Optional state?: "open" | "closed"

State of this Pull Request. Either open or closed.
Optional title?: string

The title of the pull request.

PullsUpdateRequestOptions

PullsUpdateRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PATCH"
request: RequestRequestOptions
url: "/repos/:owner/:repo/pulls/:pull_number"

PullsUpdateResponseData

PullsUpdateResponseData: object

Type declaration

_links: PullsUpdateResponseDataLinks
active_lock_reason: string
additions: number
assignee: PullsUpdateResponseDataAssignee
assignees: Array<PullsUpdateResponseDataAssigneesItem>
author_association: string
base: PullsUpdateResponseDataBase
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: PullsUpdateResponseDataHead
html_url: string
id: number
issue_url: string
labels: Array<PullsUpdateResponseDataLabelsItem>
locked: boolean
maintainer_can_modify: boolean
merge_commit_sha: string
mergeable: boolean
mergeable_state: string
merged: boolean
merged_at: string
merged_by: PullsUpdateResponseDataMergedBy
milestone: PullsUpdateResponseDataMilestone
node_id: string
number: number
patch_url: string
rebaseable: boolean
requested_reviewers: Array<PullsUpdateResponseDataRequestedReviewersItem>
requested_teams: Array<PullsUpdateResponseDataRequestedTeamsItem>
review_comment_url: string
review_comments: number
review_comments_url: string
state: string
statuses_url: string
title: string
updated_at: string
url: string
user: PullsUpdateResponseDataUser

PullsUpdateResponseDataAssignee

PullsUpdateResponseDataAssignee: object

Type declaration

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

PullsUpdateResponseDataAssigneesItem

PullsUpdateResponseDataAssigneesItem: object

Type declaration

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

PullsUpdateResponseDataBase

PullsUpdateResponseDataBase: object

Type declaration

label: string
ref: string
repo: PullsUpdateResponseDataBaseRepo
sha: string
user: PullsUpdateResponseDataBaseUser

PullsUpdateResponseDataBaseRepo

PullsUpdateResponseDataBaseRepo: object

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: PullsUpdateResponseDataBaseRepoOwner
permissions: PullsUpdateResponseDataBaseRepoPermissions
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

PullsUpdateResponseDataBaseRepoOwner

PullsUpdateResponseDataBaseRepoOwner: object

Type declaration

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

PullsUpdateResponseDataBaseRepoPermissions

PullsUpdateResponseDataBaseRepoPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

PullsUpdateResponseDataBaseUser

PullsUpdateResponseDataBaseUser: object

Type declaration

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

PullsUpdateResponseDataHead

PullsUpdateResponseDataHead: object

Type declaration

label: string
ref: string
repo: PullsUpdateResponseDataHeadRepo
sha: string
user: PullsUpdateResponseDataHeadUser

PullsUpdateResponseDataHeadRepo

PullsUpdateResponseDataHeadRepo: object

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: PullsUpdateResponseDataHeadRepoOwner
permissions: PullsUpdateResponseDataHeadRepoPermissions
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

PullsUpdateResponseDataHeadRepoOwner

PullsUpdateResponseDataHeadRepoOwner: object

Type declaration

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

PullsUpdateResponseDataHeadRepoPermissions

PullsUpdateResponseDataHeadRepoPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

PullsUpdateResponseDataHeadUser

PullsUpdateResponseDataHeadUser: object

Type declaration

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

PullsUpdateResponseDataLabelsItem

PullsUpdateResponseDataLabelsItem: object

Type declaration

color: string
default: boolean
description: string
id: number
name: string
node_id: string
url: string

PullsUpdateResponseDataLinks

PullsUpdateResponseDataLinks: object

Type declaration

comments: PullsUpdateResponseDataLinksComments
commits: PullsUpdateResponseDataLinksCommits
html: PullsUpdateResponseDataLinksHtml
issue: PullsUpdateResponseDataLinksIssue
review_comment: PullsUpdateResponseDataLinksReviewComment
review_comments: PullsUpdateResponseDataLinksReviewComments
self: PullsUpdateResponseDataLinksSelf
statuses: PullsUpdateResponseDataLinksStatuses

PullsUpdateResponseDataLinksComments

PullsUpdateResponseDataLinksComments: object

Type declaration

href: string

PullsUpdateResponseDataLinksCommits

PullsUpdateResponseDataLinksCommits: object

Type declaration

href: string

PullsUpdateResponseDataLinksHtml

PullsUpdateResponseDataLinksHtml: object

Type declaration

href: string

PullsUpdateResponseDataLinksIssue

PullsUpdateResponseDataLinksIssue: object

Type declaration

href: string

PullsUpdateResponseDataLinksReviewComment

PullsUpdateResponseDataLinksReviewComment: object

Type declaration

href: string

PullsUpdateResponseDataLinksReviewComments

PullsUpdateResponseDataLinksReviewComments: object

Type declaration

href: string

PullsUpdateResponseDataLinksSelf

PullsUpdateResponseDataLinksSelf: object

Type declaration

href: string

PullsUpdateResponseDataLinksStatuses

PullsUpdateResponseDataLinksStatuses: object

Type declaration

href: string

PullsUpdateResponseDataMergedBy

PullsUpdateResponseDataMergedBy: object

Type declaration

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

PullsUpdateResponseDataMilestone

PullsUpdateResponseDataMilestone: object

Type declaration

closed_at: string
closed_issues: number
created_at: string
creator: PullsUpdateResponseDataMilestoneCreator
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

PullsUpdateResponseDataMilestoneCreator

PullsUpdateResponseDataMilestoneCreator: object

Type declaration

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

PullsUpdateResponseDataRequestedReviewersItem

PullsUpdateResponseDataRequestedReviewersItem: object

Type declaration

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

PullsUpdateResponseDataRequestedTeamsItem

PullsUpdateResponseDataRequestedTeamsItem: object

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

PullsUpdateResponseDataUser

PullsUpdateResponseDataUser: object

Type declaration

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

PullsUpdateReviewEndpoint

PullsUpdateReviewEndpoint: object

Type declaration

body: string

The body text of the pull request review.
owner: string

owner parameter
pull_number: number

pull_number parameter
repo: string

repo parameter
review_id: number

review_id parameter

PullsUpdateReviewRequestOptions

PullsUpdateReviewRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PUT"
request: RequestRequestOptions
url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id"

PullsUpdateReviewResponseData

PullsUpdateReviewResponseData: object

Type declaration

_links: PullsUpdateReviewResponseDataLinks
body: string
commit_id: string
html_url: string
id: number
node_id: string
pull_request_url: string
state: string
user: PullsUpdateReviewResponseDataUser

PullsUpdateReviewResponseDataLinks

PullsUpdateReviewResponseDataLinks: object

Type declaration

html: PullsUpdateReviewResponseDataLinksHtml
pull_request: PullsUpdateReviewResponseDataLinksPullRequest

PullsUpdateReviewResponseDataLinksHtml

PullsUpdateReviewResponseDataLinksHtml: object

Type declaration

href: string

PullsUpdateReviewResponseDataLinksPullRequest

PullsUpdateReviewResponseDataLinksPullRequest: object

Type declaration

href: string

PullsUpdateReviewResponseDataUser

PullsUpdateReviewResponseDataUser: object

Type declaration

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

RateLimitGetEndpoint

RateLimitGetEndpoint: object

Type declaration

RateLimitGetRequestOptions

RateLimitGetRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/rate_limit"

RateLimitGetResponseData

RateLimitGetResponseData: object

Type declaration

rate: RateLimitGetResponseDataRate
resources: RateLimitGetResponseDataResources

RateLimitGetResponseDataRate

RateLimitGetResponseDataRate: object

Type declaration

limit: number
remaining: number
reset: number

RateLimitGetResponseDataResources

RateLimitGetResponseDataResources: object

Type declaration

core: RateLimitGetResponseDataResourcesCore
graphql: RateLimitGetResponseDataResourcesGraphql
integration_manifest: RateLimitGetResponseDataResourcesIntegrationManifest
search: RateLimitGetResponseDataResourcesSearch

RateLimitGetResponseDataResourcesCore

RateLimitGetResponseDataResourcesCore: object

Type declaration

limit: number
remaining: number
reset: number

RateLimitGetResponseDataResourcesGraphql

RateLimitGetResponseDataResourcesGraphql: object

Type declaration

limit: number
remaining: number
reset: number

RateLimitGetResponseDataResourcesIntegrationManifest

RateLimitGetResponseDataResourcesIntegrationManifest: object

Type declaration

limit: number
remaining: number
reset: number

RateLimitGetResponseDataResourcesSearch

RateLimitGetResponseDataResourcesSearch: object

Type declaration

limit: number
remaining: number
reset: number

ReactionsCreateForCommitCommentEndpoint

ReactionsCreateForCommitCommentEndpoint: object & RequiredPreview<"squirrel-girl">

ReactionsCreateForCommitCommentRequestOptions

ReactionsCreateForCommitCommentRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/comments/:comment_id/reactions"

ReactionsCreateForCommitCommentResponseData

ReactionsCreateForCommitCommentResponseData: object

Type declaration

content: string
created_at: string
id: number
node_id: string
user: ReactionsCreateForCommitCommentResponseDataUser

ReactionsCreateForCommitCommentResponseDataUser

ReactionsCreateForCommitCommentResponseDataUser: object

Type declaration

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

ReactionsCreateForIssueCommentEndpoint

ReactionsCreateForIssueCommentEndpoint: object & RequiredPreview<"squirrel-girl">

ReactionsCreateForIssueCommentRequestOptions

ReactionsCreateForIssueCommentRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/issues/comments/:comment_id/reactions"

ReactionsCreateForIssueCommentResponseData

ReactionsCreateForIssueCommentResponseData: object

Type declaration

content: string
created_at: string
id: number
node_id: string
user: ReactionsCreateForIssueCommentResponseDataUser

ReactionsCreateForIssueCommentResponseDataUser

ReactionsCreateForIssueCommentResponseDataUser: object

Type declaration

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

ReactionsCreateForIssueEndpoint

ReactionsCreateForIssueEndpoint: object & RequiredPreview<"squirrel-girl">

ReactionsCreateForIssueRequestOptions

ReactionsCreateForIssueRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/issues/:issue_number/reactions"

ReactionsCreateForIssueResponseData

ReactionsCreateForIssueResponseData: object

Type declaration

content: string
created_at: string
id: number
node_id: string
user: ReactionsCreateForIssueResponseDataUser

ReactionsCreateForIssueResponseDataUser

ReactionsCreateForIssueResponseDataUser: object

Type declaration

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

ReactionsCreateForPullRequestReviewCommentEndpoint

ReactionsCreateForPullRequestReviewCommentEndpoint: object & RequiredPreview<"squirrel-girl">

ReactionsCreateForPullRequestReviewCommentRequestOptions

ReactionsCreateForPullRequestReviewCommentRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/pulls/comments/:comment_id/reactions"

ReactionsCreateForPullRequestReviewCommentResponseData

ReactionsCreateForPullRequestReviewCommentResponseData: object

Type declaration

content: string
created_at: string
id: number
node_id: string
user: ReactionsCreateForPullRequestReviewCommentResponseDataUser

ReactionsCreateForPullRequestReviewCommentResponseDataUser

ReactionsCreateForPullRequestReviewCommentResponseDataUser: object

Type declaration

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

ReactionsCreateForTeamDiscussionCommentInOrgEndpoint

ReactionsCreateForTeamDiscussionCommentInOrgEndpoint: object & RequiredPreview<"squirrel-girl">

ReactionsCreateForTeamDiscussionCommentInOrgRequestOptions

ReactionsCreateForTeamDiscussionCommentInOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions"

ReactionsCreateForTeamDiscussionCommentInOrgResponseData

ReactionsCreateForTeamDiscussionCommentInOrgResponseData: object

Type declaration

content: string
created_at: string
id: number
node_id: string
user: ReactionsCreateForTeamDiscussionCommentInOrgResponseDataUser

ReactionsCreateForTeamDiscussionCommentInOrgResponseDataUser

ReactionsCreateForTeamDiscussionCommentInOrgResponseDataUser: object

Type declaration

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

ReactionsCreateForTeamDiscussionCommentLegacyEndpoint

ReactionsCreateForTeamDiscussionCommentLegacyEndpoint: object & RequiredPreview<"squirrel-girl">

ReactionsCreateForTeamDiscussionCommentLegacyRequestOptions

ReactionsCreateForTeamDiscussionCommentLegacyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions"

ReactionsCreateForTeamDiscussionCommentLegacyResponseData

ReactionsCreateForTeamDiscussionCommentLegacyResponseData: object

Type declaration

content: string
created_at: string
id: number
node_id: string
user: ReactionsCreateForTeamDiscussionCommentLegacyResponseDataUser

ReactionsCreateForTeamDiscussionCommentLegacyResponseDataUser

ReactionsCreateForTeamDiscussionCommentLegacyResponseDataUser: object

Type declaration

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

ReactionsCreateForTeamDiscussionInOrgEndpoint

ReactionsCreateForTeamDiscussionInOrgEndpoint: object & RequiredPreview<"squirrel-girl">

ReactionsCreateForTeamDiscussionInOrgRequestOptions

ReactionsCreateForTeamDiscussionInOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions"

ReactionsCreateForTeamDiscussionInOrgResponseData

ReactionsCreateForTeamDiscussionInOrgResponseData: object

Type declaration

content: string
created_at: string
id: number
node_id: string
user: ReactionsCreateForTeamDiscussionInOrgResponseDataUser

ReactionsCreateForTeamDiscussionInOrgResponseDataUser

ReactionsCreateForTeamDiscussionInOrgResponseDataUser: object

Type declaration

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

ReactionsCreateForTeamDiscussionLegacyEndpoint

ReactionsCreateForTeamDiscussionLegacyEndpoint: object & RequiredPreview<"squirrel-girl">

ReactionsCreateForTeamDiscussionLegacyRequestOptions

ReactionsCreateForTeamDiscussionLegacyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/teams/:team_id/discussions/:discussion_number/reactions"

ReactionsCreateForTeamDiscussionLegacyResponseData

ReactionsCreateForTeamDiscussionLegacyResponseData: object

Type declaration

content: string
created_at: string
id: number
node_id: string
user: ReactionsCreateForTeamDiscussionLegacyResponseDataUser

ReactionsCreateForTeamDiscussionLegacyResponseDataUser

ReactionsCreateForTeamDiscussionLegacyResponseDataUser: object

Type declaration

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

ReactionsDeleteForCommitCommentEndpoint

ReactionsDeleteForCommitCommentEndpoint: object & RequiredPreview<"squirrel-girl">

ReactionsDeleteForCommitCommentRequestOptions

ReactionsDeleteForCommitCommentRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/repos/:owner/:repo/comments/:comment_id/reactions/:reaction_id"

ReactionsDeleteForIssueCommentEndpoint

ReactionsDeleteForIssueCommentEndpoint: object & RequiredPreview<"squirrel-girl">

ReactionsDeleteForIssueCommentRequestOptions

ReactionsDeleteForIssueCommentRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/repos/:owner/:repo/issues/comments/:comment_id/reactions/:reaction_id"

ReactionsDeleteForIssueEndpoint

ReactionsDeleteForIssueEndpoint: object & RequiredPreview<"squirrel-girl">

ReactionsDeleteForIssueRequestOptions

ReactionsDeleteForIssueRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/repos/:owner/:repo/issues/:issue_number/reactions/:reaction_id"

ReactionsDeleteForPullRequestCommentEndpoint

ReactionsDeleteForPullRequestCommentEndpoint: object & RequiredPreview<"squirrel-girl">

ReactionsDeleteForPullRequestCommentRequestOptions

ReactionsDeleteForPullRequestCommentRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/repos/:owner/:repo/pulls/comments/:comment_id/reactions/:reaction_id"

ReactionsDeleteForTeamDiscussionCommentEndpoint

ReactionsDeleteForTeamDiscussionCommentEndpoint: object & RequiredPreview<"squirrel-girl">

ReactionsDeleteForTeamDiscussionCommentRequestOptions

ReactionsDeleteForTeamDiscussionCommentRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id"

ReactionsDeleteForTeamDiscussionEndpoint

ReactionsDeleteForTeamDiscussionEndpoint: object & RequiredPreview<"squirrel-girl">

ReactionsDeleteForTeamDiscussionRequestOptions

ReactionsDeleteForTeamDiscussionRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions/:reaction_id"

ReactionsDeleteLegacyEndpoint

ReactionsDeleteLegacyEndpoint: object & RequiredPreview<"squirrel-girl">

ReactionsDeleteLegacyRequestOptions

ReactionsDeleteLegacyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/reactions/:reaction_id"

ReactionsListForCommitCommentEndpoint

ReactionsListForCommitCommentEndpoint: object & RequiredPreview<"squirrel-girl">

ReactionsListForCommitCommentRequestOptions

ReactionsListForCommitCommentRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/comments/:comment_id/reactions"

ReactionsListForCommitCommentResponseData

ReactionsListForCommitCommentResponseData: Array<ReactionsListForCommitCommentResponseDataItem>

ReactionsListForCommitCommentResponseDataItem

ReactionsListForCommitCommentResponseDataItem: object

Type declaration

content: string
created_at: string
id: number
node_id: string
user: ReactionsListForCommitCommentResponseDataItemUser

ReactionsListForCommitCommentResponseDataItemUser

ReactionsListForCommitCommentResponseDataItemUser: object

Type declaration

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

ReactionsListForIssueCommentEndpoint

ReactionsListForIssueCommentEndpoint: object & RequiredPreview<"squirrel-girl">

ReactionsListForIssueCommentRequestOptions

ReactionsListForIssueCommentRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/issues/comments/:comment_id/reactions"

ReactionsListForIssueCommentResponseData

ReactionsListForIssueCommentResponseData: Array<ReactionsListForIssueCommentResponseDataItem>

ReactionsListForIssueCommentResponseDataItem

ReactionsListForIssueCommentResponseDataItem: object

Type declaration

content: string
created_at: string
id: number
node_id: string
user: ReactionsListForIssueCommentResponseDataItemUser

ReactionsListForIssueCommentResponseDataItemUser

ReactionsListForIssueCommentResponseDataItemUser: object

Type declaration

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

ReactionsListForIssueEndpoint

ReactionsListForIssueEndpoint: object & RequiredPreview<"squirrel-girl">

ReactionsListForIssueRequestOptions

ReactionsListForIssueRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/issues/:issue_number/reactions"

ReactionsListForIssueResponseData

ReactionsListForIssueResponseData: Array<ReactionsListForIssueResponseDataItem>

ReactionsListForIssueResponseDataItem

ReactionsListForIssueResponseDataItem: object

Type declaration

content: string
created_at: string
id: number
node_id: string
user: ReactionsListForIssueResponseDataItemUser

ReactionsListForIssueResponseDataItemUser

ReactionsListForIssueResponseDataItemUser: object

Type declaration

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

ReactionsListForPullRequestReviewCommentEndpoint

ReactionsListForPullRequestReviewCommentEndpoint: object & RequiredPreview<"squirrel-girl">

ReactionsListForPullRequestReviewCommentRequestOptions

ReactionsListForPullRequestReviewCommentRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/pulls/comments/:comment_id/reactions"

ReactionsListForPullRequestReviewCommentResponseData

ReactionsListForPullRequestReviewCommentResponseData: Array<ReactionsListForPullRequestReviewCommentResponseDataItem>

ReactionsListForPullRequestReviewCommentResponseDataItem

ReactionsListForPullRequestReviewCommentResponseDataItem: object

Type declaration

content: string
created_at: string
id: number
node_id: string
user: ReactionsListForPullRequestReviewCommentResponseDataItemUser

ReactionsListForPullRequestReviewCommentResponseDataItemUser

ReactionsListForPullRequestReviewCommentResponseDataItemUser: object

Type declaration

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

ReactionsListForTeamDiscussionCommentInOrgEndpoint

ReactionsListForTeamDiscussionCommentInOrgEndpoint: object & RequiredPreview<"squirrel-girl">

ReactionsListForTeamDiscussionCommentInOrgRequestOptions

ReactionsListForTeamDiscussionCommentInOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions"

ReactionsListForTeamDiscussionCommentInOrgResponseData

ReactionsListForTeamDiscussionCommentInOrgResponseData: Array<ReactionsListForTeamDiscussionCommentInOrgResponseDataItem>

ReactionsListForTeamDiscussionCommentInOrgResponseDataItem

ReactionsListForTeamDiscussionCommentInOrgResponseDataItem: object

Type declaration

content: string
created_at: string
id: number
node_id: string
user: ReactionsListForTeamDiscussionCommentInOrgResponseDataItemUser

ReactionsListForTeamDiscussionCommentInOrgResponseDataItemUser

ReactionsListForTeamDiscussionCommentInOrgResponseDataItemUser: object

Type declaration

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

ReactionsListForTeamDiscussionCommentLegacyEndpoint

ReactionsListForTeamDiscussionCommentLegacyEndpoint: object & RequiredPreview<"squirrel-girl">

ReactionsListForTeamDiscussionCommentLegacyRequestOptions

ReactionsListForTeamDiscussionCommentLegacyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions"

ReactionsListForTeamDiscussionCommentLegacyResponseData

ReactionsListForTeamDiscussionCommentLegacyResponseData: Array<ReactionsListForTeamDiscussionCommentLegacyResponseDataItem>

ReactionsListForTeamDiscussionCommentLegacyResponseDataItem

ReactionsListForTeamDiscussionCommentLegacyResponseDataItem: object

Type declaration

content: string
created_at: string
id: number
node_id: string
user: ReactionsListForTeamDiscussionCommentLegacyResponseDataItemUser

ReactionsListForTeamDiscussionCommentLegacyResponseDataItemUser

ReactionsListForTeamDiscussionCommentLegacyResponseDataItemUser: object

Type declaration

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

ReactionsListForTeamDiscussionInOrgEndpoint

ReactionsListForTeamDiscussionInOrgEndpoint: object & RequiredPreview<"squirrel-girl">

ReactionsListForTeamDiscussionInOrgRequestOptions

ReactionsListForTeamDiscussionInOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions"

ReactionsListForTeamDiscussionInOrgResponseData

ReactionsListForTeamDiscussionInOrgResponseData: Array<ReactionsListForTeamDiscussionInOrgResponseDataItem>

ReactionsListForTeamDiscussionInOrgResponseDataItem

ReactionsListForTeamDiscussionInOrgResponseDataItem: object

Type declaration

content: string
created_at: string
id: number
node_id: string
user: ReactionsListForTeamDiscussionInOrgResponseDataItemUser

ReactionsListForTeamDiscussionInOrgResponseDataItemUser

ReactionsListForTeamDiscussionInOrgResponseDataItemUser: object

Type declaration

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

ReactionsListForTeamDiscussionLegacyEndpoint

ReactionsListForTeamDiscussionLegacyEndpoint: object & RequiredPreview<"squirrel-girl">

ReactionsListForTeamDiscussionLegacyRequestOptions

ReactionsListForTeamDiscussionLegacyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/teams/:team_id/discussions/:discussion_number/reactions"

ReactionsListForTeamDiscussionLegacyResponseData

ReactionsListForTeamDiscussionLegacyResponseData: Array<ReactionsListForTeamDiscussionLegacyResponseDataItem>

ReactionsListForTeamDiscussionLegacyResponseDataItem

ReactionsListForTeamDiscussionLegacyResponseDataItem: object

Type declaration

content: string
created_at: string
id: number
node_id: string
user: ReactionsListForTeamDiscussionLegacyResponseDataItemUser

ReactionsListForTeamDiscussionLegacyResponseDataItemUser

ReactionsListForTeamDiscussionLegacyResponseDataItemUser: object

Type declaration

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

ReposAcceptInvitationEndpoint

ReposAcceptInvitationEndpoint: object

Type declaration

invitation_id: number

invitation_id parameter

ReposAcceptInvitationRequestOptions

ReposAcceptInvitationRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PATCH"
request: RequestRequestOptions
url: "/user/repository_invitations/:invitation_id"

ReposAddCollaboratorEndpoint

ReposAddCollaboratorEndpoint: object

Type declaration

owner: string

owner parameter
Optional permission?: "pull" | "push" | "admin" | "maintain" | "triage"

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. * maintain - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. * triage - Recommended for contributors who need to proactively manage issues and pull requests without write access.
repo: string

repo parameter
username: string

username parameter

ReposAddCollaboratorRequestOptions

ReposAddCollaboratorRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PUT"
request: RequestRequestOptions
url: "/repos/:owner/:repo/collaborators/:username"

ReposAddCollaboratorResponseData

ReposAddCollaboratorResponseData: object

Type declaration

created_at: string
html_url: string
id: number
invitee: ReposAddCollaboratorResponseDataInvitee
inviter: ReposAddCollaboratorResponseDataInviter
permissions: string
repository: ReposAddCollaboratorResponseDataRepository
url: string

ReposAddCollaboratorResponseDataInvitee

ReposAddCollaboratorResponseDataInvitee: object

Type declaration

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

ReposAddCollaboratorResponseDataInviter

ReposAddCollaboratorResponseDataInviter: object

Type declaration

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

ReposAddCollaboratorResponseDataRepository

ReposAddCollaboratorResponseDataRepository: object

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: ReposAddCollaboratorResponseDataRepositoryOwner
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

ReposAddCollaboratorResponseDataRepositoryOwner

ReposAddCollaboratorResponseDataRepositoryOwner: object

Type declaration

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

ReposAddDeployKeyEndpoint

ReposAddDeployKeyEndpoint: object

Type declaration

key: string

The contents of the key.
owner: string

owner parameter
Optional read_only?: boolean

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

repo parameter
Optional title?: string

A name for the key.

ReposAddDeployKeyRequestOptions

ReposAddDeployKeyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/keys"

ReposAddDeployKeyResponseData

ReposAddDeployKeyResponseData: object

Type declaration

created_at: string
id: number
key: string
read_only: boolean
title: string
url: string
verified: boolean

ReposAddProtectedBranchAdminEnforcementEndpoint

ReposAddProtectedBranchAdminEnforcementEndpoint: object

Type declaration

branch: string

branch parameter
owner: string

owner parameter
repo: string

repo parameter

ReposAddProtectedBranchAdminEnforcementRequestOptions

ReposAddProtectedBranchAdminEnforcementRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/branches/:branch/protection/enforce_admins"

ReposAddProtectedBranchAdminEnforcementResponseData

ReposAddProtectedBranchAdminEnforcementResponseData: object

Type declaration

enabled: boolean
url: string

ReposAddProtectedBranchAppRestrictionsEndpoint

ReposAddProtectedBranchAppRestrictionsEndpoint: object

Type declaration

apps: string[]

apps parameter
branch: string

branch parameter
owner: string

owner parameter
repo: string

repo parameter

ReposAddProtectedBranchAppRestrictionsRequestOptions

ReposAddProtectedBranchAppRestrictionsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps"

ReposAddProtectedBranchAppRestrictionsResponseData

ReposAddProtectedBranchAppRestrictionsResponseData: Array<ReposAddProtectedBranchAppRestrictionsResponseDataItem>

ReposAddProtectedBranchAppRestrictionsResponseDataItem

ReposAddProtectedBranchAppRestrictionsResponseDataItem: object

Type declaration

created_at: string
description: string
events: Array<string>
external_url: string
html_url: string
id: number
name: string
node_id: string
owner: ReposAddProtectedBranchAppRestrictionsResponseDataItemOwner
permissions: ReposAddProtectedBranchAppRestrictionsResponseDataItemPermissions
slug: string
updated_at: string

ReposAddProtectedBranchAppRestrictionsResponseDataItemOwner

ReposAddProtectedBranchAppRestrictionsResponseDataItemOwner: object

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

ReposAddProtectedBranchAppRestrictionsResponseDataItemPermissions

ReposAddProtectedBranchAppRestrictionsResponseDataItemPermissions: object

Type declaration

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

ReposAddProtectedBranchRequiredSignaturesEndpoint

ReposAddProtectedBranchRequiredSignaturesEndpoint: object & RequiredPreview<"zzzax">

ReposAddProtectedBranchRequiredSignaturesRequestOptions

ReposAddProtectedBranchRequiredSignaturesRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/branches/:branch/protection/required_signatures"

ReposAddProtectedBranchRequiredSignaturesResponseData

ReposAddProtectedBranchRequiredSignaturesResponseData: object

Type declaration

enabled: boolean
url: string

ReposAddProtectedBranchRequiredStatusChecksContextsEndpoint

ReposAddProtectedBranchRequiredStatusChecksContextsEndpoint: object

Type declaration

branch: string

branch parameter
contexts: string[]

contexts parameter
owner: string

owner parameter
repo: string

repo parameter

ReposAddProtectedBranchRequiredStatusChecksContextsRequestOptions

ReposAddProtectedBranchRequiredStatusChecksContextsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"

ReposAddProtectedBranchRequiredStatusChecksContextsResponseData

ReposAddProtectedBranchRequiredStatusChecksContextsResponseData: Array<string>

ReposAddProtectedBranchTeamRestrictionsEndpoint

ReposAddProtectedBranchTeamRestrictionsEndpoint: object

Type declaration

branch: string

branch parameter
owner: string

owner parameter
repo: string

repo parameter
teams: string[]

teams parameter

ReposAddProtectedBranchTeamRestrictionsRequestOptions

ReposAddProtectedBranchTeamRestrictionsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"

ReposAddProtectedBranchTeamRestrictionsResponseData

ReposAddProtectedBranchTeamRestrictionsResponseData: Array<ReposAddProtectedBranchTeamRestrictionsResponseDataItem>

ReposAddProtectedBranchTeamRestrictionsResponseDataItem

ReposAddProtectedBranchTeamRestrictionsResponseDataItem: object

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

ReposAddProtectedBranchUserRestrictionsEndpoint

ReposAddProtectedBranchUserRestrictionsEndpoint: object

Type declaration

branch: string

branch parameter
owner: string

owner parameter
repo: string

repo parameter
users: string[]

users parameter

ReposAddProtectedBranchUserRestrictionsRequestOptions

ReposAddProtectedBranchUserRestrictionsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"

ReposAddProtectedBranchUserRestrictionsResponseData

ReposAddProtectedBranchUserRestrictionsResponseData: Array<ReposAddProtectedBranchUserRestrictionsResponseDataItem>

ReposAddProtectedBranchUserRestrictionsResponseDataItem

ReposAddProtectedBranchUserRestrictionsResponseDataItem: object

Type declaration

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

ReposCheckCollaboratorEndpoint

ReposCheckCollaboratorEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter
username: string

username parameter

ReposCheckCollaboratorRequestOptions

ReposCheckCollaboratorRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/collaborators/:username"

ReposCheckVulnerabilityAlertsEndpoint

ReposCheckVulnerabilityAlertsEndpoint: object & RequiredPreview<"dorian">

ReposCheckVulnerabilityAlertsRequestOptions

ReposCheckVulnerabilityAlertsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/vulnerability-alerts"

ReposCompareCommitsEndpoint

ReposCompareCommitsEndpoint: object

Type declaration

base: string

base parameter
head: string

head parameter
owner: string

owner parameter
repo: string

repo parameter

ReposCompareCommitsRequestOptions

ReposCompareCommitsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/compare/:base...:head"

ReposCompareCommitsResponseData

ReposCompareCommitsResponseData: object

Type declaration

ahead_by: number
base_commit: ReposCompareCommitsResponseDataBaseCommit
behind_by: number
commits: Array<ReposCompareCommitsResponseDataCommitsItem>
diff_url: string
files: Array<ReposCompareCommitsResponseDataFilesItem>
html_url: string
merge_base_commit: ReposCompareCommitsResponseDataMergeBaseCommit
patch_url: string
permalink_url: string
status: string
total_commits: number
url: string

ReposCompareCommitsResponseDataBaseCommit

ReposCompareCommitsResponseDataBaseCommit: object

Type declaration

author: ReposCompareCommitsResponseDataBaseCommitAuthor
comments_url: string
commit: ReposCompareCommitsResponseDataBaseCommitCommit
committer: ReposCompareCommitsResponseDataBaseCommitCommitter
html_url: string
node_id: string
parents: Array<ReposCompareCommitsResponseDataBaseCommitParentsItem>
sha: string
url: string

ReposCompareCommitsResponseDataBaseCommitAuthor

ReposCompareCommitsResponseDataBaseCommitAuthor: object

Type declaration

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

ReposCompareCommitsResponseDataBaseCommitCommit

ReposCompareCommitsResponseDataBaseCommitCommit: object

Type declaration

author: ReposCompareCommitsResponseDataBaseCommitCommitAuthor
comment_count: number
committer: ReposCompareCommitsResponseDataBaseCommitCommitCommitter
message: string
tree: ReposCompareCommitsResponseDataBaseCommitCommitTree
url: string
verification: ReposCompareCommitsResponseDataBaseCommitCommitVerification

ReposCompareCommitsResponseDataBaseCommitCommitAuthor

ReposCompareCommitsResponseDataBaseCommitCommitAuthor: object

Type declaration

date: string
email: string
name: string

ReposCompareCommitsResponseDataBaseCommitCommitCommitter

ReposCompareCommitsResponseDataBaseCommitCommitCommitter: object

Type declaration

date: string
email: string
name: string

ReposCompareCommitsResponseDataBaseCommitCommitTree

ReposCompareCommitsResponseDataBaseCommitCommitTree: object

Type declaration

sha: string
url: string

ReposCompareCommitsResponseDataBaseCommitCommitVerification

ReposCompareCommitsResponseDataBaseCommitCommitVerification: object

Type declaration

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

ReposCompareCommitsResponseDataBaseCommitCommitter

ReposCompareCommitsResponseDataBaseCommitCommitter: object

Type declaration

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

ReposCompareCommitsResponseDataBaseCommitParentsItem

ReposCompareCommitsResponseDataBaseCommitParentsItem: object

Type declaration

sha: string
url: string

ReposCompareCommitsResponseDataCommitsItem

ReposCompareCommitsResponseDataCommitsItem: object

Type declaration

author: ReposCompareCommitsResponseDataCommitsItemAuthor
comments_url: string
commit: ReposCompareCommitsResponseDataCommitsItemCommit
committer: ReposCompareCommitsResponseDataCommitsItemCommitter
html_url: string
node_id: string
parents: Array<ReposCompareCommitsResponseDataCommitsItemParentsItem>
sha: string
url: string

ReposCompareCommitsResponseDataCommitsItemAuthor

ReposCompareCommitsResponseDataCommitsItemAuthor: object

Type declaration

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

ReposCompareCommitsResponseDataCommitsItemCommit

ReposCompareCommitsResponseDataCommitsItemCommit: object

Type declaration

author: ReposCompareCommitsResponseDataCommitsItemCommitAuthor
comment_count: number
committer: ReposCompareCommitsResponseDataCommitsItemCommitCommitter
message: string
tree: ReposCompareCommitsResponseDataCommitsItemCommitTree
url: string
verification: ReposCompareCommitsResponseDataCommitsItemCommitVerification

ReposCompareCommitsResponseDataCommitsItemCommitAuthor

ReposCompareCommitsResponseDataCommitsItemCommitAuthor: object

Type declaration

date: string
email: string
name: string

ReposCompareCommitsResponseDataCommitsItemCommitCommitter

ReposCompareCommitsResponseDataCommitsItemCommitCommitter: object

Type declaration

date: string
email: string
name: string

ReposCompareCommitsResponseDataCommitsItemCommitTree

ReposCompareCommitsResponseDataCommitsItemCommitTree: object

Type declaration

sha: string
url: string

ReposCompareCommitsResponseDataCommitsItemCommitVerification

ReposCompareCommitsResponseDataCommitsItemCommitVerification: object

Type declaration

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

ReposCompareCommitsResponseDataCommitsItemCommitter

ReposCompareCommitsResponseDataCommitsItemCommitter: object

Type declaration

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

ReposCompareCommitsResponseDataCommitsItemParentsItem

ReposCompareCommitsResponseDataCommitsItemParentsItem: object

Type declaration

sha: string
url: string

ReposCompareCommitsResponseDataFilesItem

ReposCompareCommitsResponseDataFilesItem: object

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

ReposCompareCommitsResponseDataMergeBaseCommit

ReposCompareCommitsResponseDataMergeBaseCommit: object

Type declaration

author: ReposCompareCommitsResponseDataMergeBaseCommitAuthor
comments_url: string
commit: ReposCompareCommitsResponseDataMergeBaseCommitCommit
committer: ReposCompareCommitsResponseDataMergeBaseCommitCommitter
html_url: string
node_id: string
parents: Array<ReposCompareCommitsResponseDataMergeBaseCommitParentsItem>
sha: string
url: string

ReposCompareCommitsResponseDataMergeBaseCommitAuthor

ReposCompareCommitsResponseDataMergeBaseCommitAuthor: object

Type declaration

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

ReposCompareCommitsResponseDataMergeBaseCommitCommit

ReposCompareCommitsResponseDataMergeBaseCommitCommit: object

Type declaration

author: ReposCompareCommitsResponseDataMergeBaseCommitCommitAuthor
comment_count: number
committer: ReposCompareCommitsResponseDataMergeBaseCommitCommitCommitter
message: string
tree: ReposCompareCommitsResponseDataMergeBaseCommitCommitTree
url: string
verification: ReposCompareCommitsResponseDataMergeBaseCommitCommitVerification

ReposCompareCommitsResponseDataMergeBaseCommitCommitAuthor

ReposCompareCommitsResponseDataMergeBaseCommitCommitAuthor: object

Type declaration

date: string
email: string
name: string

ReposCompareCommitsResponseDataMergeBaseCommitCommitCommitter

ReposCompareCommitsResponseDataMergeBaseCommitCommitCommitter: object

Type declaration

date: string
email: string
name: string

ReposCompareCommitsResponseDataMergeBaseCommitCommitTree

ReposCompareCommitsResponseDataMergeBaseCommitCommitTree: object

Type declaration

sha: string
url: string

ReposCompareCommitsResponseDataMergeBaseCommitCommitVerification

ReposCompareCommitsResponseDataMergeBaseCommitCommitVerification: object

Type declaration

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

ReposCompareCommitsResponseDataMergeBaseCommitCommitter

ReposCompareCommitsResponseDataMergeBaseCommitCommitter: object

Type declaration

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

ReposCompareCommitsResponseDataMergeBaseCommitParentsItem

ReposCompareCommitsResponseDataMergeBaseCommitParentsItem: object

Type declaration

sha: string
url: string

ReposCreateCommitCommentEndpoint

ReposCreateCommitCommentEndpoint: object

Type declaration

body: string

The contents of the comment.
commit_sha: string

commit_sha parameter
Optional line?: number

Deprecated. Use position parameter instead. Line number in the file to comment on.
owner: string

owner parameter
Optional path?: string

Relative path of the file to comment on.
Optional position?: number

Line index in the diff to comment on.
repo: string

repo parameter

ReposCreateCommitCommentRequestOptions

ReposCreateCommitCommentRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/commits/:commit_sha/comments"

ReposCreateCommitCommentResponseData

ReposCreateCommitCommentResponseData: object

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: ReposCreateCommitCommentResponseDataUser

ReposCreateCommitCommentResponseDataUser

ReposCreateCommitCommentResponseDataUser: object

Type declaration

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

ReposCreateDeploymentEndpoint

ReposCreateDeploymentEndpoint: object

Type declaration

Optional auto_merge?: boolean

Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.
Optional description?: string

Short description of the deployment.
Optional environment?: string

Name for the target deployment environment (e.g., production, staging, qa).
owner: string

owner parameter
Optional payload?: string

JSON payload with extra information about the deployment.
Optional production_environment?: boolean

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

repo parameter
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?: string

Specifies a task to execute (e.g., deploy or deploy:migrations).
Optional transient_environment?: boolean

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.

ReposCreateDeploymentRequestOptions

ReposCreateDeploymentRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/deployments"

ReposCreateDeploymentResponseData

ReposCreateDeploymentResponseData: object

Type declaration

created_at: string
creator: ReposCreateDeploymentResponseDataCreator
description: string
environment: string
id: number
node_id: string
original_environment: string
payload: ReposCreateDeploymentResponseDataPayload
production_environment: boolean
ref: string
repository_url: string
sha: string
statuses_url: string
task: string
transient_environment: boolean
updated_at: string
url: string

ReposCreateDeploymentResponseDataCreator

ReposCreateDeploymentResponseDataCreator: object

Type declaration

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

ReposCreateDeploymentResponseDataPayload

ReposCreateDeploymentResponseDataPayload: object

Type declaration

deploy: string

ReposCreateDeploymentStatusEndpoint

ReposCreateDeploymentStatusEndpoint: object

Type declaration

Optional auto_inactive?: boolean

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

deployment_id parameter
Optional description?: 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?: 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?: 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

owner parameter
repo: string

repo parameter
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?: 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.

ReposCreateDeploymentStatusRequestOptions

ReposCreateDeploymentStatusRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/deployments/:deployment_id/statuses"

ReposCreateDeploymentStatusResponseData

ReposCreateDeploymentStatusResponseData: object

Type declaration

created_at: string
creator: ReposCreateDeploymentStatusResponseDataCreator
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

ReposCreateDeploymentStatusResponseDataCreator

ReposCreateDeploymentStatusResponseDataCreator: object

Type declaration

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

ReposCreateDispatchEventEndpoint

ReposCreateDispatchEventEndpoint: object

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?: string

Required: A custom webhook event name.
owner: string

owner parameter
repo: string

repo parameter

ReposCreateDispatchEventParamsClientPayload

ReposCreateDispatchEventParamsClientPayload: object

Type declaration

ReposCreateDispatchEventRequestOptions

ReposCreateDispatchEventRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/dispatches"

ReposCreateForAuthenticatedUserEndpoint

ReposCreateForAuthenticatedUserEndpoint: object

Type declaration

Optional allow_merge_commit?: boolean

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?: boolean

Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.
Optional allow_squash_merge?: boolean

Either true to allow squash-merging pull requests, or false to prevent squash-merging.
Optional auto_init?: boolean

Pass true to create an initial commit with empty README.
Optional delete_branch_on_merge?: boolean

Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.
Optional description?: string

A short description of the repository.
Optional gitignore_template?: string

Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, "Haskell".
Optional has_issues?: boolean

Either true to enable issues for this repository or false to disable them.
Optional has_projects?: boolean

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?: boolean

Either true to enable the wiki for this repository or false to disable it.
Optional homepage?: string

A URL with more information about the repository.
Optional is_template?: boolean

Either true to make this repo available as a template repository or false to prevent it.
Optional license_template?: 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?: boolean

Either true to create a private repository or false to create a public one.
Optional team_id?: 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 or GitHub Enterprise Server 2.20+, 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.

ReposCreateForAuthenticatedUserRequestOptions

ReposCreateForAuthenticatedUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/user/repos"

ReposCreateForAuthenticatedUserResponseData

ReposCreateForAuthenticatedUserResponseData: object

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: ReposCreateForAuthenticatedUserResponseDataOwner
permissions: ReposCreateForAuthenticatedUserResponseDataPermissions
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

ReposCreateForAuthenticatedUserResponseDataOwner

ReposCreateForAuthenticatedUserResponseDataOwner: object

Type declaration

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

ReposCreateForAuthenticatedUserResponseDataPermissions

ReposCreateForAuthenticatedUserResponseDataPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

ReposCreateForkEndpoint

ReposCreateForkEndpoint: object

Type declaration

Optional organization?: string

Optional parameter to specify the organization name if forking into an organization.
owner: string

owner parameter
repo: string

repo parameter

ReposCreateForkRequestOptions

ReposCreateForkRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/forks"

ReposCreateForkResponseData

ReposCreateForkResponseData: object

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: ReposCreateForkResponseDataOwner
permissions: ReposCreateForkResponseDataPermissions
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

ReposCreateForkResponseDataOwner

ReposCreateForkResponseDataOwner: object

Type declaration

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

ReposCreateForkResponseDataPermissions

ReposCreateForkResponseDataPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

ReposCreateHookEndpoint

ReposCreateHookEndpoint: object

Type declaration

Optional active?: boolean

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?: string

Use web to create a webhook. Default: web. This parameter only accepts the value web.
owner: string

owner parameter
repo: string

repo parameter

ReposCreateHookParamsConfig

ReposCreateHookParamsConfig: object

Type declaration

Optional content_type?: string
Optional insecure_ssl?: string
Optional secret?: string
url: string

ReposCreateHookRequestOptions

ReposCreateHookRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/hooks"

ReposCreateHookResponseData

ReposCreateHookResponseData: object

Type declaration

active: boolean
config: ReposCreateHookResponseDataConfig
created_at: string
events: Array<string>
id: number
last_response: ReposCreateHookResponseDataLastResponse
name: string
ping_url: string
test_url: string
type: string
updated_at: string
url: string

ReposCreateHookResponseDataConfig

ReposCreateHookResponseDataConfig: object

Type declaration

content_type: string
insecure_ssl: string
url: string

ReposCreateHookResponseDataLastResponse

ReposCreateHookResponseDataLastResponse: object

Type declaration

code: null
message: null
status: string

ReposCreateInOrgEndpoint

ReposCreateInOrgEndpoint: object

Type declaration

Optional allow_merge_commit?: boolean

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?: boolean

Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.
Optional allow_squash_merge?: boolean

Either true to allow squash-merging pull requests, or false to prevent squash-merging.
Optional auto_init?: boolean

Pass true to create an initial commit with empty README.
Optional delete_branch_on_merge?: boolean

Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.
Optional description?: string

A short description of the repository.
Optional gitignore_template?: string

Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, "Haskell".
Optional has_issues?: boolean

Either true to enable issues for this repository or false to disable them.
Optional has_projects?: boolean

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?: boolean

Either true to enable the wiki for this repository or false to disable it.
Optional homepage?: string

A URL with more information about the repository.
Optional is_template?: boolean

Either true to make this repo available as a template repository or false to prevent it.
Optional license_template?: 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

org parameter
Optional private?: boolean

Either true to create a private repository or false to create a public one.
Optional team_id?: 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 or GitHub Enterprise Server 2.20+, 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.

ReposCreateInOrgRequestOptions

ReposCreateInOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/orgs/:org/repos"

ReposCreateInOrgResponseData

ReposCreateInOrgResponseData: object

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: ReposCreateInOrgResponseDataOwner
permissions: ReposCreateInOrgResponseDataPermissions
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

ReposCreateInOrgResponseDataOwner

ReposCreateInOrgResponseDataOwner: object

Type declaration

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

ReposCreateInOrgResponseDataPermissions

ReposCreateInOrgResponseDataPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

ReposCreateOrUpdateFileEndpoint

ReposCreateOrUpdateFileEndpoint: object

Type declaration

Optional author?: ReposCreateOrUpdateFileParamsAuthor

The author of the file. Default: The committer or the authenticated user if you omit committer.
Optional branch?: 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

owner parameter
path: string

path parameter
repo: string

repo parameter
Optional sha?: string

Required if you are updating a file. The blob SHA of the file being replaced.

ReposCreateOrUpdateFileParamsAuthor

ReposCreateOrUpdateFileParamsAuthor: object

Type declaration

email: string
name: string

ReposCreateOrUpdateFileParamsCommitter

ReposCreateOrUpdateFileParamsCommitter: object

Type declaration

email: string
name: string

ReposCreateOrUpdateFileRequestOptions

ReposCreateOrUpdateFileRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PUT"
request: RequestRequestOptions
url: "/repos/:owner/:repo/contents/:path"

ReposCreateOrUpdateFileResponseData

ReposCreateOrUpdateFileResponseData: object

Type declaration

commit: ReposCreateOrUpdateFileResponseDataCommit
content: ReposCreateOrUpdateFileResponseDataContent

ReposCreateOrUpdateFileResponseDataCommit

ReposCreateOrUpdateFileResponseDataCommit: object

Type declaration

author: ReposCreateOrUpdateFileResponseDataCommitAuthor
committer: ReposCreateOrUpdateFileResponseDataCommitCommitter
html_url: string
message: string
node_id: string
parents: Array<ReposCreateOrUpdateFileResponseDataCommitParentsItem>
sha: string
tree: ReposCreateOrUpdateFileResponseDataCommitTree
url: string
verification: ReposCreateOrUpdateFileResponseDataCommitVerification

ReposCreateOrUpdateFileResponseDataCommitAuthor

ReposCreateOrUpdateFileResponseDataCommitAuthor: object

Type declaration

date: string
email: string
name: string

ReposCreateOrUpdateFileResponseDataCommitCommitter

ReposCreateOrUpdateFileResponseDataCommitCommitter: object

Type declaration

date: string
email: string
name: string

ReposCreateOrUpdateFileResponseDataCommitParentsItem

ReposCreateOrUpdateFileResponseDataCommitParentsItem: object

Type declaration

html_url: string
sha: string
url: string

ReposCreateOrUpdateFileResponseDataCommitTree

ReposCreateOrUpdateFileResponseDataCommitTree: object

Type declaration

sha: string
url: string

ReposCreateOrUpdateFileResponseDataCommitVerification

ReposCreateOrUpdateFileResponseDataCommitVerification: object

Type declaration

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

ReposCreateOrUpdateFileResponseDataContent

ReposCreateOrUpdateFileResponseDataContent: object

Type declaration

_links: ReposCreateOrUpdateFileResponseDataContentLinks
download_url: string
git_url: string
html_url: string
name: string
path: string
sha: string
size: number
type: string
url: string

ReposCreateOrUpdateFileResponseDataContentLinks

ReposCreateOrUpdateFileResponseDataContentLinks: object

Type declaration

git: string
html: string
self: string

ReposCreateReleaseEndpoint

ReposCreateReleaseEndpoint: object

Type declaration

Optional body?: string

Text describing the contents of the tag.
Optional draft?: boolean

true to create a draft (unpublished) release, false to create a published one.
Optional name?: string

The name of the release.
owner: string

owner parameter
Optional prerelease?: boolean

true to identify the release as a prerelease. false to identify the release as a full release.
repo: string

repo parameter
tag_name: string

The name of the tag.
Optional target_commitish?: 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).

ReposCreateReleaseRequestOptions

ReposCreateReleaseRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/releases"

ReposCreateReleaseResponseData

ReposCreateReleaseResponseData: object

Type declaration

assets: Array<any>
assets_url: string
author: ReposCreateReleaseResponseDataAuthor
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

ReposCreateReleaseResponseDataAuthor

ReposCreateReleaseResponseDataAuthor: object

Type declaration

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

ReposCreateStatusEndpoint

ReposCreateStatusEndpoint: object

Type declaration

Optional context?: string

A string label to differentiate this status from the status of other systems.
Optional description?: string

A short description of the status.
owner: string

owner parameter
repo: string

repo parameter
sha: string

sha parameter
state: "error" | "failure" | "pending" | "success"

The state of the status. Can be one of error, failure, pending, or success.
Optional target_url?: 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

ReposCreateStatusRequestOptions

ReposCreateStatusRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/statuses/:sha"

ReposCreateStatusResponseData

ReposCreateStatusResponseData: object

Type declaration

avatar_url: string
context: string
created_at: string
creator: ReposCreateStatusResponseDataCreator
description: string
id: number
node_id: string
state: string
target_url: string
updated_at: string
url: string

ReposCreateStatusResponseDataCreator

ReposCreateStatusResponseDataCreator: object

Type declaration

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

ReposCreateUsingTemplateEndpoint

ReposCreateUsingTemplateEndpoint: object & RequiredPreview<"baptiste">

ReposCreateUsingTemplateRequestOptions

ReposCreateUsingTemplateRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:template_owner/:template_repo/generate"

ReposCreateUsingTemplateResponseData

ReposCreateUsingTemplateResponseData: object

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: ReposCreateUsingTemplateResponseDataOwner
permissions: ReposCreateUsingTemplateResponseDataPermissions
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: ReposCreateUsingTemplateResponseDataTemplateRepository
topics: Array<string>
trees_url: string
updated_at: string
url: string
visibility: string
watchers_count: number

ReposCreateUsingTemplateResponseDataOwner

ReposCreateUsingTemplateResponseDataOwner: object

Type declaration

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

ReposCreateUsingTemplateResponseDataPermissions

ReposCreateUsingTemplateResponseDataPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

ReposCreateUsingTemplateResponseDataTemplateRepository

ReposCreateUsingTemplateResponseDataTemplateRepository: object

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: ReposCreateUsingTemplateResponseDataTemplateRepositoryOwner
permissions: ReposCreateUsingTemplateResponseDataTemplateRepositoryPermissions
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

ReposCreateUsingTemplateResponseDataTemplateRepositoryOwner

ReposCreateUsingTemplateResponseDataTemplateRepositoryOwner: object

Type declaration

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

ReposCreateUsingTemplateResponseDataTemplateRepositoryPermissions

ReposCreateUsingTemplateResponseDataTemplateRepositoryPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

ReposDeclineInvitationEndpoint

ReposDeclineInvitationEndpoint: object

Type declaration

invitation_id: number

invitation_id parameter

ReposDeclineInvitationRequestOptions

ReposDeclineInvitationRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/user/repository_invitations/:invitation_id"

ReposDeleteCommitCommentEndpoint

ReposDeleteCommitCommentEndpoint: object

Type declaration

comment_id: number

comment_id parameter
owner: string

owner parameter
repo: string

repo parameter

ReposDeleteCommitCommentRequestOptions

ReposDeleteCommitCommentRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/repos/:owner/:repo/comments/:comment_id"

ReposDeleteDeploymentEndpoint

ReposDeleteDeploymentEndpoint: object

Type declaration

deployment_id: number

deployment_id parameter
owner: string

owner parameter
repo: string

repo parameter

ReposDeleteDeploymentRequestOptions

ReposDeleteDeploymentRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/repos/:owner/:repo/deployments/:deployment_id"

ReposDeleteDownloadEndpoint

ReposDeleteDownloadEndpoint: object

Type declaration

download_id: number

download_id parameter
owner: string

owner parameter
repo: string

repo parameter

ReposDeleteDownloadRequestOptions

ReposDeleteDownloadRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/repos/:owner/:repo/downloads/:download_id"

ReposDeleteEndpoint

ReposDeleteEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter

ReposDeleteFileEndpoint

ReposDeleteFileEndpoint: object

Type declaration

Optional author?: ReposDeleteFileParamsAuthor

object containing information about the author.
Optional branch?: 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

owner parameter
path: string

path parameter
repo: string

repo parameter
sha: string

The blob SHA of the file being replaced.

ReposDeleteFileParamsAuthor

ReposDeleteFileParamsAuthor: object

Type declaration

Optional email?: string
Optional name?: string

ReposDeleteFileParamsCommitter

ReposDeleteFileParamsCommitter: object

Type declaration

Optional email?: string
Optional name?: string

ReposDeleteFileRequestOptions

ReposDeleteFileRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/repos/:owner/:repo/contents/:path"

ReposDeleteFileResponseData

ReposDeleteFileResponseData: object

Type declaration

commit: ReposDeleteFileResponseDataCommit
content: null

ReposDeleteFileResponseDataCommit

ReposDeleteFileResponseDataCommit: object

Type declaration

author: ReposDeleteFileResponseDataCommitAuthor
committer: ReposDeleteFileResponseDataCommitCommitter
html_url: string
message: string
node_id: string
parents: Array<ReposDeleteFileResponseDataCommitParentsItem>
sha: string
tree: ReposDeleteFileResponseDataCommitTree
url: string
verification: ReposDeleteFileResponseDataCommitVerification

ReposDeleteFileResponseDataCommitAuthor

ReposDeleteFileResponseDataCommitAuthor: object

Type declaration

date: string
email: string
name: string

ReposDeleteFileResponseDataCommitCommitter

ReposDeleteFileResponseDataCommitCommitter: object

Type declaration

date: string
email: string
name: string

ReposDeleteFileResponseDataCommitParentsItem

ReposDeleteFileResponseDataCommitParentsItem: object

Type declaration

html_url: string
sha: string
url: string

ReposDeleteFileResponseDataCommitTree

ReposDeleteFileResponseDataCommitTree: object

Type declaration

sha: string
url: string

ReposDeleteFileResponseDataCommitVerification

ReposDeleteFileResponseDataCommitVerification: object

Type declaration

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

ReposDeleteHookEndpoint

ReposDeleteHookEndpoint: object

Type declaration

hook_id: number

hook_id parameter
owner: string

owner parameter
repo: string

repo parameter

ReposDeleteHookRequestOptions

ReposDeleteHookRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/repos/:owner/:repo/hooks/:hook_id"

ReposDeleteInvitationEndpoint

ReposDeleteInvitationEndpoint: object

Type declaration

invitation_id: number

invitation_id parameter
owner: string

owner parameter
repo: string

repo parameter

ReposDeleteInvitationRequestOptions

ReposDeleteInvitationRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/repos/:owner/:repo/invitations/:invitation_id"

ReposDeleteReleaseAssetEndpoint

ReposDeleteReleaseAssetEndpoint: object

Type declaration

asset_id: number

asset_id parameter
owner: string

owner parameter
repo: string

repo parameter

ReposDeleteReleaseAssetRequestOptions

ReposDeleteReleaseAssetRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/repos/:owner/:repo/releases/assets/:asset_id"

ReposDeleteReleaseEndpoint

ReposDeleteReleaseEndpoint: object

Type declaration

owner: string

owner parameter
release_id: number

release_id parameter
repo: string

repo parameter

ReposDeleteReleaseRequestOptions

ReposDeleteReleaseRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/repos/:owner/:repo/releases/:release_id"

ReposDeleteRequestOptions

ReposDeleteRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/repos/:owner/:repo"

ReposDeleteResponseData

ReposDeleteResponseData: object

Type declaration

documentation_url: string
message: string

ReposDisableAutomatedSecurityFixesEndpoint

ReposDisableAutomatedSecurityFixesEndpoint: object & RequiredPreview<"london">

ReposDisableAutomatedSecurityFixesRequestOptions

ReposDisableAutomatedSecurityFixesRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/repos/:owner/:repo/automated-security-fixes"

ReposDisablePagesSiteEndpoint

ReposDisablePagesSiteEndpoint: object & RequiredPreview<"switcheroo">

ReposDisablePagesSiteRequestOptions

ReposDisablePagesSiteRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/repos/:owner/:repo/pages"

ReposDisableVulnerabilityAlertsEndpoint

ReposDisableVulnerabilityAlertsEndpoint: object & RequiredPreview<"dorian">

ReposDisableVulnerabilityAlertsRequestOptions

ReposDisableVulnerabilityAlertsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/repos/:owner/:repo/vulnerability-alerts"

ReposEnableAutomatedSecurityFixesEndpoint

ReposEnableAutomatedSecurityFixesEndpoint: object & RequiredPreview<"london">

ReposEnableAutomatedSecurityFixesRequestOptions

ReposEnableAutomatedSecurityFixesRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PUT"
request: RequestRequestOptions
url: "/repos/:owner/:repo/automated-security-fixes"

ReposEnablePagesSiteEndpoint

ReposEnablePagesSiteEndpoint: object & RequiredPreview<"switcheroo">

ReposEnablePagesSiteParamsSource

ReposEnablePagesSiteParamsSource: object

Type declaration

Optional branch?: "master" | "gh-pages"
Optional path?: string

ReposEnablePagesSiteRequestOptions

ReposEnablePagesSiteRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/pages"

ReposEnablePagesSiteResponseData

ReposEnablePagesSiteResponseData: object

Type declaration

cname: string
custom_404: boolean
html_url: string
source: ReposEnablePagesSiteResponseDataSource
status: string
url: string

ReposEnablePagesSiteResponseDataSource

ReposEnablePagesSiteResponseDataSource: object

Type declaration

branch: string
directory: string

ReposEnableVulnerabilityAlertsEndpoint

ReposEnableVulnerabilityAlertsEndpoint: object & RequiredPreview<"dorian">

ReposEnableVulnerabilityAlertsRequestOptions

ReposEnableVulnerabilityAlertsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PUT"
request: RequestRequestOptions
url: "/repos/:owner/:repo/vulnerability-alerts"

ReposGetAllTopicsEndpoint

ReposGetAllTopicsEndpoint: object & RequiredPreview<"mercy">

ReposGetAllTopicsRequestOptions

ReposGetAllTopicsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/topics"

ReposGetAllTopicsResponseData

ReposGetAllTopicsResponseData: object

Type declaration

names: Array<string>

ReposGetAppsWithAccessToProtectedBranchEndpoint

ReposGetAppsWithAccessToProtectedBranchEndpoint: object

Type declaration

branch: string

branch parameter
owner: string

owner parameter
repo: string

repo parameter

ReposGetAppsWithAccessToProtectedBranchRequestOptions

ReposGetAppsWithAccessToProtectedBranchRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps"

ReposGetAppsWithAccessToProtectedBranchResponseData

ReposGetAppsWithAccessToProtectedBranchResponseData: Array<ReposGetAppsWithAccessToProtectedBranchResponseDataItem>

ReposGetAppsWithAccessToProtectedBranchResponseDataItem

ReposGetAppsWithAccessToProtectedBranchResponseDataItem: object

Type declaration

created_at: string
description: string
events: Array<string>
external_url: string
html_url: string
id: number
name: string
node_id: string
owner: ReposGetAppsWithAccessToProtectedBranchResponseDataItemOwner
permissions: ReposGetAppsWithAccessToProtectedBranchResponseDataItemPermissions
slug: string
updated_at: string

ReposGetAppsWithAccessToProtectedBranchResponseDataItemOwner

ReposGetAppsWithAccessToProtectedBranchResponseDataItemOwner: object

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

ReposGetAppsWithAccessToProtectedBranchResponseDataItemPermissions

ReposGetAppsWithAccessToProtectedBranchResponseDataItemPermissions: object

Type declaration

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

ReposGetArchiveLinkEndpoint

ReposGetArchiveLinkEndpoint: object

Type declaration

archive_format: string

archive_format parameter
owner: string

owner parameter
ref: string

ref parameter
repo: string

repo parameter

ReposGetArchiveLinkRequestOptions

ReposGetArchiveLinkRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/:archive_format/:ref"

ReposGetBranchEndpoint

ReposGetBranchEndpoint: object

Type declaration

branch: string

branch parameter
owner: string

owner parameter
repo: string

repo parameter

ReposGetBranchProtectionEndpoint

ReposGetBranchProtectionEndpoint: object

Type declaration

branch: string

branch parameter
owner: string

owner parameter
repo: string

repo parameter

ReposGetBranchProtectionRequestOptions

ReposGetBranchProtectionRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/branches/:branch/protection"

ReposGetBranchProtectionResponseData

ReposGetBranchProtectionResponseData: object

Type declaration

allow_deletions: ReposGetBranchProtectionResponseDataAllowDeletions
allow_force_pushes: ReposGetBranchProtectionResponseDataAllowForcePushes
enforce_admins: ReposGetBranchProtectionResponseDataEnforceAdmins
required_linear_history: ReposGetBranchProtectionResponseDataRequiredLinearHistory
required_pull_request_reviews: ReposGetBranchProtectionResponseDataRequiredPullRequestReviews
required_status_checks: ReposGetBranchProtectionResponseDataRequiredStatusChecks
restrictions: ReposGetBranchProtectionResponseDataRestrictions
url: string

ReposGetBranchProtectionResponseDataAllowDeletions

ReposGetBranchProtectionResponseDataAllowDeletions: object

Type declaration

enabled: boolean

ReposGetBranchProtectionResponseDataAllowForcePushes

ReposGetBranchProtectionResponseDataAllowForcePushes: object

Type declaration

enabled: boolean

ReposGetBranchProtectionResponseDataEnforceAdmins

ReposGetBranchProtectionResponseDataEnforceAdmins: object

Type declaration

enabled: boolean
url: string

ReposGetBranchProtectionResponseDataRequiredLinearHistory

ReposGetBranchProtectionResponseDataRequiredLinearHistory: object

Type declaration

enabled: boolean

ReposGetBranchProtectionResponseDataRequiredPullRequestReviews

ReposGetBranchProtectionResponseDataRequiredPullRequestReviews: object

Type declaration

dismiss_stale_reviews: boolean
dismissal_restrictions: ReposGetBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictions
require_code_owner_reviews: boolean
required_approving_review_count: number
url: string

ReposGetBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictions

ReposGetBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictions: object

Type declaration

teams: Array<ReposGetBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictionsTeamsItem>
teams_url: string
url: string
users: Array<ReposGetBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictionsUsersItem>
users_url: string

ReposGetBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictionsTeamsItem

ReposGetBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictionsTeamsItem: object

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

ReposGetBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictionsUsersItem

ReposGetBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictionsUsersItem: object

Type declaration

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

ReposGetBranchProtectionResponseDataRequiredStatusChecks

ReposGetBranchProtectionResponseDataRequiredStatusChecks: object

Type declaration

contexts: Array<string>
contexts_url: string
strict: boolean
url: string

ReposGetBranchProtectionResponseDataRestrictions

ReposGetBranchProtectionResponseDataRestrictions: object

Type declaration

apps: Array<ReposGetBranchProtectionResponseDataRestrictionsAppsItem>
apps_url: string
teams: Array<ReposGetBranchProtectionResponseDataRestrictionsTeamsItem>
teams_url: string
url: string
users: Array<ReposGetBranchProtectionResponseDataRestrictionsUsersItem>
users_url: string

ReposGetBranchProtectionResponseDataRestrictionsAppsItem

ReposGetBranchProtectionResponseDataRestrictionsAppsItem: object

Type declaration

created_at: string
description: string
events: Array<string>
external_url: string
html_url: string
id: number
name: string
node_id: string
owner: ReposGetBranchProtectionResponseDataRestrictionsAppsItemOwner
permissions: ReposGetBranchProtectionResponseDataRestrictionsAppsItemPermissions
slug: string
updated_at: string

ReposGetBranchProtectionResponseDataRestrictionsAppsItemOwner

ReposGetBranchProtectionResponseDataRestrictionsAppsItemOwner: object

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

ReposGetBranchProtectionResponseDataRestrictionsAppsItemPermissions

ReposGetBranchProtectionResponseDataRestrictionsAppsItemPermissions: object

Type declaration

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

ReposGetBranchProtectionResponseDataRestrictionsTeamsItem

ReposGetBranchProtectionResponseDataRestrictionsTeamsItem: object

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

ReposGetBranchProtectionResponseDataRestrictionsUsersItem

ReposGetBranchProtectionResponseDataRestrictionsUsersItem: object

Type declaration

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

ReposGetBranchRequestOptions

ReposGetBranchRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/branches/:branch"

ReposGetBranchResponseData

ReposGetBranchResponseData: object

Type declaration

_links: ReposGetBranchResponseDataLinks
commit: ReposGetBranchResponseDataCommit
name: string
protected: boolean
protection: ReposGetBranchResponseDataProtection
protection_url: string

ReposGetBranchResponseDataCommit

ReposGetBranchResponseDataCommit: object

Type declaration

author: ReposGetBranchResponseDataCommitAuthor
commit: ReposGetBranchResponseDataCommitCommit
committer: ReposGetBranchResponseDataCommitCommitter
node_id: string
parents: Array<ReposGetBranchResponseDataCommitParentsItem>
sha: string
url: string

ReposGetBranchResponseDataCommitAuthor

ReposGetBranchResponseDataCommitAuthor: object

Type declaration

avatar_url: string
gravatar_id: string
id: number
login: string
url: string

ReposGetBranchResponseDataCommitCommit

ReposGetBranchResponseDataCommitCommit: object

Type declaration

author: ReposGetBranchResponseDataCommitCommitAuthor
committer: ReposGetBranchResponseDataCommitCommitCommitter
message: string
tree: ReposGetBranchResponseDataCommitCommitTree
url: string
verification: ReposGetBranchResponseDataCommitCommitVerification

ReposGetBranchResponseDataCommitCommitAuthor

ReposGetBranchResponseDataCommitCommitAuthor: object

Type declaration

date: string
email: string
name: string

ReposGetBranchResponseDataCommitCommitCommitter

ReposGetBranchResponseDataCommitCommitCommitter: object

Type declaration

date: string
email: string
name: string

ReposGetBranchResponseDataCommitCommitTree

ReposGetBranchResponseDataCommitCommitTree: object

Type declaration

sha: string
url: string

ReposGetBranchResponseDataCommitCommitVerification

ReposGetBranchResponseDataCommitCommitVerification: object

Type declaration

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

ReposGetBranchResponseDataCommitCommitter

ReposGetBranchResponseDataCommitCommitter: object

Type declaration

avatar_url: string
gravatar_id: string
id: number
login: string
url: string

ReposGetBranchResponseDataCommitParentsItem

ReposGetBranchResponseDataCommitParentsItem: object

Type declaration

sha: string
url: string

ReposGetBranchResponseDataLinks

ReposGetBranchResponseDataLinks: object

Type declaration

html: string
self: string

ReposGetBranchResponseDataProtection

ReposGetBranchResponseDataProtection: object

Type declaration

enabled: boolean
required_status_checks: ReposGetBranchResponseDataProtectionRequiredStatusChecks

ReposGetBranchResponseDataProtectionRequiredStatusChecks

ReposGetBranchResponseDataProtectionRequiredStatusChecks: object

Type declaration

contexts: Array<string>
enforcement_level: string

ReposGetClonesEndpoint

ReposGetClonesEndpoint: object

Type declaration

owner: string

owner parameter
Optional per?: "day" | "week"

Must be one of: day, week.
repo: string

repo parameter

ReposGetClonesRequestOptions

ReposGetClonesRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/traffic/clones"

ReposGetClonesResponseData

ReposGetClonesResponseData: object

Type declaration

clones: Array<ReposGetClonesResponseDataClonesItem>
count: number
uniques: number

ReposGetClonesResponseDataClonesItem

ReposGetClonesResponseDataClonesItem: object

Type declaration

count: number
timestamp: string
uniques: number

ReposGetCodeFrequencyStatsEndpoint

ReposGetCodeFrequencyStatsEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter

ReposGetCodeFrequencyStatsRequestOptions

ReposGetCodeFrequencyStatsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/stats/code_frequency"

ReposGetCodeFrequencyStatsResponseData

ReposGetCodeFrequencyStatsResponseData: Array<Array<number>>

ReposGetCollaboratorPermissionLevelEndpoint

ReposGetCollaboratorPermissionLevelEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter
username: string

username parameter

ReposGetCollaboratorPermissionLevelRequestOptions

ReposGetCollaboratorPermissionLevelRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/collaborators/:username/permission"

ReposGetCollaboratorPermissionLevelResponseData

ReposGetCollaboratorPermissionLevelResponseData: object

Type declaration

permission: string
user: ReposGetCollaboratorPermissionLevelResponseDataUser

ReposGetCollaboratorPermissionLevelResponseDataUser

ReposGetCollaboratorPermissionLevelResponseDataUser: object

Type declaration

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

ReposGetCombinedStatusForRefEndpoint

ReposGetCombinedStatusForRefEndpoint: object

Type declaration

owner: string

owner parameter
ref: string

ref parameter
repo: string

repo parameter

ReposGetCombinedStatusForRefRequestOptions

ReposGetCombinedStatusForRefRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/commits/:ref/status"

ReposGetCombinedStatusForRefResponseData

ReposGetCombinedStatusForRefResponseData: object

Type declaration

commit_url: string
repository: ReposGetCombinedStatusForRefResponseDataRepository
sha: string
state: string
statuses: Array<ReposGetCombinedStatusForRefResponseDataStatusesItem>
total_count: number
url: string

ReposGetCombinedStatusForRefResponseDataRepository

ReposGetCombinedStatusForRefResponseDataRepository: object

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: ReposGetCombinedStatusForRefResponseDataRepositoryOwner
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

ReposGetCombinedStatusForRefResponseDataRepositoryOwner

ReposGetCombinedStatusForRefResponseDataRepositoryOwner: object

Type declaration

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

ReposGetCombinedStatusForRefResponseDataStatusesItem

ReposGetCombinedStatusForRefResponseDataStatusesItem: object

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

ReposGetCommitActivityStatsEndpoint

ReposGetCommitActivityStatsEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter

ReposGetCommitActivityStatsRequestOptions

ReposGetCommitActivityStatsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/stats/commit_activity"

ReposGetCommitActivityStatsResponseData

ReposGetCommitActivityStatsResponseData: Array<ReposGetCommitActivityStatsResponseDataItem>

ReposGetCommitActivityStatsResponseDataItem

ReposGetCommitActivityStatsResponseDataItem: object

Type declaration

days: Array<number>
total: number
week: number

ReposGetCommitCommentEndpoint

ReposGetCommitCommentEndpoint: object

Type declaration

comment_id: number

comment_id parameter
owner: string

owner parameter
repo: string

repo parameter

ReposGetCommitCommentRequestOptions

ReposGetCommitCommentRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/comments/:comment_id"

ReposGetCommitCommentResponseData

ReposGetCommitCommentResponseData: object

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: ReposGetCommitCommentResponseDataUser

ReposGetCommitCommentResponseDataUser

ReposGetCommitCommentResponseDataUser: object

Type declaration

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

ReposGetCommitEndpoint

ReposGetCommitEndpoint: object

Type declaration

owner: string

owner parameter
ref: string

ref parameter
repo: string

repo parameter

ReposGetCommitRequestOptions

ReposGetCommitRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/commits/:ref"

ReposGetCommitResponseData

ReposGetCommitResponseData: object

Type declaration

author: ReposGetCommitResponseDataAuthor
comments_url: string
commit: ReposGetCommitResponseDataCommit
committer: ReposGetCommitResponseDataCommitter
files: Array<ReposGetCommitResponseDataFilesItem>
html_url: string
node_id: string
parents: Array<ReposGetCommitResponseDataParentsItem>
sha: string
stats: ReposGetCommitResponseDataStats
url: string

ReposGetCommitResponseDataAuthor

ReposGetCommitResponseDataAuthor: object

Type declaration

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

ReposGetCommitResponseDataCommit

ReposGetCommitResponseDataCommit: object

Type declaration

author: ReposGetCommitResponseDataCommitAuthor
comment_count: number
committer: ReposGetCommitResponseDataCommitCommitter
message: string
tree: ReposGetCommitResponseDataCommitTree
url: string
verification: ReposGetCommitResponseDataCommitVerification

ReposGetCommitResponseDataCommitAuthor

ReposGetCommitResponseDataCommitAuthor: object

Type declaration

date: string
email: string
name: string

ReposGetCommitResponseDataCommitCommitter

ReposGetCommitResponseDataCommitCommitter: object

Type declaration

date: string
email: string
name: string

ReposGetCommitResponseDataCommitTree

ReposGetCommitResponseDataCommitTree: object

Type declaration

sha: string
url: string

ReposGetCommitResponseDataCommitVerification

ReposGetCommitResponseDataCommitVerification: object

Type declaration

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

ReposGetCommitResponseDataCommitter

ReposGetCommitResponseDataCommitter: object

Type declaration

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

ReposGetCommitResponseDataFilesItem

ReposGetCommitResponseDataFilesItem: object

Type declaration

additions: number
blob_url: string
changes: number
deletions: number
filename: string
patch: string
raw_url: string
status: string

ReposGetCommitResponseDataParentsItem

ReposGetCommitResponseDataParentsItem: object

Type declaration

sha: string
url: string

ReposGetCommitResponseDataStats

ReposGetCommitResponseDataStats: object

Type declaration

additions: number
deletions: number
total: number

ReposGetContentsEndpoint

ReposGetContentsEndpoint: object

Type declaration

owner: string

owner parameter
path: string

path parameter
Optional ref?: string

The name of the commit/branch/tag. Default: the repository’s default branch (usually master)
repo: string

repo parameter

ReposGetContentsRequestOptions

ReposGetContentsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/contents/:path"

ReposGetContentsResponseData

ReposGetContentsResponseData: object | Array<ReposGetContentsResponseDataItem>

ReposGetContentsResponseDataItem

ReposGetContentsResponseDataItem: object

Type declaration

_links: ReposGetContentsResponseDataItemLinks
download_url: string | null
git_url: string
html_url: string
name: string
path: string
sha: string
size: number
type: string
url: string

ReposGetContentsResponseDataItemLinks

ReposGetContentsResponseDataItemLinks: object

Type declaration

git: string
html: string
self: string

ReposGetContentsResponseDataLinks

ReposGetContentsResponseDataLinks: object

Type declaration

git: string
html: string
self: string

ReposGetContributorsStatsEndpoint

ReposGetContributorsStatsEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter

ReposGetContributorsStatsRequestOptions

ReposGetContributorsStatsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/stats/contributors"

ReposGetContributorsStatsResponseData

ReposGetContributorsStatsResponseData: Array<ReposGetContributorsStatsResponseDataItem>

ReposGetContributorsStatsResponseDataItem

ReposGetContributorsStatsResponseDataItem: object

Type declaration

author: ReposGetContributorsStatsResponseDataItemAuthor
total: number
weeks: Array<ReposGetContributorsStatsResponseDataItemWeeksItem>

ReposGetContributorsStatsResponseDataItemAuthor

ReposGetContributorsStatsResponseDataItemAuthor: object

Type declaration

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

ReposGetContributorsStatsResponseDataItemWeeksItem

ReposGetContributorsStatsResponseDataItemWeeksItem: object

Type declaration

a: number
c: number
d: number
w: string

ReposGetDeployKeyEndpoint

ReposGetDeployKeyEndpoint: object

Type declaration

key_id: number

key_id parameter
owner: string

owner parameter
repo: string

repo parameter

ReposGetDeployKeyRequestOptions

ReposGetDeployKeyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/keys/:key_id"

ReposGetDeployKeyResponseData

ReposGetDeployKeyResponseData: object

Type declaration

created_at: string
id: number
key: string
read_only: boolean
title: string
url: string
verified: boolean

ReposGetDeploymentEndpoint

ReposGetDeploymentEndpoint: object

Type declaration

deployment_id: number

deployment_id parameter
owner: string

owner parameter
repo: string

repo parameter

ReposGetDeploymentRequestOptions

ReposGetDeploymentRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/deployments/:deployment_id"

ReposGetDeploymentResponseData

ReposGetDeploymentResponseData: object

Type declaration

created_at: string
creator: ReposGetDeploymentResponseDataCreator
description: string
environment: string
id: number
node_id: string
original_environment: string
payload: ReposGetDeploymentResponseDataPayload
production_environment: boolean
ref: string
repository_url: string
sha: string
statuses_url: string
task: string
transient_environment: boolean
updated_at: string
url: string

ReposGetDeploymentResponseDataCreator

ReposGetDeploymentResponseDataCreator: object

Type declaration

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

ReposGetDeploymentResponseDataPayload

ReposGetDeploymentResponseDataPayload: object

Type declaration

deploy: string

ReposGetDeploymentStatusEndpoint

ReposGetDeploymentStatusEndpoint: object

Type declaration

deployment_id: number

deployment_id parameter
owner: string

owner parameter
repo: string

repo parameter
status_id: number

status_id parameter

ReposGetDeploymentStatusRequestOptions

ReposGetDeploymentStatusRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/deployments/:deployment_id/statuses/:status_id"

ReposGetDeploymentStatusResponseData

ReposGetDeploymentStatusResponseData: object

Type declaration

created_at: string
creator: ReposGetDeploymentStatusResponseDataCreator
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

ReposGetDeploymentStatusResponseDataCreator

ReposGetDeploymentStatusResponseDataCreator: object

Type declaration

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

ReposGetDownloadEndpoint

ReposGetDownloadEndpoint: object

Type declaration

download_id: number

download_id parameter
owner: string

owner parameter
repo: string

repo parameter

ReposGetDownloadRequestOptions

ReposGetDownloadRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/downloads/:download_id"

ReposGetDownloadResponseData

ReposGetDownloadResponseData: object

Type declaration

content_type: string
description: string
download_count: number
html_url: string
id: number
name: string
size: number
url: string

ReposGetEndpoint

ReposGetEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter

ReposGetHookEndpoint

ReposGetHookEndpoint: object

Type declaration

hook_id: number

hook_id parameter
owner: string

owner parameter
repo: string

repo parameter

ReposGetHookRequestOptions

ReposGetHookRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/hooks/:hook_id"

ReposGetHookResponseData

ReposGetHookResponseData: object

Type declaration

active: boolean
config: ReposGetHookResponseDataConfig
created_at: string
events: Array<string>
id: number
last_response: ReposGetHookResponseDataLastResponse
name: string
ping_url: string
test_url: string
type: string
updated_at: string
url: string

ReposGetHookResponseDataConfig

ReposGetHookResponseDataConfig: object

Type declaration

content_type: string
insecure_ssl: string
url: string

ReposGetHookResponseDataLastResponse

ReposGetHookResponseDataLastResponse: object

Type declaration

code: null
message: null
status: string

ReposGetLatestPagesBuildEndpoint

ReposGetLatestPagesBuildEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter

ReposGetLatestPagesBuildRequestOptions

ReposGetLatestPagesBuildRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/pages/builds/latest"

ReposGetLatestPagesBuildResponseData

ReposGetLatestPagesBuildResponseData: object

Type declaration

commit: string
created_at: string
duration: number
error: ReposGetLatestPagesBuildResponseDataError
pusher: ReposGetLatestPagesBuildResponseDataPusher
status: string
updated_at: string
url: string

ReposGetLatestPagesBuildResponseDataError

ReposGetLatestPagesBuildResponseDataError: object

Type declaration

message: null

ReposGetLatestPagesBuildResponseDataPusher

ReposGetLatestPagesBuildResponseDataPusher: object

Type declaration

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

ReposGetLatestReleaseEndpoint

ReposGetLatestReleaseEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter

ReposGetLatestReleaseRequestOptions

ReposGetLatestReleaseRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/releases/latest"

ReposGetLatestReleaseResponseData

ReposGetLatestReleaseResponseData: object

Type declaration

assets: Array<ReposGetLatestReleaseResponseDataAssetsItem>
assets_url: string
author: ReposGetLatestReleaseResponseDataAuthor
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

ReposGetLatestReleaseResponseDataAssetsItem

ReposGetLatestReleaseResponseDataAssetsItem: object

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: ReposGetLatestReleaseResponseDataAssetsItemUploader
url: string

ReposGetLatestReleaseResponseDataAssetsItemUploader

ReposGetLatestReleaseResponseDataAssetsItemUploader: object

Type declaration

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

ReposGetLatestReleaseResponseDataAuthor

ReposGetLatestReleaseResponseDataAuthor: object

Type declaration

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

ReposGetPagesBuildEndpoint

ReposGetPagesBuildEndpoint: object

Type declaration

build_id: number

build_id parameter
owner: string

owner parameter
repo: string

repo parameter

ReposGetPagesBuildRequestOptions

ReposGetPagesBuildRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/pages/builds/:build_id"

ReposGetPagesBuildResponseData

ReposGetPagesBuildResponseData: object

Type declaration

commit: string
created_at: string
duration: number
error: ReposGetPagesBuildResponseDataError
pusher: ReposGetPagesBuildResponseDataPusher
status: string
updated_at: string
url: string

ReposGetPagesBuildResponseDataError

ReposGetPagesBuildResponseDataError: object

Type declaration

message: null

ReposGetPagesBuildResponseDataPusher

ReposGetPagesBuildResponseDataPusher: object

Type declaration

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

ReposGetPagesEndpoint

ReposGetPagesEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter

ReposGetPagesRequestOptions

ReposGetPagesRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/pages"

ReposGetPagesResponseData

ReposGetPagesResponseData: object

Type declaration

cname: string
custom_404: boolean
html_url: string
source: ReposGetPagesResponseDataSource
status: string
url: string

ReposGetPagesResponseDataSource

ReposGetPagesResponseDataSource: object

Type declaration

branch: string
directory: string

ReposGetParticipationStatsEndpoint

ReposGetParticipationStatsEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter

ReposGetParticipationStatsRequestOptions

ReposGetParticipationStatsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/stats/participation"

ReposGetParticipationStatsResponseData

ReposGetParticipationStatsResponseData: object

Type declaration

all: Array<number>
owner: Array<number>

ReposGetProtectedBranchAdminEnforcementEndpoint

ReposGetProtectedBranchAdminEnforcementEndpoint: object

Type declaration

branch: string

branch parameter
owner: string

owner parameter
repo: string

repo parameter

ReposGetProtectedBranchAdminEnforcementRequestOptions

ReposGetProtectedBranchAdminEnforcementRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/branches/:branch/protection/enforce_admins"

ReposGetProtectedBranchAdminEnforcementResponseData

ReposGetProtectedBranchAdminEnforcementResponseData: object

Type declaration

enabled: boolean
url: string

ReposGetProtectedBranchPullRequestReviewEnforcementEndpoint

ReposGetProtectedBranchPullRequestReviewEnforcementEndpoint: object

Type declaration

branch: string

branch parameter
owner: string

owner parameter
repo: string

repo parameter

ReposGetProtectedBranchPullRequestReviewEnforcementRequestOptions

ReposGetProtectedBranchPullRequestReviewEnforcementRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews"

ReposGetProtectedBranchPullRequestReviewEnforcementResponseData

ReposGetProtectedBranchPullRequestReviewEnforcementResponseData: object

Type declaration

dismiss_stale_reviews: boolean
dismissal_restrictions: ReposGetProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictions
require_code_owner_reviews: boolean
required_approving_review_count: number
url: string

ReposGetProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictions

ReposGetProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictions: object

Type declaration

teams: Array<ReposGetProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictionsTeamsItem>
teams_url: string
url: string
users: Array<ReposGetProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictionsUsersItem>
users_url: string

ReposGetProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictionsTeamsItem

ReposGetProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictionsTeamsItem: object

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

ReposGetProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictionsUsersItem

ReposGetProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictionsUsersItem: object

Type declaration

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

ReposGetProtectedBranchRequiredSignaturesEndpoint

ReposGetProtectedBranchRequiredSignaturesEndpoint: object & RequiredPreview<"zzzax">

ReposGetProtectedBranchRequiredSignaturesRequestOptions

ReposGetProtectedBranchRequiredSignaturesRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/branches/:branch/protection/required_signatures"

ReposGetProtectedBranchRequiredSignaturesResponseData

ReposGetProtectedBranchRequiredSignaturesResponseData: object

Type declaration

enabled: boolean
url: string

ReposGetProtectedBranchRequiredStatusChecksEndpoint

ReposGetProtectedBranchRequiredStatusChecksEndpoint: object

Type declaration

branch: string

branch parameter
owner: string

owner parameter
repo: string

repo parameter

ReposGetProtectedBranchRequiredStatusChecksRequestOptions

ReposGetProtectedBranchRequiredStatusChecksRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks"

ReposGetProtectedBranchRequiredStatusChecksResponseData

ReposGetProtectedBranchRequiredStatusChecksResponseData: object

Type declaration

contexts: Array<string>
contexts_url: string
strict: boolean
url: string

ReposGetProtectedBranchRestrictionsEndpoint

ReposGetProtectedBranchRestrictionsEndpoint: object

Type declaration

branch: string

branch parameter
owner: string

owner parameter
repo: string

repo parameter

ReposGetProtectedBranchRestrictionsRequestOptions

ReposGetProtectedBranchRestrictionsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/branches/:branch/protection/restrictions"

ReposGetProtectedBranchRestrictionsResponseData

ReposGetProtectedBranchRestrictionsResponseData: object

Type declaration

apps: Array<ReposGetProtectedBranchRestrictionsResponseDataAppsItem>
apps_url: string
teams: Array<ReposGetProtectedBranchRestrictionsResponseDataTeamsItem>
teams_url: string
url: string
users: Array<ReposGetProtectedBranchRestrictionsResponseDataUsersItem>
users_url: string

ReposGetProtectedBranchRestrictionsResponseDataAppsItem

ReposGetProtectedBranchRestrictionsResponseDataAppsItem: object

Type declaration

created_at: string
description: string
events: Array<string>
external_url: string
html_url: string
id: number
name: string
node_id: string
owner: ReposGetProtectedBranchRestrictionsResponseDataAppsItemOwner
permissions: ReposGetProtectedBranchRestrictionsResponseDataAppsItemPermissions
slug: string
updated_at: string

ReposGetProtectedBranchRestrictionsResponseDataAppsItemOwner

ReposGetProtectedBranchRestrictionsResponseDataAppsItemOwner: object

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

ReposGetProtectedBranchRestrictionsResponseDataAppsItemPermissions

ReposGetProtectedBranchRestrictionsResponseDataAppsItemPermissions: object

Type declaration

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

ReposGetProtectedBranchRestrictionsResponseDataTeamsItem

ReposGetProtectedBranchRestrictionsResponseDataTeamsItem: object

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

ReposGetProtectedBranchRestrictionsResponseDataUsersItem

ReposGetProtectedBranchRestrictionsResponseDataUsersItem: object

Type declaration

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

ReposGetPunchCardStatsEndpoint

ReposGetPunchCardStatsEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter

ReposGetPunchCardStatsRequestOptions

ReposGetPunchCardStatsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/stats/punch_card"

ReposGetPunchCardStatsResponseData

ReposGetPunchCardStatsResponseData: Array<Array<number>>

ReposGetReadmeEndpoint

ReposGetReadmeEndpoint: object

Type declaration

owner: string

owner parameter
Optional ref?: string

The name of the commit/branch/tag. Default: the repository’s default branch (usually master)
repo: string

repo parameter

ReposGetReadmeRequestOptions

ReposGetReadmeRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/readme"

ReposGetReadmeResponseData

ReposGetReadmeResponseData: object

Type declaration

_links: ReposGetReadmeResponseDataLinks
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

ReposGetReadmeResponseDataLinks

ReposGetReadmeResponseDataLinks: object

Type declaration

git: string
html: string
self: string

ReposGetReleaseAssetEndpoint

ReposGetReleaseAssetEndpoint: object

Type declaration

asset_id: number

asset_id parameter
owner: string

owner parameter
repo: string

repo parameter

ReposGetReleaseAssetRequestOptions

ReposGetReleaseAssetRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/releases/assets/:asset_id"

ReposGetReleaseAssetResponseData

ReposGetReleaseAssetResponseData: object

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: ReposGetReleaseAssetResponseDataUploader
url: string

ReposGetReleaseAssetResponseDataUploader

ReposGetReleaseAssetResponseDataUploader: object

Type declaration

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

ReposGetReleaseByTagEndpoint

ReposGetReleaseByTagEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter
tag: string

tag parameter

ReposGetReleaseByTagRequestOptions

ReposGetReleaseByTagRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/releases/tags/:tag"

ReposGetReleaseByTagResponseData

ReposGetReleaseByTagResponseData: object

Type declaration

assets: Array<ReposGetReleaseByTagResponseDataAssetsItem>
assets_url: string
author: ReposGetReleaseByTagResponseDataAuthor
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

ReposGetReleaseByTagResponseDataAssetsItem

ReposGetReleaseByTagResponseDataAssetsItem: object

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: ReposGetReleaseByTagResponseDataAssetsItemUploader
url: string

ReposGetReleaseByTagResponseDataAssetsItemUploader

ReposGetReleaseByTagResponseDataAssetsItemUploader: object

Type declaration

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

ReposGetReleaseByTagResponseDataAuthor

ReposGetReleaseByTagResponseDataAuthor: object

Type declaration

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

ReposGetReleaseEndpoint

ReposGetReleaseEndpoint: object

Type declaration

owner: string

owner parameter
release_id: number

release_id parameter
repo: string

repo parameter

ReposGetReleaseRequestOptions

ReposGetReleaseRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/releases/:release_id"

ReposGetReleaseResponseData

ReposGetReleaseResponseData: object

Type declaration

assets: Array<ReposGetReleaseResponseDataAssetsItem>
assets_url: string
author: ReposGetReleaseResponseDataAuthor
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

ReposGetReleaseResponseDataAssetsItem

ReposGetReleaseResponseDataAssetsItem: object

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: ReposGetReleaseResponseDataAssetsItemUploader
url: string

ReposGetReleaseResponseDataAssetsItemUploader

ReposGetReleaseResponseDataAssetsItemUploader: object

Type declaration

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

ReposGetReleaseResponseDataAuthor

ReposGetReleaseResponseDataAuthor: object

Type declaration

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

ReposGetRequestOptions

ReposGetRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo"

ReposGetResponseData

ReposGetResponseData: object

Type declaration

Optional allow_merge_commit?: boolean
Optional allow_rebase_merge?: boolean
Optional allow_squash_merge?: boolean
archive_url: string
Optional archived?: boolean
assignees_url: string
blobs_url: string
branches_url: string
clone_url: string
Optional code_of_conduct?: ReposGetResponseDataCodeOfConduct
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 | null
Optional disabled?: boolean
downloads_url: string
events_url: string
fork: boolean
Optional forks?: number
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 | null
hooks_url: string
html_url: string
id: number
Optional 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
Optional license?: ReposGetResponseDataLicense
merges_url: string
milestones_url: string
mirror_url: string | null
name: string
network_count: number
node_id: string
notifications_url: string
Optional open_issues?: number
open_issues_count: number
Optional organization?: ReposGetResponseDataOrganization
owner: ReposGetResponseDataOwner
Optional parent?: ReposGetResponseDataParent
Optional permissions?: ReposGetResponseDataPermissions
private: boolean
pulls_url: string
pushed_at: string
releases_url: string
size: number
Optional source?: ReposGetResponseDataSource
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
Optional temp_clone_token?: string
Optional template_repository?: null
Optional topics?: Array<string>
trees_url: string
updated_at: string
url: string
Optional visibility?: string
Optional watchers?: number
watchers_count: number

ReposGetResponseDataCodeOfConduct

ReposGetResponseDataCodeOfConduct: object

Type declaration

key: string
name: string
url: string

ReposGetResponseDataLicense

ReposGetResponseDataLicense: object

Type declaration

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

ReposGetResponseDataOrganization

ReposGetResponseDataOrganization: object

Type declaration

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

ReposGetResponseDataOwner

ReposGetResponseDataOwner: object

Type declaration

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

ReposGetResponseDataParent

ReposGetResponseDataParent: object

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: ReposGetResponseDataParentOwner
permissions: ReposGetResponseDataParentPermissions
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

ReposGetResponseDataParentOwner

ReposGetResponseDataParentOwner: object

Type declaration

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

ReposGetResponseDataParentPermissions

ReposGetResponseDataParentPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

ReposGetResponseDataPermissions

ReposGetResponseDataPermissions: object

Type declaration

admin: boolean
maintain: boolean
pull: boolean
push: boolean
triage: boolean

ReposGetResponseDataSource

ReposGetResponseDataSource: object

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: ReposGetResponseDataSourceOwner
permissions: ReposGetResponseDataSourcePermissions
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

ReposGetResponseDataSourceOwner

ReposGetResponseDataSourceOwner: object

Type declaration

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

ReposGetResponseDataSourcePermissions

ReposGetResponseDataSourcePermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

ReposGetTeamsWithAccessToProtectedBranchEndpoint

ReposGetTeamsWithAccessToProtectedBranchEndpoint: object

Type declaration

branch: string

branch parameter
owner: string

owner parameter
repo: string

repo parameter

ReposGetTeamsWithAccessToProtectedBranchRequestOptions

ReposGetTeamsWithAccessToProtectedBranchRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"

ReposGetTeamsWithAccessToProtectedBranchResponseData

ReposGetTeamsWithAccessToProtectedBranchResponseData: Array<ReposGetTeamsWithAccessToProtectedBranchResponseDataItem>

ReposGetTeamsWithAccessToProtectedBranchResponseDataItem

ReposGetTeamsWithAccessToProtectedBranchResponseDataItem: object

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

ReposGetTopPathsEndpoint

ReposGetTopPathsEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter

ReposGetTopPathsRequestOptions

ReposGetTopPathsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/traffic/popular/paths"

ReposGetTopPathsResponseData

ReposGetTopPathsResponseData: Array<ReposGetTopPathsResponseDataItem>

ReposGetTopPathsResponseDataItem

ReposGetTopPathsResponseDataItem: object

Type declaration

count: number
path: string
title: string
uniques: number

ReposGetTopReferrersEndpoint

ReposGetTopReferrersEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter

ReposGetTopReferrersRequestOptions

ReposGetTopReferrersRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/traffic/popular/referrers"

ReposGetTopReferrersResponseData

ReposGetTopReferrersResponseData: Array<ReposGetTopReferrersResponseDataItem>

ReposGetTopReferrersResponseDataItem

ReposGetTopReferrersResponseDataItem: object

Type declaration

count: number
referrer: string
uniques: number

ReposGetUsersWithAccessToProtectedBranchEndpoint

ReposGetUsersWithAccessToProtectedBranchEndpoint: object

Type declaration

branch: string

branch parameter
owner: string

owner parameter
repo: string

repo parameter

ReposGetUsersWithAccessToProtectedBranchRequestOptions

ReposGetUsersWithAccessToProtectedBranchRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"

ReposGetUsersWithAccessToProtectedBranchResponseData

ReposGetUsersWithAccessToProtectedBranchResponseData: Array<ReposGetUsersWithAccessToProtectedBranchResponseDataItem>

ReposGetUsersWithAccessToProtectedBranchResponseDataItem

ReposGetUsersWithAccessToProtectedBranchResponseDataItem: object

Type declaration

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

ReposGetViewsEndpoint

ReposGetViewsEndpoint: object

Type declaration

owner: string

owner parameter
Optional per?: "day" | "week"

Must be one of: day, week.
repo: string

repo parameter

ReposGetViewsRequestOptions

ReposGetViewsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/traffic/views"

ReposGetViewsResponseData

ReposGetViewsResponseData: object

Type declaration

count: number
uniques: number
views: Array<ReposGetViewsResponseDataViewsItem>

ReposGetViewsResponseDataViewsItem

ReposGetViewsResponseDataViewsItem: object

Type declaration

count: number
timestamp: string
uniques: number

ReposListAssetsForReleaseEndpoint

ReposListAssetsForReleaseEndpoint: object

Type declaration

owner: string

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
release_id: number

release_id parameter
repo: string

repo parameter

ReposListAssetsForReleaseRequestOptions

ReposListAssetsForReleaseRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/releases/:release_id/assets"

ReposListAssetsForReleaseResponseData

ReposListAssetsForReleaseResponseData: Array<ReposListAssetsForReleaseResponseDataItem>

ReposListAssetsForReleaseResponseDataItem

ReposListAssetsForReleaseResponseDataItem: object

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: ReposListAssetsForReleaseResponseDataItemUploader
url: string

ReposListAssetsForReleaseResponseDataItemUploader

ReposListAssetsForReleaseResponseDataItemUploader: object

Type declaration

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

ReposListBranchesEndpoint

ReposListBranchesEndpoint: object

Type declaration

owner: string

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
Optional protected?: boolean

Setting to true returns only protected branches. When set to false, only unprotected branches are returned. Omitting this parameter returns all branches.
repo: string

repo parameter

ReposListBranchesForHeadCommitEndpoint

ReposListBranchesForHeadCommitEndpoint: object & RequiredPreview<"groot">

ReposListBranchesForHeadCommitRequestOptions

ReposListBranchesForHeadCommitRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/commits/:commit_sha/branches-where-head"

ReposListBranchesForHeadCommitResponseData

ReposListBranchesForHeadCommitResponseData: Array<ReposListBranchesForHeadCommitResponseDataItem>

ReposListBranchesForHeadCommitResponseDataItem

ReposListBranchesForHeadCommitResponseDataItem: object

Type declaration

commit: ReposListBranchesForHeadCommitResponseDataItemCommit
name: string
protected: string

ReposListBranchesForHeadCommitResponseDataItemCommit

ReposListBranchesForHeadCommitResponseDataItemCommit: object

Type declaration

sha: string
url: string

ReposListBranchesRequestOptions

ReposListBranchesRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/branches"

ReposListBranchesResponseData

ReposListBranchesResponseData: Array<ReposListBranchesResponseDataItem>

ReposListBranchesResponseDataItem

ReposListBranchesResponseDataItem: object

Type declaration

commit: ReposListBranchesResponseDataItemCommit
name: string
protected: boolean
protection: ReposListBranchesResponseDataItemProtection
protection_url: string

ReposListBranchesResponseDataItemCommit

ReposListBranchesResponseDataItemCommit: object

Type declaration

sha: string
url: string

ReposListBranchesResponseDataItemProtection

ReposListBranchesResponseDataItemProtection: object

Type declaration

enabled: boolean
required_status_checks: ReposListBranchesResponseDataItemProtectionRequiredStatusChecks

ReposListBranchesResponseDataItemProtectionRequiredStatusChecks

ReposListBranchesResponseDataItemProtectionRequiredStatusChecks: object

Type declaration

contexts: Array<string>
enforcement_level: string

ReposListCollaboratorsEndpoint

ReposListCollaboratorsEndpoint: object

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

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
repo: string

repo parameter

ReposListCollaboratorsRequestOptions

ReposListCollaboratorsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/collaborators"

ReposListCollaboratorsResponseData

ReposListCollaboratorsResponseData: Array<ReposListCollaboratorsResponseDataItem>

ReposListCollaboratorsResponseDataItem

ReposListCollaboratorsResponseDataItem: object

Type declaration

avatar_url: string
events_url: string
followers_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: ReposListCollaboratorsResponseDataItemPermissions
received_events_url: string
repos_url: string
site_admin: boolean
starred_url: string
subscriptions_url: string
type: string
url: string

ReposListCollaboratorsResponseDataItemPermissions

ReposListCollaboratorsResponseDataItemPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

ReposListCommentsForCommitEndpoint

ReposListCommentsForCommitEndpoint: object

Type declaration

commit_sha: string

commit_sha parameter
owner: string

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
repo: string

repo parameter

ReposListCommentsForCommitRequestOptions

ReposListCommentsForCommitRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/commits/:commit_sha/comments"

ReposListCommentsForCommitResponseData

ReposListCommentsForCommitResponseData: Array<ReposListCommentsForCommitResponseDataItem>

ReposListCommentsForCommitResponseDataItem

ReposListCommentsForCommitResponseDataItem: object

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: ReposListCommentsForCommitResponseDataItemUser

ReposListCommentsForCommitResponseDataItemUser

ReposListCommentsForCommitResponseDataItemUser: object

Type declaration

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

ReposListCommitCommentsEndpoint

ReposListCommitCommentsEndpoint: object

Type declaration

owner: string

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
repo: string

repo parameter

ReposListCommitCommentsRequestOptions

ReposListCommitCommentsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/comments"

ReposListCommitCommentsResponseData

ReposListCommitCommentsResponseData: Array<ReposListCommitCommentsResponseDataItem>

ReposListCommitCommentsResponseDataItem

ReposListCommitCommentsResponseDataItem: object

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: ReposListCommitCommentsResponseDataItemUser

ReposListCommitCommentsResponseDataItemUser

ReposListCommitCommentsResponseDataItemUser: object

Type declaration

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

ReposListCommitsEndpoint

ReposListCommitsEndpoint: object

Type declaration

Optional author?: string

GitHub login or email address by which to filter by commit author.
owner: string

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional path?: string

Only commits containing this file path will be returned.
Optional per_page?: number

Results per page (max 100)
repo: string

repo parameter
Optional sha?: string

SHA or branch to start listing commits from. Default: the repository’s default branch (usually master).
Optional since?: string

Only commits after this date will be returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Optional until?: string

Only commits before this date will be returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

ReposListCommitsRequestOptions

ReposListCommitsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/commits"

ReposListCommitsResponseData

ReposListCommitsResponseData: Array<ReposListCommitsResponseDataItem>

ReposListCommitsResponseDataItem

ReposListCommitsResponseDataItem: object

Type declaration

author: ReposListCommitsResponseDataItemAuthor
comments_url: string
commit: ReposListCommitsResponseDataItemCommit
committer: ReposListCommitsResponseDataItemCommitter
html_url: string
node_id: string
parents: Array<ReposListCommitsResponseDataItemParentsItem>
sha: string
url: string

ReposListCommitsResponseDataItemAuthor

ReposListCommitsResponseDataItemAuthor: object

Type declaration

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

ReposListCommitsResponseDataItemCommit

ReposListCommitsResponseDataItemCommit: object

Type declaration

author: ReposListCommitsResponseDataItemCommitAuthor
comment_count: number
committer: ReposListCommitsResponseDataItemCommitCommitter
message: string
tree: ReposListCommitsResponseDataItemCommitTree
url: string
verification: ReposListCommitsResponseDataItemCommitVerification

ReposListCommitsResponseDataItemCommitAuthor

ReposListCommitsResponseDataItemCommitAuthor: object

Type declaration

date: string
email: string
name: string

ReposListCommitsResponseDataItemCommitCommitter

ReposListCommitsResponseDataItemCommitCommitter: object

Type declaration

date: string
email: string
name: string

ReposListCommitsResponseDataItemCommitTree

ReposListCommitsResponseDataItemCommitTree: object

Type declaration

sha: string
url: string

ReposListCommitsResponseDataItemCommitVerification

ReposListCommitsResponseDataItemCommitVerification: object

Type declaration

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

ReposListCommitsResponseDataItemCommitter

ReposListCommitsResponseDataItemCommitter: object

Type declaration

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

ReposListCommitsResponseDataItemParentsItem

ReposListCommitsResponseDataItemParentsItem: object

Type declaration

sha: string
url: string

ReposListContributorsEndpoint

ReposListContributorsEndpoint: object

Type declaration

Optional anon?: string

Set to 1 or true to include anonymous contributors in results.
owner: string

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
repo: string

repo parameter

ReposListContributorsRequestOptions

ReposListContributorsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/contributors"

ReposListContributorsResponseData

ReposListContributorsResponseData: Array<ReposListContributorsResponseDataItem>

ReposListContributorsResponseDataItem

ReposListContributorsResponseDataItem: object

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

ReposListDeployKeysEndpoint

ReposListDeployKeysEndpoint: object

Type declaration

owner: string

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
repo: string

repo parameter

ReposListDeployKeysRequestOptions

ReposListDeployKeysRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/keys"

ReposListDeployKeysResponseData

ReposListDeployKeysResponseData: Array<ReposListDeployKeysResponseDataItem>

ReposListDeployKeysResponseDataItem

ReposListDeployKeysResponseDataItem: object

Type declaration

created_at: string
id: number
key: string
read_only: boolean
title: string
url: string
verified: boolean

ReposListDeploymentStatusesEndpoint

ReposListDeploymentStatusesEndpoint: object

Type declaration

deployment_id: number

deployment_id parameter
owner: string

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
repo: string

repo parameter

ReposListDeploymentStatusesRequestOptions

ReposListDeploymentStatusesRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/deployments/:deployment_id/statuses"

ReposListDeploymentStatusesResponseData

ReposListDeploymentStatusesResponseData: Array<ReposListDeploymentStatusesResponseDataItem>

ReposListDeploymentStatusesResponseDataItem

ReposListDeploymentStatusesResponseDataItem: object

Type declaration

created_at: string
creator: ReposListDeploymentStatusesResponseDataItemCreator
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

ReposListDeploymentStatusesResponseDataItemCreator

ReposListDeploymentStatusesResponseDataItemCreator: object

Type declaration

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

ReposListDeploymentsEndpoint

ReposListDeploymentsEndpoint: object

Type declaration

Optional environment?: string

The name of the environment that was deployed to (e.g., staging or production).
owner: string

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
Optional ref?: string

The name of the ref. This can be a branch, tag, or SHA.
repo: string

repo parameter
Optional sha?: string

The SHA recorded at creation time.
Optional task?: string

The name of the task for the deployment (e.g., deploy or deploy:migrations).

ReposListDeploymentsRequestOptions

ReposListDeploymentsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/deployments"

ReposListDeploymentsResponseData

ReposListDeploymentsResponseData: Array<ReposListDeploymentsResponseDataItem>

ReposListDeploymentsResponseDataItem

ReposListDeploymentsResponseDataItem: object

Type declaration

created_at: string
creator: ReposListDeploymentsResponseDataItemCreator
description: string
environment: string
id: number
node_id: string
original_environment: string
payload: ReposListDeploymentsResponseDataItemPayload
production_environment: boolean
ref: string
repository_url: string
sha: string
statuses_url: string
task: string
transient_environment: boolean
updated_at: string
url: string

ReposListDeploymentsResponseDataItemCreator

ReposListDeploymentsResponseDataItemCreator: object

Type declaration

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

ReposListDeploymentsResponseDataItemPayload

ReposListDeploymentsResponseDataItemPayload: object

Type declaration

deploy: string

ReposListDownloadsEndpoint

ReposListDownloadsEndpoint: object

Type declaration

owner: string

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
repo: string

repo parameter

ReposListDownloadsRequestOptions

ReposListDownloadsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/downloads"

ReposListDownloadsResponseData

ReposListDownloadsResponseData: Array<ReposListDownloadsResponseDataItem>

ReposListDownloadsResponseDataItem

ReposListDownloadsResponseDataItem: object

Type declaration

content_type: string
description: string
download_count: number
html_url: string
id: number
name: string
size: number
url: string

ReposListForAuthenticatedUserEndpoint

ReposListForAuthenticatedUserEndpoint: object

Type declaration

Optional affiliation?: 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?: number

Page number of the results to fetch.
Optional per_page?: 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.

ReposListForAuthenticatedUserRequestOptions

ReposListForAuthenticatedUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/user/repos"

ReposListForOrgEndpoint

ReposListForOrgEndpoint: object

Type declaration

Optional direction?: "asc" | "desc"

Can be one of asc or desc. Default: when using full_name: asc, otherwise desc
org: string

org parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: 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 or GitHub Enterprise Server 2.20+, type can also be internal.

ReposListForOrgRequestOptions

ReposListForOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/orgs/:org/repos"

ReposListForOrgResponseData

ReposListForOrgResponseData: Array<ReposListForOrgResponseDataItem>

ReposListForOrgResponseDataItem

ReposListForOrgResponseDataItem: object

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: ReposListForOrgResponseDataItemLicense
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: ReposListForOrgResponseDataItemOwner
permissions: ReposListForOrgResponseDataItemPermissions
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

ReposListForOrgResponseDataItemLicense

ReposListForOrgResponseDataItemLicense: object

Type declaration

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

ReposListForOrgResponseDataItemOwner

ReposListForOrgResponseDataItemOwner: object

Type declaration

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

ReposListForOrgResponseDataItemPermissions

ReposListForOrgResponseDataItemPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

ReposListForUserEndpoint

ReposListForUserEndpoint: object

Type declaration

Optional direction?: "asc" | "desc"

Can be one of asc or desc. Default: asc when using full_name, otherwise desc
Optional page?: number

Page number of the results to fetch.
Optional per_page?: 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

username parameter

ReposListForUserRequestOptions

ReposListForUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/users/:username/repos"

ReposListForksEndpoint

ReposListForksEndpoint: object

Type declaration

owner: string

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
repo: string

repo parameter
Optional sort?: "newest" | "oldest" | "stargazers"

The sort order. Can be either newest, oldest, or stargazers.

ReposListForksRequestOptions

ReposListForksRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/forks"

ReposListForksResponseData

ReposListForksResponseData: Array<ReposListForksResponseDataItem>

ReposListForksResponseDataItem

ReposListForksResponseDataItem: object

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: ReposListForksResponseDataItemLicense
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: ReposListForksResponseDataItemOwner
permissions: ReposListForksResponseDataItemPermissions
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

ReposListForksResponseDataItemLicense

ReposListForksResponseDataItemLicense: object

Type declaration

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

ReposListForksResponseDataItemOwner

ReposListForksResponseDataItemOwner: object

Type declaration

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

ReposListForksResponseDataItemPermissions

ReposListForksResponseDataItemPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

ReposListHooksEndpoint

ReposListHooksEndpoint: object

Type declaration

owner: string

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
repo: string

repo parameter

ReposListHooksRequestOptions

ReposListHooksRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/hooks"

ReposListHooksResponseData

ReposListHooksResponseData: Array<ReposListHooksResponseDataItem>

ReposListHooksResponseDataItem

ReposListHooksResponseDataItem: object

Type declaration

active: boolean
config: ReposListHooksResponseDataItemConfig
created_at: string
events: Array<string>
id: number
last_response: ReposListHooksResponseDataItemLastResponse
name: string
ping_url: string
test_url: string
type: string
updated_at: string
url: string

ReposListHooksResponseDataItemConfig

ReposListHooksResponseDataItemConfig: object

Type declaration

content_type: string
insecure_ssl: string
url: string

ReposListHooksResponseDataItemLastResponse

ReposListHooksResponseDataItemLastResponse: object

Type declaration

code: null
message: null
status: string

ReposListInvitationsEndpoint

ReposListInvitationsEndpoint: object

Type declaration

owner: string

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
repo: string

repo parameter

ReposListInvitationsForAuthenticatedUserEndpoint

ReposListInvitationsForAuthenticatedUserEndpoint: object

Type declaration

Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)

ReposListInvitationsForAuthenticatedUserRequestOptions

ReposListInvitationsForAuthenticatedUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/user/repository_invitations"

ReposListInvitationsForAuthenticatedUserResponseData

ReposListInvitationsForAuthenticatedUserResponseData: Array<ReposListInvitationsForAuthenticatedUserResponseDataItem>

ReposListInvitationsForAuthenticatedUserResponseDataItem

ReposListInvitationsForAuthenticatedUserResponseDataItem: object

Type declaration

created_at: string
html_url: string
id: number
invitee: ReposListInvitationsForAuthenticatedUserResponseDataItemInvitee
inviter: ReposListInvitationsForAuthenticatedUserResponseDataItemInviter
permissions: string
repository: ReposListInvitationsForAuthenticatedUserResponseDataItemRepository
url: string

ReposListInvitationsForAuthenticatedUserResponseDataItemInvitee

ReposListInvitationsForAuthenticatedUserResponseDataItemInvitee: object

Type declaration

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

ReposListInvitationsForAuthenticatedUserResponseDataItemInviter

ReposListInvitationsForAuthenticatedUserResponseDataItemInviter: object

Type declaration

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

ReposListInvitationsForAuthenticatedUserResponseDataItemRepository

ReposListInvitationsForAuthenticatedUserResponseDataItemRepository: object

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: ReposListInvitationsForAuthenticatedUserResponseDataItemRepositoryOwner
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

ReposListInvitationsForAuthenticatedUserResponseDataItemRepositoryOwner

ReposListInvitationsForAuthenticatedUserResponseDataItemRepositoryOwner: object

Type declaration

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

ReposListInvitationsRequestOptions

ReposListInvitationsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/invitations"

ReposListInvitationsResponseData

ReposListInvitationsResponseData: Array<ReposListInvitationsResponseDataItem>

ReposListInvitationsResponseDataItem

ReposListInvitationsResponseDataItem: object

Type declaration

created_at: string
html_url: string
id: number
invitee: ReposListInvitationsResponseDataItemInvitee
inviter: ReposListInvitationsResponseDataItemInviter
permissions: string
repository: ReposListInvitationsResponseDataItemRepository
url: string

ReposListInvitationsResponseDataItemInvitee

ReposListInvitationsResponseDataItemInvitee: object

Type declaration

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

ReposListInvitationsResponseDataItemInviter

ReposListInvitationsResponseDataItemInviter: object

Type declaration

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

ReposListInvitationsResponseDataItemRepository

ReposListInvitationsResponseDataItemRepository: object

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: ReposListInvitationsResponseDataItemRepositoryOwner
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

ReposListInvitationsResponseDataItemRepositoryOwner

ReposListInvitationsResponseDataItemRepositoryOwner: object

Type declaration

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

ReposListLanguagesEndpoint

ReposListLanguagesEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter

ReposListLanguagesRequestOptions

ReposListLanguagesRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/languages"

ReposListLanguagesResponseData

ReposListLanguagesResponseData: object

Type declaration

C: number
Python: number

ReposListPagesBuildsEndpoint

ReposListPagesBuildsEndpoint: object

Type declaration

owner: string

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
repo: string

repo parameter

ReposListPagesBuildsRequestOptions

ReposListPagesBuildsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/pages/builds"

ReposListPagesBuildsResponseData

ReposListPagesBuildsResponseData: Array<ReposListPagesBuildsResponseDataItem>

ReposListPagesBuildsResponseDataItem

ReposListPagesBuildsResponseDataItem: object

Type declaration

commit: string
created_at: string
duration: number
error: ReposListPagesBuildsResponseDataItemError
pusher: ReposListPagesBuildsResponseDataItemPusher
status: string
updated_at: string
url: string

ReposListPagesBuildsResponseDataItemError

ReposListPagesBuildsResponseDataItemError: object

Type declaration

message: null

ReposListPagesBuildsResponseDataItemPusher

ReposListPagesBuildsResponseDataItemPusher: object

Type declaration

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

ReposListProtectedBranchRequiredStatusChecksContextsEndpoint

ReposListProtectedBranchRequiredStatusChecksContextsEndpoint: object

Type declaration

branch: string

branch parameter
owner: string

owner parameter
repo: string

repo parameter

ReposListProtectedBranchRequiredStatusChecksContextsRequestOptions

ReposListProtectedBranchRequiredStatusChecksContextsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"

ReposListProtectedBranchRequiredStatusChecksContextsResponseData

ReposListProtectedBranchRequiredStatusChecksContextsResponseData: Array<string>

ReposListPublicEndpoint

ReposListPublicEndpoint: object

Type declaration

Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
Optional since?: number

The integer ID of the last repository that you've seen.

ReposListPublicRequestOptions

ReposListPublicRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repositories"

ReposListPublicResponseData

ReposListPublicResponseData: Array<ReposListPublicResponseDataItem>

ReposListPublicResponseDataItem

ReposListPublicResponseDataItem: object

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: ReposListPublicResponseDataItemOwner
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

ReposListPublicResponseDataItemOwner

ReposListPublicResponseDataItemOwner: object

Type declaration

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

ReposListPullRequestsAssociatedWithCommitEndpoint

ReposListPullRequestsAssociatedWithCommitEndpoint: object & RequiredPreview<"groot">

ReposListPullRequestsAssociatedWithCommitRequestOptions

ReposListPullRequestsAssociatedWithCommitRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/commits/:commit_sha/pulls"

ReposListPullRequestsAssociatedWithCommitResponseData

ReposListPullRequestsAssociatedWithCommitResponseData: Array<ReposListPullRequestsAssociatedWithCommitResponseDataItem>

ReposListPullRequestsAssociatedWithCommitResponseDataItem

ReposListPullRequestsAssociatedWithCommitResponseDataItem: object

Type declaration

_links: ReposListPullRequestsAssociatedWithCommitResponseDataItemLinks
active_lock_reason: string
assignee: ReposListPullRequestsAssociatedWithCommitResponseDataItemAssignee
assignees: Array<ReposListPullRequestsAssociatedWithCommitResponseDataItemAssigneesItem>
author_association: string
base: ReposListPullRequestsAssociatedWithCommitResponseDataItemBase
body: string
closed_at: string
comments_url: string
commits_url: string
created_at: string
diff_url: string
draft: boolean
head: ReposListPullRequestsAssociatedWithCommitResponseDataItemHead
html_url: string
id: number
issue_url: string
labels: Array<ReposListPullRequestsAssociatedWithCommitResponseDataItemLabelsItem>
locked: boolean
merge_commit_sha: string
merged_at: string
milestone: ReposListPullRequestsAssociatedWithCommitResponseDataItemMilestone
node_id: string
number: number
patch_url: string
requested_reviewers: Array<ReposListPullRequestsAssociatedWithCommitResponseDataItemRequestedReviewersItem>
requested_teams: Array<ReposListPullRequestsAssociatedWithCommitResponseDataItemRequestedTeamsItem>
review_comment_url: string
review_comments_url: string
state: string
statuses_url: string
title: string
updated_at: string
url: string
user: ReposListPullRequestsAssociatedWithCommitResponseDataItemUser

ReposListPullRequestsAssociatedWithCommitResponseDataItemAssignee

ReposListPullRequestsAssociatedWithCommitResponseDataItemAssignee: object

Type declaration

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

ReposListPullRequestsAssociatedWithCommitResponseDataItemAssigneesItem

ReposListPullRequestsAssociatedWithCommitResponseDataItemAssigneesItem: object

Type declaration

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

ReposListPullRequestsAssociatedWithCommitResponseDataItemBase

ReposListPullRequestsAssociatedWithCommitResponseDataItemBase: object

Type declaration

label: string
ref: string
repo: ReposListPullRequestsAssociatedWithCommitResponseDataItemBaseRepo
sha: string
user: ReposListPullRequestsAssociatedWithCommitResponseDataItemBaseUser

ReposListPullRequestsAssociatedWithCommitResponseDataItemBaseRepo

ReposListPullRequestsAssociatedWithCommitResponseDataItemBaseRepo: object

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: ReposListPullRequestsAssociatedWithCommitResponseDataItemBaseRepoOwner
permissions: ReposListPullRequestsAssociatedWithCommitResponseDataItemBaseRepoPermissions
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

ReposListPullRequestsAssociatedWithCommitResponseDataItemBaseRepoOwner

ReposListPullRequestsAssociatedWithCommitResponseDataItemBaseRepoOwner: object

Type declaration

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

ReposListPullRequestsAssociatedWithCommitResponseDataItemBaseRepoPermissions

ReposListPullRequestsAssociatedWithCommitResponseDataItemBaseRepoPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

ReposListPullRequestsAssociatedWithCommitResponseDataItemBaseUser

ReposListPullRequestsAssociatedWithCommitResponseDataItemBaseUser: object

Type declaration

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

ReposListPullRequestsAssociatedWithCommitResponseDataItemHead

ReposListPullRequestsAssociatedWithCommitResponseDataItemHead: object

Type declaration

label: string
ref: string
repo: ReposListPullRequestsAssociatedWithCommitResponseDataItemHeadRepo
sha: string
user: ReposListPullRequestsAssociatedWithCommitResponseDataItemHeadUser

ReposListPullRequestsAssociatedWithCommitResponseDataItemHeadRepo

ReposListPullRequestsAssociatedWithCommitResponseDataItemHeadRepo: object

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: ReposListPullRequestsAssociatedWithCommitResponseDataItemHeadRepoOwner
permissions: ReposListPullRequestsAssociatedWithCommitResponseDataItemHeadRepoPermissions
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

ReposListPullRequestsAssociatedWithCommitResponseDataItemHeadRepoOwner

ReposListPullRequestsAssociatedWithCommitResponseDataItemHeadRepoOwner: object

Type declaration

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

ReposListPullRequestsAssociatedWithCommitResponseDataItemHeadRepoPermissions

ReposListPullRequestsAssociatedWithCommitResponseDataItemHeadRepoPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

ReposListPullRequestsAssociatedWithCommitResponseDataItemHeadUser

ReposListPullRequestsAssociatedWithCommitResponseDataItemHeadUser: object

Type declaration

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

ReposListPullRequestsAssociatedWithCommitResponseDataItemLabelsItem

ReposListPullRequestsAssociatedWithCommitResponseDataItemLabelsItem: object

Type declaration

color: string
default: boolean
description: string
id: number
name: string
node_id: string
url: string

ReposListPullRequestsAssociatedWithCommitResponseDataItemLinks

ReposListPullRequestsAssociatedWithCommitResponseDataItemLinks: object

Type declaration

ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksComments

ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksComments: object

Type declaration

href: string

ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksCommits

ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksCommits: object

Type declaration

href: string

ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksHtml

ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksHtml: object

Type declaration

href: string

ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksIssue

ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksIssue: object

Type declaration

href: string

ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksReviewComment

ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksReviewComment: object

Type declaration

href: string

ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksReviewComments

ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksReviewComments: object

Type declaration

href: string

ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksSelf

ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksSelf: object

Type declaration

href: string

ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksStatuses

ReposListPullRequestsAssociatedWithCommitResponseDataItemLinksStatuses: object

Type declaration

href: string

ReposListPullRequestsAssociatedWithCommitResponseDataItemMilestone

ReposListPullRequestsAssociatedWithCommitResponseDataItemMilestone: object

Type declaration

closed_at: string
closed_issues: number
created_at: string
creator: ReposListPullRequestsAssociatedWithCommitResponseDataItemMilestoneCreator
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

ReposListPullRequestsAssociatedWithCommitResponseDataItemMilestoneCreator

ReposListPullRequestsAssociatedWithCommitResponseDataItemMilestoneCreator: object

Type declaration

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

ReposListPullRequestsAssociatedWithCommitResponseDataItemRequestedReviewersItem

ReposListPullRequestsAssociatedWithCommitResponseDataItemRequestedReviewersItem: object

Type declaration

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

ReposListPullRequestsAssociatedWithCommitResponseDataItemRequestedTeamsItem

ReposListPullRequestsAssociatedWithCommitResponseDataItemRequestedTeamsItem: object

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

ReposListPullRequestsAssociatedWithCommitResponseDataItemUser

ReposListPullRequestsAssociatedWithCommitResponseDataItemUser: object

Type declaration

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

ReposListReleasesEndpoint

ReposListReleasesEndpoint: object

Type declaration

owner: string

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
repo: string

repo parameter

ReposListReleasesRequestOptions

ReposListReleasesRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/releases"

ReposListReleasesResponseData

ReposListReleasesResponseData: Array<ReposListReleasesResponseDataItem>

ReposListReleasesResponseDataItem

ReposListReleasesResponseDataItem: object

Type declaration

assets: Array<ReposListReleasesResponseDataItemAssetsItem>
assets_url: string
author: ReposListReleasesResponseDataItemAuthor
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

ReposListReleasesResponseDataItemAssetsItem

ReposListReleasesResponseDataItemAssetsItem: object

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: ReposListReleasesResponseDataItemAssetsItemUploader
url: string

ReposListReleasesResponseDataItemAssetsItemUploader

ReposListReleasesResponseDataItemAssetsItemUploader: object

Type declaration

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

ReposListReleasesResponseDataItemAuthor

ReposListReleasesResponseDataItemAuthor: object

Type declaration

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

ReposListStatusesForRefEndpoint

ReposListStatusesForRefEndpoint: object

Type declaration

owner: string

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
ref: string

ref parameter
repo: string

repo parameter

ReposListStatusesForRefRequestOptions

ReposListStatusesForRefRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/commits/:ref/statuses"

ReposListStatusesForRefResponseData

ReposListStatusesForRefResponseData: Array<ReposListStatusesForRefResponseDataItem>

ReposListStatusesForRefResponseDataItem

ReposListStatusesForRefResponseDataItem: object

Type declaration

avatar_url: string
context: string
created_at: string
creator: ReposListStatusesForRefResponseDataItemCreator
description: string
id: number
node_id: string
state: string
target_url: string
updated_at: string
url: string

ReposListStatusesForRefResponseDataItemCreator

ReposListStatusesForRefResponseDataItemCreator: object

Type declaration

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

ReposListTagsEndpoint

ReposListTagsEndpoint: object

Type declaration

owner: string

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
repo: string

repo parameter

ReposListTagsRequestOptions

ReposListTagsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/tags"

ReposListTagsResponseData

ReposListTagsResponseData: Array<ReposListTagsResponseDataItem>

ReposListTagsResponseDataItem

ReposListTagsResponseDataItem: object

Type declaration

commit: ReposListTagsResponseDataItemCommit
name: string
tarball_url: string
zipball_url: string

ReposListTagsResponseDataItemCommit

ReposListTagsResponseDataItemCommit: object

Type declaration

sha: string
url: string

ReposListTeamsEndpoint

ReposListTeamsEndpoint: object

Type declaration

owner: string

owner parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
repo: string

repo parameter

ReposListTeamsRequestOptions

ReposListTeamsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/teams"

ReposListTeamsResponseData

ReposListTeamsResponseData: Array<ReposListTeamsResponseDataItem>

ReposListTeamsResponseDataItem

ReposListTeamsResponseDataItem: object

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

ReposMergeEndpoint

ReposMergeEndpoint: object

Type declaration

base: string

The name of the base branch that the head will be merged into.
Optional commit_message?: 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

owner parameter
repo: string

repo parameter

ReposMergeRequestOptions

ReposMergeRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/merges"

ReposMergeResponseData

ReposMergeResponseData: object

Type declaration

author: ReposMergeResponseDataAuthor
comments_url: string
commit: ReposMergeResponseDataCommit
committer: ReposMergeResponseDataCommitter
html_url: string
node_id: string
parents: Array<ReposMergeResponseDataParentsItem>
sha: string
url: string

ReposMergeResponseDataAuthor

ReposMergeResponseDataAuthor: object

Type declaration

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

ReposMergeResponseDataCommit

ReposMergeResponseDataCommit: object

Type declaration

author: ReposMergeResponseDataCommitAuthor
comment_count: number
committer: ReposMergeResponseDataCommitCommitter
message: string
tree: ReposMergeResponseDataCommitTree
url: string
verification: ReposMergeResponseDataCommitVerification

ReposMergeResponseDataCommitAuthor

ReposMergeResponseDataCommitAuthor: object

Type declaration

date: string
email: string
name: string

ReposMergeResponseDataCommitCommitter

ReposMergeResponseDataCommitCommitter: object

Type declaration

date: string
email: string
name: string

ReposMergeResponseDataCommitTree

ReposMergeResponseDataCommitTree: object

Type declaration

sha: string
url: string

ReposMergeResponseDataCommitVerification

ReposMergeResponseDataCommitVerification: object

Type declaration

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

ReposMergeResponseDataCommitter

ReposMergeResponseDataCommitter: object

Type declaration

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

ReposMergeResponseDataParentsItem

ReposMergeResponseDataParentsItem: object

Type declaration

sha: string
url: string

ReposPingHookEndpoint

ReposPingHookEndpoint: object

Type declaration

hook_id: number

hook_id parameter
owner: string

owner parameter
repo: string

repo parameter

ReposPingHookRequestOptions

ReposPingHookRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/hooks/:hook_id/pings"

ReposRemoveBranchProtectionEndpoint

ReposRemoveBranchProtectionEndpoint: object

Type declaration

branch: string

branch parameter
owner: string

owner parameter
repo: string

repo parameter

ReposRemoveBranchProtectionRequestOptions

ReposRemoveBranchProtectionRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/repos/:owner/:repo/branches/:branch/protection"

ReposRemoveCollaboratorEndpoint

ReposRemoveCollaboratorEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter
username: string

username parameter

ReposRemoveCollaboratorRequestOptions

ReposRemoveCollaboratorRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/repos/:owner/:repo/collaborators/:username"

ReposRemoveDeployKeyEndpoint

ReposRemoveDeployKeyEndpoint: object

Type declaration

key_id: number

key_id parameter
owner: string

owner parameter
repo: string

repo parameter

ReposRemoveDeployKeyRequestOptions

ReposRemoveDeployKeyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/repos/:owner/:repo/keys/:key_id"

ReposRemoveProtectedBranchAdminEnforcementEndpoint

ReposRemoveProtectedBranchAdminEnforcementEndpoint: object

Type declaration

branch: string

branch parameter
owner: string

owner parameter
repo: string

repo parameter

ReposRemoveProtectedBranchAdminEnforcementRequestOptions

ReposRemoveProtectedBranchAdminEnforcementRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/repos/:owner/:repo/branches/:branch/protection/enforce_admins"

ReposRemoveProtectedBranchAppRestrictionsEndpoint

ReposRemoveProtectedBranchAppRestrictionsEndpoint: object

Type declaration

apps: string[]

apps parameter
branch: string

branch parameter
owner: string

owner parameter
repo: string

repo parameter

ReposRemoveProtectedBranchAppRestrictionsRequestOptions

ReposRemoveProtectedBranchAppRestrictionsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps"

ReposRemoveProtectedBranchAppRestrictionsResponseData

ReposRemoveProtectedBranchAppRestrictionsResponseData: Array<ReposRemoveProtectedBranchAppRestrictionsResponseDataItem>

ReposRemoveProtectedBranchAppRestrictionsResponseDataItem

ReposRemoveProtectedBranchAppRestrictionsResponseDataItem: object

Type declaration

created_at: string
description: string
events: Array<string>
external_url: string
html_url: string
id: number
name: string
node_id: string
owner: ReposRemoveProtectedBranchAppRestrictionsResponseDataItemOwner
permissions: ReposRemoveProtectedBranchAppRestrictionsResponseDataItemPermissions
slug: string
updated_at: string

ReposRemoveProtectedBranchAppRestrictionsResponseDataItemOwner

ReposRemoveProtectedBranchAppRestrictionsResponseDataItemOwner: object

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

ReposRemoveProtectedBranchAppRestrictionsResponseDataItemPermissions

ReposRemoveProtectedBranchAppRestrictionsResponseDataItemPermissions: object

Type declaration

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

ReposRemoveProtectedBranchPullRequestReviewEnforcementEndpoint

ReposRemoveProtectedBranchPullRequestReviewEnforcementEndpoint: object

Type declaration

branch: string

branch parameter
owner: string

owner parameter
repo: string

repo parameter

ReposRemoveProtectedBranchPullRequestReviewEnforcementRequestOptions

ReposRemoveProtectedBranchPullRequestReviewEnforcementRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews"

ReposRemoveProtectedBranchRequiredSignaturesEndpoint

ReposRemoveProtectedBranchRequiredSignaturesEndpoint: object & RequiredPreview<"zzzax">

ReposRemoveProtectedBranchRequiredSignaturesRequestOptions

ReposRemoveProtectedBranchRequiredSignaturesRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/repos/:owner/:repo/branches/:branch/protection/required_signatures"

ReposRemoveProtectedBranchRequiredStatusChecksContextsEndpoint

ReposRemoveProtectedBranchRequiredStatusChecksContextsEndpoint: object

Type declaration

branch: string

branch parameter
contexts: string[]

contexts parameter
owner: string

owner parameter
repo: string

repo parameter

ReposRemoveProtectedBranchRequiredStatusChecksContextsRequestOptions

ReposRemoveProtectedBranchRequiredStatusChecksContextsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"

ReposRemoveProtectedBranchRequiredStatusChecksContextsResponseData

ReposRemoveProtectedBranchRequiredStatusChecksContextsResponseData: Array<string>

ReposRemoveProtectedBranchRequiredStatusChecksEndpoint

ReposRemoveProtectedBranchRequiredStatusChecksEndpoint: object

Type declaration

branch: string

branch parameter
owner: string

owner parameter
repo: string

repo parameter

ReposRemoveProtectedBranchRequiredStatusChecksRequestOptions

ReposRemoveProtectedBranchRequiredStatusChecksRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks"

ReposRemoveProtectedBranchRestrictionsEndpoint

ReposRemoveProtectedBranchRestrictionsEndpoint: object

Type declaration

branch: string

branch parameter
owner: string

owner parameter
repo: string

repo parameter

ReposRemoveProtectedBranchRestrictionsRequestOptions

ReposRemoveProtectedBranchRestrictionsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/repos/:owner/:repo/branches/:branch/protection/restrictions"

ReposRemoveProtectedBranchTeamRestrictionsEndpoint

ReposRemoveProtectedBranchTeamRestrictionsEndpoint: object

Type declaration

branch: string

branch parameter
owner: string

owner parameter
repo: string

repo parameter
teams: string[]

teams parameter

ReposRemoveProtectedBranchTeamRestrictionsRequestOptions

ReposRemoveProtectedBranchTeamRestrictionsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"

ReposRemoveProtectedBranchTeamRestrictionsResponseData

ReposRemoveProtectedBranchTeamRestrictionsResponseData: Array<ReposRemoveProtectedBranchTeamRestrictionsResponseDataItem>

ReposRemoveProtectedBranchTeamRestrictionsResponseDataItem

ReposRemoveProtectedBranchTeamRestrictionsResponseDataItem: object

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

ReposRemoveProtectedBranchUserRestrictionsEndpoint

ReposRemoveProtectedBranchUserRestrictionsEndpoint: object

Type declaration

branch: string

branch parameter
owner: string

owner parameter
repo: string

repo parameter
users: string[]

users parameter

ReposRemoveProtectedBranchUserRestrictionsRequestOptions

ReposRemoveProtectedBranchUserRestrictionsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"

ReposRemoveProtectedBranchUserRestrictionsResponseData

ReposRemoveProtectedBranchUserRestrictionsResponseData: Array<ReposRemoveProtectedBranchUserRestrictionsResponseDataItem>

ReposRemoveProtectedBranchUserRestrictionsResponseDataItem

ReposRemoveProtectedBranchUserRestrictionsResponseDataItem: object

Type declaration

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

ReposReplaceAllTopicsEndpoint

ReposReplaceAllTopicsEndpoint: object & RequiredPreview<"mercy">

ReposReplaceAllTopicsRequestOptions

ReposReplaceAllTopicsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PUT"
request: RequestRequestOptions
url: "/repos/:owner/:repo/topics"

ReposReplaceAllTopicsResponseData

ReposReplaceAllTopicsResponseData: object

Type declaration

names: Array<string>

ReposReplaceProtectedBranchAppRestrictionsEndpoint

ReposReplaceProtectedBranchAppRestrictionsEndpoint: object

Type declaration

apps: string[]

apps parameter
branch: string

branch parameter
owner: string

owner parameter
repo: string

repo parameter

ReposReplaceProtectedBranchAppRestrictionsRequestOptions

ReposReplaceProtectedBranchAppRestrictionsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PUT"
request: RequestRequestOptions
url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps"

ReposReplaceProtectedBranchAppRestrictionsResponseData

ReposReplaceProtectedBranchAppRestrictionsResponseData: Array<ReposReplaceProtectedBranchAppRestrictionsResponseDataItem>

ReposReplaceProtectedBranchAppRestrictionsResponseDataItem

ReposReplaceProtectedBranchAppRestrictionsResponseDataItem: object

Type declaration

created_at: string
description: string
events: Array<string>
external_url: string
html_url: string
id: number
name: string
node_id: string
owner: ReposReplaceProtectedBranchAppRestrictionsResponseDataItemOwner
permissions: ReposReplaceProtectedBranchAppRestrictionsResponseDataItemPermissions
slug: string
updated_at: string

ReposReplaceProtectedBranchAppRestrictionsResponseDataItemOwner

ReposReplaceProtectedBranchAppRestrictionsResponseDataItemOwner: object

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

ReposReplaceProtectedBranchAppRestrictionsResponseDataItemPermissions

ReposReplaceProtectedBranchAppRestrictionsResponseDataItemPermissions: object

Type declaration

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

ReposReplaceProtectedBranchRequiredStatusChecksContextsEndpoint

ReposReplaceProtectedBranchRequiredStatusChecksContextsEndpoint: object

Type declaration

branch: string

branch parameter
contexts: string[]

contexts parameter
owner: string

owner parameter
repo: string

repo parameter

ReposReplaceProtectedBranchRequiredStatusChecksContextsRequestOptions

ReposReplaceProtectedBranchRequiredStatusChecksContextsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PUT"
request: RequestRequestOptions
url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"

ReposReplaceProtectedBranchRequiredStatusChecksContextsResponseData

ReposReplaceProtectedBranchRequiredStatusChecksContextsResponseData: Array<string>

ReposReplaceProtectedBranchTeamRestrictionsEndpoint

ReposReplaceProtectedBranchTeamRestrictionsEndpoint: object

Type declaration

branch: string

branch parameter
owner: string

owner parameter
repo: string

repo parameter
teams: string[]

teams parameter

ReposReplaceProtectedBranchTeamRestrictionsRequestOptions

ReposReplaceProtectedBranchTeamRestrictionsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PUT"
request: RequestRequestOptions
url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"

ReposReplaceProtectedBranchTeamRestrictionsResponseData

ReposReplaceProtectedBranchTeamRestrictionsResponseData: Array<ReposReplaceProtectedBranchTeamRestrictionsResponseDataItem>

ReposReplaceProtectedBranchTeamRestrictionsResponseDataItem

ReposReplaceProtectedBranchTeamRestrictionsResponseDataItem: object

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

ReposReplaceProtectedBranchUserRestrictionsEndpoint

ReposReplaceProtectedBranchUserRestrictionsEndpoint: object

Type declaration

branch: string

branch parameter
owner: string

owner parameter
repo: string

repo parameter
users: string[]

users parameter

ReposReplaceProtectedBranchUserRestrictionsRequestOptions

ReposReplaceProtectedBranchUserRestrictionsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PUT"
request: RequestRequestOptions
url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"

ReposReplaceProtectedBranchUserRestrictionsResponseData

ReposReplaceProtectedBranchUserRestrictionsResponseData: Array<ReposReplaceProtectedBranchUserRestrictionsResponseDataItem>

ReposReplaceProtectedBranchUserRestrictionsResponseDataItem

ReposReplaceProtectedBranchUserRestrictionsResponseDataItem: object

Type declaration

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

ReposRequestPageBuildEndpoint

ReposRequestPageBuildEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter

ReposRequestPageBuildRequestOptions

ReposRequestPageBuildRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/pages/builds"

ReposRequestPageBuildResponseData

ReposRequestPageBuildResponseData: object

Type declaration

status: string
url: string

ReposRetrieveCommunityProfileMetricsEndpoint

ReposRetrieveCommunityProfileMetricsEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter

ReposRetrieveCommunityProfileMetricsRequestOptions

ReposRetrieveCommunityProfileMetricsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/repos/:owner/:repo/community/profile"

ReposRetrieveCommunityProfileMetricsResponseData

ReposRetrieveCommunityProfileMetricsResponseData: object

Type declaration

description: string
documentation: boolean
files: ReposRetrieveCommunityProfileMetricsResponseDataFiles
health_percentage: number
updated_at: string

ReposRetrieveCommunityProfileMetricsResponseDataFiles

ReposRetrieveCommunityProfileMetricsResponseDataFiles: object

Type declaration

code_of_conduct: ReposRetrieveCommunityProfileMetricsResponseDataFilesCodeOfConduct
contributing: ReposRetrieveCommunityProfileMetricsResponseDataFilesContributing
issue_template: ReposRetrieveCommunityProfileMetricsResponseDataFilesIssueTemplate
license: ReposRetrieveCommunityProfileMetricsResponseDataFilesLicense
pull_request_template: ReposRetrieveCommunityProfileMetricsResponseDataFilesPullRequestTemplate
readme: ReposRetrieveCommunityProfileMetricsResponseDataFilesReadme

ReposRetrieveCommunityProfileMetricsResponseDataFilesCodeOfConduct

ReposRetrieveCommunityProfileMetricsResponseDataFilesCodeOfConduct: object

Type declaration

html_url: string
key: string
name: string
url: string

ReposRetrieveCommunityProfileMetricsResponseDataFilesContributing

ReposRetrieveCommunityProfileMetricsResponseDataFilesContributing: object

Type declaration

html_url: string
url: string

ReposRetrieveCommunityProfileMetricsResponseDataFilesIssueTemplate

ReposRetrieveCommunityProfileMetricsResponseDataFilesIssueTemplate: object

Type declaration

html_url: string
url: string

ReposRetrieveCommunityProfileMetricsResponseDataFilesLicense

ReposRetrieveCommunityProfileMetricsResponseDataFilesLicense: object

Type declaration

html_url: string
key: string
name: string
spdx_id: string
url: string

ReposRetrieveCommunityProfileMetricsResponseDataFilesPullRequestTemplate

ReposRetrieveCommunityProfileMetricsResponseDataFilesPullRequestTemplate: object

Type declaration

html_url: string
url: string

ReposRetrieveCommunityProfileMetricsResponseDataFilesReadme

ReposRetrieveCommunityProfileMetricsResponseDataFilesReadme: object

Type declaration

html_url: string
url: string

ReposTestPushHookEndpoint

ReposTestPushHookEndpoint: object

Type declaration

hook_id: number

hook_id parameter
owner: string

owner parameter
repo: string

repo parameter

ReposTestPushHookRequestOptions

ReposTestPushHookRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/hooks/:hook_id/tests"

ReposTransferEndpoint

ReposTransferEndpoint: object

Type declaration

Optional new_owner?: string

Required: The username or organization name the repository will be transferred to.
owner: string

owner parameter
repo: string

repo parameter
Optional team_ids?: number[]

ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.

ReposTransferRequestOptions

ReposTransferRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/transfer"

ReposTransferResponseData

ReposTransferResponseData: object

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: ReposTransferResponseDataOwner
permissions: ReposTransferResponseDataPermissions
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

ReposTransferResponseDataOwner

ReposTransferResponseDataOwner: object

Type declaration

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

ReposTransferResponseDataPermissions

ReposTransferResponseDataPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

ReposUpdateBranchProtectionEndpoint

ReposUpdateBranchProtectionEndpoint: object

Type declaration

Optional allow_deletions?: boolean

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

branch parameter
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

owner parameter
repo: string

repo parameter
Optional required_linear_history?: boolean

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: object

Type declaration

Optional dismiss_stale_reviews?: boolean
Optional dismissal_restrictions?: ReposUpdateBranchProtectionParamsRequiredPullRequestReviewsDismissalRestrictions
Optional require_code_owner_reviews?: boolean
Optional required_approving_review_count?: number

ReposUpdateBranchProtectionParamsRequiredPullRequestReviewsDismissalRestrictions

ReposUpdateBranchProtectionParamsRequiredPullRequestReviewsDismissalRestrictions: object

Type declaration

Optional teams?: string[]
Optional users?: string[]

ReposUpdateBranchProtectionParamsRequiredStatusChecks

ReposUpdateBranchProtectionParamsRequiredStatusChecks: object

Type declaration

contexts: string[]
strict: boolean

ReposUpdateBranchProtectionParamsRestrictions

ReposUpdateBranchProtectionParamsRestrictions: object

Type declaration

Optional apps?: string[]
teams: string[]
users: string[]

ReposUpdateBranchProtectionRequestOptions

ReposUpdateBranchProtectionRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PUT"
request: RequestRequestOptions
url: "/repos/:owner/:repo/branches/:branch/protection"

ReposUpdateBranchProtectionResponseData

ReposUpdateBranchProtectionResponseData: object

Type declaration

allow_deletions: ReposUpdateBranchProtectionResponseDataAllowDeletions
allow_force_pushes: ReposUpdateBranchProtectionResponseDataAllowForcePushes
enforce_admins: ReposUpdateBranchProtectionResponseDataEnforceAdmins
required_linear_history: ReposUpdateBranchProtectionResponseDataRequiredLinearHistory
required_pull_request_reviews: ReposUpdateBranchProtectionResponseDataRequiredPullRequestReviews
required_status_checks: ReposUpdateBranchProtectionResponseDataRequiredStatusChecks
restrictions: ReposUpdateBranchProtectionResponseDataRestrictions
url: string

ReposUpdateBranchProtectionResponseDataAllowDeletions

ReposUpdateBranchProtectionResponseDataAllowDeletions: object

Type declaration

enabled: boolean

ReposUpdateBranchProtectionResponseDataAllowForcePushes

ReposUpdateBranchProtectionResponseDataAllowForcePushes: object

Type declaration

enabled: boolean

ReposUpdateBranchProtectionResponseDataEnforceAdmins

ReposUpdateBranchProtectionResponseDataEnforceAdmins: object

Type declaration

enabled: boolean
url: string

ReposUpdateBranchProtectionResponseDataRequiredLinearHistory

ReposUpdateBranchProtectionResponseDataRequiredLinearHistory: object

Type declaration

enabled: boolean

ReposUpdateBranchProtectionResponseDataRequiredPullRequestReviews

ReposUpdateBranchProtectionResponseDataRequiredPullRequestReviews: object

Type declaration

dismiss_stale_reviews: boolean
dismissal_restrictions: ReposUpdateBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictions
require_code_owner_reviews: boolean
required_approving_review_count: number
url: string

ReposUpdateBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictions

ReposUpdateBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictions: object

Type declaration

teams: Array<ReposUpdateBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictionsTeamsItem>
teams_url: string
url: string
users: Array<ReposUpdateBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictionsUsersItem>
users_url: string

ReposUpdateBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictionsTeamsItem

ReposUpdateBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictionsTeamsItem: object

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

ReposUpdateBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictionsUsersItem

ReposUpdateBranchProtectionResponseDataRequiredPullRequestReviewsDismissalRestrictionsUsersItem: object

Type declaration

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

ReposUpdateBranchProtectionResponseDataRequiredStatusChecks

ReposUpdateBranchProtectionResponseDataRequiredStatusChecks: object

Type declaration

contexts: Array<string>
contexts_url: string
strict: boolean
url: string

ReposUpdateBranchProtectionResponseDataRestrictions

ReposUpdateBranchProtectionResponseDataRestrictions: object

Type declaration

apps: Array<ReposUpdateBranchProtectionResponseDataRestrictionsAppsItem>
apps_url: string
teams: Array<ReposUpdateBranchProtectionResponseDataRestrictionsTeamsItem>
teams_url: string
url: string
users: Array<ReposUpdateBranchProtectionResponseDataRestrictionsUsersItem>
users_url: string

ReposUpdateBranchProtectionResponseDataRestrictionsAppsItem

ReposUpdateBranchProtectionResponseDataRestrictionsAppsItem: object

Type declaration

created_at: string
description: string
events: Array<string>
external_url: string
html_url: string
id: number
name: string
node_id: string
owner: ReposUpdateBranchProtectionResponseDataRestrictionsAppsItemOwner
permissions: ReposUpdateBranchProtectionResponseDataRestrictionsAppsItemPermissions
slug: string
updated_at: string

ReposUpdateBranchProtectionResponseDataRestrictionsAppsItemOwner

ReposUpdateBranchProtectionResponseDataRestrictionsAppsItemOwner: object

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

ReposUpdateBranchProtectionResponseDataRestrictionsAppsItemPermissions

ReposUpdateBranchProtectionResponseDataRestrictionsAppsItemPermissions: object

Type declaration

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

ReposUpdateBranchProtectionResponseDataRestrictionsTeamsItem

ReposUpdateBranchProtectionResponseDataRestrictionsTeamsItem: object

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

ReposUpdateBranchProtectionResponseDataRestrictionsUsersItem

ReposUpdateBranchProtectionResponseDataRestrictionsUsersItem: object

Type declaration

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

ReposUpdateCommitCommentEndpoint

ReposUpdateCommitCommentEndpoint: object

Type declaration

body: string

The contents of the comment
comment_id: number

comment_id parameter
owner: string

owner parameter
repo: string

repo parameter

ReposUpdateCommitCommentRequestOptions

ReposUpdateCommitCommentRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PATCH"
request: RequestRequestOptions
url: "/repos/:owner/:repo/comments/:comment_id"

ReposUpdateCommitCommentResponseData

ReposUpdateCommitCommentResponseData: object

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: ReposUpdateCommitCommentResponseDataUser

ReposUpdateCommitCommentResponseDataUser

ReposUpdateCommitCommentResponseDataUser: object

Type declaration

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

ReposUpdateEndpoint

ReposUpdateEndpoint: object

Type declaration

Optional allow_merge_commit?: boolean

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?: boolean

Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.
Optional allow_squash_merge?: boolean

Either true to allow squash-merging pull requests, or false to prevent squash-merging.
Optional archived?: boolean

true to archive this repository. Note: You cannot unarchive repositories through the API.
Optional default_branch?: string

Updates the default branch for this repository.
Optional delete_branch_on_merge?: boolean

Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.
Optional description?: string

A short description of the repository.
Optional has_issues?: boolean

Either true to enable issues for this repository or false to disable them.
Optional has_projects?: boolean

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?: boolean

Either true to enable the wiki for this repository or false to disable it.
Optional homepage?: string

A URL with more information about the repository.
Optional is_template?: boolean

Either true to make this repo available as a template repository or false to prevent it.
Optional name?: string

The name of the repository.
owner: string

owner parameter
Optional private?: boolean

Either true to make the repository private or false to make it public. 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

repo parameter
Optional visibility?: "public" | "private" | "visibility" | "internal"

Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. The visibility parameter overrides the private parameter when you use both along with the nebula-preview preview header.

ReposUpdateHookEndpoint

ReposUpdateHookEndpoint: object

Type declaration

Optional active?: boolean

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

hook_id parameter
owner: string

owner parameter
Optional remove_events?: string[]

Determines a list of events to be removed from the list of events that the Hook triggers for.
repo: string

repo parameter

ReposUpdateHookParamsConfig

ReposUpdateHookParamsConfig: object

Type declaration

Optional content_type?: string
Optional insecure_ssl?: string
Optional secret?: string
url: string

ReposUpdateHookRequestOptions

ReposUpdateHookRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PATCH"
request: RequestRequestOptions
url: "/repos/:owner/:repo/hooks/:hook_id"

ReposUpdateHookResponseData

ReposUpdateHookResponseData: object

Type declaration

active: boolean
config: ReposUpdateHookResponseDataConfig
created_at: string
events: Array<string>
id: number
last_response: ReposUpdateHookResponseDataLastResponse
name: string
ping_url: string
test_url: string
type: string
updated_at: string
url: string

ReposUpdateHookResponseDataConfig

ReposUpdateHookResponseDataConfig: object

Type declaration

content_type: string
insecure_ssl: string
url: string

ReposUpdateHookResponseDataLastResponse

ReposUpdateHookResponseDataLastResponse: object

Type declaration

code: null
message: null
status: string

ReposUpdateInformationAboutPagesSiteEndpoint

ReposUpdateInformationAboutPagesSiteEndpoint: object

Type declaration

Optional cname?: 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

owner parameter
repo: string

repo parameter
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".

ReposUpdateInformationAboutPagesSiteRequestOptions

ReposUpdateInformationAboutPagesSiteRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PUT"
request: RequestRequestOptions
url: "/repos/:owner/:repo/pages"

ReposUpdateInvitationEndpoint

ReposUpdateInvitationEndpoint: object

Type declaration

invitation_id: number

invitation_id parameter
owner: string

owner parameter
Optional permissions?: "read" | "write" | "maintain" | "triage" | "admin"

The permissions that the associated user will have on the repository. Valid values are read, write, maintain, triage, and admin.
repo: string

repo parameter

ReposUpdateInvitationRequestOptions

ReposUpdateInvitationRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PATCH"
request: RequestRequestOptions
url: "/repos/:owner/:repo/invitations/:invitation_id"

ReposUpdateInvitationResponseData

ReposUpdateInvitationResponseData: object

Type declaration

created_at: string
html_url: string
id: number
invitee: ReposUpdateInvitationResponseDataInvitee
inviter: ReposUpdateInvitationResponseDataInviter
permissions: string
repository: ReposUpdateInvitationResponseDataRepository
url: string

ReposUpdateInvitationResponseDataInvitee

ReposUpdateInvitationResponseDataInvitee: object

Type declaration

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

ReposUpdateInvitationResponseDataInviter

ReposUpdateInvitationResponseDataInviter: object

Type declaration

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

ReposUpdateInvitationResponseDataRepository

ReposUpdateInvitationResponseDataRepository: object

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: ReposUpdateInvitationResponseDataRepositoryOwner
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

ReposUpdateInvitationResponseDataRepositoryOwner

ReposUpdateInvitationResponseDataRepositoryOwner: object

Type declaration

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

ReposUpdateProtectedBranchPullRequestReviewEnforcementEndpoint

ReposUpdateProtectedBranchPullRequestReviewEnforcementEndpoint: object

Type declaration

branch: string

branch parameter
Optional dismiss_stale_reviews?: boolean

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

owner parameter
repo: string

repo parameter
Optional require_code_owner_reviews?: boolean

Blocks merging pull requests until code owners have reviewed.
Optional required_approving_review_count?: number

Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6.

ReposUpdateProtectedBranchPullRequestReviewEnforcementParamsDismissalRestrictions

ReposUpdateProtectedBranchPullRequestReviewEnforcementParamsDismissalRestrictions: object

Type declaration

Optional teams?: string[]
Optional users?: string[]

ReposUpdateProtectedBranchPullRequestReviewEnforcementRequestOptions

ReposUpdateProtectedBranchPullRequestReviewEnforcementRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PATCH"
request: RequestRequestOptions
url: "/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews"

ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseData

ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseData: object

Type declaration

dismiss_stale_reviews: boolean
dismissal_restrictions: ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictions
require_code_owner_reviews: boolean
required_approving_review_count: number
url: string

ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictions

ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictions: object

Type declaration

teams: Array<ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictionsTeamsItem>
teams_url: string
url: string
users: Array<ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictionsUsersItem>
users_url: string

ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictionsTeamsItem

ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictionsTeamsItem: object

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

ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictionsUsersItem

ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDataDismissalRestrictionsUsersItem: object

Type declaration

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

ReposUpdateProtectedBranchRequiredStatusChecksEndpoint

ReposUpdateProtectedBranchRequiredStatusChecksEndpoint: object

Type declaration

branch: string

branch parameter
Optional contexts?: string[]

The list of status checks to require in order to merge into this branch
owner: string

owner parameter
repo: string

repo parameter
Optional strict?: boolean

Require branches to be up to date before merging.

ReposUpdateProtectedBranchRequiredStatusChecksRequestOptions

ReposUpdateProtectedBranchRequiredStatusChecksRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PATCH"
request: RequestRequestOptions
url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks"

ReposUpdateProtectedBranchRequiredStatusChecksResponseData

ReposUpdateProtectedBranchRequiredStatusChecksResponseData: object

Type declaration

contexts: Array<string>
contexts_url: string
strict: boolean
url: string

ReposUpdateReleaseAssetEndpoint

ReposUpdateReleaseAssetEndpoint: object

Type declaration

asset_id: number

asset_id parameter
Optional label?: string

An alternate short description of the asset. Used in place of the filename.
Optional name?: string

The file name of the asset.
owner: string

owner parameter
repo: string

repo parameter

ReposUpdateReleaseAssetRequestOptions

ReposUpdateReleaseAssetRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PATCH"
request: RequestRequestOptions
url: "/repos/:owner/:repo/releases/assets/:asset_id"

ReposUpdateReleaseAssetResponseData

ReposUpdateReleaseAssetResponseData: object

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: ReposUpdateReleaseAssetResponseDataUploader
url: string

ReposUpdateReleaseAssetResponseDataUploader

ReposUpdateReleaseAssetResponseDataUploader: object

Type declaration

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

ReposUpdateReleaseEndpoint

ReposUpdateReleaseEndpoint: object

Type declaration

Optional body?: string

Text describing the contents of the tag.
Optional draft?: boolean

true makes the release a draft, and false publishes the release.
Optional name?: string

The name of the release.
owner: string

owner parameter
Optional prerelease?: boolean

true to identify the release as a prerelease, false to identify the release as a full release.
release_id: number

release_id parameter
repo: string

repo parameter
Optional tag_name?: string

The name of the tag.
Optional target_commitish?: 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).

ReposUpdateReleaseRequestOptions

ReposUpdateReleaseRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PATCH"
request: RequestRequestOptions
url: "/repos/:owner/:repo/releases/:release_id"

ReposUpdateReleaseResponseData

ReposUpdateReleaseResponseData: object

Type declaration

assets: Array<ReposUpdateReleaseResponseDataAssetsItem>
assets_url: string
author: ReposUpdateReleaseResponseDataAuthor
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

ReposUpdateReleaseResponseDataAssetsItem

ReposUpdateReleaseResponseDataAssetsItem: object

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: ReposUpdateReleaseResponseDataAssetsItemUploader
url: string

ReposUpdateReleaseResponseDataAssetsItemUploader

ReposUpdateReleaseResponseDataAssetsItemUploader: object

Type declaration

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

ReposUpdateReleaseResponseDataAuthor

ReposUpdateReleaseResponseDataAuthor: object

Type declaration

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

ReposUpdateRequestOptions

ReposUpdateRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PATCH"
request: RequestRequestOptions
url: "/repos/:owner/:repo"

ReposUpdateResponseData

ReposUpdateResponseData: object

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: ReposUpdateResponseDataOrganization
owner: ReposUpdateResponseDataOwner
parent: ReposUpdateResponseDataParent
permissions: ReposUpdateResponseDataPermissions
private: boolean
pulls_url: string
pushed_at: string
releases_url: string
size: number
source: ReposUpdateResponseDataSource
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

ReposUpdateResponseDataOrganization

ReposUpdateResponseDataOrganization: object

Type declaration

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

ReposUpdateResponseDataOwner

ReposUpdateResponseDataOwner: object

Type declaration

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

ReposUpdateResponseDataParent

ReposUpdateResponseDataParent: object

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: ReposUpdateResponseDataParentOwner
permissions: ReposUpdateResponseDataParentPermissions
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

ReposUpdateResponseDataParentOwner

ReposUpdateResponseDataParentOwner: object

Type declaration

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

ReposUpdateResponseDataParentPermissions

ReposUpdateResponseDataParentPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

ReposUpdateResponseDataPermissions

ReposUpdateResponseDataPermissions: object

Type declaration

admin: boolean
maintain: boolean
pull: boolean
push: boolean
triage: boolean

ReposUpdateResponseDataSource

ReposUpdateResponseDataSource: object

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: ReposUpdateResponseDataSourceOwner
permissions: ReposUpdateResponseDataSourcePermissions
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

ReposUpdateResponseDataSourceOwner

ReposUpdateResponseDataSourceOwner: object

Type declaration

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

ReposUpdateResponseDataSourcePermissions

ReposUpdateResponseDataSourcePermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

ReposUploadReleaseAssetEndpoint

ReposUploadReleaseAssetEndpoint: object & object

ReposUploadReleaseAssetRequestOptions

ReposUploadReleaseAssetRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/repos/:owner/:repo/releases/:release_id/assets{?name,label}"

ReposUploadReleaseAssetResponseData

ReposUploadReleaseAssetResponseData: object

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: ReposUploadReleaseAssetResponseDataUploader
url: string

ReposUploadReleaseAssetResponseDataUploader

ReposUploadReleaseAssetResponseDataUploader: object

Type declaration

avatar_url: string
events_url: string
followers_url: string
following_url: string
gists_url: string
gravatar_id: string
html_url: string
id: number
login: string
node_id: 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: object

Type declaration

[header: string]: string | number | undefined
Optional accept?: string

Avoid setting headers.accept, use mediaType.{format|previews} option instead.
Optional authorization?: string

Use authorization to send authenticated request, remember token / bearer prefixes. Example: token 1234567890abcdef1234567890abcdef12345678
Optional user-agent?: string

user-agent is set do a default and can be overwritten as needed.

RequestMethod

HTTP Verb supported by GitHub's REST API

RequestOptions

RequestOptions: object

Generic request options as they are returned by the endpoint() method

Type declaration

Optional body?: any
headers: RequestHeaders
method: RequestMethod
Optional request?: RequestRequestOptions
url: Url

RequestParameters

RequestParameters: object

Parameters that can be passed into request(route, parameters) or endpoint(route, parameters) methods

Type declaration

[parameter: string]: any
Any additional parameter will be passed as follows
1. URL parameter if ':parameter' or {parameter} is part of url
2. Query parameter if method is 'GET' or 'HEAD'
3. Request body if parameter is 'data'
4. JSON in the request body in the form of body[parameter] unless parameter key is 'data'
Optional baseUrl?: Url

Base URL to be used when a relative URL is passed, such as /orgs/:org. If baseUrl is https://enterprise.acme-inc.com/api/v3, then the request will be sent to https://enterprise.acme-inc.com/api/v3/orgs/:org.
Optional headers?: RequestHeaders

HTTP headers. Use lowercase keys.
Optional mediaType?: object

Media type options, see GitHub Developer Guide
- Optional format?: string
  
  json by default. Can be raw, text, html, full, diff, patch, sha, base64. Depending on endpoint
- Optional previews?: string[]
  
  Custom media type names of API Previews without the -preview suffix. Example for single preview: ['squirrel-girl']. Example for multiple previews: ['squirrel-girl', 'mister-fantastic'].
Optional request?: RequestRequestOptions

Pass custom meta information for the request. The request object will be returned as is.

RequestRequestOptions

RequestRequestOptions: object

Octokit-specific request options which are ignored for the actual request, but can be used by Octokit or plugins to manipulate how the request is sent or how a response is handled

Type declaration

[option: string]: any
Optional agent?: Agent

Node only. Useful for custom proxy, certificate, or dns lookup.
Optional fetch?: Fetch

Custom replacement for built-in fetch method. Useful for testing or request hooks.
Optional signal?: Signal

Use an AbortController instance to cancel a request. In node you can only cancel streamed requests.
Optional timeout?: number

Node only. Request/response timeout in ms, it resets on redirect. 0 to disable (OS limit applies). options.request.signal is recommended instead.

RequiredPreview

RequiredPreview<T>: object

Type parameters

Type declaration

mediaType: object
- previews: [T, string]

ResponseHeaders

ResponseHeaders: object

Type declaration

[header: string]: string | number | undefined
Optional cache-control?: string
Optional content-length?: number
Optional content-type?: string
Optional date?: string
Optional etag?: string
Optional last-modified?: string
Optional link?: string
Optional location?: string
Optional server?: string
Optional status?: string
Optional vary?: string
Optional x-github-mediatype?: string
Optional x-github-request-id?: string
Optional x-oauth-scopes?: string
Optional x-ratelimit-limit?: string
Optional x-ratelimit-remaining?: string
Optional x-ratelimit-reset?: string

Route

Route: string

String consisting of an optional HTTP method and relative path or absolute URL. Examples: '/orgs/:org', 'PUT /orgs/:org', GET https://example.com/foo/bar

ScimGetProvisioningDetailsForUserEndpoint

ScimGetProvisioningDetailsForUserEndpoint: object

Type declaration

org: string

org parameter
scim_user_id: number

scim_user_id parameter

ScimGetProvisioningDetailsForUserRequestOptions

ScimGetProvisioningDetailsForUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/scim/v2/organizations/:org/Users/:scim_user_id"

ScimGetProvisioningDetailsForUserResponseData

ScimGetProvisioningDetailsForUserResponseData: object

Type declaration

active: boolean
emails: Array<ScimGetProvisioningDetailsForUserResponseDataEmailsItem>
externalId: string
id: string
meta: ScimGetProvisioningDetailsForUserResponseDataMeta
name: ScimGetProvisioningDetailsForUserResponseDataName
schemas: Array<string>
userName: string

ScimGetProvisioningDetailsForUserResponseDataEmailsItem

ScimGetProvisioningDetailsForUserResponseDataEmailsItem: object

Type declaration

primary: boolean
type: string
value: string

ScimGetProvisioningDetailsForUserResponseDataMeta

ScimGetProvisioningDetailsForUserResponseDataMeta: object

Type declaration

created: string
lastModified: string
location: string
resourceType: string

ScimGetProvisioningDetailsForUserResponseDataName

ScimGetProvisioningDetailsForUserResponseDataName: object

Type declaration

familyName: string
givenName: string

ScimListProvisionedIdentitiesEndpoint

ScimListProvisionedIdentitiesEndpoint: object

Type declaration

Optional count?: number

Used for pagination: the number of results to return.
Optional filter?: string

Filters results using the equals query parameter operator (eq). You can filter results that are equal to id, userName, emails, and external_id. For example, to search for an identity with the userName Octocat, you would use this query: ?filter=userName%20eq%20\"Octocat\".
org: string

org parameter
Optional startIndex?: number

Used for pagination: the index of the first result to return.

ScimListProvisionedIdentitiesRequestOptions

ScimListProvisionedIdentitiesRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/scim/v2/organizations/:org/Users"

ScimListProvisionedIdentitiesResponseData

ScimListProvisionedIdentitiesResponseData: object

Type declaration

Resources: Array<ScimListProvisionedIdentitiesResponseDataResourcesItem>
itemsPerPage: number
schemas: Array<string>
startIndex: number
totalResults: number

ScimListProvisionedIdentitiesResponseDataResourcesItem

ScimListProvisionedIdentitiesResponseDataResourcesItem: object

Type declaration

active: boolean
emails: Array<ScimListProvisionedIdentitiesResponseDataResourcesItemEmailsItem>
externalId: string
id: string
meta: ScimListProvisionedIdentitiesResponseDataResourcesItemMeta
name: ScimListProvisionedIdentitiesResponseDataResourcesItemName
schemas: Array<string>
userName: string

ScimListProvisionedIdentitiesResponseDataResourcesItemEmailsItem

ScimListProvisionedIdentitiesResponseDataResourcesItemEmailsItem: object

Type declaration

primary: boolean
type: string
value: string

ScimListProvisionedIdentitiesResponseDataResourcesItemMeta

ScimListProvisionedIdentitiesResponseDataResourcesItemMeta: object

Type declaration

created: string
lastModified: string
location: string
resourceType: string

ScimListProvisionedIdentitiesResponseDataResourcesItemName

ScimListProvisionedIdentitiesResponseDataResourcesItemName: object

Type declaration

familyName: string
givenName: string

ScimProvisionAndInviteUsersEndpoint

ScimProvisionAndInviteUsersEndpoint: object

Type declaration

org: string

org parameter

ScimProvisionAndInviteUsersRequestOptions

ScimProvisionAndInviteUsersRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/scim/v2/organizations/:org/Users"

ScimProvisionAndInviteUsersResponseData

ScimProvisionAndInviteUsersResponseData: object

Type declaration

active: boolean
emails: Array<ScimProvisionAndInviteUsersResponseDataEmailsItem>
externalId: string
id: string
meta: ScimProvisionAndInviteUsersResponseDataMeta
name: ScimProvisionAndInviteUsersResponseDataName
schemas: Array<string>
userName: string

ScimProvisionAndInviteUsersResponseDataEmailsItem

ScimProvisionAndInviteUsersResponseDataEmailsItem: object

Type declaration

primary: boolean
type: string
value: string

ScimProvisionAndInviteUsersResponseDataMeta

ScimProvisionAndInviteUsersResponseDataMeta: object

Type declaration

created: string
lastModified: string
location: string
resourceType: string

ScimProvisionAndInviteUsersResponseDataName

ScimProvisionAndInviteUsersResponseDataName: object

Type declaration

familyName: string
givenName: string

ScimRemoveUserFromOrgEndpoint

ScimRemoveUserFromOrgEndpoint: object

Type declaration

org: string

org parameter
scim_user_id: number

scim_user_id parameter

ScimRemoveUserFromOrgRequestOptions

ScimRemoveUserFromOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/scim/v2/organizations/:org/Users/:scim_user_id"

ScimReplaceProvisionedUserInformationEndpoint

ScimReplaceProvisionedUserInformationEndpoint: object

Type declaration

org: string

org parameter
scim_user_id: number

scim_user_id parameter

ScimReplaceProvisionedUserInformationRequestOptions

ScimReplaceProvisionedUserInformationRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PUT"
request: RequestRequestOptions
url: "/scim/v2/organizations/:org/Users/:scim_user_id"

ScimReplaceProvisionedUserInformationResponseData

ScimReplaceProvisionedUserInformationResponseData: object

Type declaration

active: boolean
emails: Array<ScimReplaceProvisionedUserInformationResponseDataEmailsItem>
externalId: string
id: string
meta: ScimReplaceProvisionedUserInformationResponseDataMeta
name: ScimReplaceProvisionedUserInformationResponseDataName
schemas: Array<string>
userName: string

ScimReplaceProvisionedUserInformationResponseDataEmailsItem

ScimReplaceProvisionedUserInformationResponseDataEmailsItem: object

Type declaration

primary: boolean
type: string
value: string

ScimReplaceProvisionedUserInformationResponseDataMeta

ScimReplaceProvisionedUserInformationResponseDataMeta: object

Type declaration

created: string
lastModified: string
location: string
resourceType: string

ScimReplaceProvisionedUserInformationResponseDataName

ScimReplaceProvisionedUserInformationResponseDataName: object

Type declaration

familyName: string
givenName: string

ScimUpdateUserAttributeEndpoint

ScimUpdateUserAttributeEndpoint: object

Type declaration

org: string

org parameter
scim_user_id: number

scim_user_id parameter

ScimUpdateUserAttributeRequestOptions

ScimUpdateUserAttributeRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PATCH"
request: RequestRequestOptions
url: "/scim/v2/organizations/:org/Users/:scim_user_id"

ScimUpdateUserAttributeResponseData

ScimUpdateUserAttributeResponseData: object

Type declaration

active: boolean
emails: Array<ScimUpdateUserAttributeResponseDataEmailsItem>
externalId: string
id: string
meta: ScimUpdateUserAttributeResponseDataMeta
name: ScimUpdateUserAttributeResponseDataName
schemas: Array<string>
userName: string

ScimUpdateUserAttributeResponseDataEmailsItem

ScimUpdateUserAttributeResponseDataEmailsItem: object

Type declaration

Optional primary?: boolean
type: string
value: string

ScimUpdateUserAttributeResponseDataMeta

ScimUpdateUserAttributeResponseDataMeta: object

Type declaration

created: string
lastModified: string
location: string
resourceType: string

ScimUpdateUserAttributeResponseDataName

ScimUpdateUserAttributeResponseDataName: object

Type declaration

familyName: string
givenName: string

SearchCodeEndpoint

SearchCodeEndpoint: object

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?: number

Page number of the results to fetch.
Optional per_page?: 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?: "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

SearchCodeRequestOptions

SearchCodeRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/search/code"

SearchCodeResponseData

SearchCodeResponseData: object

Type declaration

incomplete_results: boolean
items: Array<SearchCodeResponseDataItemsItem>
total_count: number

SearchCodeResponseDataItemsItem

SearchCodeResponseDataItemsItem: object

Type declaration

git_url: string
html_url: string
name: string
path: string
repository: SearchCodeResponseDataItemsItemRepository
score: number
sha: string
url: string

SearchCodeResponseDataItemsItemRepository

SearchCodeResponseDataItemsItemRepository: object

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: SearchCodeResponseDataItemsItemRepositoryOwner
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

SearchCodeResponseDataItemsItemRepositoryOwner

SearchCodeResponseDataItemsItemRepositoryOwner: object

Type declaration

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

SearchCommitsEndpoint

SearchCommitsEndpoint: object & RequiredPreview<"cloak">

SearchCommitsRequestOptions

SearchCommitsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/search/commits"

SearchCommitsResponseData

SearchCommitsResponseData: object

Type declaration

incomplete_results: boolean
items: Array<SearchCommitsResponseDataItemsItem>
total_count: number

SearchCommitsResponseDataItemsItem

SearchCommitsResponseDataItemsItem: object

Type declaration

author: SearchCommitsResponseDataItemsItemAuthor
comments_url: string
commit: SearchCommitsResponseDataItemsItemCommit
committer: SearchCommitsResponseDataItemsItemCommitter
html_url: string
parents: Array<SearchCommitsResponseDataItemsItemParentsItem>
repository: SearchCommitsResponseDataItemsItemRepository
score: number
sha: string
url: string

SearchCommitsResponseDataItemsItemAuthor

SearchCommitsResponseDataItemsItemAuthor: object

Type declaration

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

SearchCommitsResponseDataItemsItemCommit

SearchCommitsResponseDataItemsItemCommit: object

Type declaration

author: SearchCommitsResponseDataItemsItemCommitAuthor
comment_count: number
committer: SearchCommitsResponseDataItemsItemCommitCommitter
message: string
tree: SearchCommitsResponseDataItemsItemCommitTree
url: string

SearchCommitsResponseDataItemsItemCommitAuthor

SearchCommitsResponseDataItemsItemCommitAuthor: object

Type declaration

date: string
email: string
name: string

SearchCommitsResponseDataItemsItemCommitCommitter

SearchCommitsResponseDataItemsItemCommitCommitter: object

Type declaration

date: string
email: string
name: string

SearchCommitsResponseDataItemsItemCommitTree

SearchCommitsResponseDataItemsItemCommitTree: object

Type declaration

sha: string
url: string

SearchCommitsResponseDataItemsItemCommitter

SearchCommitsResponseDataItemsItemCommitter: object

Type declaration

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

SearchCommitsResponseDataItemsItemParentsItem

SearchCommitsResponseDataItemsItemParentsItem: object

Type declaration

html_url: string
sha: string
url: string

SearchCommitsResponseDataItemsItemRepository

SearchCommitsResponseDataItemsItemRepository: object

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: SearchCommitsResponseDataItemsItemRepositoryOwner
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

SearchCommitsResponseDataItemsItemRepositoryOwner

SearchCommitsResponseDataItemsItemRepositoryOwner: object

Type declaration

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

SearchEmailLegacyEndpoint

SearchEmailLegacyEndpoint: object

Type declaration

email: string

The email address.

SearchEmailLegacyRequestOptions

SearchEmailLegacyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/legacy/user/email/:email"

SearchEmailLegacyResponseData

SearchEmailLegacyResponseData: object

Type declaration

user: SearchEmailLegacyResponseDataUser

SearchEmailLegacyResponseDataUser

SearchEmailLegacyResponseDataUser: object

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

SearchIssuesAndPullRequestsEndpoint

SearchIssuesAndPullRequestsEndpoint: object

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?: number

Page number of the results to fetch.
Optional per_page?: 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

SearchIssuesAndPullRequestsRequestOptions

SearchIssuesAndPullRequestsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/search/issues"

SearchIssuesAndPullRequestsResponseData

SearchIssuesAndPullRequestsResponseData: object

Type declaration

incomplete_results: boolean
items: Array<SearchIssuesAndPullRequestsResponseDataItemsItem>
total_count: number

SearchIssuesAndPullRequestsResponseDataItemsItem

SearchIssuesAndPullRequestsResponseDataItemsItem: object

Type declaration

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<SearchIssuesAndPullRequestsResponseDataItemsItemLabelsItem>
labels_url: string
milestone: null
node_id: string
number: number
pull_request: SearchIssuesAndPullRequestsResponseDataItemsItemPullRequest
repository_url: string
score: number
state: string
title: string
updated_at: string
url: string
user: SearchIssuesAndPullRequestsResponseDataItemsItemUser

SearchIssuesAndPullRequestsResponseDataItemsItemLabelsItem

SearchIssuesAndPullRequestsResponseDataItemsItemLabelsItem: object

Type declaration

color: string
id: number
name: string
node_id: string
url: string

SearchIssuesAndPullRequestsResponseDataItemsItemPullRequest

SearchIssuesAndPullRequestsResponseDataItemsItemPullRequest: object

Type declaration

diff_url: null
html_url: null
patch_url: null

SearchIssuesAndPullRequestsResponseDataItemsItemUser

SearchIssuesAndPullRequestsResponseDataItemsItemUser: object

Type declaration

avatar_url: string
events_url: string
followers_url: string
following_url: string
gists_url: 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

SearchIssuesLegacyEndpoint

SearchIssuesLegacyEndpoint: object

Type declaration

keyword: string

The search term.
owner: string

owner parameter
repository: string

repository parameter
state: "open" | "closed"

Indicates the state of the issues to return. Can be either open or closed.

SearchIssuesLegacyRequestOptions

SearchIssuesLegacyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/legacy/issues/search/:owner/:repository/:state/:keyword"

SearchIssuesLegacyResponseData

SearchIssuesLegacyResponseData: object

Type declaration

issues: Array<SearchIssuesLegacyResponseDataIssuesItem>

SearchIssuesLegacyResponseDataIssuesItem

SearchIssuesLegacyResponseDataIssuesItem: object

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

SearchLabelsEndpoint

SearchLabelsEndpoint: object

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

SearchLabelsRequestOptions

SearchLabelsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/search/labels"

SearchLabelsResponseData

SearchLabelsResponseData: object

Type declaration

incomplete_results: boolean
items: Array<SearchLabelsResponseDataItemsItem>
total_count: number

SearchLabelsResponseDataItemsItem

SearchLabelsResponseDataItemsItem: object

Type declaration

color: string
default: boolean
description: string
id: number
name: string
node_id: string
score: number
url: string

SearchReposEndpoint

SearchReposEndpoint: object

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?: number

Page number of the results to fetch.
Optional per_page?: 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

SearchReposLegacyEndpoint

SearchReposLegacyEndpoint: object

Type declaration

keyword: string

The search term.
Optional language?: 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?: string

The page number to fetch.

SearchReposLegacyRequestOptions

SearchReposLegacyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/legacy/repos/search/:keyword"

SearchReposLegacyResponseData

SearchReposLegacyResponseData: object

Type declaration

repositories: Array<SearchReposLegacyResponseDataRepositoriesItem>

SearchReposLegacyResponseDataRepositoriesItem

SearchReposLegacyResponseDataRepositoriesItem: object

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

SearchReposRequestOptions

SearchReposRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/search/repositories"

SearchReposResponseData

SearchReposResponseData: object

Type declaration

incomplete_results: boolean
items: Array<SearchReposResponseDataItemsItem>
total_count: number

SearchReposResponseDataItemsItem

SearchReposResponseDataItemsItem: object

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: SearchReposResponseDataItemsItemOwner
private: boolean
pushed_at: string
score: number
size: number
stargazers_count: number
updated_at: string
url: string
watchers_count: number

SearchReposResponseDataItemsItemOwner

SearchReposResponseDataItemsItemOwner: object

Type declaration

avatar_url: string
gravatar_id: string
id: number
login: string
node_id: string
received_events_url: string
type: string
url: string

SearchTopicsEndpoint

SearchTopicsEndpoint: object

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.

SearchTopicsRequestOptions

SearchTopicsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/search/topics"

SearchTopicsResponseData

SearchTopicsResponseData: object

Type declaration

incomplete_results: boolean
items: Array<SearchTopicsResponseDataItemsItem>
total_count: number

SearchTopicsResponseDataItemsItem

SearchTopicsResponseDataItemsItem: object

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

SearchUsersEndpoint

SearchUsersEndpoint: object

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?: number

Page number of the results to fetch.
Optional per_page?: 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

SearchUsersLegacyEndpoint

SearchUsersLegacyEndpoint: object

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?: string

The page number to fetch.

SearchUsersLegacyRequestOptions

SearchUsersLegacyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/legacy/user/search/:keyword"

SearchUsersLegacyResponseData

SearchUsersLegacyResponseData: object

Type declaration

users: Array<SearchUsersLegacyResponseDataUsersItem>

SearchUsersLegacyResponseDataUsersItem

SearchUsersLegacyResponseDataUsersItem: object

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

SearchUsersRequestOptions

SearchUsersRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/search/users"

SearchUsersResponseData

SearchUsersResponseData: object

Type declaration

incomplete_results: boolean
items: Array<SearchUsersResponseDataItemsItem>
total_count: number

SearchUsersResponseDataItemsItem

SearchUsersResponseDataItemsItem: object

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

Signal

Signal: any

Abort signal

see: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal

TeamsAddMemberLegacyEndpoint

TeamsAddMemberLegacyEndpoint: object

Type declaration

team_id: number

team_id parameter
username: string

username parameter

TeamsAddMemberLegacyRequestOptions

TeamsAddMemberLegacyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PUT"
request: RequestRequestOptions
url: "/teams/:team_id/members/:username"

TeamsAddMemberLegacyResponseData

TeamsAddMemberLegacyResponseData: object

Type declaration

errors: Array<TeamsAddMemberLegacyResponseDataErrorsItem>
message: string

TeamsAddMemberLegacyResponseDataErrorsItem

TeamsAddMemberLegacyResponseDataErrorsItem: object

Type declaration

code: string
field: string
resource: string

TeamsAddOrUpdateMembershipInOrgEndpoint

TeamsAddOrUpdateMembershipInOrgEndpoint: object

Type declaration

org: string

org parameter
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

team_slug parameter
username: string

username parameter

TeamsAddOrUpdateMembershipInOrgRequestOptions

TeamsAddOrUpdateMembershipInOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PUT"
request: RequestRequestOptions
url: "/orgs/:org/teams/:team_slug/memberships/:username"

TeamsAddOrUpdateMembershipInOrgResponseData

TeamsAddOrUpdateMembershipInOrgResponseData: object

Type declaration

role: string
state: string
url: string

TeamsAddOrUpdateMembershipLegacyEndpoint

TeamsAddOrUpdateMembershipLegacyEndpoint: object

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

team_id parameter
username: string

username parameter

TeamsAddOrUpdateMembershipLegacyRequestOptions

TeamsAddOrUpdateMembershipLegacyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PUT"
request: RequestRequestOptions
url: "/teams/:team_id/memberships/:username"

TeamsAddOrUpdateMembershipLegacyResponseData

TeamsAddOrUpdateMembershipLegacyResponseData: object

Type declaration

role: string
state: string
url: string

TeamsAddOrUpdateProjectInOrgEndpoint

TeamsAddOrUpdateProjectInOrgEndpoint: object & RequiredPreview<"inertia">

TeamsAddOrUpdateProjectInOrgRequestOptions

TeamsAddOrUpdateProjectInOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PUT"
request: RequestRequestOptions
url: "/orgs/:org/teams/:team_slug/projects/:project_id"

TeamsAddOrUpdateProjectInOrgResponseData

TeamsAddOrUpdateProjectInOrgResponseData: object

Type declaration

documentation_url: string
message: string

TeamsAddOrUpdateProjectLegacyEndpoint

TeamsAddOrUpdateProjectLegacyEndpoint: object & RequiredPreview<"inertia">

TeamsAddOrUpdateProjectLegacyRequestOptions

TeamsAddOrUpdateProjectLegacyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PUT"
request: RequestRequestOptions
url: "/teams/:team_id/projects/:project_id"

TeamsAddOrUpdateProjectLegacyResponseData

TeamsAddOrUpdateProjectLegacyResponseData: object

Type declaration

documentation_url: string
message: string

TeamsAddOrUpdateRepoInOrgEndpoint

TeamsAddOrUpdateRepoInOrgEndpoint: object

Type declaration

org: string

org parameter
owner: string

owner parameter
Optional permission?: "pull" | "push" | "admin" | "maintain" | "triage"

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. * maintain - team members can manage the repository without access to sensitive or destructive actions. Recommended for project managers. Only applies to repositories owned by organizations. * triage - team members can proactively manage issues and pull requests without write access. Recommended for contributors who triage a repository. Only applies to repositories owned by organizations.

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

repo parameter
team_slug: string

team_slug parameter

TeamsAddOrUpdateRepoInOrgRequestOptions

TeamsAddOrUpdateRepoInOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PUT"
request: RequestRequestOptions
url: "/orgs/:org/teams/:team_slug/repos/:owner/:repo"

TeamsAddOrUpdateRepoLegacyEndpoint

TeamsAddOrUpdateRepoLegacyEndpoint: object

Type declaration

owner: string

owner parameter
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

repo parameter
team_id: number

team_id parameter

TeamsAddOrUpdateRepoLegacyRequestOptions

TeamsAddOrUpdateRepoLegacyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PUT"
request: RequestRequestOptions
url: "/teams/:team_id/repos/:owner/:repo"

TeamsCheckManagesRepoInOrgEndpoint

TeamsCheckManagesRepoInOrgEndpoint: object

Type declaration

org: string

org parameter
owner: string

owner parameter
repo: string

repo parameter
team_slug: string

team_slug parameter

TeamsCheckManagesRepoInOrgRequestOptions

TeamsCheckManagesRepoInOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/orgs/:org/teams/:team_slug/repos/:owner/:repo"

TeamsCheckManagesRepoInOrgResponseData

TeamsCheckManagesRepoInOrgResponseData: object

Type declaration

organization: TeamsCheckManagesRepoInOrgResponseDataOrganization
parent: TeamsCheckManagesRepoInOrgResponseDataParent
permissions: TeamsCheckManagesRepoInOrgResponseDataPermissions
source: TeamsCheckManagesRepoInOrgResponseDataSource

TeamsCheckManagesRepoInOrgResponseDataOrganization

TeamsCheckManagesRepoInOrgResponseDataOrganization: object

Type declaration

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

TeamsCheckManagesRepoInOrgResponseDataParent

TeamsCheckManagesRepoInOrgResponseDataParent: object

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: TeamsCheckManagesRepoInOrgResponseDataParentOwner
permissions: TeamsCheckManagesRepoInOrgResponseDataParentPermissions
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

TeamsCheckManagesRepoInOrgResponseDataParentOwner

TeamsCheckManagesRepoInOrgResponseDataParentOwner: object

Type declaration

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

TeamsCheckManagesRepoInOrgResponseDataParentPermissions

TeamsCheckManagesRepoInOrgResponseDataParentPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

TeamsCheckManagesRepoInOrgResponseDataPermissions

TeamsCheckManagesRepoInOrgResponseDataPermissions: object

Type declaration

admin: boolean
maintain: boolean
pull: boolean
push: boolean
triage: boolean

TeamsCheckManagesRepoInOrgResponseDataSource

TeamsCheckManagesRepoInOrgResponseDataSource: object

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: TeamsCheckManagesRepoInOrgResponseDataSourceOwner
permissions: TeamsCheckManagesRepoInOrgResponseDataSourcePermissions
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

TeamsCheckManagesRepoInOrgResponseDataSourceOwner

TeamsCheckManagesRepoInOrgResponseDataSourceOwner: object

Type declaration

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

TeamsCheckManagesRepoInOrgResponseDataSourcePermissions

TeamsCheckManagesRepoInOrgResponseDataSourcePermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

TeamsCheckManagesRepoLegacyEndpoint

TeamsCheckManagesRepoLegacyEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter
team_id: number

team_id parameter

TeamsCheckManagesRepoLegacyRequestOptions

TeamsCheckManagesRepoLegacyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/teams/:team_id/repos/:owner/:repo"

TeamsCheckManagesRepoLegacyResponseData

TeamsCheckManagesRepoLegacyResponseData: object

Type declaration

organization: TeamsCheckManagesRepoLegacyResponseDataOrganization
parent: TeamsCheckManagesRepoLegacyResponseDataParent
permissions: TeamsCheckManagesRepoLegacyResponseDataPermissions
source: TeamsCheckManagesRepoLegacyResponseDataSource

TeamsCheckManagesRepoLegacyResponseDataOrganization

TeamsCheckManagesRepoLegacyResponseDataOrganization: object

Type declaration

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

TeamsCheckManagesRepoLegacyResponseDataParent

TeamsCheckManagesRepoLegacyResponseDataParent: object

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: TeamsCheckManagesRepoLegacyResponseDataParentOwner
permissions: TeamsCheckManagesRepoLegacyResponseDataParentPermissions
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

TeamsCheckManagesRepoLegacyResponseDataParentOwner

TeamsCheckManagesRepoLegacyResponseDataParentOwner: object

Type declaration

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

TeamsCheckManagesRepoLegacyResponseDataParentPermissions

TeamsCheckManagesRepoLegacyResponseDataParentPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

TeamsCheckManagesRepoLegacyResponseDataPermissions

TeamsCheckManagesRepoLegacyResponseDataPermissions: object

Type declaration

admin: boolean
maintain: boolean
pull: boolean
push: boolean
triage: boolean

TeamsCheckManagesRepoLegacyResponseDataSource

TeamsCheckManagesRepoLegacyResponseDataSource: object

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: TeamsCheckManagesRepoLegacyResponseDataSourceOwner
permissions: TeamsCheckManagesRepoLegacyResponseDataSourcePermissions
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

TeamsCheckManagesRepoLegacyResponseDataSourceOwner

TeamsCheckManagesRepoLegacyResponseDataSourceOwner: object

Type declaration

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

TeamsCheckManagesRepoLegacyResponseDataSourcePermissions

TeamsCheckManagesRepoLegacyResponseDataSourcePermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

TeamsCreateDiscussionCommentInOrgEndpoint

TeamsCreateDiscussionCommentInOrgEndpoint: object

Type declaration

body: string

The discussion comment's body text.
discussion_number: number

discussion_number parameter
org: string

org parameter
team_slug: string

team_slug parameter

TeamsCreateDiscussionCommentInOrgRequestOptions

TeamsCreateDiscussionCommentInOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments"

TeamsCreateDiscussionCommentInOrgResponseData

TeamsCreateDiscussionCommentInOrgResponseData: object

Type declaration

author: TeamsCreateDiscussionCommentInOrgResponseDataAuthor
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: TeamsCreateDiscussionCommentInOrgResponseDataReactions
updated_at: string
url: string

TeamsCreateDiscussionCommentInOrgResponseDataAuthor

TeamsCreateDiscussionCommentInOrgResponseDataAuthor: object

Type declaration

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

TeamsCreateDiscussionCommentInOrgResponseDataReactions

TeamsCreateDiscussionCommentInOrgResponseDataReactions: object

Type declaration

+1: number
-1: number
confused: number
heart: number
hooray: number
laugh: number
total_count: number
url: string

TeamsCreateDiscussionCommentLegacyEndpoint

TeamsCreateDiscussionCommentLegacyEndpoint: object

Type declaration

body: string

The discussion comment's body text.
discussion_number: number

discussion_number parameter
team_id: number

team_id parameter

TeamsCreateDiscussionCommentLegacyRequestOptions

TeamsCreateDiscussionCommentLegacyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/teams/:team_id/discussions/:discussion_number/comments"

TeamsCreateDiscussionCommentLegacyResponseData

TeamsCreateDiscussionCommentLegacyResponseData: object

Type declaration

author: TeamsCreateDiscussionCommentLegacyResponseDataAuthor
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: TeamsCreateDiscussionCommentLegacyResponseDataReactions
updated_at: string
url: string

TeamsCreateDiscussionCommentLegacyResponseDataAuthor

TeamsCreateDiscussionCommentLegacyResponseDataAuthor: object

Type declaration

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

TeamsCreateDiscussionCommentLegacyResponseDataReactions

TeamsCreateDiscussionCommentLegacyResponseDataReactions: object

Type declaration

+1: number
-1: number
confused: number
heart: number
hooray: number
laugh: number
total_count: number
url: string

TeamsCreateDiscussionInOrgEndpoint

TeamsCreateDiscussionInOrgEndpoint: object

Type declaration

body: string

The discussion post's body text.
org: string

org parameter
Optional private?: boolean

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

team_slug parameter
title: string

The discussion post's title.

TeamsCreateDiscussionInOrgRequestOptions

TeamsCreateDiscussionInOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/orgs/:org/teams/:team_slug/discussions"

TeamsCreateDiscussionInOrgResponseData

TeamsCreateDiscussionInOrgResponseData: object

Type declaration

author: TeamsCreateDiscussionInOrgResponseDataAuthor
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: TeamsCreateDiscussionInOrgResponseDataReactions
team_url: string
title: string
updated_at: string
url: string

TeamsCreateDiscussionInOrgResponseDataAuthor

TeamsCreateDiscussionInOrgResponseDataAuthor: object

Type declaration

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

TeamsCreateDiscussionInOrgResponseDataReactions

TeamsCreateDiscussionInOrgResponseDataReactions: object

Type declaration

+1: number
-1: number
confused: number
heart: number
hooray: number
laugh: number
total_count: number
url: string

TeamsCreateDiscussionLegacyEndpoint

TeamsCreateDiscussionLegacyEndpoint: object

Type declaration

body: string

The discussion post's body text.
Optional private?: boolean

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

team_id parameter
title: string

The discussion post's title.

TeamsCreateDiscussionLegacyRequestOptions

TeamsCreateDiscussionLegacyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/teams/:team_id/discussions"

TeamsCreateDiscussionLegacyResponseData

TeamsCreateDiscussionLegacyResponseData: object

Type declaration

author: TeamsCreateDiscussionLegacyResponseDataAuthor
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: TeamsCreateDiscussionLegacyResponseDataReactions
team_url: string
title: string
updated_at: string
url: string

TeamsCreateDiscussionLegacyResponseDataAuthor

TeamsCreateDiscussionLegacyResponseDataAuthor: object

Type declaration

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

TeamsCreateDiscussionLegacyResponseDataReactions

TeamsCreateDiscussionLegacyResponseDataReactions: object

Type declaration

+1: number
-1: number
confused: number
heart: number
hooray: number
laugh: number
total_count: number
url: string

TeamsCreateEndpoint

TeamsCreateEndpoint: object

Type declaration

Optional description?: 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

org parameter
Optional parent_team_id?: number

The ID of a team to set as the parent team.
Optional permission?: "pull" | "push" | "admin"

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.
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.

TeamsCreateOrUpdateIdPGroupConnectionsInOrgEndpoint

TeamsCreateOrUpdateIdPGroupConnectionsInOrgEndpoint: object

Type declaration

groups: TeamsCreateOrUpdateIdPGroupConnectionsInOrgParamsGroups[]

The IdP groups you want to connect to a GitHub team. When updating, the new groups object will replace the original one. You must include any existing groups that you don't want to remove.
org: string

org parameter
team_slug: string

team_slug parameter

TeamsCreateOrUpdateIdPGroupConnectionsInOrgParamsGroups

TeamsCreateOrUpdateIdPGroupConnectionsInOrgParamsGroups: object

Type declaration

group_description: string
group_id: string
group_name: string

TeamsCreateOrUpdateIdPGroupConnectionsInOrgRequestOptions

TeamsCreateOrUpdateIdPGroupConnectionsInOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PATCH"
request: RequestRequestOptions
url: "/orgs/:org/teams/:team_slug/team-sync/group-mappings"

TeamsCreateOrUpdateIdPGroupConnectionsInOrgResponseData

TeamsCreateOrUpdateIdPGroupConnectionsInOrgResponseData: object

Type declaration

groups: TeamsCreateOrUpdateIdPGroupConnectionsInOrgResponseDataGroups

TeamsCreateOrUpdateIdPGroupConnectionsInOrgResponseDataGroups

TeamsCreateOrUpdateIdPGroupConnectionsInOrgResponseDataGroups: object

Type declaration

group_description: string
group_id: string
group_name: string

TeamsCreateOrUpdateIdPGroupConnectionsLegacyEndpoint

TeamsCreateOrUpdateIdPGroupConnectionsLegacyEndpoint: object

Type declaration

groups: TeamsCreateOrUpdateIdPGroupConnectionsLegacyParamsGroups[]

The IdP groups you want to connect to a GitHub team. When updating, the new groups object will replace the original one. You must include any existing groups that you don't want to remove.
team_id: number

team_id parameter

TeamsCreateOrUpdateIdPGroupConnectionsLegacyParamsGroups

TeamsCreateOrUpdateIdPGroupConnectionsLegacyParamsGroups: object

Type declaration

group_description: string
group_id: string
group_name: string

TeamsCreateOrUpdateIdPGroupConnectionsLegacyRequestOptions

TeamsCreateOrUpdateIdPGroupConnectionsLegacyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PATCH"
request: RequestRequestOptions
url: "/teams/:team_id/team-sync/group-mappings"

TeamsCreateOrUpdateIdPGroupConnectionsLegacyResponseData

TeamsCreateOrUpdateIdPGroupConnectionsLegacyResponseData: object

Type declaration

groups: Array<TeamsCreateOrUpdateIdPGroupConnectionsLegacyResponseDataGroupsItem>

TeamsCreateOrUpdateIdPGroupConnectionsLegacyResponseDataGroupsItem

TeamsCreateOrUpdateIdPGroupConnectionsLegacyResponseDataGroupsItem: object

Type declaration

group_description: string
group_id: string
group_name: string

TeamsCreateRequestOptions

TeamsCreateRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/orgs/:org/teams"

TeamsCreateResponseData

TeamsCreateResponseData: object

Type declaration

created_at: string
description: string
html_url: string
id: number
members_count: number
members_url: string
name: string
node_id: string
organization: TeamsCreateResponseDataOrganization
parent: null
permission: string
privacy: string
repos_count: number
repositories_url: string
slug: string
updated_at: string
url: string

TeamsCreateResponseDataOrganization

TeamsCreateResponseDataOrganization: object

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

TeamsDeleteDiscussionCommentInOrgEndpoint

TeamsDeleteDiscussionCommentInOrgEndpoint: object

Type declaration

comment_number: number

comment_number parameter
discussion_number: number

discussion_number parameter
org: string

org parameter
team_slug: string

team_slug parameter

TeamsDeleteDiscussionCommentInOrgRequestOptions

TeamsDeleteDiscussionCommentInOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number"

TeamsDeleteDiscussionCommentLegacyEndpoint

TeamsDeleteDiscussionCommentLegacyEndpoint: object

Type declaration

comment_number: number

comment_number parameter
discussion_number: number

discussion_number parameter
team_id: number

team_id parameter

TeamsDeleteDiscussionCommentLegacyRequestOptions

TeamsDeleteDiscussionCommentLegacyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number"

TeamsDeleteDiscussionInOrgEndpoint

TeamsDeleteDiscussionInOrgEndpoint: object

Type declaration

discussion_number: number

discussion_number parameter
org: string

org parameter
team_slug: string

team_slug parameter

TeamsDeleteDiscussionInOrgRequestOptions

TeamsDeleteDiscussionInOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number"

TeamsDeleteDiscussionLegacyEndpoint

TeamsDeleteDiscussionLegacyEndpoint: object

Type declaration

discussion_number: number

discussion_number parameter
team_id: number

team_id parameter

TeamsDeleteDiscussionLegacyRequestOptions

TeamsDeleteDiscussionLegacyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/teams/:team_id/discussions/:discussion_number"

TeamsDeleteInOrgEndpoint

TeamsDeleteInOrgEndpoint: object

Type declaration

org: string

org parameter
team_slug: string

team_slug parameter

TeamsDeleteInOrgRequestOptions

TeamsDeleteInOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/orgs/:org/teams/:team_slug"

TeamsDeleteLegacyEndpoint

TeamsDeleteLegacyEndpoint: object

Type declaration

team_id: number

team_id parameter

TeamsDeleteLegacyRequestOptions

TeamsDeleteLegacyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/teams/:team_id"

TeamsGetByNameEndpoint

TeamsGetByNameEndpoint: object

Type declaration

org: string

org parameter
team_slug: string

team_slug parameter

TeamsGetByNameRequestOptions

TeamsGetByNameRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/orgs/:org/teams/:team_slug"

TeamsGetByNameResponseData

TeamsGetByNameResponseData: object

Type declaration

created_at: string
description: string
html_url: string
id: number
members_count: number
members_url: string
name: string
node_id: string
organization: TeamsGetByNameResponseDataOrganization
parent: null
permission: string
privacy: string
repos_count: number
repositories_url: string
slug: string
updated_at: string
url: string

TeamsGetByNameResponseDataOrganization

TeamsGetByNameResponseDataOrganization: object

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

TeamsGetDiscussionCommentInOrgEndpoint

TeamsGetDiscussionCommentInOrgEndpoint: object

Type declaration

comment_number: number

comment_number parameter
discussion_number: number

discussion_number parameter
org: string

org parameter
team_slug: string

team_slug parameter

TeamsGetDiscussionCommentInOrgRequestOptions

TeamsGetDiscussionCommentInOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number"

TeamsGetDiscussionCommentInOrgResponseData

TeamsGetDiscussionCommentInOrgResponseData: object

Type declaration

author: TeamsGetDiscussionCommentInOrgResponseDataAuthor
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: TeamsGetDiscussionCommentInOrgResponseDataReactions
updated_at: string
url: string

TeamsGetDiscussionCommentInOrgResponseDataAuthor

TeamsGetDiscussionCommentInOrgResponseDataAuthor: object

Type declaration

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

TeamsGetDiscussionCommentInOrgResponseDataReactions

TeamsGetDiscussionCommentInOrgResponseDataReactions: object

Type declaration

+1: number
-1: number
confused: number
heart: number
hooray: number
laugh: number
total_count: number
url: string

TeamsGetDiscussionCommentLegacyEndpoint

TeamsGetDiscussionCommentLegacyEndpoint: object

Type declaration

comment_number: number

comment_number parameter
discussion_number: number

discussion_number parameter
team_id: number

team_id parameter

TeamsGetDiscussionCommentLegacyRequestOptions

TeamsGetDiscussionCommentLegacyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number"

TeamsGetDiscussionCommentLegacyResponseData

TeamsGetDiscussionCommentLegacyResponseData: object

Type declaration

author: TeamsGetDiscussionCommentLegacyResponseDataAuthor
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: TeamsGetDiscussionCommentLegacyResponseDataReactions
updated_at: string
url: string

TeamsGetDiscussionCommentLegacyResponseDataAuthor

TeamsGetDiscussionCommentLegacyResponseDataAuthor: object

Type declaration

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

TeamsGetDiscussionCommentLegacyResponseDataReactions

TeamsGetDiscussionCommentLegacyResponseDataReactions: object

Type declaration

+1: number
-1: number
confused: number
heart: number
hooray: number
laugh: number
total_count: number
url: string

TeamsGetDiscussionInOrgEndpoint

TeamsGetDiscussionInOrgEndpoint: object

Type declaration

discussion_number: number

discussion_number parameter
org: string

org parameter
team_slug: string

team_slug parameter

TeamsGetDiscussionInOrgRequestOptions

TeamsGetDiscussionInOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number"

TeamsGetDiscussionInOrgResponseData

TeamsGetDiscussionInOrgResponseData: object

Type declaration

author: TeamsGetDiscussionInOrgResponseDataAuthor
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: TeamsGetDiscussionInOrgResponseDataReactions
team_url: string
title: string
updated_at: string
url: string

TeamsGetDiscussionInOrgResponseDataAuthor

TeamsGetDiscussionInOrgResponseDataAuthor: object

Type declaration

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

TeamsGetDiscussionInOrgResponseDataReactions

TeamsGetDiscussionInOrgResponseDataReactions: object

Type declaration

+1: number
-1: number
confused: number
heart: number
hooray: number
laugh: number
total_count: number
url: string

TeamsGetDiscussionLegacyEndpoint

TeamsGetDiscussionLegacyEndpoint: object

Type declaration

discussion_number: number

discussion_number parameter
team_id: number

team_id parameter

TeamsGetDiscussionLegacyRequestOptions

TeamsGetDiscussionLegacyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/teams/:team_id/discussions/:discussion_number"

TeamsGetDiscussionLegacyResponseData

TeamsGetDiscussionLegacyResponseData: object

Type declaration

author: TeamsGetDiscussionLegacyResponseDataAuthor
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: TeamsGetDiscussionLegacyResponseDataReactions
team_url: string
title: string
updated_at: string
url: string

TeamsGetDiscussionLegacyResponseDataAuthor

TeamsGetDiscussionLegacyResponseDataAuthor: object

Type declaration

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

TeamsGetDiscussionLegacyResponseDataReactions

TeamsGetDiscussionLegacyResponseDataReactions: object

Type declaration

+1: number
-1: number
confused: number
heart: number
hooray: number
laugh: number
total_count: number
url: string

TeamsGetLegacyEndpoint

TeamsGetLegacyEndpoint: object

Type declaration

team_id: number

team_id parameter

TeamsGetLegacyRequestOptions

TeamsGetLegacyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/teams/:team_id"

TeamsGetLegacyResponseData

TeamsGetLegacyResponseData: object

Type declaration

created_at: string
description: string
html_url: string
id: number
members_count: number
members_url: string
name: string
node_id: string
organization: TeamsGetLegacyResponseDataOrganization
parent: null
permission: string
privacy: string
repos_count: number
repositories_url: string
slug: string
updated_at: string
url: string

TeamsGetLegacyResponseDataOrganization

TeamsGetLegacyResponseDataOrganization: object

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

TeamsGetMemberLegacyEndpoint

TeamsGetMemberLegacyEndpoint: object

Type declaration

team_id: number

team_id parameter
username: string

username parameter

TeamsGetMemberLegacyRequestOptions

TeamsGetMemberLegacyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/teams/:team_id/members/:username"

TeamsGetMembershipInOrgEndpoint

TeamsGetMembershipInOrgEndpoint: object

Type declaration

org: string

org parameter
team_slug: string

team_slug parameter
username: string

username parameter

TeamsGetMembershipInOrgRequestOptions

TeamsGetMembershipInOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/orgs/:org/teams/:team_slug/memberships/:username"

TeamsGetMembershipInOrgResponseData

TeamsGetMembershipInOrgResponseData: object

Type declaration

role: string
state: string
url: string

TeamsGetMembershipLegacyEndpoint

TeamsGetMembershipLegacyEndpoint: object

Type declaration

team_id: number

team_id parameter
username: string

username parameter

TeamsGetMembershipLegacyRequestOptions

TeamsGetMembershipLegacyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/teams/:team_id/memberships/:username"

TeamsGetMembershipLegacyResponseData

TeamsGetMembershipLegacyResponseData: object

Type declaration

role: string
state: string
url: string

TeamsListChildInOrgEndpoint

TeamsListChildInOrgEndpoint: object

Type declaration

org: string

org parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
team_slug: string

team_slug parameter

TeamsListChildInOrgRequestOptions

TeamsListChildInOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/orgs/:org/teams/:team_slug/teams"

TeamsListChildInOrgResponseData

TeamsListChildInOrgResponseData: Array<TeamsListChildInOrgResponseDataItem>

TeamsListChildInOrgResponseDataItem

TeamsListChildInOrgResponseDataItem: object

Type declaration

description: string
id: number
members_url: string
name: string
node_id: string
parent: TeamsListChildInOrgResponseDataItemParent
permission: string
privacy: string
repositories_url: string
slug: string
url: string

TeamsListChildInOrgResponseDataItemParent

TeamsListChildInOrgResponseDataItemParent: object

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

TeamsListChildLegacyEndpoint

TeamsListChildLegacyEndpoint: object

Type declaration

Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
team_id: number

team_id parameter

TeamsListChildLegacyRequestOptions

TeamsListChildLegacyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/teams/:team_id/teams"

TeamsListChildLegacyResponseData

TeamsListChildLegacyResponseData: Array<TeamsListChildLegacyResponseDataItem>

TeamsListChildLegacyResponseDataItem

TeamsListChildLegacyResponseDataItem: object

Type declaration

description: string
id: number
members_url: string
name: string
node_id: string
parent: TeamsListChildLegacyResponseDataItemParent
permission: string
privacy: string
repositories_url: string
slug: string
url: string

TeamsListChildLegacyResponseDataItemParent

TeamsListChildLegacyResponseDataItemParent: object

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

TeamsListDiscussionCommentsInOrgEndpoint

TeamsListDiscussionCommentsInOrgEndpoint: object

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

discussion_number parameter
org: string

org parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
team_slug: string

team_slug parameter

TeamsListDiscussionCommentsInOrgRequestOptions

TeamsListDiscussionCommentsInOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments"

TeamsListDiscussionCommentsInOrgResponseData

TeamsListDiscussionCommentsInOrgResponseData: Array<TeamsListDiscussionCommentsInOrgResponseDataItem>

TeamsListDiscussionCommentsInOrgResponseDataItem

TeamsListDiscussionCommentsInOrgResponseDataItem: object

Type declaration

author: TeamsListDiscussionCommentsInOrgResponseDataItemAuthor
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: TeamsListDiscussionCommentsInOrgResponseDataItemReactions
updated_at: string
url: string

TeamsListDiscussionCommentsInOrgResponseDataItemAuthor

TeamsListDiscussionCommentsInOrgResponseDataItemAuthor: object

Type declaration

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

TeamsListDiscussionCommentsInOrgResponseDataItemReactions

TeamsListDiscussionCommentsInOrgResponseDataItemReactions: object

Type declaration

+1: number
-1: number
confused: number
heart: number
hooray: number
laugh: number
total_count: number
url: string

TeamsListDiscussionCommentsLegacyEndpoint

TeamsListDiscussionCommentsLegacyEndpoint: object

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

discussion_number parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
team_id: number

team_id parameter

TeamsListDiscussionCommentsLegacyRequestOptions

TeamsListDiscussionCommentsLegacyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/teams/:team_id/discussions/:discussion_number/comments"

TeamsListDiscussionCommentsLegacyResponseData

TeamsListDiscussionCommentsLegacyResponseData: Array<TeamsListDiscussionCommentsLegacyResponseDataItem>

TeamsListDiscussionCommentsLegacyResponseDataItem

TeamsListDiscussionCommentsLegacyResponseDataItem: object

Type declaration

author: TeamsListDiscussionCommentsLegacyResponseDataItemAuthor
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: TeamsListDiscussionCommentsLegacyResponseDataItemReactions
updated_at: string
url: string

TeamsListDiscussionCommentsLegacyResponseDataItemAuthor

TeamsListDiscussionCommentsLegacyResponseDataItemAuthor: object

Type declaration

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

TeamsListDiscussionCommentsLegacyResponseDataItemReactions

TeamsListDiscussionCommentsLegacyResponseDataItemReactions: object

Type declaration

+1: number
-1: number
confused: number
heart: number
hooray: number
laugh: number
total_count: number
url: string

TeamsListDiscussionsInOrgEndpoint

TeamsListDiscussionsInOrgEndpoint: object

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

org parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
team_slug: string

team_slug parameter

TeamsListDiscussionsInOrgRequestOptions

TeamsListDiscussionsInOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/orgs/:org/teams/:team_slug/discussions"

TeamsListDiscussionsInOrgResponseData

TeamsListDiscussionsInOrgResponseData: Array<TeamsListDiscussionsInOrgResponseDataItem>

TeamsListDiscussionsInOrgResponseDataItem

TeamsListDiscussionsInOrgResponseDataItem: object

Type declaration

author: TeamsListDiscussionsInOrgResponseDataItemAuthor
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: TeamsListDiscussionsInOrgResponseDataItemReactions
team_url: string
title: string
updated_at: string
url: string

TeamsListDiscussionsInOrgResponseDataItemAuthor

TeamsListDiscussionsInOrgResponseDataItemAuthor: object

Type declaration

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

TeamsListDiscussionsInOrgResponseDataItemReactions

TeamsListDiscussionsInOrgResponseDataItemReactions: object

Type declaration

+1: number
-1: number
confused: number
heart: number
hooray: number
laugh: number
total_count: number
url: string

TeamsListDiscussionsLegacyEndpoint

TeamsListDiscussionsLegacyEndpoint: object

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?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
team_id: number

team_id parameter

TeamsListDiscussionsLegacyRequestOptions

TeamsListDiscussionsLegacyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/teams/:team_id/discussions"

TeamsListDiscussionsLegacyResponseData

TeamsListDiscussionsLegacyResponseData: Array<TeamsListDiscussionsLegacyResponseDataItem>

TeamsListDiscussionsLegacyResponseDataItem

TeamsListDiscussionsLegacyResponseDataItem: object

Type declaration

author: TeamsListDiscussionsLegacyResponseDataItemAuthor
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: TeamsListDiscussionsLegacyResponseDataItemReactions
team_url: string
title: string
updated_at: string
url: string

TeamsListDiscussionsLegacyResponseDataItemAuthor

TeamsListDiscussionsLegacyResponseDataItemAuthor: object

Type declaration

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

TeamsListDiscussionsLegacyResponseDataItemReactions

TeamsListDiscussionsLegacyResponseDataItemReactions: object

Type declaration

+1: number
-1: number
confused: number
heart: number
hooray: number
laugh: number
total_count: number
url: string

TeamsListEndpoint

TeamsListEndpoint: object

Type declaration

org: string

org parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)

TeamsListForAuthenticatedUserEndpoint

TeamsListForAuthenticatedUserEndpoint: object

Type declaration

Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)

TeamsListForAuthenticatedUserRequestOptions

TeamsListForAuthenticatedUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/user/teams"

TeamsListForAuthenticatedUserResponseData

TeamsListForAuthenticatedUserResponseData: Array<TeamsListForAuthenticatedUserResponseDataItem>

TeamsListForAuthenticatedUserResponseDataItem

TeamsListForAuthenticatedUserResponseDataItem: object

Type declaration

created_at: string
description: string
html_url: string
id: number
members_count: number
members_url: string
name: string
node_id: string
organization: TeamsListForAuthenticatedUserResponseDataItemOrganization
parent: null
permission: string
privacy: string
repos_count: number
repositories_url: string
slug: string
updated_at: string
url: string

TeamsListForAuthenticatedUserResponseDataItemOrganization

TeamsListForAuthenticatedUserResponseDataItemOrganization: object

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

TeamsListIdPGroupsForLegacyEndpoint

TeamsListIdPGroupsForLegacyEndpoint: object

Type declaration

team_id: number

team_id parameter

TeamsListIdPGroupsForLegacyRequestOptions

TeamsListIdPGroupsForLegacyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/teams/:team_id/team-sync/group-mappings"

TeamsListIdPGroupsForLegacyResponseData

TeamsListIdPGroupsForLegacyResponseData: object

Type declaration

groups: Array<TeamsListIdPGroupsForLegacyResponseDataGroupsItem>

TeamsListIdPGroupsForLegacyResponseDataGroupsItem

TeamsListIdPGroupsForLegacyResponseDataGroupsItem: object

Type declaration

group_description: string
group_id: string
group_name: string

TeamsListIdPGroupsForOrgEndpoint

TeamsListIdPGroupsForOrgEndpoint: object

Type declaration

org: string

org parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)

TeamsListIdPGroupsForOrgRequestOptions

TeamsListIdPGroupsForOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/orgs/:org/team-sync/groups"

TeamsListIdPGroupsForOrgResponseData

TeamsListIdPGroupsForOrgResponseData: object

Type declaration

groups: Array<TeamsListIdPGroupsForOrgResponseDataGroupsItem>

TeamsListIdPGroupsForOrgResponseDataGroupsItem

TeamsListIdPGroupsForOrgResponseDataGroupsItem: object

Type declaration

group_description: string
group_id: string
group_name: string

TeamsListIdPGroupsInOrgEndpoint

TeamsListIdPGroupsInOrgEndpoint: object

Type declaration

org: string

org parameter
team_slug: string

team_slug parameter

TeamsListIdPGroupsInOrgRequestOptions

TeamsListIdPGroupsInOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/orgs/:org/teams/:team_slug/team-sync/group-mappings"

TeamsListIdPGroupsInOrgResponseData

TeamsListIdPGroupsInOrgResponseData: object

Type declaration

groups: Array<TeamsListIdPGroupsInOrgResponseDataGroupsItem>

TeamsListIdPGroupsInOrgResponseDataGroupsItem

TeamsListIdPGroupsInOrgResponseDataGroupsItem: object

Type declaration

group_description: string
group_id: string
group_name: string

TeamsListMembersInOrgEndpoint

TeamsListMembersInOrgEndpoint: object

Type declaration

org: string

org parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: 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

team_slug parameter

TeamsListMembersInOrgRequestOptions

TeamsListMembersInOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/orgs/:org/teams/:team_slug/members"

TeamsListMembersInOrgResponseData

TeamsListMembersInOrgResponseData: Array<TeamsListMembersInOrgResponseDataItem>

TeamsListMembersInOrgResponseDataItem

TeamsListMembersInOrgResponseDataItem: object

Type declaration

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

TeamsListMembersLegacyEndpoint

TeamsListMembersLegacyEndpoint: object

Type declaration

Optional page?: number

Page number of the results to fetch.
Optional per_page?: 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

team_id parameter

TeamsListMembersLegacyRequestOptions

TeamsListMembersLegacyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/teams/:team_id/members"

TeamsListMembersLegacyResponseData

TeamsListMembersLegacyResponseData: Array<TeamsListMembersLegacyResponseDataItem>

TeamsListMembersLegacyResponseDataItem

TeamsListMembersLegacyResponseDataItem: object

Type declaration

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

TeamsListPendingInvitationsInOrgEndpoint

TeamsListPendingInvitationsInOrgEndpoint: object

Type declaration

org: string

org parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
team_slug: string

team_slug parameter

TeamsListPendingInvitationsInOrgRequestOptions

TeamsListPendingInvitationsInOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/orgs/:org/teams/:team_slug/invitations"

TeamsListPendingInvitationsInOrgResponseData

TeamsListPendingInvitationsInOrgResponseData: Array<TeamsListPendingInvitationsInOrgResponseDataItem>

TeamsListPendingInvitationsInOrgResponseDataItem

TeamsListPendingInvitationsInOrgResponseDataItem: object

Type declaration

created_at: string
email: string
id: number
invitation_team_url: string
inviter: TeamsListPendingInvitationsInOrgResponseDataItemInviter
login: string
role: string
team_count: number

TeamsListPendingInvitationsInOrgResponseDataItemInviter

TeamsListPendingInvitationsInOrgResponseDataItemInviter: object

Type declaration

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

TeamsListPendingInvitationsLegacyEndpoint

TeamsListPendingInvitationsLegacyEndpoint: object

Type declaration

Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
team_id: number

team_id parameter

TeamsListPendingInvitationsLegacyRequestOptions

TeamsListPendingInvitationsLegacyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/teams/:team_id/invitations"

TeamsListPendingInvitationsLegacyResponseData

TeamsListPendingInvitationsLegacyResponseData: Array<TeamsListPendingInvitationsLegacyResponseDataItem>

TeamsListPendingInvitationsLegacyResponseDataItem

TeamsListPendingInvitationsLegacyResponseDataItem: object

Type declaration

created_at: string
email: string
id: number
invitation_team_url: string
inviter: TeamsListPendingInvitationsLegacyResponseDataItemInviter
login: string
role: string
team_count: number

TeamsListPendingInvitationsLegacyResponseDataItemInviter

TeamsListPendingInvitationsLegacyResponseDataItemInviter: object

Type declaration

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

TeamsListProjectsInOrgEndpoint

TeamsListProjectsInOrgEndpoint: object & RequiredPreview<"inertia">

TeamsListProjectsInOrgRequestOptions

TeamsListProjectsInOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/orgs/:org/teams/:team_slug/projects"

TeamsListProjectsInOrgResponseData

TeamsListProjectsInOrgResponseData: Array<TeamsListProjectsInOrgResponseDataItem>

TeamsListProjectsInOrgResponseDataItem

TeamsListProjectsInOrgResponseDataItem: object

Type declaration

body: string
columns_url: string
created_at: string
creator: TeamsListProjectsInOrgResponseDataItemCreator
html_url: string
id: number
name: string
node_id: string
number: number
organization_permission: string
owner_url: string
permissions: TeamsListProjectsInOrgResponseDataItemPermissions
private: boolean
state: string
updated_at: string
url: string

TeamsListProjectsInOrgResponseDataItemCreator

TeamsListProjectsInOrgResponseDataItemCreator: object

Type declaration

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

TeamsListProjectsInOrgResponseDataItemPermissions

TeamsListProjectsInOrgResponseDataItemPermissions: object

Type declaration

admin: boolean
read: boolean
write: boolean

TeamsListProjectsLegacyEndpoint

TeamsListProjectsLegacyEndpoint: object & RequiredPreview<"inertia">

TeamsListProjectsLegacyRequestOptions

TeamsListProjectsLegacyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/teams/:team_id/projects"

TeamsListProjectsLegacyResponseData

TeamsListProjectsLegacyResponseData: Array<TeamsListProjectsLegacyResponseDataItem>

TeamsListProjectsLegacyResponseDataItem

TeamsListProjectsLegacyResponseDataItem: object

Type declaration

body: string
columns_url: string
created_at: string
creator: TeamsListProjectsLegacyResponseDataItemCreator
html_url: string
id: number
name: string
node_id: string
number: number
organization_permission: string
owner_url: string
permissions: TeamsListProjectsLegacyResponseDataItemPermissions
private: boolean
state: string
updated_at: string
url: string

TeamsListProjectsLegacyResponseDataItemCreator

TeamsListProjectsLegacyResponseDataItemCreator: object

Type declaration

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

TeamsListProjectsLegacyResponseDataItemPermissions

TeamsListProjectsLegacyResponseDataItemPermissions: object

Type declaration

admin: boolean
read: boolean
write: boolean

TeamsListReposInOrgEndpoint

TeamsListReposInOrgEndpoint: object

Type declaration

org: string

org parameter
Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
team_slug: string

team_slug parameter

TeamsListReposInOrgRequestOptions

TeamsListReposInOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/orgs/:org/teams/:team_slug/repos"

TeamsListReposInOrgResponseData

TeamsListReposInOrgResponseData: Array<TeamsListReposInOrgResponseDataItem>

TeamsListReposInOrgResponseDataItem

TeamsListReposInOrgResponseDataItem: object

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: TeamsListReposInOrgResponseDataItemLicense
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: TeamsListReposInOrgResponseDataItemOwner
permissions: TeamsListReposInOrgResponseDataItemPermissions
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

TeamsListReposInOrgResponseDataItemLicense

TeamsListReposInOrgResponseDataItemLicense: object

Type declaration

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

TeamsListReposInOrgResponseDataItemOwner

TeamsListReposInOrgResponseDataItemOwner: object

Type declaration

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

TeamsListReposInOrgResponseDataItemPermissions

TeamsListReposInOrgResponseDataItemPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

TeamsListReposLegacyEndpoint

TeamsListReposLegacyEndpoint: object

Type declaration

Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
team_id: number

team_id parameter

TeamsListReposLegacyRequestOptions

TeamsListReposLegacyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/teams/:team_id/repos"

TeamsListReposLegacyResponseData

TeamsListReposLegacyResponseData: Array<TeamsListReposLegacyResponseDataItem>

TeamsListReposLegacyResponseDataItem

TeamsListReposLegacyResponseDataItem: object

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: TeamsListReposLegacyResponseDataItemLicense
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: TeamsListReposLegacyResponseDataItemOwner
permissions: TeamsListReposLegacyResponseDataItemPermissions
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

TeamsListReposLegacyResponseDataItemLicense

TeamsListReposLegacyResponseDataItemLicense: object

Type declaration

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

TeamsListReposLegacyResponseDataItemOwner

TeamsListReposLegacyResponseDataItemOwner: object

Type declaration

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

TeamsListReposLegacyResponseDataItemPermissions

TeamsListReposLegacyResponseDataItemPermissions: object

Type declaration

admin: boolean
pull: boolean
push: boolean

TeamsListRequestOptions

TeamsListRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/orgs/:org/teams"

TeamsListResponseData

TeamsListResponseData: Array<TeamsListResponseDataItem>

TeamsListResponseDataItem

TeamsListResponseDataItem: object

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

TeamsRemoveMemberLegacyEndpoint

TeamsRemoveMemberLegacyEndpoint: object

Type declaration

team_id: number

team_id parameter
username: string

username parameter

TeamsRemoveMemberLegacyRequestOptions

TeamsRemoveMemberLegacyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/teams/:team_id/members/:username"

TeamsRemoveMembershipInOrgEndpoint

TeamsRemoveMembershipInOrgEndpoint: object

Type declaration

org: string

org parameter
team_slug: string

team_slug parameter
username: string

username parameter

TeamsRemoveMembershipInOrgRequestOptions

TeamsRemoveMembershipInOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/orgs/:org/teams/:team_slug/memberships/:username"

TeamsRemoveMembershipLegacyEndpoint

TeamsRemoveMembershipLegacyEndpoint: object

Type declaration

team_id: number

team_id parameter
username: string

username parameter

TeamsRemoveMembershipLegacyRequestOptions

TeamsRemoveMembershipLegacyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/teams/:team_id/memberships/:username"

TeamsRemoveProjectInOrgEndpoint

TeamsRemoveProjectInOrgEndpoint: object

Type declaration

org: string

org parameter
project_id: number

project_id parameter
team_slug: string

team_slug parameter

TeamsRemoveProjectInOrgRequestOptions

TeamsRemoveProjectInOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/orgs/:org/teams/:team_slug/projects/:project_id"

TeamsRemoveProjectLegacyEndpoint

TeamsRemoveProjectLegacyEndpoint: object

Type declaration

project_id: number

project_id parameter
team_id: number

team_id parameter

TeamsRemoveProjectLegacyRequestOptions

TeamsRemoveProjectLegacyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/teams/:team_id/projects/:project_id"

TeamsRemoveRepoInOrgEndpoint

TeamsRemoveRepoInOrgEndpoint: object

Type declaration

org: string

org parameter
owner: string

owner parameter
repo: string

repo parameter
team_slug: string

team_slug parameter

TeamsRemoveRepoInOrgRequestOptions

TeamsRemoveRepoInOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/orgs/:org/teams/:team_slug/repos/:owner/:repo"

TeamsRemoveRepoLegacyEndpoint

TeamsRemoveRepoLegacyEndpoint: object

Type declaration

owner: string

owner parameter
repo: string

repo parameter
team_id: number

team_id parameter

TeamsRemoveRepoLegacyRequestOptions

TeamsRemoveRepoLegacyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/teams/:team_id/repos/:owner/:repo"

TeamsReviewProjectInOrgEndpoint

TeamsReviewProjectInOrgEndpoint: object & RequiredPreview<"inertia">

TeamsReviewProjectInOrgRequestOptions

TeamsReviewProjectInOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/orgs/:org/teams/:team_slug/projects/:project_id"

TeamsReviewProjectInOrgResponseData

TeamsReviewProjectInOrgResponseData: object

Type declaration

body: string
columns_url: string
created_at: string
creator: TeamsReviewProjectInOrgResponseDataCreator
html_url: string
id: number
name: string
node_id: string
number: number
organization_permission: string
owner_url: string
permissions: TeamsReviewProjectInOrgResponseDataPermissions
private: boolean
state: string
updated_at: string
url: string

TeamsReviewProjectInOrgResponseDataCreator

TeamsReviewProjectInOrgResponseDataCreator: object

Type declaration

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

TeamsReviewProjectInOrgResponseDataPermissions

TeamsReviewProjectInOrgResponseDataPermissions: object

Type declaration

admin: boolean
read: boolean
write: boolean

TeamsReviewProjectLegacyEndpoint

TeamsReviewProjectLegacyEndpoint: object & RequiredPreview<"inertia">

TeamsReviewProjectLegacyRequestOptions

TeamsReviewProjectLegacyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/teams/:team_id/projects/:project_id"

TeamsReviewProjectLegacyResponseData

TeamsReviewProjectLegacyResponseData: object

Type declaration

body: string
columns_url: string
created_at: string
creator: TeamsReviewProjectLegacyResponseDataCreator
html_url: string
id: number
name: string
node_id: string
number: number
organization_permission: string
owner_url: string
permissions: TeamsReviewProjectLegacyResponseDataPermissions
private: boolean
state: string
updated_at: string
url: string

TeamsReviewProjectLegacyResponseDataCreator

TeamsReviewProjectLegacyResponseDataCreator: object

Type declaration

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

TeamsReviewProjectLegacyResponseDataPermissions

TeamsReviewProjectLegacyResponseDataPermissions: object

Type declaration

admin: boolean
read: boolean
write: boolean

TeamsUpdateDiscussionCommentInOrgEndpoint

TeamsUpdateDiscussionCommentInOrgEndpoint: object

Type declaration

body: string

The discussion comment's body text.
comment_number: number

comment_number parameter
discussion_number: number

discussion_number parameter
org: string

org parameter
team_slug: string

team_slug parameter

TeamsUpdateDiscussionCommentInOrgRequestOptions

TeamsUpdateDiscussionCommentInOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PATCH"
request: RequestRequestOptions
url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number"

TeamsUpdateDiscussionCommentInOrgResponseData

TeamsUpdateDiscussionCommentInOrgResponseData: object

Type declaration

author: TeamsUpdateDiscussionCommentInOrgResponseDataAuthor
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: TeamsUpdateDiscussionCommentInOrgResponseDataReactions
updated_at: string
url: string

TeamsUpdateDiscussionCommentInOrgResponseDataAuthor

TeamsUpdateDiscussionCommentInOrgResponseDataAuthor: object

Type declaration

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

TeamsUpdateDiscussionCommentInOrgResponseDataReactions

TeamsUpdateDiscussionCommentInOrgResponseDataReactions: object

Type declaration

+1: number
-1: number
confused: number
heart: number
hooray: number
laugh: number
total_count: number
url: string

TeamsUpdateDiscussionCommentLegacyEndpoint

TeamsUpdateDiscussionCommentLegacyEndpoint: object

Type declaration

body: string

The discussion comment's body text.
comment_number: number

comment_number parameter
discussion_number: number

discussion_number parameter
team_id: number

team_id parameter

TeamsUpdateDiscussionCommentLegacyRequestOptions

TeamsUpdateDiscussionCommentLegacyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PATCH"
request: RequestRequestOptions
url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number"

TeamsUpdateDiscussionCommentLegacyResponseData

TeamsUpdateDiscussionCommentLegacyResponseData: object

Type declaration

author: TeamsUpdateDiscussionCommentLegacyResponseDataAuthor
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: TeamsUpdateDiscussionCommentLegacyResponseDataReactions
updated_at: string
url: string

TeamsUpdateDiscussionCommentLegacyResponseDataAuthor

TeamsUpdateDiscussionCommentLegacyResponseDataAuthor: object

Type declaration

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

TeamsUpdateDiscussionCommentLegacyResponseDataReactions

TeamsUpdateDiscussionCommentLegacyResponseDataReactions: object

Type declaration

+1: number
-1: number
confused: number
heart: number
hooray: number
laugh: number
total_count: number
url: string

TeamsUpdateDiscussionInOrgEndpoint

TeamsUpdateDiscussionInOrgEndpoint: object

Type declaration

Optional body?: string

The discussion post's body text.
discussion_number: number

discussion_number parameter
org: string

org parameter
team_slug: string

team_slug parameter
Optional title?: string

The discussion post's title.

TeamsUpdateDiscussionInOrgRequestOptions

TeamsUpdateDiscussionInOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PATCH"
request: RequestRequestOptions
url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number"

TeamsUpdateDiscussionInOrgResponseData

TeamsUpdateDiscussionInOrgResponseData: object

Type declaration

author: TeamsUpdateDiscussionInOrgResponseDataAuthor
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: TeamsUpdateDiscussionInOrgResponseDataReactions
team_url: string
title: string
updated_at: string
url: string

TeamsUpdateDiscussionInOrgResponseDataAuthor

TeamsUpdateDiscussionInOrgResponseDataAuthor: object

Type declaration

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

TeamsUpdateDiscussionInOrgResponseDataReactions

TeamsUpdateDiscussionInOrgResponseDataReactions: object

Type declaration

+1: number
-1: number
confused: number
heart: number
hooray: number
laugh: number
total_count: number
url: string

TeamsUpdateDiscussionLegacyEndpoint

TeamsUpdateDiscussionLegacyEndpoint: object

Type declaration

Optional body?: string

The discussion post's body text.
discussion_number: number

discussion_number parameter
team_id: number

team_id parameter
Optional title?: string

The discussion post's title.

TeamsUpdateDiscussionLegacyRequestOptions

TeamsUpdateDiscussionLegacyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PATCH"
request: RequestRequestOptions
url: "/teams/:team_id/discussions/:discussion_number"

TeamsUpdateDiscussionLegacyResponseData

TeamsUpdateDiscussionLegacyResponseData: object

Type declaration

author: TeamsUpdateDiscussionLegacyResponseDataAuthor
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: TeamsUpdateDiscussionLegacyResponseDataReactions
team_url: string
title: string
updated_at: string
url: string

TeamsUpdateDiscussionLegacyResponseDataAuthor

TeamsUpdateDiscussionLegacyResponseDataAuthor: object

Type declaration

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

TeamsUpdateDiscussionLegacyResponseDataReactions

TeamsUpdateDiscussionLegacyResponseDataReactions: object

Type declaration

+1: number
-1: number
confused: number
heart: number
hooray: number
laugh: number
total_count: number
url: string

TeamsUpdateInOrgEndpoint

TeamsUpdateInOrgEndpoint: object

Type declaration

Optional description?: string

The description of the team.
name: string

The name of the team.
org: string

org parameter
Optional parent_team_id?: number

The ID of a team to set as the parent team.
Optional permission?: "pull" | "push" | "admin"

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.
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

team_slug parameter

TeamsUpdateInOrgRequestOptions

TeamsUpdateInOrgRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PATCH"
request: RequestRequestOptions
url: "/orgs/:org/teams/:team_slug"

TeamsUpdateInOrgResponseData

TeamsUpdateInOrgResponseData: object

Type declaration

created_at: string
description: string
html_url: string
id: number
members_count: number
members_url: string
name: string
node_id: string
organization: TeamsUpdateInOrgResponseDataOrganization
parent: null
permission: string
privacy: string
repos_count: number
repositories_url: string
slug: string
updated_at: string
url: string

TeamsUpdateInOrgResponseDataOrganization

TeamsUpdateInOrgResponseDataOrganization: object

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

TeamsUpdateLegacyEndpoint

TeamsUpdateLegacyEndpoint: object

Type declaration

Optional description?: string

The description of the team.
name: string

The name of the team.
Optional parent_team_id?: number

The ID of a team to set as the parent team.
Optional permission?: "pull" | "push" | "admin"

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.
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

team_id parameter

TeamsUpdateLegacyRequestOptions

TeamsUpdateLegacyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PATCH"
request: RequestRequestOptions
url: "/teams/:team_id"

TeamsUpdateLegacyResponseData

TeamsUpdateLegacyResponseData: object

Type declaration

created_at: string
description: string
html_url: string
id: number
members_count: number
members_url: string
name: string
node_id: string
organization: TeamsUpdateLegacyResponseDataOrganization
parent: null
permission: string
privacy: string
repos_count: number
repositories_url: string
slug: string
updated_at: string
url: string

TeamsUpdateLegacyResponseDataOrganization

TeamsUpdateLegacyResponseDataOrganization: object

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

Unwrap

Unwrap<T>: T extends Promise<infer U> ? U : T

Type parameters

Url

Url: string

Relative or absolute URL. Examples: '/orgs/:org', https://example.com/foo/bar

UsersAddEmailsEndpoint

UsersAddEmailsEndpoint: object

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.

UsersAddEmailsRequestOptions

UsersAddEmailsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/user/emails"

UsersAddEmailsResponseData

UsersAddEmailsResponseData: Array<UsersAddEmailsResponseDataItem>

UsersAddEmailsResponseDataItem

UsersAddEmailsResponseDataItem: object

Type declaration

email: string
primary: boolean
verified: boolean
visibility: string | null

UsersBlockEndpoint

UsersBlockEndpoint: object

Type declaration

username: string

username parameter

UsersBlockRequestOptions

UsersBlockRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PUT"
request: RequestRequestOptions
url: "/user/blocks/:username"

UsersCheckBlockedEndpoint

UsersCheckBlockedEndpoint: object

Type declaration

username: string

username parameter

UsersCheckBlockedRequestOptions

UsersCheckBlockedRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/user/blocks/:username"

UsersCheckFollowingEndpoint

UsersCheckFollowingEndpoint: object

Type declaration

username: string

username parameter

UsersCheckFollowingForUserEndpoint

UsersCheckFollowingForUserEndpoint: object

Type declaration

target_user: string

target_user parameter
username: string

username parameter

UsersCheckFollowingForUserRequestOptions

UsersCheckFollowingForUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/users/:username/following/:target_user"

UsersCheckFollowingRequestOptions

UsersCheckFollowingRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/user/following/:username"

UsersCreateGpgKeyEndpoint

UsersCreateGpgKeyEndpoint: object

Type declaration

Optional armored_public_key?: string

Your GPG key, generated in ASCII-armored format. See "Generating a new GPG key" for help creating a GPG key.

UsersCreateGpgKeyRequestOptions

UsersCreateGpgKeyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/user/gpg_keys"

UsersCreateGpgKeyResponseData

UsersCreateGpgKeyResponseData: object

Type declaration

can_certify: boolean
can_encrypt_comms: boolean
can_encrypt_storage: boolean
can_sign: boolean
created_at: string
emails: Array<UsersCreateGpgKeyResponseDataEmailsItem>
expires_at: null
id: number
key_id: string
primary_key_id: null
public_key: string
subkeys: Array<UsersCreateGpgKeyResponseDataSubkeysItem>

UsersCreateGpgKeyResponseDataEmailsItem

UsersCreateGpgKeyResponseDataEmailsItem: object

Type declaration

email: string
verified: boolean

UsersCreateGpgKeyResponseDataSubkeysItem

UsersCreateGpgKeyResponseDataSubkeysItem: object

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>

UsersCreatePublicKeyEndpoint

UsersCreatePublicKeyEndpoint: object

Type declaration

Optional key?: 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?: 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".

UsersCreatePublicKeyRequestOptions

UsersCreatePublicKeyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "POST"
request: RequestRequestOptions
url: "/user/keys"

UsersCreatePublicKeyResponseData

UsersCreatePublicKeyResponseData: object

Type declaration

key: string
key_id: string

UsersDeleteEmailsEndpoint

UsersDeleteEmailsEndpoint: object

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.

UsersDeleteEmailsRequestOptions

UsersDeleteEmailsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/user/emails"

UsersDeleteGpgKeyEndpoint

UsersDeleteGpgKeyEndpoint: object

Type declaration

gpg_key_id: number

gpg_key_id parameter

UsersDeleteGpgKeyRequestOptions

UsersDeleteGpgKeyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/user/gpg_keys/:gpg_key_id"

UsersDeletePublicKeyEndpoint

UsersDeletePublicKeyEndpoint: object

Type declaration

key_id: number

key_id parameter

UsersDeletePublicKeyRequestOptions

UsersDeletePublicKeyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/user/keys/:key_id"

UsersFollowEndpoint

UsersFollowEndpoint: object

Type declaration

username: string

username parameter

UsersFollowRequestOptions

UsersFollowRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PUT"
request: RequestRequestOptions
url: "/user/following/:username"

UsersGetAuthenticatedEndpoint

UsersGetAuthenticatedEndpoint: object

Type declaration

UsersGetAuthenticatedRequestOptions

UsersGetAuthenticatedRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/user"

UsersGetAuthenticatedResponseData

UsersGetAuthenticatedResponseData: object

Type declaration

avatar_url: string
bio: string
blog: string
Optional collaborators?: number
company: string
created_at: string
Optional 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
Optional owned_private_repos?: number
Optional plan?: UsersGetAuthenticatedResponseDataPlan
Optional 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
Optional total_private_repos?: number
Optional two_factor_authentication?: boolean
type: string
updated_at: string
url: string

UsersGetAuthenticatedResponseDataPlan

UsersGetAuthenticatedResponseDataPlan: object

Type declaration

collaborators: number
name: string
private_repos: number
space: number

UsersGetByUsernameEndpoint

UsersGetByUsernameEndpoint: object

Type declaration

username: string

username parameter

UsersGetByUsernameRequestOptions

UsersGetByUsernameRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/users/:username"

UsersGetByUsernameResponseData

UsersGetByUsernameResponseData: object

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?: UsersGetByUsernameResponseDataPlan
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

UsersGetByUsernameResponseDataPlan

UsersGetByUsernameResponseDataPlan: object

Type declaration

collaborators: number
name: string
private_repos: number
space: number

UsersGetContextForUserEndpoint

UsersGetContextForUserEndpoint: object

Type declaration

Optional subject_id?: 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

username parameter

UsersGetContextForUserRequestOptions

UsersGetContextForUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/users/:username/hovercard"

UsersGetContextForUserResponseData

UsersGetContextForUserResponseData: object

Type declaration

contexts: Array<UsersGetContextForUserResponseDataContextsItem>

UsersGetContextForUserResponseDataContextsItem

UsersGetContextForUserResponseDataContextsItem: object

Type declaration

message: string
octicon: string

UsersGetGpgKeyEndpoint

UsersGetGpgKeyEndpoint: object

Type declaration

gpg_key_id: number

gpg_key_id parameter

UsersGetGpgKeyRequestOptions

UsersGetGpgKeyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/user/gpg_keys/:gpg_key_id"

UsersGetGpgKeyResponseData

UsersGetGpgKeyResponseData: object

Type declaration

can_certify: boolean
can_encrypt_comms: boolean
can_encrypt_storage: boolean
can_sign: boolean
created_at: string
emails: Array<UsersGetGpgKeyResponseDataEmailsItem>
expires_at: null
id: number
key_id: string
primary_key_id: null
public_key: string
subkeys: Array<UsersGetGpgKeyResponseDataSubkeysItem>

UsersGetGpgKeyResponseDataEmailsItem

UsersGetGpgKeyResponseDataEmailsItem: object

Type declaration

email: string
verified: boolean

UsersGetGpgKeyResponseDataSubkeysItem

UsersGetGpgKeyResponseDataSubkeysItem: object

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>

UsersGetPublicKeyEndpoint

UsersGetPublicKeyEndpoint: object

Type declaration

key_id: number

key_id parameter

UsersGetPublicKeyRequestOptions

UsersGetPublicKeyRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/user/keys/:key_id"

UsersGetPublicKeyResponseData

UsersGetPublicKeyResponseData: object

Type declaration

key: string
key_id: string

UsersListBlockedEndpoint

UsersListBlockedEndpoint: object

Type declaration

UsersListBlockedRequestOptions

UsersListBlockedRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/user/blocks"

UsersListBlockedResponseData

UsersListBlockedResponseData: Array<UsersListBlockedResponseDataItem>

UsersListBlockedResponseDataItem

UsersListBlockedResponseDataItem: object

Type declaration

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

UsersListEmailsEndpoint

UsersListEmailsEndpoint: object

Type declaration

Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)

UsersListEmailsRequestOptions

UsersListEmailsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/user/emails"

UsersListEmailsResponseData

UsersListEmailsResponseData: Array<UsersListEmailsResponseDataItem>

UsersListEmailsResponseDataItem

UsersListEmailsResponseDataItem: object

Type declaration

email: string
primary: boolean
verified: boolean
visibility: string

UsersListEndpoint

UsersListEndpoint: object

Type declaration

Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
Optional since?: string

The integer ID of the last User that you've seen.

UsersListFollowedByAuthenticatedEndpoint

UsersListFollowedByAuthenticatedEndpoint: object

Type declaration

Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)

UsersListFollowedByAuthenticatedRequestOptions

UsersListFollowedByAuthenticatedRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/user/following"

UsersListFollowedByAuthenticatedResponseData

UsersListFollowedByAuthenticatedResponseData: Array<UsersListFollowedByAuthenticatedResponseDataItem>

UsersListFollowedByAuthenticatedResponseDataItem

UsersListFollowedByAuthenticatedResponseDataItem: object

Type declaration

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

UsersListFollowersForAuthenticatedUserEndpoint

UsersListFollowersForAuthenticatedUserEndpoint: object

Type declaration

Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)

UsersListFollowersForAuthenticatedUserRequestOptions

UsersListFollowersForAuthenticatedUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/user/followers"

UsersListFollowersForAuthenticatedUserResponseData

UsersListFollowersForAuthenticatedUserResponseData: Array<UsersListFollowersForAuthenticatedUserResponseDataItem>

UsersListFollowersForAuthenticatedUserResponseDataItem

UsersListFollowersForAuthenticatedUserResponseDataItem: object

Type declaration

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

UsersListFollowersForUserEndpoint

UsersListFollowersForUserEndpoint: object

Type declaration

Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
username: string

username parameter

UsersListFollowersForUserRequestOptions

UsersListFollowersForUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/users/:username/followers"

UsersListFollowersForUserResponseData

UsersListFollowersForUserResponseData: Array<UsersListFollowersForUserResponseDataItem>

UsersListFollowersForUserResponseDataItem

UsersListFollowersForUserResponseDataItem: object

Type declaration

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

UsersListFollowingForUserEndpoint

UsersListFollowingForUserEndpoint: object

Type declaration

Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
username: string

username parameter

UsersListFollowingForUserRequestOptions

UsersListFollowingForUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/users/:username/following"

UsersListFollowingForUserResponseData

UsersListFollowingForUserResponseData: Array<UsersListFollowingForUserResponseDataItem>

UsersListFollowingForUserResponseDataItem

UsersListFollowingForUserResponseDataItem: object

Type declaration

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

UsersListGpgKeysEndpoint

UsersListGpgKeysEndpoint: object

Type declaration

Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)

UsersListGpgKeysForUserEndpoint

UsersListGpgKeysForUserEndpoint: object

Type declaration

Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
username: string

username parameter

UsersListGpgKeysForUserRequestOptions

UsersListGpgKeysForUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/users/:username/gpg_keys"

UsersListGpgKeysForUserResponseData

UsersListGpgKeysForUserResponseData: Array<UsersListGpgKeysForUserResponseDataItem>

UsersListGpgKeysForUserResponseDataItem

UsersListGpgKeysForUserResponseDataItem: object

Type declaration

can_certify: boolean
can_encrypt_comms: boolean
can_encrypt_storage: boolean
can_sign: boolean
created_at: string
emails: Array<UsersListGpgKeysForUserResponseDataItemEmailsItem>
expires_at: null
id: number
key_id: string
primary_key_id: null
public_key: string
subkeys: Array<UsersListGpgKeysForUserResponseDataItemSubkeysItem>

UsersListGpgKeysForUserResponseDataItemEmailsItem

UsersListGpgKeysForUserResponseDataItemEmailsItem: object

Type declaration

email: string
verified: boolean

UsersListGpgKeysForUserResponseDataItemSubkeysItem

UsersListGpgKeysForUserResponseDataItemSubkeysItem: object

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>

UsersListGpgKeysRequestOptions

UsersListGpgKeysRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/user/gpg_keys"

UsersListGpgKeysResponseData

UsersListGpgKeysResponseData: Array<UsersListGpgKeysResponseDataItem>

UsersListGpgKeysResponseDataItem

UsersListGpgKeysResponseDataItem: object

Type declaration

can_certify: boolean
can_encrypt_comms: boolean
can_encrypt_storage: boolean
can_sign: boolean
created_at: string
emails: Array<UsersListGpgKeysResponseDataItemEmailsItem>
expires_at: null
id: number
key_id: string
primary_key_id: null
public_key: string
subkeys: Array<UsersListGpgKeysResponseDataItemSubkeysItem>

UsersListGpgKeysResponseDataItemEmailsItem

UsersListGpgKeysResponseDataItemEmailsItem: object

Type declaration

email: string
verified: boolean

UsersListGpgKeysResponseDataItemSubkeysItem

UsersListGpgKeysResponseDataItemSubkeysItem: object

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>

UsersListPublicEmailsEndpoint

UsersListPublicEmailsEndpoint: object

Type declaration

Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)

UsersListPublicEmailsRequestOptions

UsersListPublicEmailsRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/user/public_emails"

UsersListPublicEmailsResponseData

UsersListPublicEmailsResponseData: Array<UsersListPublicEmailsResponseDataItem>

UsersListPublicEmailsResponseDataItem

UsersListPublicEmailsResponseDataItem: object

Type declaration

email: string
primary: boolean
verified: boolean
visibility: string

UsersListPublicKeysEndpoint

UsersListPublicKeysEndpoint: object

Type declaration

Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)

UsersListPublicKeysForUserEndpoint

UsersListPublicKeysForUserEndpoint: object

Type declaration

Optional page?: number

Page number of the results to fetch.
Optional per_page?: number

Results per page (max 100)
username: string

username parameter

UsersListPublicKeysForUserRequestOptions

UsersListPublicKeysForUserRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/users/:username/keys"

UsersListPublicKeysForUserResponseData

UsersListPublicKeysForUserResponseData: Array<UsersListPublicKeysForUserResponseDataItem>

UsersListPublicKeysForUserResponseDataItem

UsersListPublicKeysForUserResponseDataItem: object

Type declaration

id: number
key: string

UsersListPublicKeysRequestOptions

UsersListPublicKeysRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/user/keys"

UsersListPublicKeysResponseData

UsersListPublicKeysResponseData: Array<UsersListPublicKeysResponseDataItem>

UsersListPublicKeysResponseDataItem

UsersListPublicKeysResponseDataItem: object

Type declaration

key: string
key_id: string

UsersListRequestOptions

UsersListRequestOptions: object

Type declaration

headers: RequestHeaders
method: "GET"
request: RequestRequestOptions
url: "/users"

UsersListResponseData

UsersListResponseData: Array<UsersListResponseDataItem>

UsersListResponseDataItem

UsersListResponseDataItem: object

Type declaration

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

UsersTogglePrimaryEmailVisibilityEndpoint

UsersTogglePrimaryEmailVisibilityEndpoint: object

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.

UsersTogglePrimaryEmailVisibilityRequestOptions

UsersTogglePrimaryEmailVisibilityRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PATCH"
request: RequestRequestOptions
url: "/user/email/visibility"

UsersTogglePrimaryEmailVisibilityResponseData

UsersTogglePrimaryEmailVisibilityResponseData: Array<UsersTogglePrimaryEmailVisibilityResponseDataItem>

UsersTogglePrimaryEmailVisibilityResponseDataItem

UsersTogglePrimaryEmailVisibilityResponseDataItem: object

Type declaration

email: string
primary: boolean
verified: boolean
visibility: string

UsersUnblockEndpoint

UsersUnblockEndpoint: object

Type declaration

username: string

username parameter

UsersUnblockRequestOptions

UsersUnblockRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/user/blocks/:username"

UsersUnfollowEndpoint

UsersUnfollowEndpoint: object

Type declaration

username: string

username parameter

UsersUnfollowRequestOptions

UsersUnfollowRequestOptions: object

Type declaration

headers: RequestHeaders
method: "DELETE"
request: RequestRequestOptions
url: "/user/following/:username"

UsersUpdateAuthenticatedEndpoint

UsersUpdateAuthenticatedEndpoint: object

Type declaration

Optional bio?: string

The new short biography of the user.
Optional blog?: string

The new blog URL of the user.
Optional company?: string

The new company of the user.
Optional email?: string

The publicly visible email address of the user.
Optional hireable?: boolean

The new hiring availability of the user.
Optional location?: string

The new location of the user.
Optional name?: string

The new name of the user.

UsersUpdateAuthenticatedRequestOptions

UsersUpdateAuthenticatedRequestOptions: object

Type declaration

headers: RequestHeaders
method: "PATCH"
request: RequestRequestOptions
url: "/user"

UsersUpdateAuthenticatedResponseData

UsersUpdateAuthenticatedResponseData: object

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: UsersUpdateAuthenticatedResponseDataPlan
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

UsersUpdateAuthenticatedResponseDataPlan

UsersUpdateAuthenticatedResponseDataPlan: object

Type declaration

collaborators: number
name: string
private_repos: number
space: number

Variables

Const VERSION

VERSION: "2.10.0" = "2.10.0"

Const branch

branch: string = core.getInput("branch")

Const cwd

cwd: string = path.join(process.env.HOME,"/actions_publish_gh_pages_temporary_directory")

Const directory

directory: string = core.getInput("dir")

Const email

email: string = core.getInput("email") ||`${process.env.GITHUB_ACTOR}@users.noreply.github.com`

Const name

name: string = core.getInput("name") || process.env.GITHUB_ACTOR

Const payload

payload: WebhookPayload = github.context.payload

Const repository

repository: string = core.getInput("repo") || payload.repository.full_name

Const token

token: string = core.getInput("token")

Const url

url: string = `https://${token}@github.com/${repository}.git`

Functions

git

git(cmd: string): Promise<number>

- Defined in src/util.ts:10
Parameters
- cmd: string
Returns Promise<number>

init

init(url: string, branch: string): Promise<void>

- Defined in src/util.ts:14
Parameters
- url: string
- branch: string
Returns Promise<void>

publish

publish(): Promise<void>

- Defined in src/index.ts:5
Returns Promise<void>

push

push(name: string, email: string, message: string): Promise<void>

- Defined in src/util.ts:32
Parameters
- name: string
- email: string
- message: string
Returns Promise<void>

update

update(src: string, clean?: boolean): Promise<void>

- Defined in src/util.ts:27
Parameters
- src: string
- Default value clean: boolean = true
Returns Promise<void>

Index

Interfaces

Type aliases

Variables

Functions

Type aliases

ActionsCancelWorkflowRunEndpoint

Type declaration

owner: string

repo: string

run_id: number

ActionsCancelWorkflowRunRequestOptions

Type declaration

headers: RequestHeaders

method: "POST"

request: RequestRequestOptions

url: "/repos/:owner/:repo/actions/runs/:run_id/cancel"

ActionsCreateOrUpdateSecretForRepoEndpoint

Type declaration

Optional encrypted_value?: string

Optional key_id?: string

name: string

owner: string

repo: string

ActionsCreateOrUpdateSecretForRepoRequestOptions

Type declaration

headers: RequestHeaders

method: "PUT"

request: RequestRequestOptions

url: "/repos/:owner/:repo/actions/secrets/:name"

ActionsCreateRegistrationTokenEndpoint

Type declaration

owner: string

repo: string

ActionsCreateRegistrationTokenRequestOptions

Type declaration

headers: RequestHeaders

method: "POST"

request: RequestRequestOptions

url: "/repos/:owner/:repo/actions/runners/registration-token"

ActionsCreateRegistrationTokenResponseData

Type declaration

expires_at: string

token: string

ActionsCreateRemoveTokenEndpoint

Type declaration

owner: string

repo: string

ActionsCreateRemoveTokenRequestOptions

Type declaration

headers: RequestHeaders

method: "POST"

request: RequestRequestOptions

url: "/repos/:owner/:repo/actions/runners/remove-token"

ActionsCreateRemoveTokenResponseData

Type declaration

expires_at: string

token: string

ActionsDeleteArtifactEndpoint

Type declaration

artifact_id: number

owner: string

repo: string

ActionsDeleteArtifactRequestOptions

Type declaration

headers: RequestHeaders

method: "DELETE"

request: RequestRequestOptions

url: "/repos/:owner/:repo/actions/artifacts/:artifact_id"

ActionsDeleteSecretFromRepoEndpoint

Type declaration

name: string

owner: string

repo: string

ActionsDeleteSecretFromRepoRequestOptions

Type declaration

headers: RequestHeaders

method: "DELETE"

request: RequestRequestOptions

url: "/repos/:owner/:repo/actions/secrets/:name"