probot - v0.0.0-development
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Octokit
    • GitHubAPI

Index

Interfaces

Type aliases

Constructors

Properties

Methods

Type aliases

ActivityCheckStarringRepoParams

ActivityCheckStarringRepoParams: object

Type declaration

  • owner: string
  • repo: string

ActivityDeleteRepoSubscriptionParams

ActivityDeleteRepoSubscriptionParams: object

Type declaration

  • owner: string
  • repo: string

ActivityDeleteThreadSubscriptionParams

ActivityDeleteThreadSubscriptionParams: object

Type declaration

  • thread_id: number

ActivityGetRepoSubscriptionParams

ActivityGetRepoSubscriptionParams: object

Type declaration

  • owner: string
  • repo: string

ActivityGetRepoSubscriptionResponse

ActivityGetRepoSubscriptionResponse: object

Type declaration

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

ActivityGetThreadParams

ActivityGetThreadParams: object

Type declaration

  • thread_id: number

ActivityGetThreadResponse

ActivityGetThreadResponse: object

Type declaration

ActivityGetThreadResponseRepository

ActivityGetThreadResponseRepository: 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: ActivityGetThreadResponseRepositoryOwner
  • private: boolean
  • pulls_url: string
  • releases_url: string
  • ssh_url: string
  • stargazers_url: string
  • statuses_url: string
  • subscribers_url: string
  • subscription_url: string
  • tags_url: string
  • teams_url: string
  • trees_url: string
  • url: string

ActivityGetThreadResponseRepositoryOwner

ActivityGetThreadResponseRepositoryOwner: object

Type declaration

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

ActivityGetThreadResponseSubject

ActivityGetThreadResponseSubject: object

Type declaration

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

ActivityGetThreadSubscriptionParams

ActivityGetThreadSubscriptionParams: object

Type declaration

  • thread_id: number

ActivityGetThreadSubscriptionResponse

ActivityGetThreadSubscriptionResponse: object

Type declaration

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

ActivityListEventsForOrgParams

ActivityListEventsForOrgParams: object

Type declaration

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • username: string

ActivityListEventsForUserParams

ActivityListEventsForUserParams: object

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • username: string

ActivityListFeedsResponse

ActivityListFeedsResponse: object

Type declaration

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

ActivityListFeedsResponseLinks

ActivityListFeedsResponseLinks: object

Type declaration

ActivityListFeedsResponseLinksCurrentUser

ActivityListFeedsResponseLinksCurrentUser: object

Type declaration

  • href: string
  • type: string

ActivityListFeedsResponseLinksCurrentUserActor

ActivityListFeedsResponseLinksCurrentUserActor: object

Type declaration

  • href: string
  • type: string

ActivityListFeedsResponseLinksCurrentUserOrganization

ActivityListFeedsResponseLinksCurrentUserOrganization: object

Type declaration

  • href: string
  • type: string

ActivityListFeedsResponseLinksCurrentUserOrganizationsItem

ActivityListFeedsResponseLinksCurrentUserOrganizationsItem: object

Type declaration

  • href: string
  • type: string

ActivityListFeedsResponseLinksCurrentUserPublic

ActivityListFeedsResponseLinksCurrentUserPublic: object

Type declaration

  • href: string
  • type: string

ActivityListFeedsResponseLinksSecurityAdvisories

ActivityListFeedsResponseLinksSecurityAdvisories: object

Type declaration

  • href: string
  • type: string

ActivityListFeedsResponseLinksTimeline

ActivityListFeedsResponseLinksTimeline: object

Type declaration

  • href: string
  • type: string

ActivityListFeedsResponseLinksUser

ActivityListFeedsResponseLinksUser: object

Type declaration

  • href: string
  • type: string

ActivityListNotificationsForRepoParams

ActivityListNotificationsForRepoParams: object

Type declaration

  • Optional all?: undefined | false | true

    If true, show notifications marked as read.

  • Optional before?: undefined | string

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

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

    Page number of the results to fetch.

  • Optional participating?: undefined | false | true

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

  • Optional per_page?: undefined | number

    Results per page (max 100)

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

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

ActivityListNotificationsForRepoResponse

ActivityListNotificationsForRepoResponse: Array<ActivityListNotificationsForRepoResponseItem>

ActivityListNotificationsForRepoResponseItem

ActivityListNotificationsForRepoResponseItem: object

Type declaration

ActivityListNotificationsForRepoResponseItemRepository

ActivityListNotificationsForRepoResponseItemRepository: 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: ActivityListNotificationsForRepoResponseItemRepositoryOwner
  • private: boolean
  • pulls_url: string
  • releases_url: string
  • ssh_url: string
  • stargazers_url: string
  • statuses_url: string
  • subscribers_url: string
  • subscription_url: string
  • tags_url: string
  • teams_url: string
  • trees_url: string
  • url: string

ActivityListNotificationsForRepoResponseItemRepositoryOwner

ActivityListNotificationsForRepoResponseItemRepositoryOwner: object

Type declaration

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

ActivityListNotificationsForRepoResponseItemSubject

ActivityListNotificationsForRepoResponseItemSubject: object

Type declaration

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

ActivityListNotificationsParams

ActivityListNotificationsParams: object

Type declaration

  • Optional all?: undefined | false | true

    If true, show notifications marked as read.

  • Optional before?: undefined | string

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

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional participating?: undefined | false | true

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

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • Optional since?: undefined | string

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

ActivityListNotificationsResponse

ActivityListNotificationsResponse: Array<ActivityListNotificationsResponseItem>

ActivityListNotificationsResponseItem

ActivityListNotificationsResponseItem: object

Type declaration

ActivityListNotificationsResponseItemRepository

ActivityListNotificationsResponseItemRepository: 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: ActivityListNotificationsResponseItemRepositoryOwner
  • private: boolean
  • pulls_url: string
  • releases_url: string
  • ssh_url: string
  • stargazers_url: string
  • statuses_url: string
  • subscribers_url: string
  • subscription_url: string
  • tags_url: string
  • teams_url: string
  • trees_url: string
  • url: string

ActivityListNotificationsResponseItemRepositoryOwner

ActivityListNotificationsResponseItemRepositoryOwner: object

Type declaration

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

ActivityListNotificationsResponseItemSubject

ActivityListNotificationsResponseItemSubject: object

Type declaration

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

ActivityListPublicEventsForOrgParams

ActivityListPublicEventsForOrgParams: object

Type declaration

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

ActivityListPublicEventsForRepoNetworkParams

ActivityListPublicEventsForRepoNetworkParams: object

Type declaration

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ActivityListPublicEventsForUserParams

ActivityListPublicEventsForUserParams: object

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • username: string

ActivityListPublicEventsParams

ActivityListPublicEventsParams: object

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

ActivityListReceivedEventsForUserParams

ActivityListReceivedEventsForUserParams: object

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • username: string

ActivityListReceivedPublicEventsForUserParams

ActivityListReceivedPublicEventsForUserParams: object

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • username: string

ActivityListRepoEventsParams

ActivityListRepoEventsParams: object

Type declaration

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ActivityListReposStarredByAuthenticatedUserParams

ActivityListReposStarredByAuthenticatedUserParams: object

Type declaration

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

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

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

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

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

ActivityListReposStarredByAuthenticatedUserResponse

ActivityListReposStarredByAuthenticatedUserResponse: Array<ActivityListReposStarredByAuthenticatedUserResponseItem>

ActivityListReposStarredByAuthenticatedUserResponseItem

ActivityListReposStarredByAuthenticatedUserResponseItem: 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: ActivityListReposStarredByAuthenticatedUserResponseItemOwner
  • permissions: ActivityListReposStarredByAuthenticatedUserResponseItemPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

ActivityListReposStarredByAuthenticatedUserResponseItemOwner

ActivityListReposStarredByAuthenticatedUserResponseItemOwner: object

Type declaration

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

ActivityListReposStarredByAuthenticatedUserResponseItemPermissions

ActivityListReposStarredByAuthenticatedUserResponseItemPermissions: object

Type declaration

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

ActivityListReposStarredByUserParams

ActivityListReposStarredByUserParams: object

Type declaration

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

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

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

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

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

  • username: string

ActivityListReposStarredByUserResponse

ActivityListReposStarredByUserResponse: Array<ActivityListReposStarredByUserResponseItem>

ActivityListReposStarredByUserResponseItem

ActivityListReposStarredByUserResponseItem: 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: ActivityListReposStarredByUserResponseItemOwner
  • permissions: ActivityListReposStarredByUserResponseItemPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

ActivityListReposStarredByUserResponseItemOwner

ActivityListReposStarredByUserResponseItemOwner: object

Type declaration

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

ActivityListReposStarredByUserResponseItemPermissions

ActivityListReposStarredByUserResponseItemPermissions: object

Type declaration

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

ActivityListReposWatchedByUserParams

ActivityListReposWatchedByUserParams: object

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • username: string

ActivityListReposWatchedByUserResponse

ActivityListReposWatchedByUserResponse: Array<ActivityListReposWatchedByUserResponseItem>

ActivityListReposWatchedByUserResponseItem

ActivityListReposWatchedByUserResponseItem: 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: ActivityListReposWatchedByUserResponseItemLicense
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: ActivityListReposWatchedByUserResponseItemOwner
  • permissions: ActivityListReposWatchedByUserResponseItemPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

ActivityListReposWatchedByUserResponseItemLicense

ActivityListReposWatchedByUserResponseItemLicense: object

Type declaration

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

ActivityListReposWatchedByUserResponseItemOwner

ActivityListReposWatchedByUserResponseItemOwner: object

Type declaration

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

ActivityListReposWatchedByUserResponseItemPermissions

ActivityListReposWatchedByUserResponseItemPermissions: object

Type declaration

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

ActivityListStargazersForRepoParams

ActivityListStargazersForRepoParams: object

Type declaration

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ActivityListStargazersForRepoResponse

ActivityListStargazersForRepoResponse: Array<ActivityListStargazersForRepoResponseItem>

ActivityListStargazersForRepoResponseItem

ActivityListStargazersForRepoResponseItem: object

Type declaration

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

ActivityListWatchedReposForAuthenticatedUserParams

ActivityListWatchedReposForAuthenticatedUserParams: object

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

ActivityListWatchedReposForAuthenticatedUserResponse

ActivityListWatchedReposForAuthenticatedUserResponse: Array<ActivityListWatchedReposForAuthenticatedUserResponseItem>

ActivityListWatchedReposForAuthenticatedUserResponseItem

ActivityListWatchedReposForAuthenticatedUserResponseItem: 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: ActivityListWatchedReposForAuthenticatedUserResponseItemLicense
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: ActivityListWatchedReposForAuthenticatedUserResponseItemOwner
  • permissions: ActivityListWatchedReposForAuthenticatedUserResponseItemPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

ActivityListWatchedReposForAuthenticatedUserResponseItemLicense

ActivityListWatchedReposForAuthenticatedUserResponseItemLicense: object

Type declaration

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

ActivityListWatchedReposForAuthenticatedUserResponseItemOwner

ActivityListWatchedReposForAuthenticatedUserResponseItemOwner: object

Type declaration

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

ActivityListWatchedReposForAuthenticatedUserResponseItemPermissions

ActivityListWatchedReposForAuthenticatedUserResponseItemPermissions: object

Type declaration

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

ActivityListWatchersForRepoParams

ActivityListWatchersForRepoParams: object

Type declaration

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ActivityListWatchersForRepoResponse

ActivityListWatchersForRepoResponse: Array<ActivityListWatchersForRepoResponseItem>

ActivityListWatchersForRepoResponseItem

ActivityListWatchersForRepoResponseItem: object

Type declaration

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

ActivityMarkAsReadParams

ActivityMarkAsReadParams: object

Type declaration

  • Optional last_read_at?: undefined | string

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

ActivityMarkNotificationsAsReadForRepoParams

ActivityMarkNotificationsAsReadForRepoParams: object

Type declaration

  • Optional last_read_at?: undefined | string

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

  • owner: string
  • repo: string

ActivityMarkThreadAsReadParams

ActivityMarkThreadAsReadParams: object

Type declaration

  • thread_id: number

ActivitySetRepoSubscriptionParams

ActivitySetRepoSubscriptionParams: object

Type declaration

  • Optional ignored?: undefined | false | true

    Determines if all notifications should be blocked from this repository.

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

    Determines if notifications should be received from this repository.

ActivitySetRepoSubscriptionResponse

ActivitySetRepoSubscriptionResponse: object

Type declaration

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

ActivitySetThreadSubscriptionParams

ActivitySetThreadSubscriptionParams: object

Type declaration

  • Optional ignored?: undefined | false | true

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

  • thread_id: number

ActivitySetThreadSubscriptionResponse

ActivitySetThreadSubscriptionResponse: object

Type declaration

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

ActivityStarRepoParams

ActivityStarRepoParams: object

Type declaration

  • owner: string
  • repo: string

ActivityUnstarRepoParams

ActivityUnstarRepoParams: object

Type declaration

  • owner: string
  • repo: string

AnyResponse

AnyResponse: Response<any>

AppsAddRepoToInstallationParams

AppsAddRepoToInstallationParams: object

Type declaration

  • installation_id: number
  • repository_id: number

AppsCheckAccountIsAssociatedWithAnyParams

AppsCheckAccountIsAssociatedWithAnyParams: object

Type declaration

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

AppsCheckAccountIsAssociatedWithAnyResponse

AppsCheckAccountIsAssociatedWithAnyResponse: object

Type declaration

AppsCheckAccountIsAssociatedWithAnyResponseMarketplacePendingChange

AppsCheckAccountIsAssociatedWithAnyResponseMarketplacePendingChange: object

Type declaration

AppsCheckAccountIsAssociatedWithAnyResponseMarketplacePendingChangePlan

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

AppsCheckAccountIsAssociatedWithAnyResponseMarketplacePurchase

AppsCheckAccountIsAssociatedWithAnyResponseMarketplacePurchase: object

Type declaration

AppsCheckAccountIsAssociatedWithAnyResponseMarketplacePurchasePlan

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

AppsCheckAccountIsAssociatedWithAnyStubbedParams

AppsCheckAccountIsAssociatedWithAnyStubbedParams: object

Type declaration

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

AppsCheckAccountIsAssociatedWithAnyStubbedResponse

AppsCheckAccountIsAssociatedWithAnyStubbedResponse: object

Type declaration

AppsCheckAccountIsAssociatedWithAnyStubbedResponseMarketplacePendingChange

AppsCheckAccountIsAssociatedWithAnyStubbedResponseMarketplacePendingChange: object

Type declaration

AppsCheckAccountIsAssociatedWithAnyStubbedResponseMarketplacePendingChangePlan

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

AppsCheckAccountIsAssociatedWithAnyStubbedResponseMarketplacePurchase

AppsCheckAccountIsAssociatedWithAnyStubbedResponseMarketplacePurchase: object

Type declaration

AppsCheckAccountIsAssociatedWithAnyStubbedResponseMarketplacePurchasePlan

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

AppsCreateContentAttachmentParams

AppsCreateContentAttachmentParams: object

Type declaration

  • body: string

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

  • content_reference_id: number
  • title: string

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

AppsCreateContentAttachmentResponse

AppsCreateContentAttachmentResponse: object

Type declaration

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

AppsCreateFromManifestParams

AppsCreateFromManifestParams: object

Type declaration

  • code: string

AppsCreateFromManifestResponse

AppsCreateFromManifestResponse: 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: AppsCreateFromManifestResponseOwner
  • pem: string
  • updated_at: string
  • webhook_secret: string

AppsCreateFromManifestResponseOwner

AppsCreateFromManifestResponseOwner: object

Type declaration

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

AppsCreateInstallationTokenParams

AppsCreateInstallationTokenParams: object

Type declaration

  • installation_id: number
  • Optional permissions?: AppsCreateInstallationTokenParamsPermissions

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

  • Optional repository_ids?: number[]

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

AppsCreateInstallationTokenParamsPermissions

AppsCreateInstallationTokenParamsPermissions: object

Type declaration

AppsCreateInstallationTokenResponse

AppsCreateInstallationTokenResponse: object

Type declaration

AppsCreateInstallationTokenResponsePermissions

AppsCreateInstallationTokenResponsePermissions: object

Type declaration

  • contents: string
  • issues: string

AppsCreateInstallationTokenResponseRepositoriesItem

AppsCreateInstallationTokenResponseRepositoriesItem: 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: AppsCreateInstallationTokenResponseRepositoriesItemOwner
  • permissions: AppsCreateInstallationTokenResponseRepositoriesItemPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

AppsCreateInstallationTokenResponseRepositoriesItemOwner

AppsCreateInstallationTokenResponseRepositoriesItemOwner: object

Type declaration

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

AppsCreateInstallationTokenResponseRepositoriesItemPermissions

AppsCreateInstallationTokenResponseRepositoriesItemPermissions: object

Type declaration

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

AppsDeleteInstallationParams

AppsDeleteInstallationParams: object

Type declaration

  • installation_id: number

AppsFindOrgInstallationParams

AppsFindOrgInstallationParams: object

Type declaration

  • org: string

AppsFindOrgInstallationResponse

AppsFindOrgInstallationResponse: object

Type declaration

AppsFindOrgInstallationResponseAccount

AppsFindOrgInstallationResponseAccount: object

Type declaration

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

AppsFindOrgInstallationResponsePermissions

AppsFindOrgInstallationResponsePermissions: object

Type declaration

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

AppsFindRepoInstallationParams

AppsFindRepoInstallationParams: object

Type declaration

  • owner: string
  • repo: string

AppsFindRepoInstallationResponse

AppsFindRepoInstallationResponse: object

Type declaration

AppsFindRepoInstallationResponseAccount

AppsFindRepoInstallationResponseAccount: object

Type declaration

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

AppsFindRepoInstallationResponsePermissions

AppsFindRepoInstallationResponsePermissions: object

Type declaration

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

AppsFindUserInstallationParams

AppsFindUserInstallationParams: object

Type declaration

  • username: string

AppsFindUserInstallationResponse

AppsFindUserInstallationResponse: object

Type declaration

AppsFindUserInstallationResponseAccount

AppsFindUserInstallationResponseAccount: object

Type declaration

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

AppsFindUserInstallationResponsePermissions

AppsFindUserInstallationResponsePermissions: object

Type declaration

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

AppsGetAuthenticatedResponse

AppsGetAuthenticatedResponse: object

Type declaration

AppsGetAuthenticatedResponseOwner

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

AppsGetAuthenticatedResponsePermissions

AppsGetAuthenticatedResponsePermissions: object

Type declaration

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

AppsGetBySlugParams

AppsGetBySlugParams: object

Type declaration

  • app_slug: string

AppsGetBySlugResponse

AppsGetBySlugResponse: object

Type declaration

AppsGetBySlugResponseOwner

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

AppsGetBySlugResponsePermissions

AppsGetBySlugResponsePermissions: object

Type declaration

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

AppsGetInstallationParams

AppsGetInstallationParams: object

Type declaration

  • installation_id: number

AppsGetInstallationResponse

AppsGetInstallationResponse: object

Type declaration

AppsGetInstallationResponseAccount

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

AppsGetInstallationResponsePermissions

AppsGetInstallationResponsePermissions: object

Type declaration

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

AppsGetOrgInstallationParams

AppsGetOrgInstallationParams: object

Type declaration

  • org: string

AppsGetOrgInstallationResponse

AppsGetOrgInstallationResponse: object

Type declaration

AppsGetOrgInstallationResponseAccount

AppsGetOrgInstallationResponseAccount: object

Type declaration

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

AppsGetOrgInstallationResponsePermissions

AppsGetOrgInstallationResponsePermissions: object

Type declaration

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

AppsGetRepoInstallationParams

AppsGetRepoInstallationParams: object

Type declaration

  • owner: string
  • repo: string

AppsGetRepoInstallationResponse

AppsGetRepoInstallationResponse: object

Type declaration

AppsGetRepoInstallationResponseAccount

AppsGetRepoInstallationResponseAccount: object

Type declaration

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

AppsGetRepoInstallationResponsePermissions

AppsGetRepoInstallationResponsePermissions: object

Type declaration

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

AppsGetUserInstallationParams

AppsGetUserInstallationParams: object

Type declaration

  • username: string

AppsGetUserInstallationResponse

AppsGetUserInstallationResponse: object

Type declaration

AppsGetUserInstallationResponseAccount

AppsGetUserInstallationResponseAccount: object

Type declaration

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

AppsGetUserInstallationResponsePermissions

AppsGetUserInstallationResponsePermissions: object

Type declaration

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

AppsListAccountsUserOrOrgOnPlanParams

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

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

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

AppsListAccountsUserOrOrgOnPlanResponse

AppsListAccountsUserOrOrgOnPlanResponse: Array<AppsListAccountsUserOrOrgOnPlanResponseItem>

AppsListAccountsUserOrOrgOnPlanResponseItem

AppsListAccountsUserOrOrgOnPlanResponseItem: object

Type declaration

AppsListAccountsUserOrOrgOnPlanResponseItemMarketplacePendingChange

AppsListAccountsUserOrOrgOnPlanResponseItemMarketplacePendingChange: object

Type declaration

AppsListAccountsUserOrOrgOnPlanResponseItemMarketplacePendingChangePlan

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

AppsListAccountsUserOrOrgOnPlanResponseItemMarketplacePurchase

AppsListAccountsUserOrOrgOnPlanResponseItemMarketplacePurchase: object

Type declaration

AppsListAccountsUserOrOrgOnPlanResponseItemMarketplacePurchasePlan

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

AppsListAccountsUserOrOrgOnPlanStubbedParams

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

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

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

AppsListAccountsUserOrOrgOnPlanStubbedResponse

AppsListAccountsUserOrOrgOnPlanStubbedResponse: Array<AppsListAccountsUserOrOrgOnPlanStubbedResponseItem>

AppsListAccountsUserOrOrgOnPlanStubbedResponseItem

AppsListAccountsUserOrOrgOnPlanStubbedResponseItem: object

Type declaration

AppsListAccountsUserOrOrgOnPlanStubbedResponseItemMarketplacePendingChange

AppsListAccountsUserOrOrgOnPlanStubbedResponseItemMarketplacePendingChange: object

Type declaration

AppsListAccountsUserOrOrgOnPlanStubbedResponseItemMarketplacePendingChangePlan

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

AppsListAccountsUserOrOrgOnPlanStubbedResponseItemMarketplacePurchase

AppsListAccountsUserOrOrgOnPlanStubbedResponseItemMarketplacePurchase: object

Type declaration

AppsListAccountsUserOrOrgOnPlanStubbedResponseItemMarketplacePurchasePlan

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

AppsListInstallationReposForAuthenticatedUserParams

AppsListInstallationReposForAuthenticatedUserParams: object

Type declaration

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

AppsListInstallationReposForAuthenticatedUserResponse

AppsListInstallationReposForAuthenticatedUserResponse: object

Type declaration

AppsListInstallationReposForAuthenticatedUserResponseRepositoriesItem

AppsListInstallationReposForAuthenticatedUserResponseRepositoriesItem: 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: AppsListInstallationReposForAuthenticatedUserResponseRepositoriesItemOwner
  • permissions: AppsListInstallationReposForAuthenticatedUserResponseRepositoriesItemPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

AppsListInstallationReposForAuthenticatedUserResponseRepositoriesItemOwner

AppsListInstallationReposForAuthenticatedUserResponseRepositoriesItemOwner: object

Type declaration

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

AppsListInstallationReposForAuthenticatedUserResponseRepositoriesItemPermissions

AppsListInstallationReposForAuthenticatedUserResponseRepositoriesItemPermissions: object

Type declaration

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

AppsListInstallationsForAuthenticatedUserParams

AppsListInstallationsForAuthenticatedUserParams: object

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

AppsListInstallationsForAuthenticatedUserResponse

AppsListInstallationsForAuthenticatedUserResponse: object

Type declaration

AppsListInstallationsForAuthenticatedUserResponseInstallationsItem

AppsListInstallationsForAuthenticatedUserResponseInstallationsItem: object

Type declaration

AppsListInstallationsForAuthenticatedUserResponseInstallationsItemAccount

AppsListInstallationsForAuthenticatedUserResponseInstallationsItemAccount: object

Type declaration

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

AppsListInstallationsForAuthenticatedUserResponseInstallationsItemPermissions

AppsListInstallationsForAuthenticatedUserResponseInstallationsItemPermissions: object

Type declaration

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

AppsListInstallationsParams

AppsListInstallationsParams: object

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

AppsListInstallationsResponse

AppsListInstallationsResponse: Array<AppsListInstallationsResponseItem>

AppsListInstallationsResponseItem

AppsListInstallationsResponseItem: object

Type declaration

AppsListInstallationsResponseItemAccount

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

AppsListInstallationsResponseItemPermissions

AppsListInstallationsResponseItemPermissions: object

Type declaration

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

AppsListMarketplacePurchasesForAuthenticatedUserParams

AppsListMarketplacePurchasesForAuthenticatedUserParams: object

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

AppsListMarketplacePurchasesForAuthenticatedUserResponse

AppsListMarketplacePurchasesForAuthenticatedUserResponse: Array<AppsListMarketplacePurchasesForAuthenticatedUserResponseItem>

AppsListMarketplacePurchasesForAuthenticatedUserResponseItem

AppsListMarketplacePurchasesForAuthenticatedUserResponseItem: object

Type declaration

AppsListMarketplacePurchasesForAuthenticatedUserResponseItemAccount

AppsListMarketplacePurchasesForAuthenticatedUserResponseItemAccount: object

Type declaration

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

AppsListMarketplacePurchasesForAuthenticatedUserResponseItemPlan

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

AppsListMarketplacePurchasesForAuthenticatedUserStubbedParams

AppsListMarketplacePurchasesForAuthenticatedUserStubbedParams: object

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

AppsListMarketplacePurchasesForAuthenticatedUserStubbedResponse

AppsListMarketplacePurchasesForAuthenticatedUserStubbedResponse: Array<AppsListMarketplacePurchasesForAuthenticatedUserStubbedResponseItem>

AppsListMarketplacePurchasesForAuthenticatedUserStubbedResponseItem

AppsListMarketplacePurchasesForAuthenticatedUserStubbedResponseItem: object

Type declaration

AppsListMarketplacePurchasesForAuthenticatedUserStubbedResponseItemAccount

AppsListMarketplacePurchasesForAuthenticatedUserStubbedResponseItemAccount: object

Type declaration

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

AppsListMarketplacePurchasesForAuthenticatedUserStubbedResponseItemPlan

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

AppsListPlansParams

AppsListPlansParams: object

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

AppsListPlansResponse

AppsListPlansResponse: Array<AppsListPlansResponseItem>

AppsListPlansResponseItem

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

AppsListPlansStubbedParams

AppsListPlansStubbedParams: object

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

AppsListPlansStubbedResponse

AppsListPlansStubbedResponse: Array<AppsListPlansStubbedResponseItem>

AppsListPlansStubbedResponseItem

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

AppsListReposParams

AppsListReposParams: object

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

AppsListReposResponse

AppsListReposResponse: object

Type declaration

AppsListReposResponseRepositoriesItem

AppsListReposResponseRepositoriesItem: 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: AppsListReposResponseRepositoriesItemOwner
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

AppsListReposResponseRepositoriesItemOwner

AppsListReposResponseRepositoriesItemOwner: object

Type declaration

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

AppsRemoveRepoFromInstallationParams

AppsRemoveRepoFromInstallationParams: object

Type declaration

  • installation_id: number
  • repository_id: number

ChecksCreateParams

ChecksCreateParams: object

Type declaration

  • Optional actions?: ChecksCreateParamsActions[]

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

  • Optional completed_at?: undefined | string

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

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

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

  • Optional details_url?: undefined | string

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

  • Optional external_id?: undefined | string

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

  • head_sha: string

    The SHA of the commit.

  • name: string

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

  • Optional output?: ChecksCreateParamsOutput

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

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

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

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

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

ChecksCreateParamsActions

ChecksCreateParamsActions: object

Type declaration

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

ChecksCreateParamsOutput

ChecksCreateParamsOutput: object

Type declaration

ChecksCreateParamsOutputAnnotations

ChecksCreateParamsOutputAnnotations: object

Type declaration

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

ChecksCreateParamsOutputImages

ChecksCreateParamsOutputImages: object

Type declaration

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

ChecksCreateResponse

ChecksCreateResponse: object

Type declaration

ChecksCreateResponseApp

ChecksCreateResponseApp: object

Type declaration

ChecksCreateResponseAppOwner

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

ChecksCreateResponseAppPermissions

ChecksCreateResponseAppPermissions: object

Type declaration

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

ChecksCreateResponseCheckSuite

ChecksCreateResponseCheckSuite: object

Type declaration

  • id: number

ChecksCreateResponseOutput

ChecksCreateResponseOutput: object

Type declaration

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

ChecksCreateResponsePullRequestsItem

ChecksCreateResponsePullRequestsItem: object

Type declaration

ChecksCreateResponsePullRequestsItemBase

ChecksCreateResponsePullRequestsItemBase: object

Type declaration

ChecksCreateResponsePullRequestsItemBaseRepo

ChecksCreateResponsePullRequestsItemBaseRepo: object

Type declaration

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

ChecksCreateResponsePullRequestsItemHead

ChecksCreateResponsePullRequestsItemHead: object

Type declaration

ChecksCreateResponsePullRequestsItemHeadRepo

ChecksCreateResponsePullRequestsItemHeadRepo: object

Type declaration

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

ChecksCreateSuiteParams

ChecksCreateSuiteParams: object

Type declaration

  • head_sha: string

    The sha of the head commit.

  • owner: string
  • repo: string

ChecksCreateSuiteResponse

ChecksCreateSuiteResponse: object

Type declaration

ChecksCreateSuiteResponseApp

ChecksCreateSuiteResponseApp: object

Type declaration

ChecksCreateSuiteResponseAppOwner

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

ChecksCreateSuiteResponseAppPermissions

ChecksCreateSuiteResponseAppPermissions: object

Type declaration

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

ChecksCreateSuiteResponseRepository

ChecksCreateSuiteResponseRepository: 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: ChecksCreateSuiteResponseRepositoryOwner
  • permissions: ChecksCreateSuiteResponseRepositoryPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

ChecksCreateSuiteResponseRepositoryOwner

ChecksCreateSuiteResponseRepositoryOwner: object

Type declaration

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

ChecksCreateSuiteResponseRepositoryPermissions

ChecksCreateSuiteResponseRepositoryPermissions: object

Type declaration

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

ChecksGetParams

ChecksGetParams: object

Type declaration

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

ChecksGetResponse

ChecksGetResponse: object

Type declaration

ChecksGetResponseApp

ChecksGetResponseApp: object

Type declaration

ChecksGetResponseAppOwner

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

ChecksGetResponseAppPermissions

ChecksGetResponseAppPermissions: object

Type declaration

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

ChecksGetResponseCheckSuite

ChecksGetResponseCheckSuite: object

Type declaration

  • id: number

ChecksGetResponseOutput

ChecksGetResponseOutput: object

Type declaration

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

ChecksGetResponsePullRequestsItem

ChecksGetResponsePullRequestsItem: object

Type declaration

ChecksGetResponsePullRequestsItemBase

ChecksGetResponsePullRequestsItemBase: object

Type declaration

ChecksGetResponsePullRequestsItemBaseRepo

ChecksGetResponsePullRequestsItemBaseRepo: object

Type declaration

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

ChecksGetResponsePullRequestsItemHead

ChecksGetResponsePullRequestsItemHead: object

Type declaration

ChecksGetResponsePullRequestsItemHeadRepo

ChecksGetResponsePullRequestsItemHeadRepo: object

Type declaration

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

ChecksGetSuiteParams

ChecksGetSuiteParams: object

Type declaration

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

ChecksGetSuiteResponse

ChecksGetSuiteResponse: object

Type declaration

ChecksGetSuiteResponseApp

ChecksGetSuiteResponseApp: object

Type declaration

ChecksGetSuiteResponseAppOwner

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

ChecksGetSuiteResponseAppPermissions

ChecksGetSuiteResponseAppPermissions: object

Type declaration

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

ChecksGetSuiteResponseRepository

ChecksGetSuiteResponseRepository: 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: ChecksGetSuiteResponseRepositoryOwner
  • permissions: ChecksGetSuiteResponseRepositoryPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

ChecksGetSuiteResponseRepositoryOwner

ChecksGetSuiteResponseRepositoryOwner: object

Type declaration

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

ChecksGetSuiteResponseRepositoryPermissions

ChecksGetSuiteResponseRepositoryPermissions: object

Type declaration

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

ChecksListAnnotationsParams

ChecksListAnnotationsParams: object

Type declaration

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ChecksListAnnotationsResponse

ChecksListAnnotationsResponse: Array<ChecksListAnnotationsResponseItem>

ChecksListAnnotationsResponseItem

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

ChecksListForRefParams

ChecksListForRefParams: object

Type declaration

  • Optional check_name?: undefined | string

    Returns check runs with the specified name.

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

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

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

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

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

ChecksListForRefResponse

ChecksListForRefResponse: object

Type declaration

ChecksListForRefResponseCheckRunsItem

ChecksListForRefResponseCheckRunsItem: object

Type declaration

ChecksListForRefResponseCheckRunsItemApp

ChecksListForRefResponseCheckRunsItemApp: object

Type declaration

ChecksListForRefResponseCheckRunsItemAppOwner

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

ChecksListForRefResponseCheckRunsItemAppPermissions

ChecksListForRefResponseCheckRunsItemAppPermissions: object

Type declaration

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

ChecksListForRefResponseCheckRunsItemCheckSuite

ChecksListForRefResponseCheckRunsItemCheckSuite: object

Type declaration

  • id: number

ChecksListForRefResponseCheckRunsItemOutput

ChecksListForRefResponseCheckRunsItemOutput: object

Type declaration

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

ChecksListForRefResponseCheckRunsItemPullRequestsItem

ChecksListForRefResponseCheckRunsItemPullRequestsItem: object

Type declaration

ChecksListForRefResponseCheckRunsItemPullRequestsItemBase

ChecksListForRefResponseCheckRunsItemPullRequestsItemBase: object

Type declaration

ChecksListForRefResponseCheckRunsItemPullRequestsItemBaseRepo

ChecksListForRefResponseCheckRunsItemPullRequestsItemBaseRepo: object

Type declaration

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

ChecksListForRefResponseCheckRunsItemPullRequestsItemHead

ChecksListForRefResponseCheckRunsItemPullRequestsItemHead: object

Type declaration

ChecksListForRefResponseCheckRunsItemPullRequestsItemHeadRepo

ChecksListForRefResponseCheckRunsItemPullRequestsItemHeadRepo: object

Type declaration

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

ChecksListForSuiteParams

ChecksListForSuiteParams: object

Type declaration

  • Optional check_name?: undefined | string

    Returns check runs with the specified name.

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

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

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

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

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

ChecksListForSuiteResponse

ChecksListForSuiteResponse: object

Type declaration

ChecksListForSuiteResponseCheckRunsItem

ChecksListForSuiteResponseCheckRunsItem: object

Type declaration

ChecksListForSuiteResponseCheckRunsItemApp

ChecksListForSuiteResponseCheckRunsItemApp: object

Type declaration

ChecksListForSuiteResponseCheckRunsItemAppOwner

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

ChecksListForSuiteResponseCheckRunsItemAppPermissions

ChecksListForSuiteResponseCheckRunsItemAppPermissions: object

Type declaration

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

ChecksListForSuiteResponseCheckRunsItemCheckSuite

ChecksListForSuiteResponseCheckRunsItemCheckSuite: object

Type declaration

  • id: number

ChecksListForSuiteResponseCheckRunsItemOutput

ChecksListForSuiteResponseCheckRunsItemOutput: object

Type declaration

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

ChecksListForSuiteResponseCheckRunsItemPullRequestsItem

ChecksListForSuiteResponseCheckRunsItemPullRequestsItem: object

Type declaration

ChecksListForSuiteResponseCheckRunsItemPullRequestsItemBase

ChecksListForSuiteResponseCheckRunsItemPullRequestsItemBase: object

Type declaration

ChecksListForSuiteResponseCheckRunsItemPullRequestsItemBaseRepo

ChecksListForSuiteResponseCheckRunsItemPullRequestsItemBaseRepo: object

Type declaration

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

ChecksListForSuiteResponseCheckRunsItemPullRequestsItemHead

ChecksListForSuiteResponseCheckRunsItemPullRequestsItemHead: object

Type declaration

ChecksListForSuiteResponseCheckRunsItemPullRequestsItemHeadRepo

ChecksListForSuiteResponseCheckRunsItemPullRequestsItemHeadRepo: object

Type declaration

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

ChecksListSuitesForRefParams

ChecksListSuitesForRefParams: object

Type declaration

  • Optional app_id?: undefined | number

    Filters check suites by GitHub App id.

  • Optional check_name?: undefined | string

    Filters checks suites by the name of the check run.

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • ref: string
  • repo: string

ChecksListSuitesForRefResponse

ChecksListSuitesForRefResponse: object

Type declaration

ChecksListSuitesForRefResponseCheckSuitesItem

ChecksListSuitesForRefResponseCheckSuitesItem: object

Type declaration

ChecksListSuitesForRefResponseCheckSuitesItemApp

ChecksListSuitesForRefResponseCheckSuitesItemApp: object

Type declaration

ChecksListSuitesForRefResponseCheckSuitesItemAppOwner

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

ChecksListSuitesForRefResponseCheckSuitesItemAppPermissions

ChecksListSuitesForRefResponseCheckSuitesItemAppPermissions: object

Type declaration

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

ChecksListSuitesForRefResponseCheckSuitesItemRepository

ChecksListSuitesForRefResponseCheckSuitesItemRepository: 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: ChecksListSuitesForRefResponseCheckSuitesItemRepositoryOwner
  • permissions: ChecksListSuitesForRefResponseCheckSuitesItemRepositoryPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

ChecksListSuitesForRefResponseCheckSuitesItemRepositoryOwner

ChecksListSuitesForRefResponseCheckSuitesItemRepositoryOwner: object

Type declaration

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

ChecksListSuitesForRefResponseCheckSuitesItemRepositoryPermissions

ChecksListSuitesForRefResponseCheckSuitesItemRepositoryPermissions: object

Type declaration

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

ChecksRerequestSuiteParams

ChecksRerequestSuiteParams: object

Type declaration

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

ChecksSetSuitesPreferencesParams

ChecksSetSuitesPreferencesParams: object

Type declaration

ChecksSetSuitesPreferencesParamsAutoTriggerChecks

ChecksSetSuitesPreferencesParamsAutoTriggerChecks: object

Type declaration

  • app_id: number
  • setting: boolean

ChecksSetSuitesPreferencesResponse

ChecksSetSuitesPreferencesResponse: object

Type declaration

ChecksSetSuitesPreferencesResponsePreferences

ChecksSetSuitesPreferencesResponsePreferences: object

Type declaration

ChecksSetSuitesPreferencesResponsePreferencesAutoTriggerChecksItem

ChecksSetSuitesPreferencesResponsePreferencesAutoTriggerChecksItem: object

Type declaration

  • app_id: number
  • setting: boolean

ChecksSetSuitesPreferencesResponseRepository

ChecksSetSuitesPreferencesResponseRepository: 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: ChecksSetSuitesPreferencesResponseRepositoryOwner
  • permissions: ChecksSetSuitesPreferencesResponseRepositoryPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

ChecksSetSuitesPreferencesResponseRepositoryOwner

ChecksSetSuitesPreferencesResponseRepositoryOwner: object

Type declaration

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

ChecksSetSuitesPreferencesResponseRepositoryPermissions

ChecksSetSuitesPreferencesResponseRepositoryPermissions: object

Type declaration

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

ChecksUpdateParams

ChecksUpdateParams: object

Type declaration

  • Optional actions?: ChecksUpdateParamsActions[]

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

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

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

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

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

  • Optional details_url?: undefined | string

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

  • Optional external_id?: undefined | string

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

  • Optional name?: undefined | string

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

  • Optional output?: ChecksUpdateParamsOutput

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

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

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

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

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

ChecksUpdateParamsActions

ChecksUpdateParamsActions: object

Type declaration

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

ChecksUpdateParamsOutput

ChecksUpdateParamsOutput: object

Type declaration

ChecksUpdateParamsOutputAnnotations

ChecksUpdateParamsOutputAnnotations: object

Type declaration

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

ChecksUpdateParamsOutputImages

ChecksUpdateParamsOutputImages: object

Type declaration

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

ChecksUpdateResponse

ChecksUpdateResponse: object

Type declaration

ChecksUpdateResponseApp

ChecksUpdateResponseApp: object

Type declaration

ChecksUpdateResponseAppOwner

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

ChecksUpdateResponseAppPermissions

ChecksUpdateResponseAppPermissions: object

Type declaration

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

ChecksUpdateResponseCheckSuite

ChecksUpdateResponseCheckSuite: object

Type declaration

  • id: number

ChecksUpdateResponseOutput

ChecksUpdateResponseOutput: object

Type declaration

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

ChecksUpdateResponsePullRequestsItem

ChecksUpdateResponsePullRequestsItem: object

Type declaration

ChecksUpdateResponsePullRequestsItemBase

ChecksUpdateResponsePullRequestsItemBase: object

Type declaration

ChecksUpdateResponsePullRequestsItemBaseRepo

ChecksUpdateResponsePullRequestsItemBaseRepo: object

Type declaration

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

ChecksUpdateResponsePullRequestsItemHead

ChecksUpdateResponsePullRequestsItemHead: object

Type declaration

ChecksUpdateResponsePullRequestsItemHeadRepo

ChecksUpdateResponsePullRequestsItemHeadRepo: object

Type declaration

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

CodesOfConductGetConductCodeParams

CodesOfConductGetConductCodeParams: object

Type declaration

  • key: string

CodesOfConductGetConductCodeResponse

CodesOfConductGetConductCodeResponse: object

Type declaration

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

CodesOfConductGetForRepoParams

CodesOfConductGetForRepoParams: object

Type declaration

  • owner: string
  • repo: string

CodesOfConductGetForRepoResponse

CodesOfConductGetForRepoResponse: object

Type declaration

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

CodesOfConductListConductCodesResponse

CodesOfConductListConductCodesResponse: Array<CodesOfConductListConductCodesResponseItem>

CodesOfConductListConductCodesResponseItem

CodesOfConductListConductCodesResponseItem: object

Type declaration

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

GistsCheckIsStarredParams

GistsCheckIsStarredParams: object

Type declaration

  • gist_id: string

GistsCreateCommentParams

GistsCreateCommentParams: object

Type declaration

  • body: string

    The comment text.

  • gist_id: string

GistsCreateCommentResponse

GistsCreateCommentResponse: object

Type declaration

GistsCreateCommentResponseUser

GistsCreateCommentResponseUser: object

Type declaration

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

GistsCreateParams

GistsCreateParams: object

Type declaration

  • Optional description?: undefined | string

    A descriptive name for this gist.

  • files: GistsCreateParamsFiles

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

  • Optional public?: undefined | false | true

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

GistsCreateParamsFiles

GistsCreateParamsFiles: object

Type declaration

  • Optional content?: undefined | string

GistsCreateResponse

GistsCreateResponse: object

Type declaration

GistsCreateResponseFiles

GistsCreateResponseFiles: object

Type declaration

GistsCreateResponseFilesHelloWorldPy

GistsCreateResponseFilesHelloWorldPy: object

Type declaration

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

GistsCreateResponseFilesHelloWorldPythonTxt

GistsCreateResponseFilesHelloWorldPythonTxt: object

Type declaration

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

GistsCreateResponseFilesHelloWorldRb

GistsCreateResponseFilesHelloWorldRb: object

Type declaration

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

GistsCreateResponseFilesHelloWorldRubyTxt

GistsCreateResponseFilesHelloWorldRubyTxt: object

Type declaration

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

GistsCreateResponseForksItem

GistsCreateResponseForksItem: object

Type declaration

GistsCreateResponseForksItemUser

GistsCreateResponseForksItemUser: object

Type declaration

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

GistsCreateResponseHistoryItem

GistsCreateResponseHistoryItem: object

Type declaration

GistsCreateResponseHistoryItemChangeStatus

GistsCreateResponseHistoryItemChangeStatus: object

Type declaration

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

GistsCreateResponseHistoryItemUser

GistsCreateResponseHistoryItemUser: object

Type declaration

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

GistsCreateResponseOwner

GistsCreateResponseOwner: object

Type declaration

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

GistsDeleteCommentParams

GistsDeleteCommentParams: object

Type declaration

  • comment_id: number
  • gist_id: string

GistsDeleteParams

GistsDeleteParams: object

Type declaration

  • gist_id: string

GistsForkParams

GistsForkParams: object

Type declaration

  • gist_id: string

GistsForkResponse

GistsForkResponse: object

Type declaration

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

GistsForkResponseFiles

GistsForkResponseFiles: object

Type declaration

GistsForkResponseFilesHelloWorldRb

GistsForkResponseFilesHelloWorldRb: object

Type declaration

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

GistsForkResponseOwner

GistsForkResponseOwner: object

Type declaration

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

GistsGetCommentParams

GistsGetCommentParams: object

Type declaration

  • comment_id: number
  • gist_id: string

GistsGetCommentResponse

GistsGetCommentResponse: object

Type declaration

GistsGetCommentResponseUser

GistsGetCommentResponseUser: object

Type declaration

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

GistsGetParams

GistsGetParams: object

Type declaration

  • gist_id: string

GistsGetResponse

GistsGetResponse: object

Type declaration

GistsGetResponseFiles

GistsGetResponseFiles: object

Type declaration

GistsGetResponseFilesHelloWorldPy

GistsGetResponseFilesHelloWorldPy: object

Type declaration

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

GistsGetResponseFilesHelloWorldPythonTxt

GistsGetResponseFilesHelloWorldPythonTxt: object

Type declaration

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

GistsGetResponseFilesHelloWorldRb

GistsGetResponseFilesHelloWorldRb: object

Type declaration

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

GistsGetResponseFilesHelloWorldRubyTxt

GistsGetResponseFilesHelloWorldRubyTxt: object

Type declaration

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

GistsGetResponseForksItem

GistsGetResponseForksItem: object

Type declaration

GistsGetResponseForksItemUser

GistsGetResponseForksItemUser: object

Type declaration

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

GistsGetResponseHistoryItem

GistsGetResponseHistoryItem: object

Type declaration

GistsGetResponseHistoryItemChangeStatus

GistsGetResponseHistoryItemChangeStatus: object

Type declaration

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

GistsGetResponseHistoryItemUser

GistsGetResponseHistoryItemUser: object

Type declaration

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

GistsGetResponseOwner

GistsGetResponseOwner: object

Type declaration

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

GistsGetRevisionParams

GistsGetRevisionParams: object

Type declaration

  • gist_id: string
  • sha: string

GistsGetRevisionResponse

GistsGetRevisionResponse: object

Type declaration

GistsGetRevisionResponseFiles

GistsGetRevisionResponseFiles: object

Type declaration

GistsGetRevisionResponseFilesHelloWorldPy

GistsGetRevisionResponseFilesHelloWorldPy: object

Type declaration

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

GistsGetRevisionResponseFilesHelloWorldPythonTxt

GistsGetRevisionResponseFilesHelloWorldPythonTxt: object

Type declaration

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

GistsGetRevisionResponseFilesHelloWorldRb

GistsGetRevisionResponseFilesHelloWorldRb: object

Type declaration

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

GistsGetRevisionResponseFilesHelloWorldRubyTxt

GistsGetRevisionResponseFilesHelloWorldRubyTxt: object

Type declaration

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

GistsGetRevisionResponseForksItem

GistsGetRevisionResponseForksItem: object

Type declaration

GistsGetRevisionResponseForksItemUser

GistsGetRevisionResponseForksItemUser: object

Type declaration

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

GistsGetRevisionResponseHistoryItem

GistsGetRevisionResponseHistoryItem: object

Type declaration

GistsGetRevisionResponseHistoryItemChangeStatus

GistsGetRevisionResponseHistoryItemChangeStatus: object

Type declaration

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

GistsGetRevisionResponseHistoryItemUser

GistsGetRevisionResponseHistoryItemUser: object

Type declaration

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

GistsGetRevisionResponseOwner

GistsGetRevisionResponseOwner: object

Type declaration

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

GistsListCommentsParams

GistsListCommentsParams: object

Type declaration

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

GistsListCommentsResponse

GistsListCommentsResponse: Array<GistsListCommentsResponseItem>

GistsListCommentsResponseItem

GistsListCommentsResponseItem: object

Type declaration

GistsListCommentsResponseItemUser

GistsListCommentsResponseItemUser: object

Type declaration

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

GistsListCommitsParams

GistsListCommitsParams: object

Type declaration

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

GistsListCommitsResponse

GistsListCommitsResponse: Array<GistsListCommitsResponseItem>

GistsListCommitsResponseItem

GistsListCommitsResponseItem: object

Type declaration

GistsListCommitsResponseItemChangeStatus

GistsListCommitsResponseItemChangeStatus: object

Type declaration

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

GistsListCommitsResponseItemUser

GistsListCommitsResponseItemUser: object

Type declaration

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

GistsListForksParams

GistsListForksParams: object

Type declaration

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

GistsListForksResponse

GistsListForksResponse: Array<GistsListForksResponseItem>

GistsListForksResponseItem

GistsListForksResponseItem: object

Type declaration

GistsListForksResponseItemUser

GistsListForksResponseItemUser: object

Type declaration

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

GistsListParams

GistsListParams: object

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • Optional since?: undefined | string

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

GistsListPublicForUserParams

GistsListPublicForUserParams: object

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • Optional since?: undefined | string

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

  • username: string

GistsListPublicForUserResponse

GistsListPublicForUserResponse: Array<GistsListPublicForUserResponseItem>

GistsListPublicForUserResponseItem

GistsListPublicForUserResponseItem: object

Type declaration

GistsListPublicForUserResponseItemFiles

GistsListPublicForUserResponseItemFiles: object

Type declaration

GistsListPublicForUserResponseItemFilesHelloWorldRb

GistsListPublicForUserResponseItemFilesHelloWorldRb: object

Type declaration

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

GistsListPublicForUserResponseItemOwner

GistsListPublicForUserResponseItemOwner: object

Type declaration

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

GistsListPublicParams

GistsListPublicParams: object

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • Optional since?: undefined | string

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

GistsListPublicResponse

GistsListPublicResponse: Array<GistsListPublicResponseItem>

GistsListPublicResponseItem

GistsListPublicResponseItem: object

Type declaration

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

GistsListPublicResponseItemFiles

GistsListPublicResponseItemFiles: object

Type declaration

GistsListPublicResponseItemFilesHelloWorldRb

GistsListPublicResponseItemFilesHelloWorldRb: object

Type declaration

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

GistsListPublicResponseItemOwner

GistsListPublicResponseItemOwner: object

Type declaration

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

GistsListResponse

GistsListResponse: Array<GistsListResponseItem>

GistsListResponseItem

GistsListResponseItem: object

Type declaration

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

GistsListResponseItemFiles

GistsListResponseItemFiles: object

Type declaration

GistsListResponseItemFilesHelloWorldRb

GistsListResponseItemFilesHelloWorldRb: object

Type declaration

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

GistsListResponseItemOwner

GistsListResponseItemOwner: object

Type declaration

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

GistsListStarredParams

GistsListStarredParams: object

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • Optional since?: undefined | string

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

GistsListStarredResponse

GistsListStarredResponse: Array<GistsListStarredResponseItem>

GistsListStarredResponseItem

GistsListStarredResponseItem: object

Type declaration

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

GistsListStarredResponseItemFiles

GistsListStarredResponseItemFiles: object

Type declaration

GistsListStarredResponseItemFilesHelloWorldRb

GistsListStarredResponseItemFilesHelloWorldRb: object

Type declaration

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

GistsListStarredResponseItemOwner

GistsListStarredResponseItemOwner: object

Type declaration

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

GistsStarParams

GistsStarParams: object

Type declaration

  • gist_id: string

GistsUnstarParams

GistsUnstarParams: object

Type declaration

  • gist_id: string

GistsUpdateCommentParams

GistsUpdateCommentParams: object

Type declaration

  • body: string

    The comment text.

  • comment_id: number
  • gist_id: string

GistsUpdateCommentResponse

GistsUpdateCommentResponse: object

Type declaration

GistsUpdateCommentResponseUser

GistsUpdateCommentResponseUser: object

Type declaration

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

GistsUpdateParams

GistsUpdateParams: object

Type declaration

  • Optional description?: undefined | string

    A descriptive name for this gist.

  • Optional files?: GistsUpdateParamsFiles

    The filenames and content that make up this gist.

  • gist_id: string

GistsUpdateParamsFiles

GistsUpdateParamsFiles: object

Type declaration

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

GistsUpdateResponse

GistsUpdateResponse: object

Type declaration

GistsUpdateResponseFiles

GistsUpdateResponseFiles: object

Type declaration

GistsUpdateResponseFilesHelloWorldMd

GistsUpdateResponseFilesHelloWorldMd: object

Type declaration

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

GistsUpdateResponseFilesHelloWorldPy

GistsUpdateResponseFilesHelloWorldPy: object

Type declaration

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

GistsUpdateResponseFilesHelloWorldRb

GistsUpdateResponseFilesHelloWorldRb: object

Type declaration

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

GistsUpdateResponseFilesNewFileTxt

GistsUpdateResponseFilesNewFileTxt: object

Type declaration

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

GistsUpdateResponseForksItem

GistsUpdateResponseForksItem: object

Type declaration

GistsUpdateResponseForksItemUser

GistsUpdateResponseForksItemUser: object

Type declaration

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

GistsUpdateResponseHistoryItem

GistsUpdateResponseHistoryItem: object

Type declaration

GistsUpdateResponseHistoryItemChangeStatus

GistsUpdateResponseHistoryItemChangeStatus: object

Type declaration

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

GistsUpdateResponseHistoryItemUser

GistsUpdateResponseHistoryItemUser: object

Type declaration

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

GistsUpdateResponseOwner

GistsUpdateResponseOwner: object

Type declaration

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

GitCreateBlobParams

GitCreateBlobParams: object

Type declaration

  • content: string

    The new blob's content.

  • Optional encoding?: undefined | string

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

  • owner: string
  • repo: string

GitCreateBlobResponse

GitCreateBlobResponse: object

Type declaration

  • sha: string
  • url: string

GitCreateCommitParams

GitCreateCommitParams: 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
  • parents: string[]

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

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

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

  • tree: string

    The SHA of the tree object this commit points to

GitCreateCommitParamsAuthor

GitCreateCommitParamsAuthor: object

Type declaration

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

GitCreateCommitParamsCommitter

GitCreateCommitParamsCommitter: object

Type declaration

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

GitCreateCommitResponse

GitCreateCommitResponse: object

Type declaration

GitCreateCommitResponseAuthor

GitCreateCommitResponseAuthor: object

Type declaration

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

GitCreateCommitResponseCommitter

GitCreateCommitResponseCommitter: object

Type declaration

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

GitCreateCommitResponseParentsItem

GitCreateCommitResponseParentsItem: object

Type declaration

  • sha: string
  • url: string

GitCreateCommitResponseTree

GitCreateCommitResponseTree: object

Type declaration

  • sha: string
  • url: string

GitCreateCommitResponseVerification

GitCreateCommitResponseVerification: object

Type declaration

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

GitCreateRefParams

GitCreateRefParams: object

Type declaration

  • owner: string
  • ref: string

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

  • repo: string
  • sha: string

    The SHA1 value for this reference.

GitCreateRefResponse

GitCreateRefResponse: object

Type declaration

GitCreateRefResponseObject

GitCreateRefResponseObject: object

Type declaration

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

GitCreateTagParams

GitCreateTagParams: object

Type declaration

  • message: string

    The tag message.

  • object: string

    The SHA of the git object this is tagging.

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

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

  • Optional tagger?: GitCreateTagParamsTagger

    An object with information about the individual creating the tag.

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

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

GitCreateTagParamsTagger

GitCreateTagParamsTagger: object

Type declaration

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

GitCreateTagResponse

GitCreateTagResponse: object

Type declaration

GitCreateTagResponseObject

GitCreateTagResponseObject: object

Type declaration

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

GitCreateTagResponseTagger

GitCreateTagResponseTagger: object

Type declaration

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

GitCreateTagResponseVerification

GitCreateTagResponseVerification: object

Type declaration

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

GitCreateTreeParams

GitCreateTreeParams: object

Type declaration

  • Optional base_tree?: undefined | string

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

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

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

GitCreateTreeParamsTree

GitCreateTreeParamsTree: object

Type declaration

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

GitCreateTreeResponse

GitCreateTreeResponse: object

Type declaration

GitCreateTreeResponseTreeItem

GitCreateTreeResponseTreeItem: object

Type declaration

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

GitDeleteRefParams

GitDeleteRefParams: object

Type declaration

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

GitGetBlobParams

GitGetBlobParams: object

Type declaration

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

GitGetBlobResponse

GitGetBlobResponse: object

Type declaration

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

GitGetCommitParams

GitGetCommitParams: object

Type declaration

  • commit_sha: string
  • owner: string
  • repo: string

GitGetCommitResponse

GitGetCommitResponse: object

Type declaration

GitGetCommitResponseAuthor

GitGetCommitResponseAuthor: object

Type declaration

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

GitGetCommitResponseCommitter

GitGetCommitResponseCommitter: object

Type declaration

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

GitGetCommitResponseParentsItem

GitGetCommitResponseParentsItem: object

Type declaration

  • sha: string
  • url: string

GitGetCommitResponseTree

GitGetCommitResponseTree: object

Type declaration

  • sha: string
  • url: string

GitGetCommitResponseVerification

GitGetCommitResponseVerification: object

Type declaration

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

GitGetRefParams

GitGetRefParams: object

Type declaration

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

GitGetRefResponse

GitGetRefResponse: object

Type declaration

GitGetRefResponseObject

GitGetRefResponseObject: object

Type declaration

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

GitGetTagParams

GitGetTagParams: object

Type declaration

  • owner: string
  • repo: string
  • tag_sha: string

GitGetTagResponse

GitGetTagResponse: object

Type declaration

GitGetTagResponseObject

GitGetTagResponseObject: object

Type declaration

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

GitGetTagResponseTagger

GitGetTagResponseTagger: object

Type declaration

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

GitGetTagResponseVerification

GitGetTagResponseVerification: object

Type declaration

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

GitGetTreeParams

GitGetTreeParams: object

Type declaration

  • owner: string
  • Optional recursive?: undefined | "1"
  • repo: string
  • tree_sha: string

GitListMatchingRefsParams

GitListMatchingRefsParams: object

Type declaration

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • ref: string
  • repo: string

GitListMatchingRefsResponse

GitListMatchingRefsResponse: Array<GitListMatchingRefsResponseItem>

GitListMatchingRefsResponseItem

GitListMatchingRefsResponseItem: object

Type declaration

GitListMatchingRefsResponseItemObject

GitListMatchingRefsResponseItemObject: object

Type declaration

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

GitListRefsParams

GitListRefsParams: object

Type declaration

  • Optional namespace?: undefined | string

    Filter by sub-namespace (reference prefix). Most commen examples would be 'heads/' and 'tags/' to retrieve branches or tags

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

GitUpdateRefParams

GitUpdateRefParams: object

Type declaration

  • Optional force?: undefined | false | true

    Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to false will make sure you're not overwriting work.

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

    The SHA1 value to set this reference to

GitUpdateRefResponse

GitUpdateRefResponse: object

Type declaration

GitUpdateRefResponseObject

GitUpdateRefResponseObject: object

Type declaration

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

GitignoreGetTemplateParams

GitignoreGetTemplateParams: object

Type declaration

  • name: string

GitignoreGetTemplateResponse

GitignoreGetTemplateResponse: object

Type declaration

  • name: string
  • source: string

GitignoreListTemplatesResponse

GitignoreListTemplatesResponse: Array<string>

HookError

HookError: Error & object

HookOptions

HookOptions: object

Type declaration

  • [index: string]: any
  • baseUrl: string
  • data: any
  • headers: object
    • [header: string]: string
  • method: string
  • request: object
    • Optional agent?: string | null
    • Optional compress?: undefined | false | true
    • Optional follow?: undefined | number
    • Optional size?: undefined | number
    • Optional timeout?: undefined | number
  • url: string

InteractionsAddOrUpdateRestrictionsForOrgParams

InteractionsAddOrUpdateRestrictionsForOrgParams: object

Type declaration

  • limit: "existing_users" | "contributors_only" | "collaborators_only"

    Specifies the group of GitHub users who can comment, open issues, or create pull requests in public repositories for the given organization. Must be one of: existing_users, contributors_only, or collaborators_only.

  • org: string

InteractionsAddOrUpdateRestrictionsForOrgResponse

InteractionsAddOrUpdateRestrictionsForOrgResponse: object

Type declaration

  • expires_at: string
  • limit: string
  • origin: string

InteractionsAddOrUpdateRestrictionsForRepoParams

InteractionsAddOrUpdateRestrictionsForRepoParams: object

Type declaration

  • limit: "existing_users" | "contributors_only" | "collaborators_only"

    Specifies the group of GitHub users who can comment, open issues, or create pull requests for the given repository. Must be one of: existing_users, contributors_only, or collaborators_only.

  • owner: string
  • repo: string

InteractionsAddOrUpdateRestrictionsForRepoResponse

InteractionsAddOrUpdateRestrictionsForRepoResponse: object

Type declaration

  • expires_at: string
  • limit: string
  • origin: string

InteractionsGetRestrictionsForOrgParams

InteractionsGetRestrictionsForOrgParams: object

Type declaration

  • org: string

InteractionsGetRestrictionsForOrgResponse

InteractionsGetRestrictionsForOrgResponse: object

Type declaration

  • expires_at: string
  • limit: string
  • origin: string

InteractionsGetRestrictionsForRepoParams

InteractionsGetRestrictionsForRepoParams: object

Type declaration

  • owner: string
  • repo: string

InteractionsGetRestrictionsForRepoResponse

InteractionsGetRestrictionsForRepoResponse: object

Type declaration

  • expires_at: string
  • limit: string
  • origin: string

InteractionsRemoveRestrictionsForOrgParams

InteractionsRemoveRestrictionsForOrgParams: object

Type declaration

  • org: string

InteractionsRemoveRestrictionsForRepoParams

InteractionsRemoveRestrictionsForRepoParams: object

Type declaration

  • owner: string
  • repo: string

IssuesAddAssigneesParams

IssuesAddAssigneesParams: 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
  • owner: string
  • repo: string

IssuesAddAssigneesParamsDeprecatedNumber

IssuesAddAssigneesParamsDeprecatedNumber: 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.

  • number: number
    deprecated

    "number" parameter renamed to "issue_number"

  • owner: string
  • repo: string

IssuesAddAssigneesResponse

IssuesAddAssigneesResponse: object

Type declaration

IssuesAddAssigneesResponseAssignee

IssuesAddAssigneesResponseAssignee: object

Type declaration

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

IssuesAddAssigneesResponseAssigneesItem

IssuesAddAssigneesResponseAssigneesItem: object

Type declaration

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

IssuesAddAssigneesResponseLabelsItem

IssuesAddAssigneesResponseLabelsItem: object

Type declaration

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

IssuesAddAssigneesResponseMilestone

IssuesAddAssigneesResponseMilestone: object

Type declaration

  • closed_at: string
  • closed_issues: number
  • created_at: string
  • creator: IssuesAddAssigneesResponseMilestoneCreator
  • description: string
  • due_on: string
  • html_url: string
  • id: number
  • labels_url: string
  • node_id: string
  • number: number
  • open_issues: number
  • state: string
  • title: string
  • updated_at: string
  • url: string

IssuesAddAssigneesResponseMilestoneCreator

IssuesAddAssigneesResponseMilestoneCreator: object

Type declaration

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

IssuesAddAssigneesResponsePullRequest

IssuesAddAssigneesResponsePullRequest: object

Type declaration

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

IssuesAddAssigneesResponseUser

IssuesAddAssigneesResponseUser: object

Type declaration

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

IssuesAddLabelsParams

IssuesAddLabelsParams: object

Type declaration

  • issue_number: number
  • labels: string[]

    The name of the label to add to the issue. Must contain at least one label. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

  • owner: string
  • repo: string

IssuesAddLabelsParamsDeprecatedNumber

IssuesAddLabelsParamsDeprecatedNumber: object

Type declaration

  • labels: string[]

    The name of the label to add to the issue. Must contain at least one label. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

  • number: number
    deprecated

    "number" parameter renamed to "issue_number"

  • owner: string
  • repo: string

IssuesAddLabelsResponse

IssuesAddLabelsResponse: Array<IssuesAddLabelsResponseItem>

IssuesAddLabelsResponseItem

IssuesAddLabelsResponseItem: object

Type declaration

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

IssuesCheckAssigneeParams

IssuesCheckAssigneeParams: object

Type declaration

  • assignee: string
  • owner: string
  • repo: string

IssuesCreateCommentParams

IssuesCreateCommentParams: object

Type declaration

  • body: string

    The contents of the comment.

  • issue_number: number
  • owner: string
  • repo: string

IssuesCreateCommentParamsDeprecatedNumber

IssuesCreateCommentParamsDeprecatedNumber: object

Type declaration

  • body: string

    The contents of the comment.

  • number: number
    deprecated

    "number" parameter renamed to "issue_number"

  • owner: string
  • repo: string

IssuesCreateCommentResponse

IssuesCreateCommentResponse: object

Type declaration

IssuesCreateCommentResponseUser

IssuesCreateCommentResponseUser: object

Type declaration

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

IssuesCreateLabelParams

IssuesCreateLabelParams: object

Type declaration

  • color: string

    The hexadecimal color code for the label, without the leading #.

  • Optional description?: undefined | string

    A short description of the label.

  • name: string

    The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji :strawberry:. For a full list of available emoji and codes, see emoji-cheat-sheet.com.

  • owner: string
  • repo: string

IssuesCreateLabelResponse

IssuesCreateLabelResponse: object

Type declaration

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

IssuesCreateMilestoneParams

IssuesCreateMilestoneParams: object

Type declaration

  • Optional description?: undefined | string

    A description of the milestone.

  • Optional due_on?: undefined | string

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

  • owner: string
  • repo: string
  • Optional state?: "open" | "closed"

    The state of the milestone. Either open or closed.

  • title: string

    The title of the milestone.

IssuesCreateMilestoneResponse

IssuesCreateMilestoneResponse: object

Type declaration

  • closed_at: string
  • closed_issues: number
  • created_at: string
  • creator: IssuesCreateMilestoneResponseCreator
  • description: string
  • due_on: string
  • html_url: string
  • id: number
  • labels_url: string
  • node_id: string
  • number: number
  • open_issues: number
  • state: string
  • title: string
  • updated_at: string
  • url: string

IssuesCreateMilestoneResponseCreator

IssuesCreateMilestoneResponseCreator: object

Type declaration

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

IssuesCreateParams

IssuesCreateParams: object

Type declaration

  • Optional assignees?: string[]

    Logins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

  • Optional body?: undefined | string

    The contents of the issue.

  • Optional labels?: string[]

    Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

  • Optional milestone?: undefined | number

    The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

  • owner: string
  • repo: string
  • title: string

    The title of the issue.

IssuesCreateParamsDeprecatedAssignee

IssuesCreateParamsDeprecatedAssignee: object

Type declaration

  • Optional assignee?: undefined | string

    Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

    deprecated

    "assignee" parameter has been deprecated and will be removed in future

  • Optional assignees?: string[]

    Logins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

  • Optional body?: undefined | string

    The contents of the issue.

  • Optional labels?: string[]

    Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

  • Optional milestone?: undefined | number

    The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

  • owner: string
  • repo: string
  • title: string

    The title of the issue.

IssuesCreateResponse

IssuesCreateResponse: object

Type declaration

IssuesCreateResponseAssignee

IssuesCreateResponseAssignee: object

Type declaration

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

IssuesCreateResponseAssigneesItem

IssuesCreateResponseAssigneesItem: object

Type declaration

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

IssuesCreateResponseClosedBy

IssuesCreateResponseClosedBy: object

Type declaration

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

IssuesCreateResponseLabelsItem

IssuesCreateResponseLabelsItem: object

Type declaration

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

IssuesCreateResponseMilestone

IssuesCreateResponseMilestone: object

Type declaration

  • closed_at: string
  • closed_issues: number
  • created_at: string
  • creator: IssuesCreateResponseMilestoneCreator
  • description: string
  • due_on: string
  • html_url: string
  • id: number
  • labels_url: string
  • node_id: string
  • number: number
  • open_issues: number
  • state: string
  • title: string
  • updated_at: string
  • url: string

IssuesCreateResponseMilestoneCreator

IssuesCreateResponseMilestoneCreator: object

Type declaration

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

IssuesCreateResponsePullRequest

IssuesCreateResponsePullRequest: object

Type declaration

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

IssuesCreateResponseUser

IssuesCreateResponseUser: object

Type declaration

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

IssuesDeleteCommentParams

IssuesDeleteCommentParams: object

Type declaration

  • comment_id: number
  • owner: string
  • repo: string

IssuesDeleteLabelParams

IssuesDeleteLabelParams: object

Type declaration

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

IssuesDeleteMilestoneParams

IssuesDeleteMilestoneParams: object

Type declaration

  • milestone_number: number
  • owner: string
  • repo: string

IssuesDeleteMilestoneParamsDeprecatedNumber

IssuesDeleteMilestoneParamsDeprecatedNumber: object

Type declaration

  • number: number
    deprecated

    "number" parameter renamed to "milestone_number"

  • owner: string
  • repo: string

IssuesGetCommentParams

IssuesGetCommentParams: object

Type declaration

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

IssuesGetCommentResponse

IssuesGetCommentResponse: object

Type declaration

  • body: string
  • created_at: string
  • html_url: string
  • id: number
  • node_id: string
  • updated_at: string
  • url: string
  • user: IssuesGetCommentResponseUser

IssuesGetCommentResponseUser

IssuesGetCommentResponseUser: object

Type declaration

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

IssuesGetEventParams

IssuesGetEventParams: object

Type declaration

  • event_id: number
  • owner: string
  • repo: string

IssuesGetEventResponse

IssuesGetEventResponse: object

Type declaration

IssuesGetEventResponseActor

IssuesGetEventResponseActor: object

Type declaration

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

IssuesGetEventResponseIssue

IssuesGetEventResponseIssue: object

Type declaration

IssuesGetEventResponseIssueAssignee

IssuesGetEventResponseIssueAssignee: object

Type declaration

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

IssuesGetEventResponseIssueAssigneesItem

IssuesGetEventResponseIssueAssigneesItem: object

Type declaration

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

IssuesGetEventResponseIssueLabelsItem

IssuesGetEventResponseIssueLabelsItem: object

Type declaration

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

IssuesGetEventResponseIssueMilestone

IssuesGetEventResponseIssueMilestone: object

Type declaration

  • closed_at: string
  • closed_issues: number
  • created_at: string
  • creator: IssuesGetEventResponseIssueMilestoneCreator
  • description: string
  • due_on: string
  • html_url: string
  • id: number
  • labels_url: string
  • node_id: string
  • number: number
  • open_issues: number
  • state: string
  • title: string
  • updated_at: string
  • url: string

IssuesGetEventResponseIssueMilestoneCreator

IssuesGetEventResponseIssueMilestoneCreator: object

Type declaration

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

IssuesGetEventResponseIssuePullRequest

IssuesGetEventResponseIssuePullRequest: object

Type declaration

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

IssuesGetEventResponseIssueUser

IssuesGetEventResponseIssueUser: object

Type declaration

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

IssuesGetLabelParams

IssuesGetLabelParams: object

Type declaration

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

IssuesGetLabelResponse

IssuesGetLabelResponse: object

Type declaration

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

IssuesGetMilestoneParams

IssuesGetMilestoneParams: object

Type declaration

  • milestone_number: number
  • owner: string
  • repo: string

IssuesGetMilestoneParamsDeprecatedNumber

IssuesGetMilestoneParamsDeprecatedNumber: object

Type declaration

  • number: number
    deprecated

    "number" parameter renamed to "milestone_number"

  • owner: string
  • repo: string

IssuesGetMilestoneResponse

IssuesGetMilestoneResponse: object

Type declaration

  • closed_at: string
  • closed_issues: number
  • created_at: string
  • creator: IssuesGetMilestoneResponseCreator
  • description: string
  • due_on: string
  • html_url: string
  • id: number
  • labels_url: string
  • node_id: string
  • number: number
  • open_issues: number
  • state: string
  • title: string
  • updated_at: string
  • url: string

IssuesGetMilestoneResponseCreator

IssuesGetMilestoneResponseCreator: object

Type declaration

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

IssuesGetParams

IssuesGetParams: object

Type declaration

  • issue_number: number
  • owner: string
  • repo: string

IssuesGetParamsDeprecatedNumber

IssuesGetParamsDeprecatedNumber: object

Type declaration

  • number: number
    deprecated

    "number" parameter renamed to "issue_number"

  • owner: string
  • repo: string

IssuesGetResponse

IssuesGetResponse: object

Type declaration

IssuesGetResponseAssignee

IssuesGetResponseAssignee: object

Type declaration

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

IssuesGetResponseAssigneesItem

IssuesGetResponseAssigneesItem: object

Type declaration

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

IssuesGetResponseClosedBy

IssuesGetResponseClosedBy: object

Type declaration

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

IssuesGetResponseLabelsItem

IssuesGetResponseLabelsItem: object

Type declaration

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

IssuesGetResponseMilestone

IssuesGetResponseMilestone: object

Type declaration

  • closed_at: string
  • closed_issues: number
  • created_at: string
  • creator: IssuesGetResponseMilestoneCreator
  • description: string
  • due_on: string
  • html_url: string
  • id: number
  • labels_url: string
  • node_id: string
  • number: number
  • open_issues: number
  • state: string
  • title: string
  • updated_at: string
  • url: string

IssuesGetResponseMilestoneCreator

IssuesGetResponseMilestoneCreator: object

Type declaration

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

IssuesGetResponsePullRequest

IssuesGetResponsePullRequest: object

Type declaration

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

IssuesGetResponseUser

IssuesGetResponseUser: object

Type declaration

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

IssuesListAssigneesParams

IssuesListAssigneesParams: object

Type declaration

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

IssuesListAssigneesResponse

IssuesListAssigneesResponse: Array<IssuesListAssigneesResponseItem>

IssuesListAssigneesResponseItem

IssuesListAssigneesResponseItem: object

Type declaration

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

IssuesListCommentsForRepoParams

IssuesListCommentsForRepoParams: object

Type declaration

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

    Either asc or desc. Ignored without the sort parameter.

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

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

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

    Either created or updated.

IssuesListCommentsForRepoResponse

IssuesListCommentsForRepoResponse: Array<IssuesListCommentsForRepoResponseItem>

IssuesListCommentsForRepoResponseItem

IssuesListCommentsForRepoResponseItem: object

Type declaration

IssuesListCommentsForRepoResponseItemUser

IssuesListCommentsForRepoResponseItemUser: object

Type declaration

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

IssuesListCommentsParams

IssuesListCommentsParams: object

Type declaration

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

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

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

IssuesListCommentsParamsDeprecatedNumber

IssuesListCommentsParamsDeprecatedNumber: object

Type declaration

  • number: number
    deprecated

    "number" parameter renamed to "issue_number"

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

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

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

IssuesListCommentsResponse

IssuesListCommentsResponse: Array<IssuesListCommentsResponseItem>

IssuesListCommentsResponseItem

IssuesListCommentsResponseItem: object

Type declaration

IssuesListCommentsResponseItemUser

IssuesListCommentsResponseItemUser: object

Type declaration

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

IssuesListEventsForRepoParams

IssuesListEventsForRepoParams: object

Type declaration

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

IssuesListEventsForRepoResponse

IssuesListEventsForRepoResponse: Array<IssuesListEventsForRepoResponseItem>

IssuesListEventsForRepoResponseItem

IssuesListEventsForRepoResponseItem: object

Type declaration

IssuesListEventsForRepoResponseItemActor

IssuesListEventsForRepoResponseItemActor: object

Type declaration

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

IssuesListEventsForRepoResponseItemIssue

IssuesListEventsForRepoResponseItemIssue: object

Type declaration

IssuesListEventsForRepoResponseItemIssueAssignee

IssuesListEventsForRepoResponseItemIssueAssignee: object

Type declaration

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

IssuesListEventsForRepoResponseItemIssueAssigneesItem

IssuesListEventsForRepoResponseItemIssueAssigneesItem: object

Type declaration

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

IssuesListEventsForRepoResponseItemIssueLabelsItem

IssuesListEventsForRepoResponseItemIssueLabelsItem: object

Type declaration

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

IssuesListEventsForRepoResponseItemIssueMilestone

IssuesListEventsForRepoResponseItemIssueMilestone: object

Type declaration

  • closed_at: string
  • closed_issues: number
  • created_at: string
  • creator: IssuesListEventsForRepoResponseItemIssueMilestoneCreator
  • description: string
  • due_on: string
  • html_url: string
  • id: number
  • labels_url: string
  • node_id: string
  • number: number
  • open_issues: number
  • state: string
  • title: string
  • updated_at: string
  • url: string

IssuesListEventsForRepoResponseItemIssueMilestoneCreator

IssuesListEventsForRepoResponseItemIssueMilestoneCreator: object

Type declaration

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

IssuesListEventsForRepoResponseItemIssuePullRequest

IssuesListEventsForRepoResponseItemIssuePullRequest: object

Type declaration

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

IssuesListEventsForRepoResponseItemIssueUser

IssuesListEventsForRepoResponseItemIssueUser: object

Type declaration

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

IssuesListEventsForTimelineParams

IssuesListEventsForTimelineParams: object

Type declaration

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

IssuesListEventsForTimelineParamsDeprecatedNumber

IssuesListEventsForTimelineParamsDeprecatedNumber: object

Type declaration

  • number: number
    deprecated

    "number" parameter renamed to "issue_number"

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

IssuesListEventsForTimelineResponse

IssuesListEventsForTimelineResponse: Array<IssuesListEventsForTimelineResponseItem>

IssuesListEventsForTimelineResponseItem

IssuesListEventsForTimelineResponseItem: object

Type declaration

IssuesListEventsForTimelineResponseItemActor

IssuesListEventsForTimelineResponseItemActor: object

Type declaration

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

IssuesListEventsParams

IssuesListEventsParams: object

Type declaration

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

IssuesListEventsParamsDeprecatedNumber

IssuesListEventsParamsDeprecatedNumber: object

Type declaration

  • number: number
    deprecated

    "number" parameter renamed to "issue_number"

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

IssuesListEventsResponse

IssuesListEventsResponse: Array<IssuesListEventsResponseItem>

IssuesListEventsResponseItem

IssuesListEventsResponseItem: object

Type declaration

IssuesListEventsResponseItemActor

IssuesListEventsResponseItemActor: object

Type declaration

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

IssuesListForAuthenticatedUserParams

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

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

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • Optional since?: undefined | string

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

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

    What to sort results by. Can be either created, updated, comments.

  • Optional state?: "open" | "closed" | "all"

    Indicates the state of the issues to return. Can be either open, closed, or all.

IssuesListForAuthenticatedUserResponse

IssuesListForAuthenticatedUserResponse: Array<IssuesListForAuthenticatedUserResponseItem>

IssuesListForAuthenticatedUserResponseItem

IssuesListForAuthenticatedUserResponseItem: object

Type declaration

IssuesListForAuthenticatedUserResponseItemAssignee

IssuesListForAuthenticatedUserResponseItemAssignee: object

Type declaration

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

IssuesListForAuthenticatedUserResponseItemAssigneesItem

IssuesListForAuthenticatedUserResponseItemAssigneesItem: object

Type declaration

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

IssuesListForAuthenticatedUserResponseItemLabelsItem

IssuesListForAuthenticatedUserResponseItemLabelsItem: object

Type declaration

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

IssuesListForAuthenticatedUserResponseItemMilestone

IssuesListForAuthenticatedUserResponseItemMilestone: object

Type declaration

  • closed_at: string
  • closed_issues: number
  • created_at: string
  • creator: IssuesListForAuthenticatedUserResponseItemMilestoneCreator
  • description: string
  • due_on: string
  • html_url: string
  • id: number
  • labels_url: string
  • node_id: string
  • number: number
  • open_issues: number
  • state: string
  • title: string
  • updated_at: string
  • url: string

IssuesListForAuthenticatedUserResponseItemMilestoneCreator

IssuesListForAuthenticatedUserResponseItemMilestoneCreator: object

Type declaration

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

IssuesListForAuthenticatedUserResponseItemPullRequest

IssuesListForAuthenticatedUserResponseItemPullRequest: object

Type declaration

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

IssuesListForAuthenticatedUserResponseItemRepository

IssuesListForAuthenticatedUserResponseItemRepository: 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: IssuesListForAuthenticatedUserResponseItemRepositoryOwner
  • permissions: IssuesListForAuthenticatedUserResponseItemRepositoryPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

IssuesListForAuthenticatedUserResponseItemRepositoryOwner

IssuesListForAuthenticatedUserResponseItemRepositoryOwner: object

Type declaration

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

IssuesListForAuthenticatedUserResponseItemRepositoryPermissions

IssuesListForAuthenticatedUserResponseItemRepositoryPermissions: object

Type declaration

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

IssuesListForAuthenticatedUserResponseItemUser

IssuesListForAuthenticatedUserResponseItemUser: object

Type declaration

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

IssuesListForOrgParams

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

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

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • Optional since?: undefined | string

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

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

    What to sort results by. Can be either created, updated, comments.

  • Optional state?: "open" | "closed" | "all"

    Indicates the state of the issues to return. Can be either open, closed, or all.

IssuesListForOrgResponse

IssuesListForOrgResponse: Array<IssuesListForOrgResponseItem>

IssuesListForOrgResponseItem

IssuesListForOrgResponseItem: object

Type declaration

IssuesListForOrgResponseItemAssignee

IssuesListForOrgResponseItemAssignee: object

Type declaration

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

IssuesListForOrgResponseItemAssigneesItem

IssuesListForOrgResponseItemAssigneesItem: object

Type declaration

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

IssuesListForOrgResponseItemLabelsItem

IssuesListForOrgResponseItemLabelsItem: object

Type declaration

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

IssuesListForOrgResponseItemMilestone

IssuesListForOrgResponseItemMilestone: object

Type declaration

  • closed_at: string
  • closed_issues: number
  • created_at: string
  • creator: IssuesListForOrgResponseItemMilestoneCreator
  • description: string
  • due_on: string
  • html_url: string
  • id: number
  • labels_url: string
  • node_id: string
  • number: number
  • open_issues: number
  • state: string
  • title: string
  • updated_at: string
  • url: string

IssuesListForOrgResponseItemMilestoneCreator

IssuesListForOrgResponseItemMilestoneCreator: object

Type declaration

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

IssuesListForOrgResponseItemPullRequest

IssuesListForOrgResponseItemPullRequest: object

Type declaration

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

IssuesListForOrgResponseItemRepository

IssuesListForOrgResponseItemRepository: 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: IssuesListForOrgResponseItemRepositoryOwner
  • permissions: IssuesListForOrgResponseItemRepositoryPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

IssuesListForOrgResponseItemRepositoryOwner

IssuesListForOrgResponseItemRepositoryOwner: object

Type declaration

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

IssuesListForOrgResponseItemRepositoryPermissions

IssuesListForOrgResponseItemRepositoryPermissions: object

Type declaration

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

IssuesListForOrgResponseItemUser

IssuesListForOrgResponseItemUser: object

Type declaration

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

IssuesListForRepoParams

IssuesListForRepoParams: object

Type declaration

  • Optional assignee?: undefined | string

    Can be the name of a user. Pass in none for issues with no assigned user, and * for issues assigned to any user.

  • Optional creator?: undefined | string

    The user that created the issue.

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

    The direction of the sort. Can be either asc or desc.

  • Optional labels?: undefined | string

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

  • Optional mentioned?: undefined | string

    A user that's mentioned in the issue.

  • Optional milestone?: undefined | string

    If an integer is passed, it should refer to a milestone by its number field. If the string * is passed, issues with any milestone are accepted. If the string none is passed, issues without milestones are returned.

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

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

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

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

    What to sort results by. Can be either created, updated, comments.

  • Optional state?: "open" | "closed" | "all"

    Indicates the state of the issues to return. Can be either open, closed, or all.

IssuesListForRepoResponse

IssuesListForRepoResponse: Array<IssuesListForRepoResponseItem>

IssuesListForRepoResponseItem

IssuesListForRepoResponseItem: object

Type declaration

IssuesListForRepoResponseItemAssignee

IssuesListForRepoResponseItemAssignee: object

Type declaration

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

IssuesListForRepoResponseItemAssigneesItem

IssuesListForRepoResponseItemAssigneesItem: object

Type declaration

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

IssuesListForRepoResponseItemLabelsItem

IssuesListForRepoResponseItemLabelsItem: object

Type declaration

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

IssuesListForRepoResponseItemMilestone

IssuesListForRepoResponseItemMilestone: object

Type declaration

  • closed_at: string
  • closed_issues: number
  • created_at: string
  • creator: IssuesListForRepoResponseItemMilestoneCreator
  • description: string
  • due_on: string
  • html_url: string
  • id: number
  • labels_url: string
  • node_id: string
  • number: number
  • open_issues: number
  • state: string
  • title: string
  • updated_at: string
  • url: string

IssuesListForRepoResponseItemMilestoneCreator

IssuesListForRepoResponseItemMilestoneCreator: object

Type declaration

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

IssuesListForRepoResponseItemPullRequest

IssuesListForRepoResponseItemPullRequest: object

Type declaration

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

IssuesListForRepoResponseItemUser

IssuesListForRepoResponseItemUser: object

Type declaration

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

IssuesListLabelsForMilestoneParams

IssuesListLabelsForMilestoneParams: object

Type declaration

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

IssuesListLabelsForMilestoneParamsDeprecatedNumber

IssuesListLabelsForMilestoneParamsDeprecatedNumber: object

Type declaration

  • number: number
    deprecated

    "number" parameter renamed to "milestone_number"

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

IssuesListLabelsForMilestoneResponse

IssuesListLabelsForMilestoneResponse: Array<IssuesListLabelsForMilestoneResponseItem>

IssuesListLabelsForMilestoneResponseItem

IssuesListLabelsForMilestoneResponseItem: object

Type declaration

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

IssuesListLabelsForRepoParams

IssuesListLabelsForRepoParams: object

Type declaration

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

IssuesListLabelsForRepoResponse

IssuesListLabelsForRepoResponse: Array<IssuesListLabelsForRepoResponseItem>

IssuesListLabelsForRepoResponseItem

IssuesListLabelsForRepoResponseItem: object

Type declaration

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

IssuesListLabelsOnIssueParams

IssuesListLabelsOnIssueParams: object

Type declaration

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

IssuesListLabelsOnIssueParamsDeprecatedNumber

IssuesListLabelsOnIssueParamsDeprecatedNumber: object

Type declaration

  • number: number
    deprecated

    "number" parameter renamed to "issue_number"

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

IssuesListLabelsOnIssueResponse

IssuesListLabelsOnIssueResponse: Array<IssuesListLabelsOnIssueResponseItem>

IssuesListLabelsOnIssueResponseItem

IssuesListLabelsOnIssueResponseItem: object

Type declaration

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

IssuesListMilestonesForRepoParams

IssuesListMilestonesForRepoParams: object

Type declaration

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

    The direction of the sort. Either asc or desc.

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string
  • Optional sort?: "due_on" | "completeness"

    What to sort results by. Either due_on or completeness.

  • Optional state?: "open" | "closed" | "all"

    The state of the milestone. Either open, closed, or all.

IssuesListMilestonesForRepoResponse

IssuesListMilestonesForRepoResponse: Array<IssuesListMilestonesForRepoResponseItem>

IssuesListMilestonesForRepoResponseItem

IssuesListMilestonesForRepoResponseItem: object

Type declaration

  • closed_at: string
  • closed_issues: number
  • created_at: string
  • creator: IssuesListMilestonesForRepoResponseItemCreator
  • description: string
  • due_on: string
  • html_url: string
  • id: number
  • labels_url: string
  • node_id: string
  • number: number
  • open_issues: number
  • state: string
  • title: string
  • updated_at: string
  • url: string

IssuesListMilestonesForRepoResponseItemCreator

IssuesListMilestonesForRepoResponseItemCreator: object

Type declaration

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

IssuesListParams

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

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

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • Optional since?: undefined | string

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

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

    What to sort results by. Can be either created, updated, comments.

  • Optional state?: "open" | "closed" | "all"

    Indicates the state of the issues to return. Can be either open, closed, or all.

IssuesListResponse

IssuesListResponse: Array<IssuesListResponseItem>

IssuesListResponseItem

IssuesListResponseItem: object

Type declaration

IssuesListResponseItemAssignee

IssuesListResponseItemAssignee: object

Type declaration

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

IssuesListResponseItemAssigneesItem

IssuesListResponseItemAssigneesItem: object

Type declaration

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

IssuesListResponseItemLabelsItem

IssuesListResponseItemLabelsItem: object

Type declaration

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

IssuesListResponseItemMilestone

IssuesListResponseItemMilestone: object

Type declaration

  • closed_at: string
  • closed_issues: number
  • created_at: string
  • creator: IssuesListResponseItemMilestoneCreator
  • description: string
  • due_on: string
  • html_url: string
  • id: number
  • labels_url: string
  • node_id: string
  • number: number
  • open_issues: number
  • state: string
  • title: string
  • updated_at: string
  • url: string

IssuesListResponseItemMilestoneCreator

IssuesListResponseItemMilestoneCreator: object

Type declaration

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

IssuesListResponseItemPullRequest

IssuesListResponseItemPullRequest: object

Type declaration

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

IssuesListResponseItemRepository

IssuesListResponseItemRepository: 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: IssuesListResponseItemRepositoryOwner
  • permissions: IssuesListResponseItemRepositoryPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

IssuesListResponseItemRepositoryOwner

IssuesListResponseItemRepositoryOwner: object

Type declaration

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

IssuesListResponseItemRepositoryPermissions

IssuesListResponseItemRepositoryPermissions: object

Type declaration

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

IssuesListResponseItemUser

IssuesListResponseItemUser: object

Type declaration

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

IssuesLockParams

IssuesLockParams: object

Type declaration

  • issue_number: number
  • Optional lock_reason?: "off-topic" | "too heated" | "resolved" | "spam"

    The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: * off-topic * too heated * resolved * spam

  • owner: string
  • repo: string

IssuesLockParamsDeprecatedNumber

IssuesLockParamsDeprecatedNumber: object

Type declaration

  • Optional lock_reason?: "off-topic" | "too heated" | "resolved" | "spam"

    The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: * off-topic * too heated * resolved * spam

  • number: number
    deprecated

    "number" parameter renamed to "issue_number"

  • owner: string
  • repo: string

IssuesRemoveAssigneesParams

IssuesRemoveAssigneesParams: 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
  • owner: string
  • repo: string

IssuesRemoveAssigneesParamsDeprecatedNumber

IssuesRemoveAssigneesParamsDeprecatedNumber: 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.

  • number: number
    deprecated

    "number" parameter renamed to "issue_number"

  • owner: string
  • repo: string

IssuesRemoveAssigneesResponse

IssuesRemoveAssigneesResponse: object

Type declaration

IssuesRemoveAssigneesResponseAssignee

IssuesRemoveAssigneesResponseAssignee: object

Type declaration

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

IssuesRemoveAssigneesResponseAssigneesItem

IssuesRemoveAssigneesResponseAssigneesItem: object

Type declaration

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

IssuesRemoveAssigneesResponseLabelsItem

IssuesRemoveAssigneesResponseLabelsItem: object

Type declaration

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

IssuesRemoveAssigneesResponseMilestone

IssuesRemoveAssigneesResponseMilestone: object

Type declaration

  • closed_at: string
  • closed_issues: number
  • created_at: string
  • creator: IssuesRemoveAssigneesResponseMilestoneCreator
  • description: string
  • due_on: string
  • html_url: string
  • id: number
  • labels_url: string
  • node_id: string
  • number: number
  • open_issues: number
  • state: string
  • title: string
  • updated_at: string
  • url: string

IssuesRemoveAssigneesResponseMilestoneCreator

IssuesRemoveAssigneesResponseMilestoneCreator: object

Type declaration

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

IssuesRemoveAssigneesResponsePullRequest

IssuesRemoveAssigneesResponsePullRequest: object

Type declaration

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

IssuesRemoveAssigneesResponseUser

IssuesRemoveAssigneesResponseUser: object

Type declaration

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

IssuesRemoveLabelParams

IssuesRemoveLabelParams: object

Type declaration

  • issue_number: number
  • name: string
  • owner: string
  • repo: string

IssuesRemoveLabelParamsDeprecatedNumber

IssuesRemoveLabelParamsDeprecatedNumber: object

Type declaration

  • name: string
  • number: number
    deprecated

    "number" parameter renamed to "issue_number"

  • owner: string
  • repo: string

IssuesRemoveLabelResponse

IssuesRemoveLabelResponse: Array<IssuesRemoveLabelResponseItem>

IssuesRemoveLabelResponseItem

IssuesRemoveLabelResponseItem: object

Type declaration

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

IssuesRemoveLabelsParams

IssuesRemoveLabelsParams: object

Type declaration

  • issue_number: number
  • owner: string
  • repo: string

IssuesRemoveLabelsParamsDeprecatedNumber

IssuesRemoveLabelsParamsDeprecatedNumber: object

Type declaration

  • number: number
    deprecated

    "number" parameter renamed to "issue_number"

  • owner: string
  • repo: string

IssuesReplaceLabelsParams

IssuesReplaceLabelsParams: object

Type declaration

  • issue_number: number
  • Optional labels?: string[]

    The names of the labels to add to the issue. You can pass an empty array to remove all labels. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

  • owner: string
  • repo: string

IssuesReplaceLabelsParamsDeprecatedNumber

IssuesReplaceLabelsParamsDeprecatedNumber: object

Type declaration

  • Optional labels?: string[]

    The names of the labels to add to the issue. You can pass an empty array to remove all labels. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

  • number: number
    deprecated

    "number" parameter renamed to "issue_number"

  • owner: string
  • repo: string

IssuesReplaceLabelsResponse

IssuesReplaceLabelsResponse: Array<IssuesReplaceLabelsResponseItem>

IssuesReplaceLabelsResponseItem

IssuesReplaceLabelsResponseItem: object

Type declaration

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

IssuesUnlockParams

IssuesUnlockParams: object

Type declaration

  • issue_number: number
  • owner: string
  • repo: string

IssuesUnlockParamsDeprecatedNumber

IssuesUnlockParamsDeprecatedNumber: object

Type declaration

  • number: number
    deprecated

    "number" parameter renamed to "issue_number"

  • owner: string
  • repo: string

IssuesUpdateCommentParams

IssuesUpdateCommentParams: object

Type declaration

  • body: string

    The contents of the comment.

  • comment_id: number
  • owner: string
  • repo: string

IssuesUpdateCommentResponse

IssuesUpdateCommentResponse: object

Type declaration

IssuesUpdateCommentResponseUser

IssuesUpdateCommentResponseUser: object

Type declaration

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

IssuesUpdateLabelParams

IssuesUpdateLabelParams: object

Type declaration

  • Optional color?: undefined | string

    The hexadecimal color code for the label, without the leading #.

  • current_name: string
  • Optional description?: undefined | string

    A short description of the label.

  • Optional name?: undefined | string

    The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji :strawberry:. For a full list of available emoji and codes, see emoji-cheat-sheet.com.

  • owner: string
  • repo: string

IssuesUpdateLabelResponse

IssuesUpdateLabelResponse: object

Type declaration

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

IssuesUpdateMilestoneParams

IssuesUpdateMilestoneParams: object

Type declaration

  • Optional description?: undefined | string

    A description of the milestone.

  • Optional due_on?: undefined | string

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

  • milestone_number: number
  • owner: string
  • repo: string
  • Optional state?: "open" | "closed"

    The state of the milestone. Either open or closed.

  • Optional title?: undefined | string

    The title of the milestone.

IssuesUpdateMilestoneParamsDeprecatedNumber

IssuesUpdateMilestoneParamsDeprecatedNumber: object

Type declaration

  • Optional description?: undefined | string

    A description of the milestone.

  • Optional due_on?: undefined | string

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

  • number: number
    deprecated

    "number" parameter renamed to "milestone_number"

  • owner: string
  • repo: string
  • Optional state?: "open" | "closed"

    The state of the milestone. Either open or closed.

  • Optional title?: undefined | string

    The title of the milestone.

IssuesUpdateMilestoneResponse

IssuesUpdateMilestoneResponse: object

Type declaration

  • closed_at: string
  • closed_issues: number
  • created_at: string
  • creator: IssuesUpdateMilestoneResponseCreator
  • description: string
  • due_on: string
  • html_url: string
  • id: number
  • labels_url: string
  • node_id: string
  • number: number
  • open_issues: number
  • state: string
  • title: string
  • updated_at: string
  • url: string

IssuesUpdateMilestoneResponseCreator

IssuesUpdateMilestoneResponseCreator: object

Type declaration

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

IssuesUpdateParams

IssuesUpdateParams: object

Type declaration

  • Optional assignees?: string[]

    Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty array ([]) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

  • Optional body?: undefined | string

    The contents of the issue.

  • issue_number: number
  • Optional labels?: string[]

    Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

  • Optional milestone?: number | null

    The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

  • owner: string
  • repo: string
  • Optional state?: "open" | "closed"

    State of the issue. Either open or closed.

  • Optional title?: undefined | string

    The title of the issue.

IssuesUpdateParamsDeprecatedAssignee

IssuesUpdateParamsDeprecatedAssignee: object

Type declaration

  • Optional assignee?: undefined | string

    Login for the user that this issue should be assigned to. This field is deprecated.

    deprecated

    "assignee" parameter has been deprecated and will be removed in future

  • Optional assignees?: string[]

    Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty array ([]) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

  • Optional body?: undefined | string

    The contents of the issue.

  • issue_number: number
  • Optional labels?: string[]

    Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

  • Optional milestone?: number | null

    The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

  • owner: string
  • repo: string
  • Optional state?: "open" | "closed"

    State of the issue. Either open or closed.

  • Optional title?: undefined | string

    The title of the issue.

IssuesUpdateParamsDeprecatedNumber

IssuesUpdateParamsDeprecatedNumber: object

Type declaration

  • Optional assignees?: string[]

    Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty array ([]) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

  • Optional body?: undefined | string

    The contents of the issue.

  • Optional labels?: string[]

    Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

  • Optional milestone?: number | null

    The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

  • number: number
    deprecated

    "number" parameter renamed to "issue_number"

  • owner: string
  • repo: string
  • Optional state?: "open" | "closed"

    State of the issue. Either open or closed.

  • Optional title?: undefined | string

    The title of the issue.

IssuesUpdateResponse

IssuesUpdateResponse: object

Type declaration

IssuesUpdateResponseAssignee

IssuesUpdateResponseAssignee: object

Type declaration

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

IssuesUpdateResponseAssigneesItem

IssuesUpdateResponseAssigneesItem: object

Type declaration

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

IssuesUpdateResponseClosedBy

IssuesUpdateResponseClosedBy: object

Type declaration

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

IssuesUpdateResponseLabelsItem

IssuesUpdateResponseLabelsItem: object

Type declaration

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

IssuesUpdateResponseMilestone

IssuesUpdateResponseMilestone: object

Type declaration

  • closed_at: string
  • closed_issues: number
  • created_at: string
  • creator: IssuesUpdateResponseMilestoneCreator
  • description: string
  • due_on: string
  • html_url: string
  • id: number
  • labels_url: string
  • node_id: string
  • number: number
  • open_issues: number
  • state: string
  • title: string
  • updated_at: string
  • url: string

IssuesUpdateResponseMilestoneCreator

IssuesUpdateResponseMilestoneCreator: object

Type declaration

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

IssuesUpdateResponsePullRequest

IssuesUpdateResponsePullRequest: object

Type declaration

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

IssuesUpdateResponseUser

IssuesUpdateResponseUser: object

Type declaration

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

LicensesGetForRepoParams

LicensesGetForRepoParams: object

Type declaration

  • owner: string
  • repo: string

LicensesGetForRepoResponse

LicensesGetForRepoResponse: object

Type declaration

LicensesGetForRepoResponseLicense

LicensesGetForRepoResponseLicense: object

Type declaration

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

LicensesGetForRepoResponseLinks

LicensesGetForRepoResponseLinks: object

Type declaration

  • git: string
  • html: string
  • self: string

LicensesGetParams

LicensesGetParams: object

Type declaration

  • license: string

LicensesGetResponse

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

LicensesListCommonlyUsedResponse

LicensesListCommonlyUsedResponse: Array<LicensesListCommonlyUsedResponseItem>

LicensesListCommonlyUsedResponseItem

LicensesListCommonlyUsedResponseItem: object

Type declaration

  • key: string
  • name: string
  • Optional node_id?: undefined | string
  • spdx_id: string
  • url: string

LicensesListResponse

LicensesListResponse: Array<LicensesListResponseItem>

LicensesListResponseItem

LicensesListResponseItem: object

Type declaration

  • key: string
  • name: string
  • Optional node_id?: undefined | string
  • spdx_id: string
  • url: string

Link

Link: object | object | string

MarkdownRenderParams

MarkdownRenderParams: object

Type declaration

  • Optional context?: undefined | string

    The repository context to use when creating references in gfm mode. Omit this parameter when using markdown mode.

  • Optional mode?: "markdown" | "gfm"

    The rendering mode. Can be either: * markdown to render a document in plain Markdown, just like README.md files are rendered. * gfm to render a document in GitHub Flavored Markdown, which creates links for user mentions as well as references to SHA-1 hashes, issues, and pull requests.

  • text: string

    The Markdown text to render in HTML. Markdown content must be 400 KB or less.

MarkdownRenderRawParams

MarkdownRenderRawParams: object

Type declaration

  • data: string

MetaGetResponse

MetaGetResponse: object

Type declaration

  • git: Array<string>
  • hooks: Array<string>
  • importer: Array<string>
  • pages: Array<string>
  • verifiable_password_authentication: boolean

MigrationsCancelImportParams

MigrationsCancelImportParams: object

Type declaration

  • owner: string
  • repo: string

MigrationsDeleteArchiveForAuthenticatedUserParams

MigrationsDeleteArchiveForAuthenticatedUserParams: object

Type declaration

  • migration_id: number

MigrationsDeleteArchiveForOrgParams

MigrationsDeleteArchiveForOrgParams: object

Type declaration

  • migration_id: number
  • org: string

MigrationsGetArchiveForAuthenticatedUserParams

MigrationsGetArchiveForAuthenticatedUserParams: object

Type declaration

  • migration_id: number

MigrationsGetArchiveForOrgParams

MigrationsGetArchiveForOrgParams: object

Type declaration

  • migration_id: number
  • org: string

MigrationsGetCommitAuthorsParams

MigrationsGetCommitAuthorsParams: object

Type declaration

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

    Only authors found after this id are returned. Provide the highest author ID you've seen so far. New authors may be added to the list at any point while the importer is performing the raw step.

MigrationsGetCommitAuthorsResponse

MigrationsGetCommitAuthorsResponse: Array<MigrationsGetCommitAuthorsResponseItem>

MigrationsGetCommitAuthorsResponseItem

MigrationsGetCommitAuthorsResponseItem: object

Type declaration

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

MigrationsGetImportProgressParams

MigrationsGetImportProgressParams: object

Type declaration

  • owner: string
  • repo: string

MigrationsGetImportProgressResponse

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

MigrationsGetLargeFilesParams

MigrationsGetLargeFilesParams: object

Type declaration

  • owner: string
  • repo: string

MigrationsGetLargeFilesResponse

MigrationsGetLargeFilesResponse: Array<MigrationsGetLargeFilesResponseItem>

MigrationsGetLargeFilesResponseItem

MigrationsGetLargeFilesResponseItem: object

Type declaration

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

MigrationsGetStatusForAuthenticatedUserParams

MigrationsGetStatusForAuthenticatedUserParams: object

Type declaration

  • migration_id: number

MigrationsGetStatusForAuthenticatedUserResponse

MigrationsGetStatusForAuthenticatedUserResponse: object

Type declaration

MigrationsGetStatusForAuthenticatedUserResponseOwner

MigrationsGetStatusForAuthenticatedUserResponseOwner: object

Type declaration

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

MigrationsGetStatusForAuthenticatedUserResponseRepositoriesItem

MigrationsGetStatusForAuthenticatedUserResponseRepositoriesItem: 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: MigrationsGetStatusForAuthenticatedUserResponseRepositoriesItemOwner
  • permissions: MigrationsGetStatusForAuthenticatedUserResponseRepositoriesItemPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

MigrationsGetStatusForAuthenticatedUserResponseRepositoriesItemOwner

MigrationsGetStatusForAuthenticatedUserResponseRepositoriesItemOwner: object

Type declaration

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

MigrationsGetStatusForAuthenticatedUserResponseRepositoriesItemPermissions

MigrationsGetStatusForAuthenticatedUserResponseRepositoriesItemPermissions: object

Type declaration

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

MigrationsGetStatusForOrgParams

MigrationsGetStatusForOrgParams: object

Type declaration

  • migration_id: number
  • org: string

MigrationsGetStatusForOrgResponse

MigrationsGetStatusForOrgResponse: object

Type declaration

MigrationsGetStatusForOrgResponseOwner

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

MigrationsGetStatusForOrgResponseRepositoriesItem

MigrationsGetStatusForOrgResponseRepositoriesItem: 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: MigrationsGetStatusForOrgResponseRepositoriesItemOwner
  • permissions: MigrationsGetStatusForOrgResponseRepositoriesItemPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

MigrationsGetStatusForOrgResponseRepositoriesItemOwner

MigrationsGetStatusForOrgResponseRepositoriesItemOwner: object

Type declaration

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

MigrationsGetStatusForOrgResponseRepositoriesItemPermissions

MigrationsGetStatusForOrgResponseRepositoriesItemPermissions: object

Type declaration

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

MigrationsListForAuthenticatedUserParams

MigrationsListForAuthenticatedUserParams: object

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

MigrationsListForAuthenticatedUserResponse

MigrationsListForAuthenticatedUserResponse: Array<MigrationsListForAuthenticatedUserResponseItem>

MigrationsListForAuthenticatedUserResponseItem

MigrationsListForAuthenticatedUserResponseItem: object

Type declaration

MigrationsListForAuthenticatedUserResponseItemOwner

MigrationsListForAuthenticatedUserResponseItemOwner: object

Type declaration

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

MigrationsListForAuthenticatedUserResponseItemRepositoriesItem

MigrationsListForAuthenticatedUserResponseItemRepositoriesItem: 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: MigrationsListForAuthenticatedUserResponseItemRepositoriesItemOwner
  • permissions: MigrationsListForAuthenticatedUserResponseItemRepositoriesItemPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

MigrationsListForAuthenticatedUserResponseItemRepositoriesItemOwner

MigrationsListForAuthenticatedUserResponseItemRepositoriesItemOwner: object

Type declaration

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

MigrationsListForAuthenticatedUserResponseItemRepositoriesItemPermissions

MigrationsListForAuthenticatedUserResponseItemRepositoriesItemPermissions: object

Type declaration

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

MigrationsListForOrgParams

MigrationsListForOrgParams: object

Type declaration

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

MigrationsListForOrgResponse

MigrationsListForOrgResponse: Array<MigrationsListForOrgResponseItem>

MigrationsListForOrgResponseItem

MigrationsListForOrgResponseItem: object

Type declaration

MigrationsListForOrgResponseItemOwner

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

MigrationsListForOrgResponseItemRepositoriesItem

MigrationsListForOrgResponseItemRepositoriesItem: 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: MigrationsListForOrgResponseItemRepositoriesItemOwner
  • permissions: MigrationsListForOrgResponseItemRepositoriesItemPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

MigrationsListForOrgResponseItemRepositoriesItemOwner

MigrationsListForOrgResponseItemRepositoriesItemOwner: object

Type declaration

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

MigrationsListForOrgResponseItemRepositoriesItemPermissions

MigrationsListForOrgResponseItemRepositoriesItemPermissions: object

Type declaration

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

MigrationsMapCommitAuthorParams

MigrationsMapCommitAuthorParams: object

Type declaration

  • author_id: number
  • Optional email?: undefined | string

    The new Git author email.

  • Optional name?: undefined | string

    The new Git author name.

  • owner: string
  • repo: string

MigrationsMapCommitAuthorResponse

MigrationsMapCommitAuthorResponse: object

Type declaration

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

MigrationsSetLfsPreferenceParams

MigrationsSetLfsPreferenceParams: object

Type declaration

  • owner: string
  • repo: string
  • use_lfs: "opt_in" | "opt_out"

    Can be one of opt_in (large files will be stored using Git LFS) or opt_out (large files will be removed during the import).

MigrationsSetLfsPreferenceResponse

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

MigrationsStartForAuthenticatedUserParams

MigrationsStartForAuthenticatedUserParams: object

Type declaration

  • Optional exclude_attachments?: undefined | false | true

    Does not include attachments uploaded to GitHub.com in the migration data when set to true. Excluding attachments will reduce the migration archive file size.

  • Optional lock_repositories?: undefined | false | true

    Locks the repositories to prevent changes during the migration when set to true.

  • repositories: string[]

    An array of repositories to include in the migration.

MigrationsStartForAuthenticatedUserResponse

MigrationsStartForAuthenticatedUserResponse: object

Type declaration

MigrationsStartForAuthenticatedUserResponseOwner

MigrationsStartForAuthenticatedUserResponseOwner: object

Type declaration

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

MigrationsStartForAuthenticatedUserResponseRepositoriesItem

MigrationsStartForAuthenticatedUserResponseRepositoriesItem: 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: MigrationsStartForAuthenticatedUserResponseRepositoriesItemOwner
  • permissions: MigrationsStartForAuthenticatedUserResponseRepositoriesItemPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

MigrationsStartForAuthenticatedUserResponseRepositoriesItemOwner

MigrationsStartForAuthenticatedUserResponseRepositoriesItemOwner: object

Type declaration

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

MigrationsStartForAuthenticatedUserResponseRepositoriesItemPermissions

MigrationsStartForAuthenticatedUserResponseRepositoriesItemPermissions: object

Type declaration

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

MigrationsStartForOrgParams

MigrationsStartForOrgParams: object

Type declaration

  • Optional exclude_attachments?: undefined | false | true

    Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).

  • Optional lock_repositories?: undefined | false | true

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

  • org: string
  • repositories: string[]

    A list of arrays indicating which repositories should be migrated.

MigrationsStartForOrgResponse

MigrationsStartForOrgResponse: object

Type declaration

MigrationsStartForOrgResponseOwner

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

MigrationsStartForOrgResponseRepositoriesItem

MigrationsStartForOrgResponseRepositoriesItem: 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: MigrationsStartForOrgResponseRepositoriesItemOwner
  • permissions: MigrationsStartForOrgResponseRepositoriesItemPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

MigrationsStartForOrgResponseRepositoriesItemOwner

MigrationsStartForOrgResponseRepositoriesItemOwner: object

Type declaration

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

MigrationsStartForOrgResponseRepositoriesItemPermissions

MigrationsStartForOrgResponseRepositoriesItemPermissions: object

Type declaration

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

MigrationsStartImportParams

MigrationsStartImportParams: object

Type declaration

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

    For a tfvc import, the name of the project that is being imported.

  • Optional vcs?: "subversion" | "git" | "mercurial" | "tfvc"

    The originating VCS type. Can be one of subversion, git, mercurial, or tfvc. Please be aware that without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response.

  • Optional vcs_password?: undefined | string

    If authentication is required, the password to provide to vcs_url.

  • vcs_url: string

    The URL of the originating repository.

  • Optional vcs_username?: undefined | string

    If authentication is required, the username to provide to vcs_url.

MigrationsStartImportResponse

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

MigrationsUnlockRepoForAuthenticatedUserParams

MigrationsUnlockRepoForAuthenticatedUserParams: object

Type declaration

  • migration_id: number
  • repo_name: string

MigrationsUnlockRepoForOrgParams

MigrationsUnlockRepoForOrgParams: object

Type declaration

  • migration_id: number
  • org: string
  • repo_name: string

MigrationsUpdateImportParams

MigrationsUpdateImportParams: object

Type declaration

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

    The password to provide to the originating repository.

  • Optional vcs_username?: undefined | string

    The username to provide to the originating repository.

MigrationsUpdateImportResponse

MigrationsUpdateImportResponse: object

Type declaration

  • Optional authors_count?: undefined | number
  • authors_url: string
  • Optional commit_count?: undefined | number
  • Optional has_large_files?: undefined | false | true
  • html_url: string
  • Optional large_files_count?: undefined | number
  • Optional large_files_size?: undefined | number
  • Optional percent?: undefined | number
  • repository_url: string
  • status: string
  • Optional status_text?: undefined | string
  • Optional tfvc_project?: undefined | string
  • url: string
  • use_lfs: string
  • vcs: string
  • vcs_url: string

OauthAuthorizationsCheckAuthorizationParams

OauthAuthorizationsCheckAuthorizationParams: object

Type declaration

  • access_token: string
  • client_id: string

OauthAuthorizationsCheckAuthorizationResponse

OauthAuthorizationsCheckAuthorizationResponse: object

Type declaration

OauthAuthorizationsCheckAuthorizationResponseApp

OauthAuthorizationsCheckAuthorizationResponseApp: object

Type declaration

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

OauthAuthorizationsCheckAuthorizationResponseUser

OauthAuthorizationsCheckAuthorizationResponseUser: object

Type declaration

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

OauthAuthorizationsCreateAuthorizationParams

OauthAuthorizationsCreateAuthorizationParams: object

Type declaration

  • Optional client_id?: undefined | string

    The 20 character OAuth app client key for which to create the token.

  • Optional client_secret?: undefined | string

    The 40 character OAuth app client secret for which to create the token.

  • Optional fingerprint?: undefined | string

    A unique string to distinguish an authorization from others created for the same client ID and user.

  • note: string

    A note to remind you what the OAuth token is for. Tokens not associated with a specific OAuth application (i.e. personal access tokens) must have a unique note.

  • Optional note_url?: undefined | string

    A URL to remind you what app the OAuth token is for.

  • Optional scopes?: string[]

    A list of scopes that this authorization is in.

OauthAuthorizationsCreateAuthorizationResponse

OauthAuthorizationsCreateAuthorizationResponse: object

Type declaration

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

OauthAuthorizationsCreateAuthorizationResponseApp

OauthAuthorizationsCreateAuthorizationResponseApp: object

Type declaration

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

OauthAuthorizationsDeleteAuthorizationParams

OauthAuthorizationsDeleteAuthorizationParams: object

Type declaration

  • authorization_id: number

OauthAuthorizationsDeleteGrantParams

OauthAuthorizationsDeleteGrantParams: object

Type declaration

  • grant_id: number

OauthAuthorizationsGetAuthorizationParams

OauthAuthorizationsGetAuthorizationParams: object

Type declaration

  • authorization_id: number

OauthAuthorizationsGetAuthorizationResponse

OauthAuthorizationsGetAuthorizationResponse: object

Type declaration

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

OauthAuthorizationsGetAuthorizationResponseApp

OauthAuthorizationsGetAuthorizationResponseApp: object

Type declaration

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

OauthAuthorizationsGetGrantParams

OauthAuthorizationsGetGrantParams: object

Type declaration

  • grant_id: number

OauthAuthorizationsGetGrantResponse

OauthAuthorizationsGetGrantResponse: object

Type declaration

OauthAuthorizationsGetGrantResponseApp

OauthAuthorizationsGetGrantResponseApp: object

Type declaration

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

OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintParams

OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintParams: object

Type declaration

  • client_id: string
  • client_secret: string

    The 40 character OAuth app client secret associated with the client ID specified in the URL.

  • fingerprint: string
  • Optional note?: undefined | string

    A note to remind you what the OAuth token is for.

  • Optional note_url?: undefined | string

    A URL to remind you what app the OAuth token is for.

  • Optional scopes?: string[]

    A list of scopes that this authorization is in.

OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintResponse

OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintResponse: object

Type declaration

OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintResponseApp

OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintResponseApp: object

Type declaration

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

OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintParams

OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintParams: object

Type declaration

  • client_id: string
  • client_secret: string

    The 40 character OAuth app client secret associated with the client ID specified in the URL.

  • fingerprint: string
  • Optional note?: undefined | string

    A note to remind you what the OAuth token is for.

  • Optional note_url?: undefined | string

    A URL to remind you what app the OAuth token is for.

  • Optional scopes?: string[]

    A list of scopes that this authorization is in.

OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintResponse

OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintResponse: object

Type declaration

OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintResponseApp

OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintResponseApp: object

Type declaration

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

OauthAuthorizationsGetOrCreateAuthorizationForAppParams

OauthAuthorizationsGetOrCreateAuthorizationForAppParams: object

Type declaration

  • client_id: string
  • client_secret: string

    The 40 character OAuth app client secret associated with the client ID specified in the URL.

  • Optional fingerprint?: undefined | string

    A unique string to distinguish an authorization from others created for the same client and user. If provided, this API is functionally equivalent to Get-or-create an authorization for a specific app and fingerprint.

  • Optional note?: undefined | string

    A note to remind you what the OAuth token is for.

  • Optional note_url?: undefined | string

    A URL to remind you what app the OAuth token is for.

  • Optional scopes?: string[]

    A list of scopes that this authorization is in.

OauthAuthorizationsGetOrCreateAuthorizationForAppResponse

OauthAuthorizationsGetOrCreateAuthorizationForAppResponse: object

Type declaration

OauthAuthorizationsGetOrCreateAuthorizationForAppResponseApp

OauthAuthorizationsGetOrCreateAuthorizationForAppResponseApp: object

Type declaration

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

OauthAuthorizationsListAuthorizationsParams

OauthAuthorizationsListAuthorizationsParams: object

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

OauthAuthorizationsListAuthorizationsResponse

OauthAuthorizationsListAuthorizationsResponse: Array<OauthAuthorizationsListAuthorizationsResponseItem>

OauthAuthorizationsListAuthorizationsResponseItem

OauthAuthorizationsListAuthorizationsResponseItem: object

Type declaration

OauthAuthorizationsListAuthorizationsResponseItemApp

OauthAuthorizationsListAuthorizationsResponseItemApp: object

Type declaration

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

OauthAuthorizationsListGrantsParams

OauthAuthorizationsListGrantsParams: object

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

OauthAuthorizationsListGrantsResponse

OauthAuthorizationsListGrantsResponse: Array<OauthAuthorizationsListGrantsResponseItem>

OauthAuthorizationsListGrantsResponseItem

OauthAuthorizationsListGrantsResponseItem: object

Type declaration

OauthAuthorizationsListGrantsResponseItemApp

OauthAuthorizationsListGrantsResponseItemApp: object

Type declaration

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

OauthAuthorizationsResetAuthorizationParams

OauthAuthorizationsResetAuthorizationParams: object

Type declaration

  • access_token: string
  • client_id: string

OauthAuthorizationsResetAuthorizationResponse

OauthAuthorizationsResetAuthorizationResponse: object

Type declaration

OauthAuthorizationsResetAuthorizationResponseApp

OauthAuthorizationsResetAuthorizationResponseApp: object

Type declaration

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

OauthAuthorizationsResetAuthorizationResponseUser

OauthAuthorizationsResetAuthorizationResponseUser: object

Type declaration

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

OauthAuthorizationsRevokeAuthorizationForApplicationParams

OauthAuthorizationsRevokeAuthorizationForApplicationParams: object

Type declaration

  • access_token: string
  • client_id: string

OauthAuthorizationsRevokeGrantForApplicationParams

OauthAuthorizationsRevokeGrantForApplicationParams: object

Type declaration

  • access_token: string
  • client_id: string

OauthAuthorizationsUpdateAuthorizationParams

OauthAuthorizationsUpdateAuthorizationParams: object

Type declaration

  • Optional add_scopes?: string[]

    A list of scopes to add to this authorization.

  • authorization_id: number
  • Optional fingerprint?: undefined | string

    A unique string to distinguish an authorization from others created for the same client ID and user.

  • Optional note?: undefined | string

    A note to remind you what the OAuth token is for. Tokens not associated with a specific OAuth application (i.e. personal access tokens) must have a unique note.

  • Optional note_url?: undefined | string

    A URL to remind you what app the OAuth token is for.

  • Optional remove_scopes?: string[]

    A list of scopes to remove from this authorization.

  • Optional scopes?: string[]

    Replaces the authorization scopes with these.

OauthAuthorizationsUpdateAuthorizationResponse

OauthAuthorizationsUpdateAuthorizationResponse: object

Type declaration

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

OauthAuthorizationsUpdateAuthorizationResponseApp

OauthAuthorizationsUpdateAuthorizationResponseApp: object

Type declaration

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

OctokitRequestOptions

OctokitRequestOptions: object

Type declaration

  • [option: string]: any
  • Optional agent?: http.Agent

    Node only. Useful for custom proxy, certificate, or dns lookup.

  • Optional fetch?: any

    Custom replacement for built-in fetch method. Useful for testing or request hooks.

  • Optional signal?: any

    Use an AbortController instance to cancel a request. In node you can only cancel streamed requests.

  • Optional timeout?: undefined | number

    Node only. Request/response timeout in ms, it resets on redirect. 0 to disable (OS limit applies). options.request.signal is recommended instead.

OrgsAddOrUpdateMembershipParams

OrgsAddOrUpdateMembershipParams: object

Type declaration

  • org: string
  • Optional role?: "admin" | "member"

    The role to give the user in the organization. Can be one of: * admin - The user will become an owner of the organization. * member - The user will become a non-owner member of the organization.

  • username: string

OrgsAddOrUpdateMembershipResponse

OrgsAddOrUpdateMembershipResponse: object

Type declaration

OrgsAddOrUpdateMembershipResponseOrganization

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

OrgsAddOrUpdateMembershipResponseUser

OrgsAddOrUpdateMembershipResponseUser: object

Type declaration

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

OrgsBlockUserParams

OrgsBlockUserParams: object

Type declaration

  • org: string
  • username: string

OrgsCheckBlockedUserParams

OrgsCheckBlockedUserParams: object

Type declaration

  • org: string
  • username: string

OrgsCheckMembershipParams

OrgsCheckMembershipParams: object

Type declaration

  • org: string
  • username: string

OrgsCheckPublicMembershipParams

OrgsCheckPublicMembershipParams: object

Type declaration

  • org: string
  • username: string

OrgsConcealMembershipParams

OrgsConcealMembershipParams: object

Type declaration

  • org: string
  • username: string

OrgsConvertMemberToOutsideCollaboratorParams

OrgsConvertMemberToOutsideCollaboratorParams: object

Type declaration

  • org: string
  • username: string

OrgsConvertMemberToOutsideCollaboratorResponse

OrgsConvertMemberToOutsideCollaboratorResponse: object

Type declaration

  • documentation_url: string
  • message: string

OrgsCreateHookParams

OrgsCreateHookParams: object

Type declaration

  • Optional active?: undefined | false | true

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

  • config: OrgsCreateHookParamsConfig

    Key/value pairs to provide settings for this webhook. These are defined below.

  • Optional events?: string[]

    Determines what events the hook is triggered for.

  • name: string

    Must be passed as "web".

  • org: string

OrgsCreateHookParamsConfig

OrgsCreateHookParamsConfig: object

Type declaration

  • Optional content_type?: undefined | string
  • Optional insecure_ssl?: undefined | string
  • Optional secret?: undefined | string
  • url: string

OrgsCreateHookResponse

OrgsCreateHookResponse: object

Type declaration

  • active: boolean
  • config: OrgsCreateHookResponseConfig
  • created_at: string
  • events: Array<string>
  • id: number
  • name: string
  • ping_url: string
  • updated_at: string
  • url: string

OrgsCreateHookResponseConfig

OrgsCreateHookResponseConfig: object

Type declaration

  • content_type: string
  • url: string

OrgsCreateInvitationParams

OrgsCreateInvitationParams: object

Type declaration

  • Optional email?: undefined | string

    Required unless you provide invitee_id. Email address of the person you are inviting, which can be an existing GitHub user.

  • Optional invitee_id?: undefined | number

    Required unless you provide email. GitHub user ID for the person you are inviting.

  • org: string
  • Optional role?: "admin" | "direct_member" | "billing_manager"

    Specify role for new member. Can be one of: * admin - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. * direct_member - Non-owner organization members with ability to see other members and join teams by invitation. * billing_manager - Non-owner organization members with ability to manage the billing settings of your organization.

  • Optional team_ids?: number[]

    Specify IDs for the teams you want to invite new members to.

OrgsCreateInvitationResponse

OrgsCreateInvitationResponse: object

Type declaration

OrgsCreateInvitationResponseInviter

OrgsCreateInvitationResponseInviter: object

Type declaration

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

OrgsDeleteHookParams

OrgsDeleteHookParams: object

Type declaration

  • hook_id: number
  • org: string

OrgsGetHookParams

OrgsGetHookParams: object

Type declaration

  • hook_id: number
  • org: string

OrgsGetHookResponse

OrgsGetHookResponse: object

Type declaration

  • active: boolean
  • config: OrgsGetHookResponseConfig
  • created_at: string
  • events: Array<string>
  • id: number
  • name: string
  • ping_url: string
  • updated_at: string
  • url: string

OrgsGetHookResponseConfig

OrgsGetHookResponseConfig: object

Type declaration

  • content_type: string
  • url: string

OrgsGetMembershipForAuthenticatedUserParams

OrgsGetMembershipForAuthenticatedUserParams: object

Type declaration

  • org: string

OrgsGetMembershipForAuthenticatedUserResponse

OrgsGetMembershipForAuthenticatedUserResponse: object

Type declaration

OrgsGetMembershipForAuthenticatedUserResponseOrganization

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

OrgsGetMembershipForAuthenticatedUserResponseUser

OrgsGetMembershipForAuthenticatedUserResponseUser: object

Type declaration

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

OrgsGetMembershipParams

OrgsGetMembershipParams: object

Type declaration

  • org: string
  • username: string

OrgsGetMembershipResponse

OrgsGetMembershipResponse: object

Type declaration

OrgsGetMembershipResponseOrganization

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

OrgsGetMembershipResponseUser

OrgsGetMembershipResponseUser: object

Type declaration

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

OrgsGetParams

OrgsGetParams: object

Type declaration

  • org: string

OrgsGetResponse

OrgsGetResponse: object

Type declaration

  • avatar_url: string
  • Optional billing_email?: undefined | string
  • blog: string
  • Optional collaborators?: undefined | number
  • company: string
  • created_at: string
  • Optional default_repository_settings?: undefined | string
  • description: string
  • Optional disk_usage?: undefined | number
  • email: string
  • events_url: string
  • followers: number
  • following: number
  • has_organization_projects: boolean
  • has_repository_projects: boolean
  • hooks_url: string
  • html_url: string
  • id: number
  • is_verified: boolean
  • issues_url: string
  • location: string
  • login: string
  • Optional members_allowed_repository_creation_type?: undefined | string
  • Optional members_can_create_repositories?: undefined | false | true
  • members_url: string
  • name: string
  • node_id: string
  • Optional owned_private_repos?: undefined | number
  • plan: OrgsGetResponsePlan
  • Optional private_gists?: undefined | number
  • public_gists: number
  • public_members_url: string
  • public_repos: number
  • repos_url: string
  • Optional total_private_repos?: undefined | number
  • Optional two_factor_requirement_enabled?: undefined | false | true
  • type: string
  • url: string

OrgsGetResponsePlan

OrgsGetResponsePlan: object

Type declaration

  • Optional filled_seats?: undefined | number
  • name: string
  • private_repos: number
  • Optional seats?: undefined | number
  • space: number

OrgsListBlockedUsersParams

OrgsListBlockedUsersParams: object

Type declaration

  • org: string

OrgsListBlockedUsersResponse

OrgsListBlockedUsersResponse: Array<OrgsListBlockedUsersResponseItem>

OrgsListBlockedUsersResponseItem

OrgsListBlockedUsersResponseItem: object

Type declaration

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

OrgsListForAuthenticatedUserParams

OrgsListForAuthenticatedUserParams: object

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

OrgsListForAuthenticatedUserResponse

OrgsListForAuthenticatedUserResponse: Array<OrgsListForAuthenticatedUserResponseItem>

OrgsListForAuthenticatedUserResponseItem

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

OrgsListForUserParams

OrgsListForUserParams: object

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • username: string

OrgsListForUserResponse

OrgsListForUserResponse: Array<OrgsListForUserResponseItem>

OrgsListForUserResponseItem

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

OrgsListHooksParams

OrgsListHooksParams: object

Type declaration

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

OrgsListHooksResponse

OrgsListHooksResponse: Array<OrgsListHooksResponseItem>

OrgsListHooksResponseItem

OrgsListHooksResponseItem: object

Type declaration

  • active: boolean
  • config: OrgsListHooksResponseItemConfig
  • created_at: string
  • events: Array<string>
  • id: number
  • name: string
  • ping_url: string
  • updated_at: string
  • url: string

OrgsListHooksResponseItemConfig

OrgsListHooksResponseItemConfig: object

Type declaration

  • content_type: string
  • url: string

OrgsListInstallationsParams

OrgsListInstallationsParams: object

Type declaration

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

OrgsListInstallationsResponse

OrgsListInstallationsResponse: object

Type declaration

OrgsListInstallationsResponseInstallationsItem

OrgsListInstallationsResponseInstallationsItem: object

Type declaration

OrgsListInstallationsResponseInstallationsItemAccount

OrgsListInstallationsResponseInstallationsItemAccount: object

Type declaration

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

OrgsListInstallationsResponseInstallationsItemPermissions

OrgsListInstallationsResponseInstallationsItemPermissions: object

Type declaration

  • deployments: string
  • metadata: string
  • pull_requests: string
  • statuses: string

OrgsListInvitationTeamsParams

OrgsListInvitationTeamsParams: object

Type declaration

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

OrgsListInvitationTeamsResponse

OrgsListInvitationTeamsResponse: Array<OrgsListInvitationTeamsResponseItem>

OrgsListInvitationTeamsResponseItem

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

OrgsListMembersParams

OrgsListMembersParams: 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
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • Optional role?: "all" | "admin" | "member"

    Filter members returned by their role. Can be one of: * all - All members of the organization, regardless of role. * admin - Organization owners. * member - Non-owner organization members.

OrgsListMembersResponse

OrgsListMembersResponse: Array<OrgsListMembersResponseItem>

OrgsListMembersResponseItem

OrgsListMembersResponseItem: object

Type declaration

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

OrgsListMembershipsParams

OrgsListMembershipsParams: object

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • Optional state?: "active" | "pending"

    Indicates the state of the memberships to return. Can be either active or pending. If not specified, the API returns both active and pending memberships.

OrgsListMembershipsResponse

OrgsListMembershipsResponse: Array<OrgsListMembershipsResponseItem>

OrgsListMembershipsResponseItem

OrgsListMembershipsResponseItem: object

Type declaration

OrgsListMembershipsResponseItemOrganization

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

OrgsListMembershipsResponseItemUser

OrgsListMembershipsResponseItemUser: object

Type declaration

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

OrgsListOutsideCollaboratorsParams

OrgsListOutsideCollaboratorsParams: 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
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

OrgsListOutsideCollaboratorsResponse

OrgsListOutsideCollaboratorsResponse: Array<OrgsListOutsideCollaboratorsResponseItem>

OrgsListOutsideCollaboratorsResponseItem

OrgsListOutsideCollaboratorsResponseItem: object

Type declaration

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

OrgsListParams

OrgsListParams: object

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • Optional since?: undefined | string

    The integer ID of the last Organization that you've seen.

OrgsListPendingInvitationsParams

OrgsListPendingInvitationsParams: object

Type declaration

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

OrgsListPendingInvitationsResponse

OrgsListPendingInvitationsResponse: Array<OrgsListPendingInvitationsResponseItem>

OrgsListPendingInvitationsResponseItem

OrgsListPendingInvitationsResponseItem: object

Type declaration

OrgsListPendingInvitationsResponseItemInviter

OrgsListPendingInvitationsResponseItemInviter: object

Type declaration

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

OrgsListPublicMembersParams

OrgsListPublicMembersParams: object

Type declaration

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

OrgsListPublicMembersResponse

OrgsListPublicMembersResponse: Array<OrgsListPublicMembersResponseItem>

OrgsListPublicMembersResponseItem

OrgsListPublicMembersResponseItem: object

Type declaration

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

OrgsListResponse

OrgsListResponse: Array<OrgsListResponseItem>

OrgsListResponseItem

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

OrgsPingHookParams

OrgsPingHookParams: object

Type declaration

  • hook_id: number
  • org: string

OrgsPublicizeMembershipParams

OrgsPublicizeMembershipParams: object

Type declaration

  • org: string
  • username: string

OrgsRemoveMemberParams

OrgsRemoveMemberParams: object

Type declaration

  • org: string
  • username: string

OrgsRemoveMembershipParams

OrgsRemoveMembershipParams: object

Type declaration

  • org: string
  • username: string

OrgsRemoveOutsideCollaboratorParams

OrgsRemoveOutsideCollaboratorParams: object

Type declaration

  • org: string
  • username: string

OrgsRemoveOutsideCollaboratorResponse

OrgsRemoveOutsideCollaboratorResponse: object

Type declaration

  • documentation_url: string
  • message: string

OrgsUnblockUserParams

OrgsUnblockUserParams: object

Type declaration

  • org: string
  • username: string

OrgsUpdateHookParams

OrgsUpdateHookParams: object

Type declaration

  • Optional active?: undefined | false | true

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

  • Optional config?: OrgsUpdateHookParamsConfig

    Key/value pairs to provide settings for this webhook. These are defined below.

  • Optional events?: string[]

    Determines what events the hook is triggered for.

  • hook_id: number
  • org: string

OrgsUpdateHookParamsConfig

OrgsUpdateHookParamsConfig: object

Type declaration

  • Optional content_type?: undefined | string
  • Optional insecure_ssl?: undefined | string
  • Optional secret?: undefined | string
  • url: string

OrgsUpdateHookResponse

OrgsUpdateHookResponse: object

Type declaration

  • active: boolean
  • config: OrgsUpdateHookResponseConfig
  • created_at: string
  • events: Array<string>
  • id: number
  • name: string
  • ping_url: string
  • updated_at: string
  • url: string

OrgsUpdateHookResponseConfig

OrgsUpdateHookResponseConfig: object

Type declaration

  • content_type: string
  • url: string

OrgsUpdateMembershipParams

OrgsUpdateMembershipParams: object

Type declaration

  • org: string
  • state: "active"

    The state that the membership should be in. Only "active" will be accepted.

OrgsUpdateMembershipResponse

OrgsUpdateMembershipResponse: object

Type declaration

OrgsUpdateMembershipResponseOrganization

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

OrgsUpdateMembershipResponseUser

OrgsUpdateMembershipResponseUser: object

Type declaration

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

OrgsUpdateParams

OrgsUpdateParams: object

Type declaration

  • Optional billing_email?: undefined | string

    Billing email address. This address is not publicized.

  • Optional company?: undefined | string

    The company name.

  • Optional default_repository_permission?: "read" | "write" | "admin" | "none"

    Default permission level members have for organization repositories: * read - can pull, but not push to or administer this repository. * write - can pull and push, but not administer this repository. * admin - can pull, push, and administer this repository. * none - no permissions granted by default.

  • Optional description?: undefined | string

    The description of the company.

  • Optional email?: undefined | string

    The publicly visible email address.

  • Optional has_organization_projects?: undefined | false | true

    Toggles whether organization projects are enabled for the organization.

  • Optional has_repository_projects?: undefined | false | true

    Toggles whether repository projects are enabled for repositories that belong to the organization.

  • Optional location?: undefined | 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 Business Cloud. * none - only admin members can create repositories. Note: Using this parameter will override values set in members_can_create_repositories. See this note for details.

  • Optional members_can_create_repositories?: undefined | false | true

    Toggles the ability of non-admin organization members to create repositories. Can be one of: * true - all organization members can create repositories. * false - only admin members can create repositories. Default: true Note: Another parameter can override the this parameter. See this note for details. Note: Another parameter can override the this parameter. See this note for details.

  • Optional name?: undefined | string

    The shorthand name of the company.

  • org: string

OrgsUpdateResponse

OrgsUpdateResponse: object

Type declaration

  • avatar_url: string
  • billing_email: string
  • blog: string
  • collaborators: number
  • company: string
  • created_at: string
  • default_repository_settings: 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_repositories: boolean
  • members_url: string
  • name: string
  • node_id: string
  • owned_private_repos: number
  • plan: OrgsUpdateResponsePlan
  • private_gists: number
  • public_gists: number
  • public_members_url: string
  • public_repos: number
  • repos_url: string
  • total_private_repos: number
  • two_factor_requirement_enabled: boolean
  • type: string
  • url: string

OrgsUpdateResponsePlan

OrgsUpdateResponsePlan: object

Type declaration

  • name: string
  • private_repos: number
  • space: number

Plugin

Plugin: function

Type declaration

    • (octokit: Octokit, options: Options): void

    • Parameters

      • octokit: Octokit
      • options: Options

      Returns void

ProjectsAddCollaboratorParams

ProjectsAddCollaboratorParams: object

Type declaration

  • Optional permission?: "read" | "write" | "admin"

    The permission to grant the collaborator. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs." Can be one of: * read - can read, but not write to or administer this project. * write - can read and write, but not administer this project. * admin - can read, write and administer this project.

  • project_id: number
  • username: string

ProjectsCreateCardParams

ProjectsCreateCardParams: object

Type declaration

  • column_id: number
  • Optional content_id?: undefined | number

    The issue or pull request id you want to associate with this card. You can use the List issues for a repository and List pull requests endpoints to find this id. Note: Depending on whether you use the issue id or pull request id, you will need to specify Issue or PullRequest as the content_type.

  • Optional content_type?: undefined | string

    Required if you provide content_id. The type of content you want to associate with this card. Use Issue when content_id is an issue id and use PullRequest when content_id is a pull request id.

  • Optional note?: undefined | string

    The card's note content. Only valid for cards without another type of content, so you must omit when specifying content_id and content_type.

ProjectsCreateCardResponse

ProjectsCreateCardResponse: object

Type declaration

  • archived: boolean
  • column_url: string
  • content_url: string
  • created_at: string
  • creator: ProjectsCreateCardResponseCreator
  • id: number
  • node_id: string
  • note: string
  • project_url: string
  • updated_at: string
  • url: string

ProjectsCreateCardResponseCreator

ProjectsCreateCardResponseCreator: object

Type declaration

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

ProjectsCreateColumnParams

ProjectsCreateColumnParams: object

Type declaration

  • name: string

    The name of the column.

  • project_id: number

ProjectsCreateColumnResponse

ProjectsCreateColumnResponse: object

Type declaration

  • cards_url: string
  • created_at: string
  • id: number
  • name: string
  • node_id: string
  • project_url: string
  • updated_at: string
  • url: string

ProjectsCreateForAuthenticatedUserParams

ProjectsCreateForAuthenticatedUserParams: object

Type declaration

  • Optional body?: undefined | string

    The description of the project.

  • name: string

    The name of the project.

ProjectsCreateForAuthenticatedUserResponse

ProjectsCreateForAuthenticatedUserResponse: object

Type declaration

  • body: string
  • columns_url: string
  • created_at: string
  • creator: ProjectsCreateForAuthenticatedUserResponseCreator
  • html_url: string
  • id: number
  • name: string
  • node_id: string
  • number: number
  • owner_url: string
  • state: string
  • updated_at: string
  • url: string

ProjectsCreateForAuthenticatedUserResponseCreator

ProjectsCreateForAuthenticatedUserResponseCreator: object

Type declaration

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

ProjectsCreateForOrgParams

ProjectsCreateForOrgParams: object

Type declaration

  • Optional body?: undefined | string

    The description of the project.

  • name: string

    The name of the project.

  • org: string

ProjectsCreateForOrgResponse

ProjectsCreateForOrgResponse: object

Type declaration

  • body: string
  • columns_url: string
  • created_at: string
  • creator: ProjectsCreateForOrgResponseCreator
  • html_url: string
  • id: number
  • name: string
  • node_id: string
  • number: number
  • owner_url: string
  • state: string
  • updated_at: string
  • url: string

ProjectsCreateForOrgResponseCreator

ProjectsCreateForOrgResponseCreator: object

Type declaration

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

ProjectsCreateForRepoParams

ProjectsCreateForRepoParams: object

Type declaration

  • Optional body?: undefined | string

    The description of the project.

  • name: string

    The name of the project.

  • owner: string
  • repo: string

ProjectsCreateForRepoResponse

ProjectsCreateForRepoResponse: object

Type declaration

  • body: string
  • columns_url: string
  • created_at: string
  • creator: ProjectsCreateForRepoResponseCreator
  • html_url: string
  • id: number
  • name: string
  • node_id: string
  • number: number
  • owner_url: string
  • state: string
  • updated_at: string
  • url: string

ProjectsCreateForRepoResponseCreator

ProjectsCreateForRepoResponseCreator: object

Type declaration

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

ProjectsDeleteCardParams

ProjectsDeleteCardParams: object

Type declaration

  • card_id: number

ProjectsDeleteColumnParams

ProjectsDeleteColumnParams: object

Type declaration

  • column_id: number

ProjectsDeleteParams

ProjectsDeleteParams: object

Type declaration

  • project_id: number

ProjectsGetCardParams

ProjectsGetCardParams: object

Type declaration

  • card_id: number

ProjectsGetCardResponse

ProjectsGetCardResponse: object

Type declaration

  • archived: boolean
  • column_url: string
  • content_url: string
  • created_at: string
  • creator: ProjectsGetCardResponseCreator
  • id: number
  • node_id: string
  • note: string
  • project_url: string
  • updated_at: string
  • url: string

ProjectsGetCardResponseCreator

ProjectsGetCardResponseCreator: object

Type declaration

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

ProjectsGetColumnParams

ProjectsGetColumnParams: object

Type declaration

  • column_id: number

ProjectsGetColumnResponse

ProjectsGetColumnResponse: object

Type declaration

  • cards_url: string
  • created_at: string
  • id: number
  • name: string
  • node_id: string
  • project_url: string
  • updated_at: string
  • url: string

ProjectsGetParams

ProjectsGetParams: object

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • project_id: number

ProjectsGetResponse

ProjectsGetResponse: object

Type declaration

  • body: string
  • columns_url: string
  • created_at: string
  • creator: ProjectsGetResponseCreator
  • html_url: string
  • id: number
  • name: string
  • node_id: string
  • number: number
  • owner_url: string
  • state: string
  • updated_at: string
  • url: string

ProjectsGetResponseCreator

ProjectsGetResponseCreator: object

Type declaration

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

ProjectsListCardsParams

ProjectsListCardsParams: object

Type declaration

  • Optional archived_state?: "all" | "archived" | "not_archived"

    Filters the project cards that are returned by the card's state. Can be one of all,archived, or not_archived.

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

ProjectsListCardsResponse

ProjectsListCardsResponse: Array<ProjectsListCardsResponseItem>

ProjectsListCardsResponseItem

ProjectsListCardsResponseItem: object

Type declaration

  • archived: boolean
  • column_url: string
  • content_url: string
  • created_at: string
  • creator: ProjectsListCardsResponseItemCreator
  • id: number
  • node_id: string
  • note: string
  • project_url: string
  • updated_at: string
  • url: string

ProjectsListCardsResponseItemCreator

ProjectsListCardsResponseItemCreator: object

Type declaration

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

ProjectsListCollaboratorsParams

ProjectsListCollaboratorsParams: object

Type declaration

  • Optional affiliation?: "outside" | "direct" | "all"

    Filters the collaborators by their affiliation. Can be one of: * outside: Outside collaborators of a project that are not a member of the project's organization. * direct: Collaborators with permissions to a project, regardless of organization membership status. * all: All collaborators the authenticated user can see.

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • project_id: number

ProjectsListCollaboratorsResponse

ProjectsListCollaboratorsResponse: Array<ProjectsListCollaboratorsResponseItem>

ProjectsListCollaboratorsResponseItem

ProjectsListCollaboratorsResponseItem: object

Type declaration

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

ProjectsListColumnsParams

ProjectsListColumnsParams: object

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • project_id: number

ProjectsListColumnsResponse

ProjectsListColumnsResponse: Array<ProjectsListColumnsResponseItem>

ProjectsListColumnsResponseItem

ProjectsListColumnsResponseItem: object

Type declaration

  • cards_url: string
  • created_at: string
  • id: number
  • name: string
  • node_id: string
  • project_url: string
  • updated_at: string
  • url: string

ProjectsListForOrgParams

ProjectsListForOrgParams: object

Type declaration

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • Optional state?: "open" | "closed" | "all"

    Indicates the state of the projects to return. Can be either open, closed, or all.

ProjectsListForOrgResponse

ProjectsListForOrgResponse: Array<ProjectsListForOrgResponseItem>

ProjectsListForOrgResponseItem

ProjectsListForOrgResponseItem: object

Type declaration

  • body: string
  • columns_url: string
  • created_at: string
  • creator: ProjectsListForOrgResponseItemCreator
  • html_url: string
  • id: number
  • name: string
  • node_id: string
  • number: number
  • owner_url: string
  • state: string
  • updated_at: string
  • url: string

ProjectsListForOrgResponseItemCreator

ProjectsListForOrgResponseItemCreator: object

Type declaration

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

ProjectsListForRepoParams

ProjectsListForRepoParams: object

Type declaration

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string
  • Optional state?: "open" | "closed" | "all"

    Indicates the state of the projects to return. Can be either open, closed, or all.

ProjectsListForRepoResponse

ProjectsListForRepoResponse: Array<ProjectsListForRepoResponseItem>

ProjectsListForRepoResponseItem

ProjectsListForRepoResponseItem: object

Type declaration

  • body: string
  • columns_url: string
  • created_at: string
  • creator: ProjectsListForRepoResponseItemCreator
  • html_url: string
  • id: number
  • name: string
  • node_id: string
  • number: number
  • owner_url: string
  • state: string
  • updated_at: string
  • url: string

ProjectsListForRepoResponseItemCreator

ProjectsListForRepoResponseItemCreator: object

Type declaration

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

ProjectsListForUserParams

ProjectsListForUserParams: object

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • Optional state?: "open" | "closed" | "all"

    Indicates the state of the projects to return. Can be either open, closed, or all.

  • username: string

ProjectsListForUserResponse

ProjectsListForUserResponse: Array<ProjectsListForUserResponseItem>

ProjectsListForUserResponseItem

ProjectsListForUserResponseItem: object

Type declaration

  • body: string
  • columns_url: string
  • created_at: string
  • creator: ProjectsListForUserResponseItemCreator
  • html_url: string
  • id: number
  • name: string
  • node_id: string
  • number: number
  • owner_url: string
  • state: string
  • updated_at: string
  • url: string

ProjectsListForUserResponseItemCreator

ProjectsListForUserResponseItemCreator: object

Type declaration

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

ProjectsMoveCardParams

ProjectsMoveCardParams: object

Type declaration

  • card_id: number
  • Optional column_id?: undefined | number

    The id value of a column in the same project.

  • position: string

    Can be one of top, bottom, or after:<card_id>, where <card_id> is the id value of a card in the same column, or in the new column specified by column_id.

ProjectsMoveColumnParams

ProjectsMoveColumnParams: object

Type declaration

  • column_id: number
  • position: string

    Can be one of first, last, or after:<column_id>, where <column_id> is the id value of a column in the same project.

ProjectsRemoveCollaboratorParams

ProjectsRemoveCollaboratorParams: object

Type declaration

  • project_id: number
  • username: string

ProjectsReviewUserPermissionLevelParams

ProjectsReviewUserPermissionLevelParams: object

Type declaration

  • project_id: number
  • username: string

ProjectsReviewUserPermissionLevelResponse

ProjectsReviewUserPermissionLevelResponse: object

Type declaration

ProjectsReviewUserPermissionLevelResponseUser

ProjectsReviewUserPermissionLevelResponseUser: object

Type declaration

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

ProjectsUpdateCardParams

ProjectsUpdateCardParams: object

Type declaration

  • Optional archived?: undefined | false | true

    Use true to archive a project card. Specify false if you need to restore a previously archived project card.

  • card_id: number
  • Optional note?: undefined | string

    The card's note content. Only valid for cards without another type of content, so this cannot be specified if the card already has a content_id and content_type.

ProjectsUpdateCardResponse

ProjectsUpdateCardResponse: object

Type declaration

  • archived: boolean
  • column_url: string
  • content_url: string
  • created_at: string
  • creator: ProjectsUpdateCardResponseCreator
  • id: number
  • node_id: string
  • note: string
  • project_url: string
  • updated_at: string
  • url: string

ProjectsUpdateCardResponseCreator

ProjectsUpdateCardResponseCreator: object

Type declaration

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

ProjectsUpdateColumnParams

ProjectsUpdateColumnParams: object

Type declaration

  • column_id: number
  • name: string

    The new name of the column.

ProjectsUpdateColumnResponse

ProjectsUpdateColumnResponse: object

Type declaration

  • cards_url: string
  • created_at: string
  • id: number
  • name: string
  • node_id: string
  • project_url: string
  • updated_at: string
  • url: string

ProjectsUpdateParams

ProjectsUpdateParams: object

Type declaration

  • Optional body?: undefined | string

    The description of the project.

  • Optional name?: undefined | string

    The name of the project.

  • Optional organization_permission?: undefined | string

    The permission level that determines whether all members of the project's organization can see and/or make changes to the project. Setting organization_permission is only available for organization projects. If an organization member belongs to a team with a higher level of access or is a collaborator with a higher level of access, their permission level is not lowered by organization_permission. For information on changing access for a team or collaborator, see Add or update team project or Add user as a collaborator.

    Note: Updating a project's organization_permission requires admin access to the project.

    Can be one of: * read - Organization members can read, but not write to or administer this project. * write - Organization members can read and write, but not administer this project. * admin - Organization members can read, write and administer this project. * none - Organization members can only see this project if it is public.

  • Optional private?: undefined | false | true

    Sets the visibility of a project board. Setting private is only available for organization and user projects. Note: Updating a project's visibility requires admin access to the project.

    Can be one of: * false - Anyone can see the project. * true - Only the user can view a project board created on a user account. Organization members with the appropriate organization_permission can see project boards in an organization account.

  • project_id: number
  • Optional state?: "open" | "closed"

    State of the project. Either open or closed.

ProjectsUpdateResponse

ProjectsUpdateResponse: object

Type declaration

  • body: string
  • columns_url: string
  • created_at: string
  • creator: ProjectsUpdateResponseCreator
  • html_url: string
  • id: number
  • name: string
  • node_id: string
  • number: number
  • owner_url: string
  • state: string
  • updated_at: string
  • url: string

ProjectsUpdateResponseCreator

ProjectsUpdateResponseCreator: object

Type declaration

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

PullsCheckIfMergedParams

PullsCheckIfMergedParams: object

Type declaration

  • owner: string
  • pull_number: number
  • repo: string

PullsCheckIfMergedParamsDeprecatedNumber

PullsCheckIfMergedParamsDeprecatedNumber: object

Type declaration

  • number: number
    deprecated

    "number" parameter renamed to "pull_number"

  • owner: string
  • repo: string

PullsCreateCommentParams

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

    Required with comfort-fade preview. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

  • owner: string
  • path: string

    The relative path to the file that necessitates a comment.

  • Optional position?: undefined | number

    Required without comfort-fade preview. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

  • pull_number: number
  • repo: string
  • Optional side?: "LEFT" | "RIGHT"

    Required with comfort-fade preview. In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "Diff view options" in the GitHub Help documentation.

  • Optional start_line?: undefined | number

    Required when using multi-line comments. To create multi-line comments, you must use the comfort-fade preview header. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "Commenting on a pull request" in the GitHub Help documentation.

  • Optional start_side?: "LEFT" | "RIGHT" | "side"

    Required when using multi-line comments. To create multi-line comments, you must use the comfort-fade preview header. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see "Commenting on a pull request" in the GitHub Help documentation. See side in this table for additional context.

PullsCreateCommentParamsDeprecatedInReplyTo

PullsCreateCommentParamsDeprecatedInReplyTo: 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 in_reply_to?: undefined | number

    The comment ID to reply to. Note: This must be the ID of a top-level comment, not a reply to that comment. Replies to replies are not supported.

    deprecated

    "in_reply_to" parameter has been deprecated and will be removed in future

  • Optional line?: undefined | number

    Required with comfort-fade preview. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

  • owner: string
  • path: string

    The relative path to the file that necessitates a comment.

  • Optional position?: undefined | number

    Required without comfort-fade preview. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

  • pull_number: number
  • repo: string
  • Optional side?: "LEFT" | "RIGHT"

    Required with comfort-fade preview. In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "Diff view options" in the GitHub Help documentation.

  • Optional start_line?: undefined | number

    Required when using multi-line comments. To create multi-line comments, you must use the comfort-fade preview header. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "Commenting on a pull request" in the GitHub Help documentation.

  • Optional start_side?: "LEFT" | "RIGHT" | "side"

    Required when using multi-line comments. To create multi-line comments, you must use the comfort-fade preview header. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see "Commenting on a pull request" in the GitHub Help documentation. See side in this table for additional context.

PullsCreateCommentParamsDeprecatedNumber

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

    Required with comfort-fade preview. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

  • number: number
    deprecated

    "number" parameter renamed to "pull_number"

  • owner: string
  • path: string

    The relative path to the file that necessitates a comment.

  • Optional position?: undefined | number

    Required without comfort-fade preview. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

  • repo: string
  • Optional side?: "LEFT" | "RIGHT"

    Required with comfort-fade preview. In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "Diff view options" in the GitHub Help documentation.

  • Optional start_line?: undefined | number

    Required when using multi-line comments. To create multi-line comments, you must use the comfort-fade preview header. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "Commenting on a pull request" in the GitHub Help documentation.

  • Optional start_side?: "LEFT" | "RIGHT" | "side"

    Required when using multi-line comments. To create multi-line comments, you must use the comfort-fade preview header. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see "Commenting on a pull request" in the GitHub Help documentation. See side in this table for additional context.

PullsCreateCommentReplyParams

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

    Required with comfort-fade preview. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

  • owner: string
  • path: string

    The relative path to the file that necessitates a comment.

  • Optional position?: undefined | number

    Required without comfort-fade preview. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

  • pull_number: number
  • repo: string
  • Optional side?: "LEFT" | "RIGHT"

    Required with comfort-fade preview. In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "Diff view options" in the GitHub Help documentation.

  • Optional start_line?: undefined | number

    Required when using multi-line comments. To create multi-line comments, you must use the comfort-fade preview header. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "Commenting on a pull request" in the GitHub Help documentation.

  • Optional start_side?: "LEFT" | "RIGHT" | "side"

    Required when using multi-line comments. To create multi-line comments, you must use the comfort-fade preview header. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see "Commenting on a pull request" in the GitHub Help documentation. See side in this table for additional context.

PullsCreateCommentReplyParamsDeprecatedInReplyTo

PullsCreateCommentReplyParamsDeprecatedInReplyTo: 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 in_reply_to?: undefined | number

    The comment ID to reply to. Note: This must be the ID of a top-level comment, not a reply to that comment. Replies to replies are not supported.

    deprecated

    "in_reply_to" parameter has been deprecated and will be removed in future

  • Optional line?: undefined | number

    Required with comfort-fade preview. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

  • owner: string
  • path: string

    The relative path to the file that necessitates a comment.

  • Optional position?: undefined | number

    Required without comfort-fade preview. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

  • pull_number: number
  • repo: string
  • Optional side?: "LEFT" | "RIGHT"

    Required with comfort-fade preview. In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "Diff view options" in the GitHub Help documentation.

  • Optional start_line?: undefined | number

    Required when using multi-line comments. To create multi-line comments, you must use the comfort-fade preview header. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "Commenting on a pull request" in the GitHub Help documentation.

  • Optional start_side?: "LEFT" | "RIGHT" | "side"

    Required when using multi-line comments. To create multi-line comments, you must use the comfort-fade preview header. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see "Commenting on a pull request" in the GitHub Help documentation. See side in this table for additional context.

PullsCreateCommentReplyParamsDeprecatedNumber

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

    Required with comfort-fade preview. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

  • number: number
    deprecated

    "number" parameter renamed to "pull_number"

  • owner: string
  • path: string

    The relative path to the file that necessitates a comment.

  • Optional position?: undefined | number

    Required without comfort-fade preview. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

  • repo: string
  • Optional side?: "LEFT" | "RIGHT"

    Required with comfort-fade preview. In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "Diff view options" in the GitHub Help documentation.

  • Optional start_line?: undefined | number

    Required when using multi-line comments. To create multi-line comments, you must use the comfort-fade preview header. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "Commenting on a pull request" in the GitHub Help documentation.

  • Optional start_side?: "LEFT" | "RIGHT" | "side"

    Required when using multi-line comments. To create multi-line comments, you must use the comfort-fade preview header. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see "Commenting on a pull request" in the GitHub Help documentation. See side in this table for additional context.

PullsCreateCommentReplyResponse

PullsCreateCommentReplyResponse: object

Type declaration

  • _links: PullsCreateCommentReplyResponseLinks
  • author_association: string
  • body: string
  • commit_id: string
  • created_at: string
  • diff_hunk: string
  • html_url: string
  • id: number
  • in_reply_to_id: number
  • line: number
  • node_id: string
  • original_commit_id: string
  • original_line: number
  • original_position: number
  • original_start_line: number
  • path: string
  • position: number
  • pull_request_review_id: number
  • pull_request_url: string
  • side: string
  • start_line: number
  • start_side: string
  • updated_at: string
  • url: string
  • user: PullsCreateCommentReplyResponseUser

PullsCreateCommentReplyResponseLinks

PullsCreateCommentReplyResponseLinks: object

Type declaration

PullsCreateCommentReplyResponseLinksHtml

PullsCreateCommentReplyResponseLinksHtml: object

Type declaration

  • href: string

PullsCreateCommentReplyResponseLinksPullRequest

PullsCreateCommentReplyResponseLinksPullRequest: object

Type declaration

  • href: string

PullsCreateCommentReplyResponseLinksSelf

PullsCreateCommentReplyResponseLinksSelf: object

Type declaration

  • href: string

PullsCreateCommentReplyResponseUser

PullsCreateCommentReplyResponseUser: object

Type declaration

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

PullsCreateCommentResponse

PullsCreateCommentResponse: object

Type declaration

  • _links: PullsCreateCommentResponseLinks
  • author_association: string
  • body: string
  • commit_id: string
  • created_at: string
  • diff_hunk: string
  • html_url: string
  • id: number
  • in_reply_to_id: number
  • line: number
  • node_id: string
  • original_commit_id: string
  • original_line: number
  • original_position: number
  • original_start_line: number
  • path: string
  • position: number
  • pull_request_review_id: number
  • pull_request_url: string
  • side: string
  • start_line: number
  • start_side: string
  • updated_at: string
  • url: string
  • user: PullsCreateCommentResponseUser

PullsCreateCommentResponseLinks

PullsCreateCommentResponseLinks: object

Type declaration

PullsCreateCommentResponseLinksHtml

PullsCreateCommentResponseLinksHtml: object

Type declaration

  • href: string

PullsCreateCommentResponseLinksPullRequest

PullsCreateCommentResponseLinksPullRequest: object

Type declaration

  • href: string

PullsCreateCommentResponseLinksSelf

PullsCreateCommentResponseLinksSelf: object

Type declaration

  • href: string

PullsCreateCommentResponseUser

PullsCreateCommentResponseUser: object

Type declaration

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

PullsCreateFromIssueParams

PullsCreateFromIssueParams: object

Type declaration

  • base: string
  • Optional draft?: undefined | false | true
  • head: string
  • issue: number
  • Optional maintainer_can_modify?: undefined | false | true
  • owner: string
  • repo: string

PullsCreateFromIssueResponse

PullsCreateFromIssueResponse: object

Type declaration

PullsCreateFromIssueResponseAssignee

PullsCreateFromIssueResponseAssignee: object

Type declaration

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

PullsCreateFromIssueResponseAssigneesItem

PullsCreateFromIssueResponseAssigneesItem: object

Type declaration

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

PullsCreateFromIssueResponseBase

PullsCreateFromIssueResponseBase: object

Type declaration

PullsCreateFromIssueResponseBaseRepo

PullsCreateFromIssueResponseBaseRepo: 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: PullsCreateFromIssueResponseBaseRepoOwner
  • permissions: PullsCreateFromIssueResponseBaseRepoPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

PullsCreateFromIssueResponseBaseRepoOwner

PullsCreateFromIssueResponseBaseRepoOwner: object

Type declaration

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

PullsCreateFromIssueResponseBaseRepoPermissions

PullsCreateFromIssueResponseBaseRepoPermissions: object

Type declaration

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

PullsCreateFromIssueResponseBaseUser

PullsCreateFromIssueResponseBaseUser: object

Type declaration

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

PullsCreateFromIssueResponseHead

PullsCreateFromIssueResponseHead: object

Type declaration

PullsCreateFromIssueResponseHeadRepo

PullsCreateFromIssueResponseHeadRepo: 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: PullsCreateFromIssueResponseHeadRepoOwner
  • permissions: PullsCreateFromIssueResponseHeadRepoPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

PullsCreateFromIssueResponseHeadRepoOwner

PullsCreateFromIssueResponseHeadRepoOwner: object

Type declaration

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

PullsCreateFromIssueResponseHeadRepoPermissions

PullsCreateFromIssueResponseHeadRepoPermissions: object

Type declaration

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

PullsCreateFromIssueResponseHeadUser

PullsCreateFromIssueResponseHeadUser: object

Type declaration

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

PullsCreateFromIssueResponseLabelsItem

PullsCreateFromIssueResponseLabelsItem: object

Type declaration

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

PullsCreateFromIssueResponseLinks

PullsCreateFromIssueResponseLinks: object

Type declaration

PullsCreateFromIssueResponseLinksComments

PullsCreateFromIssueResponseLinksComments: object

Type declaration

  • href: string

PullsCreateFromIssueResponseLinksCommits

PullsCreateFromIssueResponseLinksCommits: object

Type declaration

  • href: string

PullsCreateFromIssueResponseLinksHtml

PullsCreateFromIssueResponseLinksHtml: object

Type declaration

  • href: string

PullsCreateFromIssueResponseLinksIssue

PullsCreateFromIssueResponseLinksIssue: object

Type declaration

  • href: string

PullsCreateFromIssueResponseLinksReviewComment

PullsCreateFromIssueResponseLinksReviewComment: object

Type declaration

  • href: string

PullsCreateFromIssueResponseLinksReviewComments

PullsCreateFromIssueResponseLinksReviewComments: object

Type declaration

  • href: string

PullsCreateFromIssueResponseLinksSelf

PullsCreateFromIssueResponseLinksSelf: object

Type declaration

  • href: string

PullsCreateFromIssueResponseLinksStatuses

PullsCreateFromIssueResponseLinksStatuses: object

Type declaration

  • href: string

PullsCreateFromIssueResponseMergedBy

PullsCreateFromIssueResponseMergedBy: object

Type declaration

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

PullsCreateFromIssueResponseMilestone

PullsCreateFromIssueResponseMilestone: object

Type declaration

  • closed_at: string
  • closed_issues: number
  • created_at: string
  • creator: PullsCreateFromIssueResponseMilestoneCreator
  • description: string
  • due_on: string
  • html_url: string
  • id: number
  • labels_url: string
  • node_id: string
  • number: number
  • open_issues: number
  • state: string
  • title: string
  • updated_at: string
  • url: string

PullsCreateFromIssueResponseMilestoneCreator

PullsCreateFromIssueResponseMilestoneCreator: object

Type declaration

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

PullsCreateFromIssueResponseRequestedReviewersItem

PullsCreateFromIssueResponseRequestedReviewersItem: object

Type declaration

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

PullsCreateFromIssueResponseRequestedTeamsItem

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

PullsCreateFromIssueResponseUser

PullsCreateFromIssueResponseUser: object

Type declaration

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

PullsCreateParams

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

    The contents of the pull request.

  • Optional draft?: undefined | false | true

    Indicates whether the pull request is a draft. See "Draft Pull Requests" in the GitHub Help documentation to learn more.

  • head: string

    The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username:branch.

  • Optional maintainer_can_modify?: undefined | false | true

    Indicates whether maintainers can modify the pull request.

  • owner: string
  • repo: string
  • title: string

    The title of the new pull request.

PullsCreateResponse

PullsCreateResponse: object

Type declaration

PullsCreateResponseAssignee

PullsCreateResponseAssignee: object

Type declaration

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

PullsCreateResponseAssigneesItem

PullsCreateResponseAssigneesItem: object

Type declaration

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

PullsCreateResponseBase

PullsCreateResponseBase: object

Type declaration

PullsCreateResponseBaseRepo

PullsCreateResponseBaseRepo: 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: PullsCreateResponseBaseRepoOwner
  • permissions: PullsCreateResponseBaseRepoPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

PullsCreateResponseBaseRepoOwner

PullsCreateResponseBaseRepoOwner: object

Type declaration

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

PullsCreateResponseBaseRepoPermissions

PullsCreateResponseBaseRepoPermissions: object

Type declaration

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

PullsCreateResponseBaseUser

PullsCreateResponseBaseUser: object

Type declaration

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

PullsCreateResponseHead

PullsCreateResponseHead: object

Type declaration

PullsCreateResponseHeadRepo

PullsCreateResponseHeadRepo: 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: PullsCreateResponseHeadRepoOwner
  • permissions: PullsCreateResponseHeadRepoPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

PullsCreateResponseHeadRepoOwner

PullsCreateResponseHeadRepoOwner: object

Type declaration

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

PullsCreateResponseHeadRepoPermissions

PullsCreateResponseHeadRepoPermissions: object

Type declaration

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

PullsCreateResponseHeadUser

PullsCreateResponseHeadUser: object

Type declaration

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

PullsCreateResponseLabelsItem

PullsCreateResponseLabelsItem: object

Type declaration

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

PullsCreateResponseLinks

PullsCreateResponseLinks: object

Type declaration

PullsCreateResponseLinksComments

PullsCreateResponseLinksComments: object

Type declaration

  • href: string

PullsCreateResponseLinksCommits

PullsCreateResponseLinksCommits: object

Type declaration

  • href: string

PullsCreateResponseLinksHtml

PullsCreateResponseLinksHtml: object

Type declaration

  • href: string

PullsCreateResponseLinksIssue

PullsCreateResponseLinksIssue: object

Type declaration

  • href: string

PullsCreateResponseLinksReviewComment

PullsCreateResponseLinksReviewComment: object

Type declaration

  • href: string

PullsCreateResponseLinksReviewComments

PullsCreateResponseLinksReviewComments: object

Type declaration

  • href: string

PullsCreateResponseLinksSelf

PullsCreateResponseLinksSelf: object

Type declaration

  • href: string

PullsCreateResponseLinksStatuses

PullsCreateResponseLinksStatuses: object

Type declaration

  • href: string

PullsCreateResponseMergedBy

PullsCreateResponseMergedBy: object

Type declaration

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

PullsCreateResponseMilestone

PullsCreateResponseMilestone: object

Type declaration

  • closed_at: string
  • closed_issues: number
  • created_at: string
  • creator: PullsCreateResponseMilestoneCreator
  • description: string
  • due_on: string
  • html_url: string
  • id: number
  • labels_url: string
  • node_id: string
  • number: number
  • open_issues: number
  • state: string
  • title: string
  • updated_at: string
  • url: string

PullsCreateResponseMilestoneCreator

PullsCreateResponseMilestoneCreator: object

Type declaration

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

PullsCreateResponseRequestedReviewersItem

PullsCreateResponseRequestedReviewersItem: object

Type declaration

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

PullsCreateResponseRequestedTeamsItem

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

PullsCreateResponseUser

PullsCreateResponseUser: object

Type declaration

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

PullsCreateReviewCommentReplyParams

PullsCreateReviewCommentReplyParams: object

Type declaration

  • body: string

    The text of the review comment.

  • comment_id: number
  • owner: string
  • pull_number: number
  • repo: string

PullsCreateReviewCommentReplyResponse

PullsCreateReviewCommentReplyResponse: object

Type declaration

PullsCreateReviewCommentReplyResponseLinks

PullsCreateReviewCommentReplyResponseLinks: object

Type declaration

PullsCreateReviewCommentReplyResponseLinksHtml

PullsCreateReviewCommentReplyResponseLinksHtml: object

Type declaration

  • href: string

PullsCreateReviewCommentReplyResponseLinksPullRequest

PullsCreateReviewCommentReplyResponseLinksPullRequest: object

Type declaration

  • href: string

PullsCreateReviewCommentReplyResponseLinksSelf

PullsCreateReviewCommentReplyResponseLinksSelf: object

Type declaration

  • href: string

PullsCreateReviewCommentReplyResponseUser

PullsCreateReviewCommentReplyResponseUser: object

Type declaration

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

PullsCreateReviewParams

PullsCreateReviewParams: object

Type declaration

  • Optional body?: undefined | string

    Required when using REQUEST_CHANGES or COMMENT for the event parameter. The body text of the pull request review.

  • Optional comments?: PullsCreateReviewParamsComments[]

    Use the following table to specify the location, destination, and contents of the draft review comment.

  • Optional commit_id?: undefined | string

    The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the position. Defaults to the most recent commit in the pull request when you do not specify a value.

  • Optional event?: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"

    The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. By leaving this blank, you set the review action state to PENDING, which means you will need to submit the pull request review when you are ready.

  • owner: string
  • pull_number: number
  • repo: string

PullsCreateReviewParamsComments

PullsCreateReviewParamsComments: object

Type declaration

  • body: string
  • path: string
  • position: number

PullsCreateReviewParamsDeprecatedNumber

PullsCreateReviewParamsDeprecatedNumber: object

Type declaration

  • Optional body?: undefined | string

    Required when using REQUEST_CHANGES or COMMENT for the event parameter. The body text of the pull request review.

  • Optional comments?: PullsCreateReviewParamsComments[]

    Use the following table to specify the location, destination, and contents of the draft review comment.

  • Optional commit_id?: undefined | string

    The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the position. Defaults to the most recent commit in the pull request when you do not specify a value.

  • Optional event?: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"

    The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. By leaving this blank, you set the review action state to PENDING, which means you will need to submit the pull request review when you are ready.

  • number: number
    deprecated

    "number" parameter renamed to "pull_number"

  • owner: string
  • repo: string

PullsCreateReviewRequestParams

PullsCreateReviewRequestParams: object

Type declaration

  • owner: string
  • pull_number: number
  • repo: string
  • Optional reviewers?: string[]

    An array of user logins that will be requested.

  • Optional team_reviewers?: string[]

    An array of team slugs that will be requested.

PullsCreateReviewRequestParamsDeprecatedNumber

PullsCreateReviewRequestParamsDeprecatedNumber: object

Type declaration

  • number: number
    deprecated

    "number" parameter renamed to "pull_number"

  • owner: string
  • repo: string
  • Optional reviewers?: string[]

    An array of user logins that will be requested.

  • Optional team_reviewers?: string[]

    An array of team slugs that will be requested.

PullsCreateReviewRequestResponse

PullsCreateReviewRequestResponse: object

Type declaration

PullsCreateReviewRequestResponseAssignee

PullsCreateReviewRequestResponseAssignee: object

Type declaration

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

PullsCreateReviewRequestResponseAssigneesItem

PullsCreateReviewRequestResponseAssigneesItem: object

Type declaration

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

PullsCreateReviewRequestResponseBase

PullsCreateReviewRequestResponseBase: object

Type declaration

PullsCreateReviewRequestResponseBaseRepo

PullsCreateReviewRequestResponseBaseRepo: 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: PullsCreateReviewRequestResponseBaseRepoOwner
  • permissions: PullsCreateReviewRequestResponseBaseRepoPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

PullsCreateReviewRequestResponseBaseRepoOwner

PullsCreateReviewRequestResponseBaseRepoOwner: object

Type declaration

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

PullsCreateReviewRequestResponseBaseRepoPermissions

PullsCreateReviewRequestResponseBaseRepoPermissions: object

Type declaration

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

PullsCreateReviewRequestResponseBaseUser

PullsCreateReviewRequestResponseBaseUser: object

Type declaration

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

PullsCreateReviewRequestResponseHead

PullsCreateReviewRequestResponseHead: object

Type declaration

PullsCreateReviewRequestResponseHeadRepo

PullsCreateReviewRequestResponseHeadRepo: 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: PullsCreateReviewRequestResponseHeadRepoOwner
  • permissions: PullsCreateReviewRequestResponseHeadRepoPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

PullsCreateReviewRequestResponseHeadRepoOwner

PullsCreateReviewRequestResponseHeadRepoOwner: object

Type declaration

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

PullsCreateReviewRequestResponseHeadRepoPermissions

PullsCreateReviewRequestResponseHeadRepoPermissions: object

Type declaration

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

PullsCreateReviewRequestResponseHeadUser

PullsCreateReviewRequestResponseHeadUser: object

Type declaration

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

PullsCreateReviewRequestResponseLabelsItem

PullsCreateReviewRequestResponseLabelsItem: object

Type declaration

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

PullsCreateReviewRequestResponseLinks

PullsCreateReviewRequestResponseLinks: object

Type declaration

PullsCreateReviewRequestResponseLinksComments

PullsCreateReviewRequestResponseLinksComments: object

Type declaration

  • href: string

PullsCreateReviewRequestResponseLinksCommits

PullsCreateReviewRequestResponseLinksCommits: object

Type declaration

  • href: string

PullsCreateReviewRequestResponseLinksHtml

PullsCreateReviewRequestResponseLinksHtml: object

Type declaration

  • href: string

PullsCreateReviewRequestResponseLinksIssue

PullsCreateReviewRequestResponseLinksIssue: object

Type declaration

  • href: string

PullsCreateReviewRequestResponseLinksReviewComment

PullsCreateReviewRequestResponseLinksReviewComment: object

Type declaration

  • href: string

PullsCreateReviewRequestResponseLinksReviewComments

PullsCreateReviewRequestResponseLinksReviewComments: object

Type declaration

  • href: string

PullsCreateReviewRequestResponseLinksSelf

PullsCreateReviewRequestResponseLinksSelf: object

Type declaration

  • href: string

PullsCreateReviewRequestResponseLinksStatuses

PullsCreateReviewRequestResponseLinksStatuses: object

Type declaration

  • href: string

PullsCreateReviewRequestResponseMilestone

PullsCreateReviewRequestResponseMilestone: object

Type declaration

  • closed_at: string
  • closed_issues: number
  • created_at: string
  • creator: PullsCreateReviewRequestResponseMilestoneCreator
  • description: string
  • due_on: string
  • html_url: string
  • id: number
  • labels_url: string
  • node_id: string
  • number: number
  • open_issues: number
  • state: string
  • title: string
  • updated_at: string
  • url: string

PullsCreateReviewRequestResponseMilestoneCreator

PullsCreateReviewRequestResponseMilestoneCreator: object

Type declaration

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

PullsCreateReviewRequestResponseRequestedReviewersItem

PullsCreateReviewRequestResponseRequestedReviewersItem: object

Type declaration

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

PullsCreateReviewRequestResponseRequestedTeamsItem

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

PullsCreateReviewRequestResponseUser

PullsCreateReviewRequestResponseUser: object

Type declaration

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

PullsCreateReviewResponse

PullsCreateReviewResponse: object

Type declaration

PullsCreateReviewResponseLinks

PullsCreateReviewResponseLinks: object

Type declaration

PullsCreateReviewResponseLinksHtml

PullsCreateReviewResponseLinksHtml: object

Type declaration

  • href: string

PullsCreateReviewResponseLinksPullRequest

PullsCreateReviewResponseLinksPullRequest: object

Type declaration

  • href: string

PullsCreateReviewResponseUser

PullsCreateReviewResponseUser: object

Type declaration

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

PullsDeleteCommentParams

PullsDeleteCommentParams: object

Type declaration

  • comment_id: number
  • owner: string
  • repo: string

PullsDeletePendingReviewParams

PullsDeletePendingReviewParams: object

Type declaration

  • owner: string
  • pull_number: number
  • repo: string
  • review_id: number

PullsDeletePendingReviewParamsDeprecatedNumber

PullsDeletePendingReviewParamsDeprecatedNumber: object

Type declaration

  • number: number
    deprecated

    "number" parameter renamed to "pull_number"

  • owner: string
  • repo: string
  • review_id: number

PullsDeletePendingReviewResponse

PullsDeletePendingReviewResponse: object

Type declaration

PullsDeletePendingReviewResponseLinks

PullsDeletePendingReviewResponseLinks: object

Type declaration

PullsDeletePendingReviewResponseLinksHtml

PullsDeletePendingReviewResponseLinksHtml: object

Type declaration

  • href: string

PullsDeletePendingReviewResponseLinksPullRequest

PullsDeletePendingReviewResponseLinksPullRequest: object

Type declaration

  • href: string

PullsDeletePendingReviewResponseUser

PullsDeletePendingReviewResponseUser: object

Type declaration

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

PullsDeleteReviewRequestParams

PullsDeleteReviewRequestParams: object

Type declaration

  • owner: string
  • pull_number: number
  • repo: string
  • Optional reviewers?: string[]

    An array of user logins that will be removed.

  • Optional team_reviewers?: string[]

    An array of team slugs that will be removed.

PullsDeleteReviewRequestParamsDeprecatedNumber

PullsDeleteReviewRequestParamsDeprecatedNumber: object

Type declaration

  • number: number
    deprecated

    "number" parameter renamed to "pull_number"

  • owner: string
  • repo: string
  • Optional reviewers?: string[]

    An array of user logins that will be removed.

  • Optional team_reviewers?: string[]

    An array of team slugs that will be removed.

PullsDismissReviewParams

PullsDismissReviewParams: object

Type declaration

  • message: string

    The message for the pull request review dismissal

  • owner: string
  • pull_number: number
  • repo: string
  • review_id: number

PullsDismissReviewParamsDeprecatedNumber

PullsDismissReviewParamsDeprecatedNumber: object

Type declaration

  • message: string

    The message for the pull request review dismissal

  • number: number
    deprecated

    "number" parameter renamed to "pull_number"

  • owner: string
  • repo: string
  • review_id: number

PullsDismissReviewResponse

PullsDismissReviewResponse: object

Type declaration

PullsDismissReviewResponseLinks

PullsDismissReviewResponseLinks: object

Type declaration

PullsDismissReviewResponseLinksHtml

PullsDismissReviewResponseLinksHtml: object

Type declaration

  • href: string

PullsDismissReviewResponseLinksPullRequest

PullsDismissReviewResponseLinksPullRequest: object

Type declaration

  • href: string

PullsDismissReviewResponseUser

PullsDismissReviewResponseUser: object

Type declaration

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

PullsGetCommentParams

PullsGetCommentParams: object

Type declaration

  • comment_id: number
  • owner: string
  • repo: string

PullsGetCommentResponse

PullsGetCommentResponse: object

Type declaration

  • _links: PullsGetCommentResponseLinks
  • author_association: string
  • body: string
  • commit_id: string
  • created_at: string
  • diff_hunk: string
  • html_url: string
  • id: number
  • in_reply_to_id: number
  • line: number
  • node_id: string
  • original_commit_id: string
  • original_line: number
  • original_position: number
  • original_start_line: number
  • path: string
  • position: number
  • pull_request_review_id: number
  • pull_request_url: string
  • side: string
  • start_line: number
  • start_side: string
  • updated_at: string
  • url: string
  • user: PullsGetCommentResponseUser

PullsGetCommentResponseLinks

PullsGetCommentResponseLinks: object

Type declaration

PullsGetCommentResponseLinksHtml

PullsGetCommentResponseLinksHtml: object

Type declaration

  • href: string

PullsGetCommentResponseLinksPullRequest

PullsGetCommentResponseLinksPullRequest: object

Type declaration

  • href: string

PullsGetCommentResponseLinksSelf

PullsGetCommentResponseLinksSelf: object

Type declaration

  • href: string

PullsGetCommentResponseUser

PullsGetCommentResponseUser: object

Type declaration

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

PullsGetCommentsForReviewParams

PullsGetCommentsForReviewParams: object

Type declaration

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • pull_number: number
  • repo: string
  • review_id: number

PullsGetCommentsForReviewParamsDeprecatedNumber

PullsGetCommentsForReviewParamsDeprecatedNumber: object

Type declaration

  • number: number
    deprecated

    "number" parameter renamed to "pull_number"

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string
  • review_id: number

PullsGetCommentsForReviewResponse

PullsGetCommentsForReviewResponse: Array<PullsGetCommentsForReviewResponseItem>

PullsGetCommentsForReviewResponseItem

PullsGetCommentsForReviewResponseItem: object

Type declaration

  • _links: PullsGetCommentsForReviewResponseItemLinks
  • author_association: string
  • body: string
  • commit_id: string
  • created_at: string
  • diff_hunk: string
  • html_url: string
  • id: number
  • in_reply_to_id: number
  • node_id: string
  • original_commit_id: string
  • original_position: number
  • path: string
  • position: number
  • pull_request_review_id: number
  • pull_request_url: string
  • updated_at: string
  • url: string
  • user: PullsGetCommentsForReviewResponseItemUser

PullsGetCommentsForReviewResponseItemLinks

PullsGetCommentsForReviewResponseItemLinks: object

Type declaration

PullsGetCommentsForReviewResponseItemLinksHtml

PullsGetCommentsForReviewResponseItemLinksHtml: object

Type declaration

  • href: string

PullsGetCommentsForReviewResponseItemLinksPullRequest

PullsGetCommentsForReviewResponseItemLinksPullRequest: object

Type declaration

  • href: string

PullsGetCommentsForReviewResponseItemLinksSelf

PullsGetCommentsForReviewResponseItemLinksSelf: object

Type declaration

  • href: string

PullsGetCommentsForReviewResponseItemUser

PullsGetCommentsForReviewResponseItemUser: object

Type declaration

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

PullsGetParams

PullsGetParams: object

Type declaration

  • owner: string
  • pull_number: number
  • repo: string

PullsGetParamsDeprecatedNumber

PullsGetParamsDeprecatedNumber: object

Type declaration

  • number: number
    deprecated

    "number" parameter renamed to "pull_number"

  • owner: string
  • repo: string

PullsGetResponse

PullsGetResponse: object

Type declaration

PullsGetResponseAssignee

PullsGetResponseAssignee: object

Type declaration

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

PullsGetResponseAssigneesItem

PullsGetResponseAssigneesItem: object

Type declaration

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

PullsGetResponseBase

PullsGetResponseBase: object

Type declaration

PullsGetResponseBaseRepo

PullsGetResponseBaseRepo: 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: PullsGetResponseBaseRepoOwner
  • permissions: PullsGetResponseBaseRepoPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

PullsGetResponseBaseRepoOwner

PullsGetResponseBaseRepoOwner: object

Type declaration

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

PullsGetResponseBaseRepoPermissions

PullsGetResponseBaseRepoPermissions: object

Type declaration

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

PullsGetResponseBaseUser

PullsGetResponseBaseUser: object

Type declaration

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

PullsGetResponseHead

PullsGetResponseHead: object

Type declaration

PullsGetResponseHeadRepo

PullsGetResponseHeadRepo: 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: PullsGetResponseHeadRepoOwner
  • permissions: PullsGetResponseHeadRepoPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

PullsGetResponseHeadRepoOwner

PullsGetResponseHeadRepoOwner: object

Type declaration

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

PullsGetResponseHeadRepoPermissions

PullsGetResponseHeadRepoPermissions: object

Type declaration

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

PullsGetResponseHeadUser

PullsGetResponseHeadUser: object

Type declaration

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

PullsGetResponseLabelsItem

PullsGetResponseLabelsItem: object

Type declaration

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

PullsGetResponseLinks

PullsGetResponseLinks: object

Type declaration

PullsGetResponseLinksComments

PullsGetResponseLinksComments: object

Type declaration

  • href: string

PullsGetResponseLinksCommits

PullsGetResponseLinksCommits: object

Type declaration

  • href: string

PullsGetResponseLinksHtml

PullsGetResponseLinksHtml: object

Type declaration

  • href: string

PullsGetResponseLinksIssue

PullsGetResponseLinksIssue: object

Type declaration

  • href: string

PullsGetResponseLinksReviewComment

PullsGetResponseLinksReviewComment: object

Type declaration

  • href: string

PullsGetResponseLinksReviewComments

PullsGetResponseLinksReviewComments: object

Type declaration

  • href: string

PullsGetResponseLinksSelf

PullsGetResponseLinksSelf: object

Type declaration

  • href: string

PullsGetResponseLinksStatuses

PullsGetResponseLinksStatuses: object

Type declaration

  • href: string

PullsGetResponseMergedBy

PullsGetResponseMergedBy: object

Type declaration

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

PullsGetResponseMilestone

PullsGetResponseMilestone: object

Type declaration

  • closed_at: string
  • closed_issues: number
  • created_at: string
  • creator: PullsGetResponseMilestoneCreator
  • description: string
  • due_on: string
  • html_url: string
  • id: number
  • labels_url: string
  • node_id: string
  • number: number
  • open_issues: number
  • state: string
  • title: string
  • updated_at: string
  • url: string

PullsGetResponseMilestoneCreator

PullsGetResponseMilestoneCreator: object

Type declaration

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

PullsGetResponseRequestedReviewersItem

PullsGetResponseRequestedReviewersItem: object

Type declaration

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

PullsGetResponseRequestedTeamsItem

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

PullsGetResponseUser

PullsGetResponseUser: object

Type declaration

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

PullsGetReviewParams

PullsGetReviewParams: object

Type declaration

  • owner: string
  • pull_number: number
  • repo: string
  • review_id: number

PullsGetReviewParamsDeprecatedNumber

PullsGetReviewParamsDeprecatedNumber: object

Type declaration

  • number: number
    deprecated

    "number" parameter renamed to "pull_number"

  • owner: string
  • repo: string
  • review_id: number

PullsGetReviewResponse

PullsGetReviewResponse: object

Type declaration

PullsGetReviewResponseLinks

PullsGetReviewResponseLinks: object

Type declaration

PullsGetReviewResponseLinksHtml

PullsGetReviewResponseLinksHtml: object

Type declaration

  • href: string

PullsGetReviewResponseLinksPullRequest

PullsGetReviewResponseLinksPullRequest: object

Type declaration

  • href: string

PullsGetReviewResponseUser

PullsGetReviewResponseUser: object

Type declaration

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

PullsListCommentsForRepoParams

PullsListCommentsForRepoParams: object

Type declaration

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

    Can be either asc or desc. Ignored without sort parameter.

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

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

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

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

    Can be either created or updated comments.

PullsListCommentsForRepoResponse

PullsListCommentsForRepoResponse: Array<PullsListCommentsForRepoResponseItem>

PullsListCommentsForRepoResponseItem

PullsListCommentsForRepoResponseItem: object

Type declaration

  • _links: PullsListCommentsForRepoResponseItemLinks
  • author_association: string
  • body: string
  • commit_id: string
  • created_at: string
  • diff_hunk: string
  • html_url: string
  • id: number
  • in_reply_to_id: number
  • line: number
  • node_id: string
  • original_commit_id: string
  • original_line: number
  • original_position: number
  • original_start_line: number
  • path: string
  • position: number
  • pull_request_review_id: number
  • pull_request_url: string
  • side: string
  • start_line: number
  • start_side: string
  • updated_at: string
  • url: string
  • user: PullsListCommentsForRepoResponseItemUser

PullsListCommentsForRepoResponseItemLinks

PullsListCommentsForRepoResponseItemLinks: object

Type declaration

PullsListCommentsForRepoResponseItemLinksHtml

PullsListCommentsForRepoResponseItemLinksHtml: object

Type declaration

  • href: string

PullsListCommentsForRepoResponseItemLinksPullRequest

PullsListCommentsForRepoResponseItemLinksPullRequest: object

Type declaration

  • href: string

PullsListCommentsForRepoResponseItemLinksSelf

PullsListCommentsForRepoResponseItemLinksSelf: object

Type declaration

  • href: string

PullsListCommentsForRepoResponseItemUser

PullsListCommentsForRepoResponseItemUser: object

Type declaration

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

PullsListCommentsParams

PullsListCommentsParams: object

Type declaration

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

    Can be either asc or desc. Ignored without sort parameter.

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

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

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

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

    Can be either created or updated comments.

PullsListCommentsParamsDeprecatedNumber

PullsListCommentsParamsDeprecatedNumber: object

Type declaration

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

    Can be either asc or desc. Ignored without sort parameter.

  • number: number
    deprecated

    "number" parameter renamed to "pull_number"

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

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

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

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

    Can be either created or updated comments.

PullsListCommentsResponse

PullsListCommentsResponse: Array<PullsListCommentsResponseItem>

PullsListCommentsResponseItem

PullsListCommentsResponseItem: object

Type declaration

  • _links: PullsListCommentsResponseItemLinks
  • author_association: string
  • body: string
  • commit_id: string
  • created_at: string
  • diff_hunk: string
  • html_url: string
  • id: number
  • in_reply_to_id: number
  • line: number
  • node_id: string
  • original_commit_id: string
  • original_line: number
  • original_position: number
  • original_start_line: number
  • path: string
  • position: number
  • pull_request_review_id: number
  • pull_request_url: string
  • side: string
  • start_line: number
  • start_side: string
  • updated_at: string
  • url: string
  • user: PullsListCommentsResponseItemUser

PullsListCommentsResponseItemLinks

PullsListCommentsResponseItemLinks: object

Type declaration

PullsListCommentsResponseItemLinksHtml

PullsListCommentsResponseItemLinksHtml: object

Type declaration

  • href: string

PullsListCommentsResponseItemLinksPullRequest

PullsListCommentsResponseItemLinksPullRequest: object

Type declaration

  • href: string

PullsListCommentsResponseItemLinksSelf

PullsListCommentsResponseItemLinksSelf: object

Type declaration

  • href: string

PullsListCommentsResponseItemUser

PullsListCommentsResponseItemUser: object

Type declaration

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

PullsListCommitsParams

PullsListCommitsParams: object

Type declaration

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • pull_number: number
  • repo: string

PullsListCommitsParamsDeprecatedNumber

PullsListCommitsParamsDeprecatedNumber: object

Type declaration

  • number: number
    deprecated

    "number" parameter renamed to "pull_number"

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

PullsListCommitsResponse

PullsListCommitsResponse: Array<PullsListCommitsResponseItem>

PullsListCommitsResponseItem

PullsListCommitsResponseItem: object

Type declaration

PullsListCommitsResponseItemAuthor

PullsListCommitsResponseItemAuthor: object

Type declaration

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

PullsListCommitsResponseItemCommit

PullsListCommitsResponseItemCommit: object

Type declaration

PullsListCommitsResponseItemCommitAuthor

PullsListCommitsResponseItemCommitAuthor: object

Type declaration

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

PullsListCommitsResponseItemCommitCommitter

PullsListCommitsResponseItemCommitCommitter: object

Type declaration

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

PullsListCommitsResponseItemCommitTree

PullsListCommitsResponseItemCommitTree: object

Type declaration

  • sha: string
  • url: string

PullsListCommitsResponseItemCommitVerification

PullsListCommitsResponseItemCommitVerification: object

Type declaration

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

PullsListCommitsResponseItemCommitter

PullsListCommitsResponseItemCommitter: object

Type declaration

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

PullsListCommitsResponseItemParentsItem

PullsListCommitsResponseItemParentsItem: object

Type declaration

  • sha: string
  • url: string

PullsListFilesParams

PullsListFilesParams: object

Type declaration

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • pull_number: number
  • repo: string

PullsListFilesParamsDeprecatedNumber

PullsListFilesParamsDeprecatedNumber: object

Type declaration

  • number: number
    deprecated

    "number" parameter renamed to "pull_number"

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

PullsListFilesResponse

PullsListFilesResponse: Array<PullsListFilesResponseItem>

PullsListFilesResponseItem

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

PullsListParams

PullsListParams: object

Type declaration

  • Optional base?: undefined | string

    Filter pulls by base branch name. Example: gh-pages.

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

    The direction of the sort. Can be either asc or desc. Default: desc when sort is created or sort is not specified, otherwise asc.

  • Optional head?: undefined | string

    Filter pulls by head user or head organization and branch name in the format of user:ref-name or organization:ref-name. For example: github:new-script-format or octocat:test-branch.

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string
  • Optional sort?: "created" | "updated" | "popularity" | "long-running"

    What to sort results by. Can be either created, updated, popularity (comment count) or long-running (age, filtering by pulls updated in the last month).

  • Optional state?: "open" | "closed" | "all"

    Either open, closed, or all to filter by state.

PullsListResponse

PullsListResponse: Array<PullsListResponseItem>

PullsListResponseItem

PullsListResponseItem: object

Type declaration

PullsListResponseItemAssignee

PullsListResponseItemAssignee: object

Type declaration

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

PullsListResponseItemAssigneesItem

PullsListResponseItemAssigneesItem: object

Type declaration

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

PullsListResponseItemBase

PullsListResponseItemBase: object

Type declaration

PullsListResponseItemBaseRepo

PullsListResponseItemBaseRepo: 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: PullsListResponseItemBaseRepoOwner
  • permissions: PullsListResponseItemBaseRepoPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

PullsListResponseItemBaseRepoOwner

PullsListResponseItemBaseRepoOwner: object

Type declaration

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

PullsListResponseItemBaseRepoPermissions

PullsListResponseItemBaseRepoPermissions: object

Type declaration

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

PullsListResponseItemBaseUser

PullsListResponseItemBaseUser: object

Type declaration

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

PullsListResponseItemHead

PullsListResponseItemHead: object

Type declaration

PullsListResponseItemHeadRepo

PullsListResponseItemHeadRepo: 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: PullsListResponseItemHeadRepoOwner
  • permissions: PullsListResponseItemHeadRepoPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

PullsListResponseItemHeadRepoOwner

PullsListResponseItemHeadRepoOwner: object

Type declaration

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

PullsListResponseItemHeadRepoPermissions

PullsListResponseItemHeadRepoPermissions: object

Type declaration

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

PullsListResponseItemHeadUser

PullsListResponseItemHeadUser: object

Type declaration

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

PullsListResponseItemLabelsItem

PullsListResponseItemLabelsItem: object

Type declaration

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

PullsListResponseItemLinks

PullsListResponseItemLinks: object

Type declaration

PullsListResponseItemLinksComments

PullsListResponseItemLinksComments: object

Type declaration

  • href: string

PullsListResponseItemLinksCommits

PullsListResponseItemLinksCommits: object

Type declaration

  • href: string

PullsListResponseItemLinksHtml

PullsListResponseItemLinksHtml: object

Type declaration

  • href: string

PullsListResponseItemLinksIssue

PullsListResponseItemLinksIssue: object

Type declaration

  • href: string

PullsListResponseItemLinksReviewComment

PullsListResponseItemLinksReviewComment: object

Type declaration

  • href: string

PullsListResponseItemLinksReviewComments

PullsListResponseItemLinksReviewComments: object

Type declaration

  • href: string

PullsListResponseItemLinksSelf

PullsListResponseItemLinksSelf: object

Type declaration

  • href: string

PullsListResponseItemLinksStatuses

PullsListResponseItemLinksStatuses: object

Type declaration

  • href: string

PullsListResponseItemMilestone

PullsListResponseItemMilestone: object

Type declaration

  • closed_at: string
  • closed_issues: number
  • created_at: string
  • creator: PullsListResponseItemMilestoneCreator
  • description: string
  • due_on: string
  • html_url: string
  • id: number
  • labels_url: string
  • node_id: string
  • number: number
  • open_issues: number
  • state: string
  • title: string
  • updated_at: string
  • url: string

PullsListResponseItemMilestoneCreator

PullsListResponseItemMilestoneCreator: object

Type declaration

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

PullsListResponseItemRequestedReviewersItem

PullsListResponseItemRequestedReviewersItem: object

Type declaration

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

PullsListResponseItemRequestedTeamsItem

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

PullsListResponseItemUser

PullsListResponseItemUser: object

Type declaration

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

PullsListReviewRequestsParams

PullsListReviewRequestsParams: object

Type declaration

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • pull_number: number
  • repo: string

PullsListReviewRequestsParamsDeprecatedNumber

PullsListReviewRequestsParamsDeprecatedNumber: object

Type declaration

  • number: number
    deprecated

    "number" parameter renamed to "pull_number"

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

PullsListReviewRequestsResponse

PullsListReviewRequestsResponse: object

Type declaration

PullsListReviewRequestsResponseTeamsItem

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

PullsListReviewRequestsResponseUsersItem

PullsListReviewRequestsResponseUsersItem: object

Type declaration

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

PullsListReviewsParams

PullsListReviewsParams: object

Type declaration

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • pull_number: number
  • repo: string

PullsListReviewsParamsDeprecatedNumber

PullsListReviewsParamsDeprecatedNumber: object

Type declaration

  • number: number
    deprecated

    "number" parameter renamed to "pull_number"

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

PullsListReviewsResponse

PullsListReviewsResponse: Array<PullsListReviewsResponseItem>

PullsListReviewsResponseItem

PullsListReviewsResponseItem: object

Type declaration

PullsListReviewsResponseItemLinks

PullsListReviewsResponseItemLinks: object

Type declaration

PullsListReviewsResponseItemLinksHtml

PullsListReviewsResponseItemLinksHtml: object

Type declaration

  • href: string

PullsListReviewsResponseItemLinksPullRequest

PullsListReviewsResponseItemLinksPullRequest: object

Type declaration

  • href: string

PullsListReviewsResponseItemUser

PullsListReviewsResponseItemUser: object

Type declaration

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

PullsMergeParams

PullsMergeParams: object

Type declaration

  • Optional commit_message?: undefined | string

    Extra detail to append to automatic commit message.

  • Optional commit_title?: undefined | string

    Title for the automatic commit message.

  • Optional merge_method?: "merge" | "squash" | "rebase"

    Merge method to use. Possible values are merge, squash or rebase. Default is merge.

  • owner: string
  • pull_number: number
  • repo: string
  • Optional sha?: undefined | string

    SHA that pull request head must match to allow merge.

PullsMergeParamsDeprecatedNumber

PullsMergeParamsDeprecatedNumber: object

Type declaration

  • Optional commit_message?: undefined | string

    Extra detail to append to automatic commit message.

  • Optional commit_title?: undefined | string

    Title for the automatic commit message.

  • Optional merge_method?: "merge" | "squash" | "rebase"

    Merge method to use. Possible values are merge, squash or rebase. Default is merge.

  • number: number
    deprecated

    "number" parameter renamed to "pull_number"

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

    SHA that pull request head must match to allow merge.

PullsMergeResponse

PullsMergeResponse: object

Type declaration

  • merged: boolean
  • message: string
  • sha: string

PullsSubmitReviewParams

PullsSubmitReviewParams: object

Type declaration

  • Optional body?: undefined | string

    The body text of the pull request review

  • event: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"

    The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. When you leave this blank, the API returns HTTP 422 (Unrecognizable entity) and sets the review action state to PENDING, which means you will need to re-submit the pull request review using a review action.

  • owner: string
  • pull_number: number
  • repo: string
  • review_id: number

PullsSubmitReviewParamsDeprecatedNumber

PullsSubmitReviewParamsDeprecatedNumber: object

Type declaration

  • Optional body?: undefined | string

    The body text of the pull request review

  • event: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"

    The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. When you leave this blank, the API returns HTTP 422 (Unrecognizable entity) and sets the review action state to PENDING, which means you will need to re-submit the pull request review using a review action.

  • number: number
    deprecated

    "number" parameter renamed to "pull_number"

  • owner: string
  • repo: string
  • review_id: number

PullsSubmitReviewResponse

PullsSubmitReviewResponse: object

Type declaration

PullsSubmitReviewResponseLinks

PullsSubmitReviewResponseLinks: object

Type declaration

PullsSubmitReviewResponseLinksHtml

PullsSubmitReviewResponseLinksHtml: object

Type declaration

  • href: string

PullsSubmitReviewResponseLinksPullRequest

PullsSubmitReviewResponseLinksPullRequest: object

Type declaration

  • href: string

PullsSubmitReviewResponseUser

PullsSubmitReviewResponseUser: object

Type declaration

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

PullsUpdateBranchParams

PullsUpdateBranchParams: object

Type declaration

  • Optional expected_head_sha?: undefined | string

    The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a 422 Unprocessable Entity status. You can use the "List commits on a repository" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.

  • owner: string
  • pull_number: number
  • repo: string

PullsUpdateBranchResponse

PullsUpdateBranchResponse: object

Type declaration

  • message: string
  • url: string

PullsUpdateCommentParams

PullsUpdateCommentParams: object

Type declaration

  • body: string

    The text of the reply to the review comment.

  • comment_id: number
  • owner: string
  • repo: string

PullsUpdateCommentResponse

PullsUpdateCommentResponse: object

Type declaration

  • _links: PullsUpdateCommentResponseLinks
  • author_association: string
  • body: string
  • commit_id: string
  • created_at: string
  • diff_hunk: string
  • html_url: string
  • id: number
  • in_reply_to_id: number
  • line: number
  • node_id: string
  • original_commit_id: string
  • original_line: number
  • original_position: number
  • original_start_line: number
  • path: string
  • position: number
  • pull_request_review_id: number
  • pull_request_url: string
  • side: string
  • start_line: number
  • start_side: string
  • updated_at: string
  • url: string
  • user: PullsUpdateCommentResponseUser

PullsUpdateCommentResponseLinks

PullsUpdateCommentResponseLinks: object

Type declaration

PullsUpdateCommentResponseLinksHtml

PullsUpdateCommentResponseLinksHtml: object

Type declaration

  • href: string

PullsUpdateCommentResponseLinksPullRequest

PullsUpdateCommentResponseLinksPullRequest: object

Type declaration

  • href: string

PullsUpdateCommentResponseLinksSelf

PullsUpdateCommentResponseLinksSelf: object

Type declaration

  • href: string

PullsUpdateCommentResponseUser

PullsUpdateCommentResponseUser: object

Type declaration

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

PullsUpdateParams

PullsUpdateParams: object

Type declaration

  • Optional base?: undefined | string

    The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.

  • Optional body?: undefined | string

    The contents of the pull request.

  • Optional maintainer_can_modify?: undefined | false | true

    Indicates whether maintainers can modify the pull request.

  • owner: string
  • pull_number: number
  • repo: string
  • Optional state?: "open" | "closed"

    State of this Pull Request. Either open or closed.

  • Optional title?: undefined | string

    The title of the pull request.

PullsUpdateParamsDeprecatedNumber

PullsUpdateParamsDeprecatedNumber: object

Type declaration

  • Optional base?: undefined | string

    The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.

  • Optional body?: undefined | string

    The contents of the pull request.

  • Optional maintainer_can_modify?: undefined | false | true

    Indicates whether maintainers can modify the pull request.

  • number: number
    deprecated

    "number" parameter renamed to "pull_number"

  • owner: string
  • repo: string
  • Optional state?: "open" | "closed"

    State of this Pull Request. Either open or closed.

  • Optional title?: undefined | string

    The title of the pull request.

PullsUpdateResponse

PullsUpdateResponse: object

Type declaration

PullsUpdateResponseAssignee

PullsUpdateResponseAssignee: object

Type declaration

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

PullsUpdateResponseAssigneesItem

PullsUpdateResponseAssigneesItem: object

Type declaration

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

PullsUpdateResponseBase

PullsUpdateResponseBase: object

Type declaration

PullsUpdateResponseBaseRepo

PullsUpdateResponseBaseRepo: 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: PullsUpdateResponseBaseRepoOwner
  • permissions: PullsUpdateResponseBaseRepoPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

PullsUpdateResponseBaseRepoOwner

PullsUpdateResponseBaseRepoOwner: object

Type declaration

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

PullsUpdateResponseBaseRepoPermissions

PullsUpdateResponseBaseRepoPermissions: object

Type declaration

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

PullsUpdateResponseBaseUser

PullsUpdateResponseBaseUser: object

Type declaration

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

PullsUpdateResponseHead

PullsUpdateResponseHead: object

Type declaration

PullsUpdateResponseHeadRepo

PullsUpdateResponseHeadRepo: 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: PullsUpdateResponseHeadRepoOwner
  • permissions: PullsUpdateResponseHeadRepoPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

PullsUpdateResponseHeadRepoOwner

PullsUpdateResponseHeadRepoOwner: object

Type declaration

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

PullsUpdateResponseHeadRepoPermissions

PullsUpdateResponseHeadRepoPermissions: object

Type declaration

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

PullsUpdateResponseHeadUser

PullsUpdateResponseHeadUser: object

Type declaration

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

PullsUpdateResponseLabelsItem

PullsUpdateResponseLabelsItem: object

Type declaration

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

PullsUpdateResponseLinks

PullsUpdateResponseLinks: object

Type declaration

PullsUpdateResponseLinksComments

PullsUpdateResponseLinksComments: object

Type declaration

  • href: string

PullsUpdateResponseLinksCommits

PullsUpdateResponseLinksCommits: object

Type declaration

  • href: string

PullsUpdateResponseLinksHtml

PullsUpdateResponseLinksHtml: object

Type declaration

  • href: string

PullsUpdateResponseLinksIssue

PullsUpdateResponseLinksIssue: object

Type declaration

  • href: string

PullsUpdateResponseLinksReviewComment

PullsUpdateResponseLinksReviewComment: object

Type declaration

  • href: string

PullsUpdateResponseLinksReviewComments

PullsUpdateResponseLinksReviewComments: object

Type declaration

  • href: string

PullsUpdateResponseLinksSelf

PullsUpdateResponseLinksSelf: object

Type declaration

  • href: string

PullsUpdateResponseLinksStatuses

PullsUpdateResponseLinksStatuses: object

Type declaration

  • href: string

PullsUpdateResponseMergedBy

PullsUpdateResponseMergedBy: object

Type declaration

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

PullsUpdateResponseMilestone

PullsUpdateResponseMilestone: object

Type declaration

  • closed_at: string
  • closed_issues: number
  • created_at: string
  • creator: PullsUpdateResponseMilestoneCreator
  • description: string
  • due_on: string
  • html_url: string
  • id: number
  • labels_url: string
  • node_id: string
  • number: number
  • open_issues: number
  • state: string
  • title: string
  • updated_at: string
  • url: string

PullsUpdateResponseMilestoneCreator

PullsUpdateResponseMilestoneCreator: object

Type declaration

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

PullsUpdateResponseRequestedReviewersItem

PullsUpdateResponseRequestedReviewersItem: object

Type declaration

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

PullsUpdateResponseRequestedTeamsItem

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

PullsUpdateResponseUser

PullsUpdateResponseUser: object

Type declaration

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

PullsUpdateReviewParams

PullsUpdateReviewParams: object

Type declaration

  • body: string

    The body text of the pull request review.

  • owner: string
  • pull_number: number
  • repo: string
  • review_id: number

PullsUpdateReviewParamsDeprecatedNumber

PullsUpdateReviewParamsDeprecatedNumber: object

Type declaration

  • body: string

    The body text of the pull request review.

  • number: number
    deprecated

    "number" parameter renamed to "pull_number"

  • owner: string
  • repo: string
  • review_id: number

PullsUpdateReviewResponse

PullsUpdateReviewResponse: object

Type declaration

PullsUpdateReviewResponseLinks

PullsUpdateReviewResponseLinks: object

Type declaration

PullsUpdateReviewResponseLinksHtml

PullsUpdateReviewResponseLinksHtml: object

Type declaration

  • href: string

PullsUpdateReviewResponseLinksPullRequest

PullsUpdateReviewResponseLinksPullRequest: object

Type declaration

  • href: string

PullsUpdateReviewResponseUser

PullsUpdateReviewResponseUser: object

Type declaration

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

RateLimitGetResponse

RateLimitGetResponse: object

Type declaration

RateLimitGetResponseRate

RateLimitGetResponseRate: object

Type declaration

  • limit: number
  • remaining: number
  • reset: number

RateLimitGetResponseResources

RateLimitGetResponseResources: object

Type declaration

RateLimitGetResponseResourcesCore

RateLimitGetResponseResourcesCore: object

Type declaration

  • limit: number
  • remaining: number
  • reset: number

RateLimitGetResponseResourcesGraphql

RateLimitGetResponseResourcesGraphql: object

Type declaration

  • limit: number
  • remaining: number
  • reset: number

RateLimitGetResponseResourcesIntegrationManifest

RateLimitGetResponseResourcesIntegrationManifest: object

Type declaration

  • limit: number
  • remaining: number
  • reset: number

RateLimitGetResponseResourcesSearch

RateLimitGetResponseResourcesSearch: object

Type declaration

  • limit: number
  • remaining: number
  • reset: number

ReactionsCreateForCommitCommentParams

ReactionsCreateForCommitCommentParams: object

Type declaration

  • comment_id: number
  • content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    The reaction type to add to the commit comment.

  • owner: string
  • repo: string

ReactionsCreateForCommitCommentResponse

ReactionsCreateForCommitCommentResponse: object

Type declaration

ReactionsCreateForCommitCommentResponseUser

ReactionsCreateForCommitCommentResponseUser: object

Type declaration

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

ReactionsCreateForIssueCommentParams

ReactionsCreateForIssueCommentParams: object

Type declaration

  • comment_id: number
  • content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    The reaction type to add to the issue comment.

  • owner: string
  • repo: string

ReactionsCreateForIssueCommentResponse

ReactionsCreateForIssueCommentResponse: object

Type declaration

ReactionsCreateForIssueCommentResponseUser

ReactionsCreateForIssueCommentResponseUser: object

Type declaration

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

ReactionsCreateForIssueParams

ReactionsCreateForIssueParams: object

Type declaration

  • content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    The reaction type to add to the issue.

  • issue_number: number
  • owner: string
  • repo: string

ReactionsCreateForIssueParamsDeprecatedNumber

ReactionsCreateForIssueParamsDeprecatedNumber: object

Type declaration

  • content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    The reaction type to add to the issue.

  • number: number
    deprecated

    "number" parameter renamed to "issue_number"

  • owner: string
  • repo: string

ReactionsCreateForIssueResponse

ReactionsCreateForIssueResponse: object

Type declaration

ReactionsCreateForIssueResponseUser

ReactionsCreateForIssueResponseUser: object

Type declaration

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

ReactionsCreateForPullRequestReviewCommentParams

ReactionsCreateForPullRequestReviewCommentParams: object

Type declaration

  • comment_id: number
  • content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    The reaction type to add to the pull request review comment.

  • owner: string
  • repo: string

ReactionsCreateForPullRequestReviewCommentResponse

ReactionsCreateForPullRequestReviewCommentResponse: object

Type declaration

ReactionsCreateForPullRequestReviewCommentResponseUser

ReactionsCreateForPullRequestReviewCommentResponseUser: object

Type declaration

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

ReactionsCreateForTeamDiscussionCommentParams

ReactionsCreateForTeamDiscussionCommentParams: object

Type declaration

  • comment_number: number
  • content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    The reaction type to add to the team discussion comment.

  • discussion_number: number
  • team_id: number

ReactionsCreateForTeamDiscussionCommentResponse

ReactionsCreateForTeamDiscussionCommentResponse: object

Type declaration

ReactionsCreateForTeamDiscussionCommentResponseUser

ReactionsCreateForTeamDiscussionCommentResponseUser: object

Type declaration

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

ReactionsCreateForTeamDiscussionParams

ReactionsCreateForTeamDiscussionParams: object

Type declaration

  • content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    The reaction type to add to the team discussion.

  • discussion_number: number
  • team_id: number

ReactionsCreateForTeamDiscussionResponse

ReactionsCreateForTeamDiscussionResponse: object

Type declaration

ReactionsCreateForTeamDiscussionResponseUser

ReactionsCreateForTeamDiscussionResponseUser: object

Type declaration

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

ReactionsDeleteParams

ReactionsDeleteParams: object

Type declaration

  • reaction_id: number

ReactionsListForCommitCommentParams

ReactionsListForCommitCommentParams: object

Type declaration

  • comment_id: number
  • Optional content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    Returns a single reaction type. Omit this parameter to list all reactions to a commit comment.

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ReactionsListForCommitCommentResponse

ReactionsListForCommitCommentResponse: Array<ReactionsListForCommitCommentResponseItem>

ReactionsListForCommitCommentResponseItem

ReactionsListForCommitCommentResponseItem: object

Type declaration

ReactionsListForCommitCommentResponseItemUser

ReactionsListForCommitCommentResponseItemUser: object

Type declaration

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

ReactionsListForIssueCommentParams

ReactionsListForIssueCommentParams: object

Type declaration

  • comment_id: number
  • Optional content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    Returns a single reaction type. Omit this parameter to list all reactions to an issue comment.

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ReactionsListForIssueCommentResponse

ReactionsListForIssueCommentResponse: Array<ReactionsListForIssueCommentResponseItem>

ReactionsListForIssueCommentResponseItem

ReactionsListForIssueCommentResponseItem: object

Type declaration

ReactionsListForIssueCommentResponseItemUser

ReactionsListForIssueCommentResponseItemUser: object

Type declaration

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

ReactionsListForIssueParams

ReactionsListForIssueParams: object

Type declaration

  • Optional content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    Returns a single reaction type. Omit this parameter to list all reactions to an issue.

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ReactionsListForIssueParamsDeprecatedNumber

ReactionsListForIssueParamsDeprecatedNumber: object

Type declaration

  • Optional content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    Returns a single reaction type. Omit this parameter to list all reactions to an issue.

  • number: number
    deprecated

    "number" parameter renamed to "issue_number"

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ReactionsListForIssueResponse

ReactionsListForIssueResponse: Array<ReactionsListForIssueResponseItem>

ReactionsListForIssueResponseItem

ReactionsListForIssueResponseItem: object

Type declaration

ReactionsListForIssueResponseItemUser

ReactionsListForIssueResponseItemUser: object

Type declaration

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

ReactionsListForPullRequestReviewCommentParams

ReactionsListForPullRequestReviewCommentParams: object

Type declaration

  • comment_id: number
  • Optional content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    Returns a single reaction type. Omit this parameter to list all reactions to a pull request review comment.

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ReactionsListForPullRequestReviewCommentResponse

ReactionsListForPullRequestReviewCommentResponse: Array<ReactionsListForPullRequestReviewCommentResponseItem>

ReactionsListForPullRequestReviewCommentResponseItem

ReactionsListForPullRequestReviewCommentResponseItem: object

Type declaration

ReactionsListForPullRequestReviewCommentResponseItemUser

ReactionsListForPullRequestReviewCommentResponseItemUser: object

Type declaration

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

ReactionsListForTeamDiscussionCommentParams

ReactionsListForTeamDiscussionCommentParams: object

Type declaration

  • comment_number: number
  • Optional content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • team_id: number

ReactionsListForTeamDiscussionCommentResponse

ReactionsListForTeamDiscussionCommentResponse: Array<ReactionsListForTeamDiscussionCommentResponseItem>

ReactionsListForTeamDiscussionCommentResponseItem

ReactionsListForTeamDiscussionCommentResponseItem: object

Type declaration

ReactionsListForTeamDiscussionCommentResponseItemUser

ReactionsListForTeamDiscussionCommentResponseItemUser: object

Type declaration

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

ReactionsListForTeamDiscussionParams

ReactionsListForTeamDiscussionParams: object

Type declaration

  • Optional content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • team_id: number

ReactionsListForTeamDiscussionResponse

ReactionsListForTeamDiscussionResponse: Array<ReactionsListForTeamDiscussionResponseItem>

ReactionsListForTeamDiscussionResponseItem

ReactionsListForTeamDiscussionResponseItem: object

Type declaration

ReactionsListForTeamDiscussionResponseItemUser

ReactionsListForTeamDiscussionResponseItemUser: object

Type declaration

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

ReposAcceptInvitationParams

ReposAcceptInvitationParams: object

Type declaration

  • invitation_id: number

ReposAddCollaboratorParams

ReposAddCollaboratorParams: object

Type declaration

  • owner: string
  • Optional permission?: "pull" | "push" | "admin"

    The permission to grant the collaborator. Only valid on organization-owned repositories. Can be one of: * pull - can pull, but not push to or administer this repository. * push - can pull and push, but not administer this repository. * admin - can pull, push and administer this repository.

  • repo: string
  • username: string

ReposAddCollaboratorResponse

ReposAddCollaboratorResponse: object

Type declaration

ReposAddCollaboratorResponseInvitee

ReposAddCollaboratorResponseInvitee: object

Type declaration

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

ReposAddCollaboratorResponseInviter

ReposAddCollaboratorResponseInviter: object

Type declaration

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

ReposAddCollaboratorResponseRepository

ReposAddCollaboratorResponseRepository: 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: ReposAddCollaboratorResponseRepositoryOwner
  • private: boolean
  • pulls_url: string
  • releases_url: string
  • ssh_url: string
  • stargazers_url: string
  • statuses_url: string
  • subscribers_url: string
  • subscription_url: string
  • tags_url: string
  • teams_url: string
  • trees_url: string
  • url: string

ReposAddCollaboratorResponseRepositoryOwner

ReposAddCollaboratorResponseRepositoryOwner: object

Type declaration

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

ReposAddDeployKeyParams

ReposAddDeployKeyParams: object

Type declaration

  • key: string

    The contents of the key.

  • owner: string
  • Optional read_only?: undefined | false | true

    If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.

    Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "Repository permission levels for an organization" and "Permission levels for a user account repository."

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

    A name for the key.

ReposAddDeployKeyResponse

ReposAddDeployKeyResponse: object

Type declaration

  • created_at: string
  • id: number
  • key: string
  • read_only: boolean
  • title: string
  • url: string
  • verified: boolean

ReposAddProtectedBranchAdminEnforcementParams

ReposAddProtectedBranchAdminEnforcementParams: object

Type declaration

  • branch: string
  • owner: string
  • repo: string

ReposAddProtectedBranchAdminEnforcementResponse

ReposAddProtectedBranchAdminEnforcementResponse: object

Type declaration

  • enabled: boolean
  • url: string

ReposAddProtectedBranchAppRestrictionsParams

ReposAddProtectedBranchAppRestrictionsParams: object

Type declaration

  • apps: string[]
  • branch: string
  • owner: string
  • repo: string

ReposAddProtectedBranchAppRestrictionsResponse

ReposAddProtectedBranchAppRestrictionsResponse: Array<ReposAddProtectedBranchAppRestrictionsResponseItem>

ReposAddProtectedBranchAppRestrictionsResponseItem

ReposAddProtectedBranchAppRestrictionsResponseItem: object

Type declaration

ReposAddProtectedBranchAppRestrictionsResponseItemOwner

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

ReposAddProtectedBranchAppRestrictionsResponseItemPermissions

ReposAddProtectedBranchAppRestrictionsResponseItemPermissions: object

Type declaration

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

ReposAddProtectedBranchRequiredSignaturesParams

ReposAddProtectedBranchRequiredSignaturesParams: object

Type declaration

  • branch: string
  • owner: string
  • repo: string

ReposAddProtectedBranchRequiredSignaturesResponse

ReposAddProtectedBranchRequiredSignaturesResponse: object

Type declaration

  • enabled: boolean
  • url: string

ReposAddProtectedBranchRequiredStatusChecksContextsParams

ReposAddProtectedBranchRequiredStatusChecksContextsParams: object

Type declaration

  • branch: string
  • contexts: string[]
  • owner: string
  • repo: string

ReposAddProtectedBranchRequiredStatusChecksContextsResponse

ReposAddProtectedBranchRequiredStatusChecksContextsResponse: Array<string>

ReposAddProtectedBranchTeamRestrictionsParams

ReposAddProtectedBranchTeamRestrictionsParams: object

Type declaration

  • branch: string
  • owner: string
  • repo: string
  • teams: string[]

ReposAddProtectedBranchTeamRestrictionsResponse

ReposAddProtectedBranchTeamRestrictionsResponse: Array<ReposAddProtectedBranchTeamRestrictionsResponseItem>

ReposAddProtectedBranchTeamRestrictionsResponseItem

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

ReposAddProtectedBranchUserRestrictionsParams

ReposAddProtectedBranchUserRestrictionsParams: object

Type declaration

  • branch: string
  • owner: string
  • repo: string
  • users: string[]

ReposAddProtectedBranchUserRestrictionsResponse

ReposAddProtectedBranchUserRestrictionsResponse: Array<ReposAddProtectedBranchUserRestrictionsResponseItem>

ReposAddProtectedBranchUserRestrictionsResponseItem

ReposAddProtectedBranchUserRestrictionsResponseItem: object

Type declaration

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

ReposCheckCollaboratorParams

ReposCheckCollaboratorParams: object

Type declaration

  • owner: string
  • repo: string
  • username: string

ReposCheckVulnerabilityAlertsParams

ReposCheckVulnerabilityAlertsParams: object

Type declaration

  • owner: string
  • repo: string

ReposCompareCommitsParams

ReposCompareCommitsParams: object

Type declaration

  • base: string
  • head: string
  • owner: string
  • repo: string

ReposCompareCommitsResponse

ReposCompareCommitsResponse: object

Type declaration

ReposCompareCommitsResponseBaseCommit

ReposCompareCommitsResponseBaseCommit: object

Type declaration

ReposCompareCommitsResponseBaseCommitAuthor

ReposCompareCommitsResponseBaseCommitAuthor: object

Type declaration

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

ReposCompareCommitsResponseBaseCommitCommit

ReposCompareCommitsResponseBaseCommitCommit: object

Type declaration

ReposCompareCommitsResponseBaseCommitCommitAuthor

ReposCompareCommitsResponseBaseCommitCommitAuthor: object

Type declaration

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

ReposCompareCommitsResponseBaseCommitCommitCommitter

ReposCompareCommitsResponseBaseCommitCommitCommitter: object

Type declaration

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

ReposCompareCommitsResponseBaseCommitCommitTree

ReposCompareCommitsResponseBaseCommitCommitTree: object

Type declaration

  • sha: string
  • url: string

ReposCompareCommitsResponseBaseCommitCommitVerification

ReposCompareCommitsResponseBaseCommitCommitVerification: object

Type declaration

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

ReposCompareCommitsResponseBaseCommitCommitter

ReposCompareCommitsResponseBaseCommitCommitter: object

Type declaration

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

ReposCompareCommitsResponseBaseCommitParentsItem

ReposCompareCommitsResponseBaseCommitParentsItem: object

Type declaration

  • sha: string
  • url: string

ReposCompareCommitsResponseCommitsItem

ReposCompareCommitsResponseCommitsItem: object

Type declaration

ReposCompareCommitsResponseCommitsItemAuthor

ReposCompareCommitsResponseCommitsItemAuthor: object

Type declaration

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

ReposCompareCommitsResponseCommitsItemCommit

ReposCompareCommitsResponseCommitsItemCommit: object

Type declaration

ReposCompareCommitsResponseCommitsItemCommitAuthor

ReposCompareCommitsResponseCommitsItemCommitAuthor: object

Type declaration

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

ReposCompareCommitsResponseCommitsItemCommitCommitter

ReposCompareCommitsResponseCommitsItemCommitCommitter: object

Type declaration

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

ReposCompareCommitsResponseCommitsItemCommitTree

ReposCompareCommitsResponseCommitsItemCommitTree: object

Type declaration

  • sha: string
  • url: string

ReposCompareCommitsResponseCommitsItemCommitVerification

ReposCompareCommitsResponseCommitsItemCommitVerification: object

Type declaration

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

ReposCompareCommitsResponseCommitsItemCommitter

ReposCompareCommitsResponseCommitsItemCommitter: object

Type declaration

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

ReposCompareCommitsResponseCommitsItemParentsItem

ReposCompareCommitsResponseCommitsItemParentsItem: object

Type declaration

  • sha: string
  • url: string

ReposCompareCommitsResponseFilesItem

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

ReposCompareCommitsResponseMergeBaseCommit

ReposCompareCommitsResponseMergeBaseCommit: object

Type declaration

ReposCompareCommitsResponseMergeBaseCommitAuthor

ReposCompareCommitsResponseMergeBaseCommitAuthor: object

Type declaration

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

ReposCompareCommitsResponseMergeBaseCommitCommit

ReposCompareCommitsResponseMergeBaseCommitCommit: object

Type declaration

ReposCompareCommitsResponseMergeBaseCommitCommitAuthor

ReposCompareCommitsResponseMergeBaseCommitCommitAuthor: object

Type declaration

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

ReposCompareCommitsResponseMergeBaseCommitCommitCommitter

ReposCompareCommitsResponseMergeBaseCommitCommitCommitter: object

Type declaration

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

ReposCompareCommitsResponseMergeBaseCommitCommitTree

ReposCompareCommitsResponseMergeBaseCommitCommitTree: object

Type declaration

  • sha: string
  • url: string

ReposCompareCommitsResponseMergeBaseCommitCommitVerification

ReposCompareCommitsResponseMergeBaseCommitCommitVerification: object

Type declaration

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

ReposCompareCommitsResponseMergeBaseCommitCommitter

ReposCompareCommitsResponseMergeBaseCommitCommitter: object

Type declaration

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

ReposCompareCommitsResponseMergeBaseCommitParentsItem

ReposCompareCommitsResponseMergeBaseCommitParentsItem: object

Type declaration

  • sha: string
  • url: string

ReposCreateCommitCommentParams

ReposCreateCommitCommentParams: object

Type declaration

  • body: string

    The contents of the comment.

  • commit_sha: string
  • owner: string
  • Optional path?: undefined | string

    Relative path of the file to comment on.

  • Optional position?: undefined | number

    Line index in the diff to comment on.

  • repo: string

ReposCreateCommitCommentParamsDeprecatedLine

ReposCreateCommitCommentParamsDeprecatedLine: object

Type declaration

  • body: string

    The contents of the comment.

  • commit_sha: string
  • Optional line?: undefined | number

    Deprecated. Use position parameter instead. Line number in the file to comment on.

    deprecated

    "line" parameter has been deprecated and will be removed in future

  • owner: string
  • Optional path?: undefined | string

    Relative path of the file to comment on.

  • Optional position?: undefined | number

    Line index in the diff to comment on.

  • repo: string

ReposCreateCommitCommentParamsDeprecatedSha

ReposCreateCommitCommentParamsDeprecatedSha: object

Type declaration

  • body: string

    The contents of the comment.

  • owner: string
  • Optional path?: undefined | string

    Relative path of the file to comment on.

  • Optional position?: undefined | number

    Line index in the diff to comment on.

  • repo: string
  • sha: string
    deprecated

    "sha" parameter renamed to "commit_sha"

ReposCreateCommitCommentResponse

ReposCreateCommitCommentResponse: 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: ReposCreateCommitCommentResponseUser

ReposCreateCommitCommentResponseUser

ReposCreateCommitCommentResponseUser: object

Type declaration

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

ReposCreateDeploymentParams

ReposCreateDeploymentParams: object

Type declaration

  • Optional auto_merge?: undefined | false | true

    Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.

  • Optional description?: undefined | string

    Short description of the deployment.

  • Optional environment?: undefined | string

    Name for the target deployment environment (e.g., production, staging, qa).

  • owner: string
  • Optional payload?: undefined | string

    JSON payload with extra information about the deployment.

  • Optional production_environment?: undefined | false | true

    Specifies if the given environment is one that end-users directly interact with. Default: true when environment is production and false otherwise. Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

  • ref: string

    The ref to deploy. This can be a branch, tag, or SHA.

  • repo: string
  • Optional required_contexts?: string[]

    The status contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.

  • Optional task?: undefined | string

    Specifies a task to execute (e.g., deploy or deploy:migrations).

  • Optional transient_environment?: undefined | false | true

    Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: false Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type. Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

ReposCreateDeploymentResponse

ReposCreateDeploymentResponse: object

Type declaration

  • created_at: string
  • creator: ReposCreateDeploymentResponseCreator
  • description: string
  • environment: string
  • id: number
  • node_id: string
  • original_environment: string
  • payload: ReposCreateDeploymentResponsePayload
  • production_environment: boolean
  • ref: string
  • repository_url: string
  • sha: string
  • statuses_url: string
  • task: string
  • transient_environment: boolean
  • updated_at: string
  • url: string

ReposCreateDeploymentResponseCreator

ReposCreateDeploymentResponseCreator: object

Type declaration

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

ReposCreateDeploymentResponsePayload

ReposCreateDeploymentResponsePayload: object

Type declaration

  • deploy: string

ReposCreateDeploymentStatusParams

ReposCreateDeploymentStatusParams: object

Type declaration

  • Optional auto_inactive?: undefined | false | true

    Adds a new inactive status to all prior non-transient, non-production environment deployments with the same repository and environment name as the created status's deployment. An inactive status is only added to deployments that had a success state. Default: true Note: To add an inactive status to production environments, you must use the application/vnd.github.flash-preview+json custom media type. Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

  • deployment_id: number
  • Optional description?: undefined | string

    A short description of the status. The maximum description length is 140 characters.

  • Optional environment?: "production" | "staging" | "qa"

    Name for the target deployment environment, which can be changed when setting a deploy status. For example, production, staging, or qa. Note: This parameter requires you to use the application/vnd.github.flash-preview+json custom media type.

  • Optional environment_url?: undefined | string

    Sets the URL for accessing your environment. Default: "" Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type. Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

  • Optional log_url?: undefined | string

    The full URL of the deployment's output. This parameter replaces target_url. We will continue to accept target_url to support legacy uses, but we recommend replacing target_url with log_url. Setting log_url will automatically set target_url to the same value. Default: "" Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type. Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

  • owner: string
  • repo: string
  • state: "error" | "failure" | "inactive" | "in_progress" | "queued" | "pending" | "success"

    The state of the status. Can be one of error, failure, inactive, in_progress, queued pending, or success. Note: To use the inactive state, you must provide the application/vnd.github.ant-man-preview+json custom media type. To use the in_progress and queued states, you must provide the application/vnd.github.flash-preview+json custom media type.

  • Optional target_url?: undefined | string

    The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. Note: It's recommended to use the log_url parameter, which replaces target_url.

ReposCreateDeploymentStatusResponse

ReposCreateDeploymentStatusResponse: object

Type declaration

  • created_at: string
  • creator: ReposCreateDeploymentStatusResponseCreator
  • deployment_url: string
  • description: string
  • environment: string
  • environment_url: string
  • id: number
  • log_url: string
  • node_id: string
  • repository_url: string
  • state: string
  • target_url: string
  • updated_at: string
  • url: string

ReposCreateDeploymentStatusResponseCreator

ReposCreateDeploymentStatusResponseCreator: object

Type declaration

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

ReposCreateDispatchEventParams

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

    Required: A custom webhook event name.

  • owner: string
  • repo: string

ReposCreateDispatchEventParamsClientPayload

ReposCreateDispatchEventParamsClientPayload: object

Type declaration

ReposCreateFileParams

ReposCreateFileParams: object

Type declaration

  • Optional author?: ReposCreateFileParamsAuthor

    The author of the file. Default: The committer or the authenticated user if you omit committer.

  • Optional branch?: undefined | string

    The branch name. Default: the repository’s default branch (usually master)

  • Optional committer?: ReposCreateFileParamsCommitter

    The person that committed the file. Default: the authenticated user.

  • content: string

    The new file content, using Base64 encoding.

  • message: string

    The commit message.

  • owner: string
  • path: string
  • repo: string
  • Optional sha?: undefined | string

    Required if you are updating a file. The blob SHA of the file being replaced.

ReposCreateFileParamsAuthor

ReposCreateFileParamsAuthor: object

Type declaration

  • email: string
  • name: string

ReposCreateFileParamsCommitter

ReposCreateFileParamsCommitter: object

Type declaration

  • email: string
  • name: string

ReposCreateFileResponse

ReposCreateFileResponse: object

Type declaration

ReposCreateFileResponseCommit

ReposCreateFileResponseCommit: object

Type declaration

ReposCreateFileResponseCommitAuthor

ReposCreateFileResponseCommitAuthor: object

Type declaration

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

ReposCreateFileResponseCommitCommitter

ReposCreateFileResponseCommitCommitter: object

Type declaration

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

ReposCreateFileResponseCommitParentsItem

ReposCreateFileResponseCommitParentsItem: object

Type declaration

  • html_url: string
  • sha: string
  • url: string

ReposCreateFileResponseCommitTree

ReposCreateFileResponseCommitTree: object

Type declaration

  • sha: string
  • url: string

ReposCreateFileResponseCommitVerification

ReposCreateFileResponseCommitVerification: object

Type declaration

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

ReposCreateFileResponseContent

ReposCreateFileResponseContent: object

Type declaration

  • _links: ReposCreateFileResponseContentLinks
  • download_url: string
  • git_url: string
  • html_url: string
  • name: string
  • path: string
  • sha: string
  • size: number
  • type: string
  • url: string

ReposCreateFileResponseContentLinks

ReposCreateFileResponseContentLinks: object

Type declaration

  • git: string
  • html: string
  • self: string

ReposCreateForAuthenticatedUserParams

ReposCreateForAuthenticatedUserParams: object

Type declaration

  • Optional allow_merge_commit?: undefined | false | true

    Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

  • Optional allow_rebase_merge?: undefined | false | true

    Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

  • Optional allow_squash_merge?: undefined | false | true

    Either true to allow squash-merging pull requests, or false to prevent squash-merging.

  • Optional auto_init?: undefined | false | true

    Pass true to create an initial commit with empty README.

  • Optional description?: undefined | string

    A short description of the repository.

  • Optional gitignore_template?: undefined | string

    Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, "Haskell".

  • Optional has_issues?: undefined | false | true

    Either true to enable issues for this repository or false to disable them.

  • Optional has_projects?: undefined | false | true

    Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

  • Optional has_wiki?: undefined | false | true

    Either true to enable the wiki for this repository or false to disable it.

  • Optional homepage?: undefined | string

    A URL with more information about the repository.

  • Optional is_template?: undefined | false | true

    Either true to make this repo available as a template repository or false to prevent it.

  • Optional license_template?: undefined | string

    Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, "mit" or "mpl-2.0".

  • name: string

    The name of the repository.

  • Optional private?: undefined | false | true

    Either true to create a private repository or false to create a public one. Creating private repositories requires a paid GitHub account.

  • Optional team_id?: undefined | number

    The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

ReposCreateForAuthenticatedUserResponse

ReposCreateForAuthenticatedUserResponse: 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: ReposCreateForAuthenticatedUserResponseOwner
  • permissions: ReposCreateForAuthenticatedUserResponsePermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

ReposCreateForAuthenticatedUserResponseOwner

ReposCreateForAuthenticatedUserResponseOwner: object

Type declaration

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

ReposCreateForAuthenticatedUserResponsePermissions

ReposCreateForAuthenticatedUserResponsePermissions: object

Type declaration

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

ReposCreateForkParams

ReposCreateForkParams: object

Type declaration

  • Optional organization?: undefined | string

    Optional parameter to specify the organization name if forking into an organization.

  • owner: string
  • repo: string

ReposCreateForkResponse

ReposCreateForkResponse: 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: ReposCreateForkResponseOwner
  • permissions: ReposCreateForkResponsePermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

ReposCreateForkResponseOwner

ReposCreateForkResponseOwner: object

Type declaration

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

ReposCreateForkResponsePermissions

ReposCreateForkResponsePermissions: object

Type declaration

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

ReposCreateHookParams

ReposCreateHookParams: object

Type declaration

  • Optional active?: undefined | false | true

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

  • config: ReposCreateHookParamsConfig

    Key/value pairs to provide settings for this webhook. These are defined below.

  • Optional events?: string[]

    Determines what events the hook is triggered for.

  • Optional name?: undefined | string

    Use web to create a webhook. Default: web. This parameter only accepts the value web.

  • owner: string
  • repo: string

ReposCreateHookParamsConfig

ReposCreateHookParamsConfig: object

Type declaration

  • Optional content_type?: undefined | string
  • Optional insecure_ssl?: undefined | string
  • Optional secret?: undefined | string
  • url: string

ReposCreateHookResponse

ReposCreateHookResponse: object

Type declaration

ReposCreateHookResponseConfig

ReposCreateHookResponseConfig: object

Type declaration

  • content_type: string
  • insecure_ssl: string
  • url: string

ReposCreateHookResponseLastResponse

ReposCreateHookResponseLastResponse: object

Type declaration

  • code: null
  • message: null
  • status: string

ReposCreateInOrgParams

ReposCreateInOrgParams: object

Type declaration

  • Optional allow_merge_commit?: undefined | false | true

    Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

  • Optional allow_rebase_merge?: undefined | false | true

    Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

  • Optional allow_squash_merge?: undefined | false | true

    Either true to allow squash-merging pull requests, or false to prevent squash-merging.

  • Optional auto_init?: undefined | false | true

    Pass true to create an initial commit with empty README.

  • Optional description?: undefined | string

    A short description of the repository.

  • Optional gitignore_template?: undefined | string

    Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, "Haskell".

  • Optional has_issues?: undefined | false | true

    Either true to enable issues for this repository or false to disable them.

  • Optional has_projects?: undefined | false | true

    Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

  • Optional has_wiki?: undefined | false | true

    Either true to enable the wiki for this repository or false to disable it.

  • Optional homepage?: undefined | string

    A URL with more information about the repository.

  • Optional is_template?: undefined | false | true

    Either true to make this repo available as a template repository or false to prevent it.

  • Optional license_template?: undefined | string

    Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, "mit" or "mpl-2.0".

  • name: string

    The name of the repository.

  • org: string
  • Optional private?: undefined | false | true

    Either true to create a private repository or false to create a public one. Creating private repositories requires a paid GitHub account.

  • Optional team_id?: undefined | number

    The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

ReposCreateInOrgResponse

ReposCreateInOrgResponse: 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: ReposCreateInOrgResponseOwner
  • permissions: ReposCreateInOrgResponsePermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

ReposCreateInOrgResponseOwner

ReposCreateInOrgResponseOwner: object

Type declaration

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

ReposCreateInOrgResponsePermissions

ReposCreateInOrgResponsePermissions: object

Type declaration

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

ReposCreateOrUpdateFileParams

ReposCreateOrUpdateFileParams: object

Type declaration

  • Optional author?: ReposCreateOrUpdateFileParamsAuthor

    The author of the file. Default: The committer or the authenticated user if you omit committer.

  • Optional branch?: undefined | string

    The branch name. Default: the repository’s default branch (usually master)

  • Optional committer?: ReposCreateOrUpdateFileParamsCommitter

    The person that committed the file. Default: the authenticated user.

  • content: string

    The new file content, using Base64 encoding.

  • message: string

    The commit message.

  • owner: string
  • path: string
  • repo: string
  • Optional sha?: undefined | string

    Required if you are updating a file. The blob SHA of the file being replaced.

ReposCreateOrUpdateFileParamsAuthor

ReposCreateOrUpdateFileParamsAuthor: object

Type declaration

  • email: string
  • name: string

ReposCreateOrUpdateFileParamsCommitter

ReposCreateOrUpdateFileParamsCommitter: object

Type declaration

  • email: string
  • name: string

ReposCreateOrUpdateFileResponse

ReposCreateOrUpdateFileResponse: object

Type declaration

ReposCreateOrUpdateFileResponseCommit

ReposCreateOrUpdateFileResponseCommit: object

Type declaration

ReposCreateOrUpdateFileResponseCommitAuthor

ReposCreateOrUpdateFileResponseCommitAuthor: object

Type declaration

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

ReposCreateOrUpdateFileResponseCommitCommitter

ReposCreateOrUpdateFileResponseCommitCommitter: object

Type declaration

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

ReposCreateOrUpdateFileResponseCommitParentsItem

ReposCreateOrUpdateFileResponseCommitParentsItem: object

Type declaration

  • html_url: string
  • sha: string
  • url: string

ReposCreateOrUpdateFileResponseCommitTree

ReposCreateOrUpdateFileResponseCommitTree: object

Type declaration

  • sha: string
  • url: string

ReposCreateOrUpdateFileResponseCommitVerification

ReposCreateOrUpdateFileResponseCommitVerification: object

Type declaration

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

ReposCreateOrUpdateFileResponseContent

ReposCreateOrUpdateFileResponseContent: object

Type declaration

ReposCreateOrUpdateFileResponseContentLinks

ReposCreateOrUpdateFileResponseContentLinks: object

Type declaration

  • git: string
  • html: string
  • self: string

ReposCreateReleaseParams

ReposCreateReleaseParams: object

Type declaration

  • Optional body?: undefined | string

    Text describing the contents of the tag.

  • Optional draft?: undefined | false | true

    true to create a draft (unpublished) release, false to create a published one.

  • Optional name?: undefined | string

    The name of the release.

  • owner: string
  • Optional prerelease?: undefined | false | true

    true to identify the release as a prerelease. false to identify the release as a full release.

  • repo: string
  • tag_name: string

    The name of the tag.

  • Optional target_commitish?: undefined | string

    Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

ReposCreateReleaseResponse

ReposCreateReleaseResponse: object

Type declaration

  • assets: Array<any>
  • assets_url: string
  • author: ReposCreateReleaseResponseAuthor
  • body: string
  • created_at: string
  • draft: boolean
  • html_url: string
  • id: number
  • name: string
  • node_id: string
  • prerelease: boolean
  • published_at: string
  • tag_name: string
  • tarball_url: string
  • target_commitish: string
  • upload_url: string
  • url: string
  • zipball_url: string

ReposCreateReleaseResponseAuthor

ReposCreateReleaseResponseAuthor: object

Type declaration

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

ReposCreateStatusParams

ReposCreateStatusParams: object

Type declaration

  • Optional context?: undefined | string

    A string label to differentiate this status from the status of other systems.

  • Optional description?: undefined | string

    A short description of the status.

  • owner: string
  • repo: string
  • sha: string
  • state: "error" | "failure" | "pending" | "success"

    The state of the status. Can be one of error, failure, pending, or success.

  • Optional target_url?: undefined | string

    The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: http://ci.example.com/user/repo/build/sha

ReposCreateStatusResponse

ReposCreateStatusResponse: object

Type declaration

  • avatar_url: string
  • context: string
  • created_at: string
  • creator: ReposCreateStatusResponseCreator
  • description: string
  • id: number
  • node_id: string
  • state: string
  • target_url: string
  • updated_at: string
  • url: string

ReposCreateStatusResponseCreator

ReposCreateStatusResponseCreator: object

Type declaration

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

ReposCreateUsingTemplateParams

ReposCreateUsingTemplateParams: object

Type declaration

  • Optional description?: undefined | string

    A short description of the new repository.

  • name: string

    The name of the new repository.

  • Optional owner?: undefined | string

    The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.

  • Optional private?: undefined | false | true

    Either true to create a new private repository or false to create a new public one.

  • template_owner: string
  • template_repo: string

ReposCreateUsingTemplateResponse

ReposCreateUsingTemplateResponse: 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: ReposCreateUsingTemplateResponseOwner
  • permissions: ReposCreateUsingTemplateResponsePermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: ReposCreateUsingTemplateResponseTemplateRepository
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

ReposCreateUsingTemplateResponseOwner

ReposCreateUsingTemplateResponseOwner: object

Type declaration

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

ReposCreateUsingTemplateResponsePermissions

ReposCreateUsingTemplateResponsePermissions: object

Type declaration

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

ReposCreateUsingTemplateResponseTemplateRepository

ReposCreateUsingTemplateResponseTemplateRepository: 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: ReposCreateUsingTemplateResponseTemplateRepositoryOwner
  • permissions: ReposCreateUsingTemplateResponseTemplateRepositoryPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

ReposCreateUsingTemplateResponseTemplateRepositoryOwner

ReposCreateUsingTemplateResponseTemplateRepositoryOwner: object

Type declaration

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

ReposCreateUsingTemplateResponseTemplateRepositoryPermissions

ReposCreateUsingTemplateResponseTemplateRepositoryPermissions: object

Type declaration

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

ReposDeclineInvitationParams

ReposDeclineInvitationParams: object

Type declaration

  • invitation_id: number

ReposDeleteCommitCommentParams

ReposDeleteCommitCommentParams: object

Type declaration

  • comment_id: number
  • owner: string
  • repo: string

ReposDeleteDownloadParams

ReposDeleteDownloadParams: object

Type declaration

  • download_id: number
  • owner: string
  • repo: string

ReposDeleteFileParams

ReposDeleteFileParams: object

Type declaration

  • Optional author?: ReposDeleteFileParamsAuthor

    object containing information about the author.

  • Optional branch?: undefined | string

    The branch name. Default: the repository’s default branch (usually master)

  • Optional committer?: ReposDeleteFileParamsCommitter

    object containing information about the committer.

  • message: string

    The commit message.

  • owner: string
  • path: string
  • repo: string
  • sha: string

    The blob SHA of the file being replaced.

ReposDeleteFileParamsAuthor

ReposDeleteFileParamsAuthor: object

Type declaration

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

ReposDeleteFileParamsCommitter

ReposDeleteFileParamsCommitter: object

Type declaration

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

ReposDeleteFileResponse

ReposDeleteFileResponse: object

Type declaration

ReposDeleteFileResponseCommit

ReposDeleteFileResponseCommit: object

Type declaration

ReposDeleteFileResponseCommitAuthor

ReposDeleteFileResponseCommitAuthor: object

Type declaration

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

ReposDeleteFileResponseCommitCommitter

ReposDeleteFileResponseCommitCommitter: object

Type declaration

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

ReposDeleteFileResponseCommitParentsItem

ReposDeleteFileResponseCommitParentsItem: object

Type declaration

  • html_url: string
  • sha: string
  • url: string

ReposDeleteFileResponseCommitTree

ReposDeleteFileResponseCommitTree: object

Type declaration

  • sha: string
  • url: string

ReposDeleteFileResponseCommitVerification

ReposDeleteFileResponseCommitVerification: object

Type declaration

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

ReposDeleteHookParams

ReposDeleteHookParams: object

Type declaration

  • hook_id: number
  • owner: string
  • repo: string

ReposDeleteInvitationParams

ReposDeleteInvitationParams: object

Type declaration

  • invitation_id: number
  • owner: string
  • repo: string

ReposDeleteParams

ReposDeleteParams: object

Type declaration

  • owner: string
  • repo: string

ReposDeleteReleaseAssetParams

ReposDeleteReleaseAssetParams: object

Type declaration

  • asset_id: number
  • owner: string
  • repo: string

ReposDeleteReleaseParams

ReposDeleteReleaseParams: object

Type declaration

  • owner: string
  • release_id: number
  • repo: string

ReposDeleteResponse

ReposDeleteResponse: object

Type declaration

  • documentation_url: string
  • message: string

ReposDisableAutomatedSecurityFixesParams

ReposDisableAutomatedSecurityFixesParams: object

Type declaration

  • owner: string
  • repo: string

ReposDisablePagesSiteParams

ReposDisablePagesSiteParams: object

Type declaration

  • owner: string
  • repo: string

ReposDisableVulnerabilityAlertsParams

ReposDisableVulnerabilityAlertsParams: object

Type declaration

  • owner: string
  • repo: string

ReposEnableAutomatedSecurityFixesParams

ReposEnableAutomatedSecurityFixesParams: object

Type declaration

  • owner: string
  • repo: string

ReposEnablePagesSiteParams

ReposEnablePagesSiteParams: object

Type declaration

ReposEnablePagesSiteParamsSource

ReposEnablePagesSiteParamsSource: object

Type declaration

  • Optional branch?: "master" | "gh-pages"
  • Optional path?: undefined | string

ReposEnablePagesSiteResponse

ReposEnablePagesSiteResponse: object

Type declaration

ReposEnablePagesSiteResponseSource

ReposEnablePagesSiteResponseSource: object

Type declaration

  • branch: string
  • directory: string

ReposEnableVulnerabilityAlertsParams

ReposEnableVulnerabilityAlertsParams: object

Type declaration

  • owner: string
  • repo: string

ReposGetAppsWithAccessToProtectedBranchParams

ReposGetAppsWithAccessToProtectedBranchParams: object

Type declaration

  • branch: string
  • owner: string
  • repo: string

ReposGetAppsWithAccessToProtectedBranchResponse

ReposGetAppsWithAccessToProtectedBranchResponse: Array<ReposGetAppsWithAccessToProtectedBranchResponseItem>

ReposGetAppsWithAccessToProtectedBranchResponseItem

ReposGetAppsWithAccessToProtectedBranchResponseItem: object

Type declaration

ReposGetAppsWithAccessToProtectedBranchResponseItemOwner

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

ReposGetAppsWithAccessToProtectedBranchResponseItemPermissions

ReposGetAppsWithAccessToProtectedBranchResponseItemPermissions: object

Type declaration

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

ReposGetArchiveLinkParams

ReposGetArchiveLinkParams: object

Type declaration

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

ReposGetBranchParams

ReposGetBranchParams: object

Type declaration

  • branch: string
  • owner: string
  • repo: string

ReposGetBranchProtectionParams

ReposGetBranchProtectionParams: object

Type declaration

  • branch: string
  • owner: string
  • repo: string

ReposGetBranchProtectionResponse

ReposGetBranchProtectionResponse: object

Type declaration

ReposGetBranchProtectionResponseEnforceAdmins

ReposGetBranchProtectionResponseEnforceAdmins: object

Type declaration

  • enabled: boolean
  • url: string

ReposGetBranchProtectionResponseRequiredPullRequestReviews

ReposGetBranchProtectionResponseRequiredPullRequestReviews: object

Type declaration

ReposGetBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictions

ReposGetBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictions: object

Type declaration

ReposGetBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictionsTeamsItem

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

ReposGetBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictionsUsersItem

ReposGetBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictionsUsersItem: object

Type declaration

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

ReposGetBranchProtectionResponseRequiredStatusChecks

ReposGetBranchProtectionResponseRequiredStatusChecks: object

Type declaration

  • contexts: Array<string>
  • contexts_url: string
  • strict: boolean
  • url: string

ReposGetBranchProtectionResponseRestrictions

ReposGetBranchProtectionResponseRestrictions: object

Type declaration

ReposGetBranchProtectionResponseRestrictionsAppsItem

ReposGetBranchProtectionResponseRestrictionsAppsItem: object

Type declaration

ReposGetBranchProtectionResponseRestrictionsAppsItemOwner

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

ReposGetBranchProtectionResponseRestrictionsAppsItemPermissions

ReposGetBranchProtectionResponseRestrictionsAppsItemPermissions: object

Type declaration

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

ReposGetBranchProtectionResponseRestrictionsTeamsItem

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

ReposGetBranchProtectionResponseRestrictionsUsersItem

ReposGetBranchProtectionResponseRestrictionsUsersItem: object

Type declaration

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

ReposGetBranchResponse

ReposGetBranchResponse: object

Type declaration

ReposGetBranchResponseCommit

ReposGetBranchResponseCommit: object

Type declaration

ReposGetBranchResponseCommitAuthor

ReposGetBranchResponseCommitAuthor: object

Type declaration

  • avatar_url: string
  • gravatar_id: string
  • id: number
  • login: string
  • url: string

ReposGetBranchResponseCommitCommit

ReposGetBranchResponseCommitCommit: object

Type declaration

ReposGetBranchResponseCommitCommitAuthor

ReposGetBranchResponseCommitCommitAuthor: object

Type declaration

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

ReposGetBranchResponseCommitCommitCommitter

ReposGetBranchResponseCommitCommitCommitter: object

Type declaration

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

ReposGetBranchResponseCommitCommitTree

ReposGetBranchResponseCommitCommitTree: object

Type declaration

  • sha: string
  • url: string

ReposGetBranchResponseCommitCommitVerification

ReposGetBranchResponseCommitCommitVerification: object

Type declaration

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

ReposGetBranchResponseCommitCommitter

ReposGetBranchResponseCommitCommitter: object

Type declaration

  • avatar_url: string
  • gravatar_id: string
  • id: number
  • login: string
  • url: string

ReposGetBranchResponseCommitParentsItem

ReposGetBranchResponseCommitParentsItem: object

Type declaration

  • sha: string
  • url: string

ReposGetBranchResponseLinks

ReposGetBranchResponseLinks: object

Type declaration

  • html: string
  • self: string

ReposGetBranchResponseProtection

ReposGetBranchResponseProtection: object

Type declaration

ReposGetBranchResponseProtectionRequiredStatusChecks

ReposGetBranchResponseProtectionRequiredStatusChecks: object

Type declaration

  • contexts: Array<string>
  • enforcement_level: string

ReposGetClonesParams

ReposGetClonesParams: object

Type declaration

  • owner: string
  • Optional per?: "day" | "week"

    Must be one of: day, week.

  • repo: string

ReposGetClonesResponse

ReposGetClonesResponse: object

Type declaration

ReposGetClonesResponseClonesItem

ReposGetClonesResponseClonesItem: object

Type declaration

  • count: number
  • timestamp: string
  • uniques: number

ReposGetCodeFrequencyStatsParams

ReposGetCodeFrequencyStatsParams: object

Type declaration

  • owner: string
  • repo: string

ReposGetCodeFrequencyStatsResponse

ReposGetCodeFrequencyStatsResponse: Array<Array<number>>

ReposGetCollaboratorPermissionLevelParams

ReposGetCollaboratorPermissionLevelParams: object

Type declaration

  • owner: string
  • repo: string
  • username: string

ReposGetCollaboratorPermissionLevelResponse

ReposGetCollaboratorPermissionLevelResponse: object

Type declaration

ReposGetCollaboratorPermissionLevelResponseUser

ReposGetCollaboratorPermissionLevelResponseUser: object

Type declaration

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

ReposGetCombinedStatusForRefParams

ReposGetCombinedStatusForRefParams: object

Type declaration

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

ReposGetCombinedStatusForRefResponse

ReposGetCombinedStatusForRefResponse: object

Type declaration

ReposGetCombinedStatusForRefResponseRepository

ReposGetCombinedStatusForRefResponseRepository: 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: ReposGetCombinedStatusForRefResponseRepositoryOwner
  • private: boolean
  • pulls_url: string
  • releases_url: string
  • ssh_url: string
  • stargazers_url: string
  • statuses_url: string
  • subscribers_url: string
  • subscription_url: string
  • tags_url: string
  • teams_url: string
  • trees_url: string
  • url: string

ReposGetCombinedStatusForRefResponseRepositoryOwner

ReposGetCombinedStatusForRefResponseRepositoryOwner: object

Type declaration

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

ReposGetCombinedStatusForRefResponseStatusesItem

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

ReposGetCommitActivityStatsParams

ReposGetCommitActivityStatsParams: object

Type declaration

  • owner: string
  • repo: string

ReposGetCommitActivityStatsResponse

ReposGetCommitActivityStatsResponse: Array<ReposGetCommitActivityStatsResponseItem>

ReposGetCommitActivityStatsResponseItem

ReposGetCommitActivityStatsResponseItem: object

Type declaration

  • days: Array<number>
  • total: number
  • week: number

ReposGetCommitCommentParams

ReposGetCommitCommentParams: object

Type declaration

  • comment_id: number
  • owner: string
  • repo: string

ReposGetCommitCommentResponse

ReposGetCommitCommentResponse: 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: ReposGetCommitCommentResponseUser

ReposGetCommitCommentResponseUser

ReposGetCommitCommentResponseUser: object

Type declaration

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

ReposGetCommitParams

ReposGetCommitParams: object

Type declaration

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

ReposGetCommitParamsDeprecatedCommitSha

ReposGetCommitParamsDeprecatedCommitSha: object

Type declaration

  • commit_sha: string
    deprecated

    "commit_sha" parameter renamed to "ref"

  • owner: string
  • repo: string

ReposGetCommitParamsDeprecatedSha

ReposGetCommitParamsDeprecatedSha: object

Type declaration

  • owner: string
  • repo: string
  • sha: string
    deprecated

    "sha" parameter renamed to "ref"

ReposGetCommitRefShaParams

ReposGetCommitRefShaParams: object

Type declaration

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

ReposGetCommitResponse

ReposGetCommitResponse: object

Type declaration

ReposGetCommitResponseAuthor

ReposGetCommitResponseAuthor: object

Type declaration

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

ReposGetCommitResponseCommit

ReposGetCommitResponseCommit: object

Type declaration

ReposGetCommitResponseCommitAuthor

ReposGetCommitResponseCommitAuthor: object

Type declaration

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

ReposGetCommitResponseCommitCommitter

ReposGetCommitResponseCommitCommitter: object

Type declaration

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

ReposGetCommitResponseCommitTree

ReposGetCommitResponseCommitTree: object

Type declaration

  • sha: string
  • url: string

ReposGetCommitResponseCommitVerification

ReposGetCommitResponseCommitVerification: object

Type declaration

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

ReposGetCommitResponseCommitter

ReposGetCommitResponseCommitter: object

Type declaration

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

ReposGetCommitResponseFilesItem

ReposGetCommitResponseFilesItem: object

Type declaration

  • additions: number
  • blob_url: string
  • changes: number
  • deletions: number
  • filename: string
  • patch: string
  • raw_url: string
  • status: string

ReposGetCommitResponseParentsItem

ReposGetCommitResponseParentsItem: object

Type declaration

  • sha: string
  • url: string

ReposGetCommitResponseStats

ReposGetCommitResponseStats: object

Type declaration

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

ReposGetContentsParams

ReposGetContentsParams: object

Type declaration

  • owner: string
  • path: string
  • Optional ref?: undefined | string

    The name of the commit/branch/tag. Default: the repository’s default branch (usually master)

  • repo: string

ReposGetContentsResponse

ReposGetContentsResponse: object | Array<ReposGetContentsResponseItem>

ReposGetContentsResponseItem

ReposGetContentsResponseItem: object

Type declaration

  • _links: ReposGetContentsResponseItemLinks
  • download_url: string | null
  • git_url: string
  • html_url: string
  • name: string
  • path: string
  • sha: string
  • size: number
  • type: string
  • url: string

ReposGetContentsResponseItemLinks

ReposGetContentsResponseItemLinks: object

Type declaration

  • git: string
  • html: string
  • self: string

ReposGetContentsResponseLinks

ReposGetContentsResponseLinks: object

Type declaration

  • git: string
  • html: string
  • self: string

ReposGetContributorsStatsParams

ReposGetContributorsStatsParams: object

Type declaration

  • owner: string
  • repo: string

ReposGetContributorsStatsResponse

ReposGetContributorsStatsResponse: Array<ReposGetContributorsStatsResponseItem>

ReposGetContributorsStatsResponseItem

ReposGetContributorsStatsResponseItem: object

Type declaration

ReposGetContributorsStatsResponseItemAuthor

ReposGetContributorsStatsResponseItemAuthor: object

Type declaration

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

ReposGetContributorsStatsResponseItemWeeksItem

ReposGetContributorsStatsResponseItemWeeksItem: object

Type declaration

  • a: number
  • c: number
  • d: number
  • w: string

ReposGetDeployKeyParams

ReposGetDeployKeyParams: object

Type declaration

  • key_id: number
  • owner: string
  • repo: string

ReposGetDeployKeyResponse

ReposGetDeployKeyResponse: object

Type declaration

  • created_at: string
  • id: number
  • key: string
  • read_only: boolean
  • title: string
  • url: string
  • verified: boolean

ReposGetDeploymentParams

ReposGetDeploymentParams: object

Type declaration

  • deployment_id: number
  • owner: string
  • repo: string

ReposGetDeploymentResponse

ReposGetDeploymentResponse: object

Type declaration

  • created_at: string
  • creator: ReposGetDeploymentResponseCreator
  • description: string
  • environment: string
  • id: number
  • node_id: string
  • original_environment: string
  • payload: ReposGetDeploymentResponsePayload
  • production_environment: boolean
  • ref: string
  • repository_url: string
  • sha: string
  • statuses_url: string
  • task: string
  • transient_environment: boolean
  • updated_at: string
  • url: string

ReposGetDeploymentResponseCreator

ReposGetDeploymentResponseCreator: object

Type declaration

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

ReposGetDeploymentResponsePayload

ReposGetDeploymentResponsePayload: object

Type declaration

  • deploy: string

ReposGetDeploymentStatusParams

ReposGetDeploymentStatusParams: object

Type declaration

  • deployment_id: number
  • owner: string
  • repo: string
  • status_id: number

ReposGetDeploymentStatusResponse

ReposGetDeploymentStatusResponse: object

Type declaration

  • created_at: string
  • creator: ReposGetDeploymentStatusResponseCreator
  • deployment_url: string
  • description: string
  • environment: string
  • environment_url: string
  • id: number
  • log_url: string
  • node_id: string
  • repository_url: string
  • state: string
  • target_url: string
  • updated_at: string
  • url: string

ReposGetDeploymentStatusResponseCreator

ReposGetDeploymentStatusResponseCreator: object

Type declaration

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

ReposGetDownloadParams

ReposGetDownloadParams: object

Type declaration

  • download_id: number
  • owner: string
  • repo: string

ReposGetDownloadResponse

ReposGetDownloadResponse: object

Type declaration

  • content_type: string
  • description: string
  • download_count: number
  • html_url: string
  • id: number
  • name: string
  • size: number
  • url: string

ReposGetHookParams

ReposGetHookParams: object

Type declaration

  • hook_id: number
  • owner: string
  • repo: string

ReposGetHookResponse

ReposGetHookResponse: object

Type declaration

ReposGetHookResponseConfig

ReposGetHookResponseConfig: object

Type declaration

  • content_type: string
  • insecure_ssl: string
  • url: string

ReposGetHookResponseLastResponse

ReposGetHookResponseLastResponse: object

Type declaration

  • code: null
  • message: null
  • status: string

ReposGetLatestPagesBuildParams

ReposGetLatestPagesBuildParams: object

Type declaration

  • owner: string
  • repo: string

ReposGetLatestPagesBuildResponse

ReposGetLatestPagesBuildResponse: object

Type declaration

ReposGetLatestPagesBuildResponseError

ReposGetLatestPagesBuildResponseError: object

Type declaration

  • message: null

ReposGetLatestPagesBuildResponsePusher

ReposGetLatestPagesBuildResponsePusher: object

Type declaration

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

ReposGetLatestReleaseParams

ReposGetLatestReleaseParams: object

Type declaration

  • owner: string
  • repo: string

ReposGetLatestReleaseResponse

ReposGetLatestReleaseResponse: object

Type declaration

  • assets: Array<ReposGetLatestReleaseResponseAssetsItem>
  • assets_url: string
  • author: ReposGetLatestReleaseResponseAuthor
  • body: string
  • created_at: string
  • draft: boolean
  • html_url: string
  • id: number
  • name: string
  • node_id: string
  • prerelease: boolean
  • published_at: string
  • tag_name: string
  • tarball_url: string
  • target_commitish: string
  • upload_url: string
  • url: string
  • zipball_url: string

ReposGetLatestReleaseResponseAssetsItem

ReposGetLatestReleaseResponseAssetsItem: 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: ReposGetLatestReleaseResponseAssetsItemUploader
  • url: string

ReposGetLatestReleaseResponseAssetsItemUploader

ReposGetLatestReleaseResponseAssetsItemUploader: object

Type declaration

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

ReposGetLatestReleaseResponseAuthor

ReposGetLatestReleaseResponseAuthor: object

Type declaration

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

ReposGetPagesBuildParams

ReposGetPagesBuildParams: object

Type declaration

  • build_id: number
  • owner: string
  • repo: string

ReposGetPagesBuildResponse

ReposGetPagesBuildResponse: object

Type declaration

ReposGetPagesBuildResponseError

ReposGetPagesBuildResponseError: object

Type declaration

  • message: null

ReposGetPagesBuildResponsePusher

ReposGetPagesBuildResponsePusher: object

Type declaration

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

ReposGetPagesParams

ReposGetPagesParams: object

Type declaration

  • owner: string
  • repo: string

ReposGetPagesResponse

ReposGetPagesResponse: object

Type declaration

ReposGetPagesResponseSource

ReposGetPagesResponseSource: object

Type declaration

  • branch: string
  • directory: string

ReposGetParams

ReposGetParams: object

Type declaration

  • owner: string
  • repo: string

ReposGetParticipationStatsParams

ReposGetParticipationStatsParams: object

Type declaration

  • owner: string
  • repo: string

ReposGetParticipationStatsResponse

ReposGetParticipationStatsResponse: object

Type declaration

  • all: Array<number>
  • owner: Array<number>

ReposGetProtectedBranchAdminEnforcementParams

ReposGetProtectedBranchAdminEnforcementParams: object

Type declaration

  • branch: string
  • owner: string
  • repo: string

ReposGetProtectedBranchAdminEnforcementResponse

ReposGetProtectedBranchAdminEnforcementResponse: object

Type declaration

  • enabled: boolean
  • url: string

ReposGetProtectedBranchPullRequestReviewEnforcementParams

ReposGetProtectedBranchPullRequestReviewEnforcementParams: object

Type declaration

  • branch: string
  • owner: string
  • repo: string

ReposGetProtectedBranchPullRequestReviewEnforcementResponse

ReposGetProtectedBranchPullRequestReviewEnforcementResponse: object

Type declaration

ReposGetProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictions

ReposGetProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictions: object

Type declaration

ReposGetProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictionsTeamsItem

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

ReposGetProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictionsUsersItem

ReposGetProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictionsUsersItem: object

Type declaration

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

ReposGetProtectedBranchRequiredSignaturesParams

ReposGetProtectedBranchRequiredSignaturesParams: object

Type declaration

  • branch: string
  • owner: string
  • repo: string

ReposGetProtectedBranchRequiredSignaturesResponse

ReposGetProtectedBranchRequiredSignaturesResponse: object

Type declaration

  • enabled: boolean
  • url: string

ReposGetProtectedBranchRequiredStatusChecksParams

ReposGetProtectedBranchRequiredStatusChecksParams: object

Type declaration

  • branch: string
  • owner: string
  • repo: string

ReposGetProtectedBranchRequiredStatusChecksResponse

ReposGetProtectedBranchRequiredStatusChecksResponse: object

Type declaration

  • contexts: Array<string>
  • contexts_url: string
  • strict: boolean
  • url: string

ReposGetProtectedBranchRestrictionsParams

ReposGetProtectedBranchRestrictionsParams: object

Type declaration

  • branch: string
  • owner: string
  • repo: string

ReposGetProtectedBranchRestrictionsResponse

ReposGetProtectedBranchRestrictionsResponse: object

Type declaration

ReposGetProtectedBranchRestrictionsResponseAppsItem

ReposGetProtectedBranchRestrictionsResponseAppsItem: object

Type declaration

ReposGetProtectedBranchRestrictionsResponseAppsItemOwner

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

ReposGetProtectedBranchRestrictionsResponseAppsItemPermissions

ReposGetProtectedBranchRestrictionsResponseAppsItemPermissions: object

Type declaration

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

ReposGetProtectedBranchRestrictionsResponseTeamsItem

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

ReposGetProtectedBranchRestrictionsResponseUsersItem

ReposGetProtectedBranchRestrictionsResponseUsersItem: object

Type declaration

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

ReposGetPunchCardStatsParams

ReposGetPunchCardStatsParams: object

Type declaration

  • owner: string
  • repo: string

ReposGetPunchCardStatsResponse

ReposGetPunchCardStatsResponse: Array<Array<number>>

ReposGetReadmeParams

ReposGetReadmeParams: object

Type declaration

  • owner: string
  • Optional ref?: undefined | string

    The name of the commit/branch/tag. Default: the repository’s default branch (usually master)

  • repo: string

ReposGetReadmeResponse

ReposGetReadmeResponse: object

Type declaration

  • _links: ReposGetReadmeResponseLinks
  • content: string
  • download_url: string
  • encoding: string
  • git_url: string
  • html_url: string
  • name: string
  • path: string
  • sha: string
  • size: number
  • type: string
  • url: string

ReposGetReadmeResponseLinks

ReposGetReadmeResponseLinks: object

Type declaration

  • git: string
  • html: string
  • self: string

ReposGetReleaseAssetParams

ReposGetReleaseAssetParams: object

Type declaration

  • asset_id: number
  • owner: string
  • repo: string

ReposGetReleaseAssetResponse

ReposGetReleaseAssetResponse: 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: ReposGetReleaseAssetResponseUploader
  • url: string

ReposGetReleaseAssetResponseUploader

ReposGetReleaseAssetResponseUploader: object

Type declaration

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

ReposGetReleaseByTagParams

ReposGetReleaseByTagParams: object

Type declaration

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

ReposGetReleaseByTagResponse

ReposGetReleaseByTagResponse: object

Type declaration

  • assets: Array<ReposGetReleaseByTagResponseAssetsItem>
  • assets_url: string
  • author: ReposGetReleaseByTagResponseAuthor
  • body: string
  • created_at: string
  • draft: boolean
  • html_url: string
  • id: number
  • name: string
  • node_id: string
  • prerelease: boolean
  • published_at: string
  • tag_name: string
  • tarball_url: string
  • target_commitish: string
  • upload_url: string
  • url: string
  • zipball_url: string

ReposGetReleaseByTagResponseAssetsItem

ReposGetReleaseByTagResponseAssetsItem: 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: ReposGetReleaseByTagResponseAssetsItemUploader
  • url: string

ReposGetReleaseByTagResponseAssetsItemUploader

ReposGetReleaseByTagResponseAssetsItemUploader: object

Type declaration

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

ReposGetReleaseByTagResponseAuthor

ReposGetReleaseByTagResponseAuthor: object

Type declaration

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

ReposGetReleaseParams

ReposGetReleaseParams: object

Type declaration

  • owner: string
  • release_id: number
  • repo: string

ReposGetReleaseResponse

ReposGetReleaseResponse: object

Type declaration

  • assets: Array<ReposGetReleaseResponseAssetsItem>
  • assets_url: string
  • author: ReposGetReleaseResponseAuthor
  • body: string
  • created_at: string
  • draft: boolean
  • html_url: string
  • id: number
  • name: string
  • node_id: string
  • prerelease: boolean
  • published_at: string
  • tag_name: string
  • tarball_url: string
  • target_commitish: string
  • upload_url: string
  • url: string
  • zipball_url: string

ReposGetReleaseResponseAssetsItem

ReposGetReleaseResponseAssetsItem: 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: ReposGetReleaseResponseAssetsItemUploader
  • url: string

ReposGetReleaseResponseAssetsItemUploader

ReposGetReleaseResponseAssetsItemUploader: object

Type declaration

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

ReposGetReleaseResponseAuthor

ReposGetReleaseResponseAuthor: object

Type declaration

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

ReposGetResponse

ReposGetResponse: 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
  • license: ReposGetResponseLicense
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • organization: ReposGetResponseOrganization
  • owner: ReposGetResponseOwner
  • parent: ReposGetResponseParent
  • permissions: ReposGetResponsePermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • source: ReposGetResponseSource
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

ReposGetResponseLicense

ReposGetResponseLicense: object

Type declaration

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

ReposGetResponseOrganization

ReposGetResponseOrganization: object

Type declaration

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

ReposGetResponseOwner

ReposGetResponseOwner: object

Type declaration

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

ReposGetResponseParent

ReposGetResponseParent: 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: ReposGetResponseParentOwner
  • permissions: ReposGetResponseParentPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

ReposGetResponseParentOwner

ReposGetResponseParentOwner: object

Type declaration

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

ReposGetResponseParentPermissions

ReposGetResponseParentPermissions: object

Type declaration

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

ReposGetResponsePermissions

ReposGetResponsePermissions: object

Type declaration

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

ReposGetResponseSource

ReposGetResponseSource: 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: ReposGetResponseSourceOwner
  • permissions: ReposGetResponseSourcePermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

ReposGetResponseSourceOwner

ReposGetResponseSourceOwner: object

Type declaration

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

ReposGetResponseSourcePermissions

ReposGetResponseSourcePermissions: object

Type declaration

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

ReposGetTeamsWithAccessToProtectedBranchParams

ReposGetTeamsWithAccessToProtectedBranchParams: object

Type declaration

  • branch: string
  • owner: string
  • repo: string

ReposGetTeamsWithAccessToProtectedBranchResponse

ReposGetTeamsWithAccessToProtectedBranchResponse: Array<ReposGetTeamsWithAccessToProtectedBranchResponseItem>

ReposGetTeamsWithAccessToProtectedBranchResponseItem

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

ReposGetTopPathsParams

ReposGetTopPathsParams: object

Type declaration

  • owner: string
  • repo: string

ReposGetTopPathsResponse

ReposGetTopPathsResponse: Array<ReposGetTopPathsResponseItem>

ReposGetTopPathsResponseItem

ReposGetTopPathsResponseItem: object

Type declaration

  • count: number
  • path: string
  • title: string
  • uniques: number

ReposGetTopReferrersParams

ReposGetTopReferrersParams: object

Type declaration

  • owner: string
  • repo: string

ReposGetTopReferrersResponse

ReposGetTopReferrersResponse: Array<ReposGetTopReferrersResponseItem>

ReposGetTopReferrersResponseItem

ReposGetTopReferrersResponseItem: object

Type declaration

  • count: number
  • referrer: string
  • uniques: number

ReposGetUsersWithAccessToProtectedBranchParams

ReposGetUsersWithAccessToProtectedBranchParams: object

Type declaration

  • branch: string
  • owner: string
  • repo: string

ReposGetUsersWithAccessToProtectedBranchResponse

ReposGetUsersWithAccessToProtectedBranchResponse: Array<ReposGetUsersWithAccessToProtectedBranchResponseItem>

ReposGetUsersWithAccessToProtectedBranchResponseItem

ReposGetUsersWithAccessToProtectedBranchResponseItem: object

Type declaration

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

ReposGetViewsParams

ReposGetViewsParams: object

Type declaration

  • owner: string
  • Optional per?: "day" | "week"

    Must be one of: day, week.

  • repo: string

ReposGetViewsResponse

ReposGetViewsResponse: object

Type declaration

ReposGetViewsResponseViewsItem

ReposGetViewsResponseViewsItem: object

Type declaration

  • count: number
  • timestamp: string
  • uniques: number

ReposListAppsWithAccessToProtectedBranchParams

ReposListAppsWithAccessToProtectedBranchParams: object

Type declaration

  • branch: string
  • owner: string
  • repo: string

ReposListAppsWithAccessToProtectedBranchResponse

ReposListAppsWithAccessToProtectedBranchResponse: Array<ReposListAppsWithAccessToProtectedBranchResponseItem>

ReposListAppsWithAccessToProtectedBranchResponseItem

ReposListAppsWithAccessToProtectedBranchResponseItem: object

Type declaration

ReposListAppsWithAccessToProtectedBranchResponseItemOwner

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

ReposListAppsWithAccessToProtectedBranchResponseItemPermissions

ReposListAppsWithAccessToProtectedBranchResponseItemPermissions: object

Type declaration

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

ReposListAssetsForReleaseParams

ReposListAssetsForReleaseParams: object

Type declaration

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • release_id: number
  • repo: string

ReposListAssetsForReleaseResponse

ReposListAssetsForReleaseResponse: Array<ReposListAssetsForReleaseResponseItem>

ReposListAssetsForReleaseResponseItem

ReposListAssetsForReleaseResponseItem: 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: ReposListAssetsForReleaseResponseItemUploader
  • url: string

ReposListAssetsForReleaseResponseItemUploader

ReposListAssetsForReleaseResponseItemUploader: object

Type declaration

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

ReposListBranchesForHeadCommitParams

ReposListBranchesForHeadCommitParams: object

Type declaration

  • commit_sha: string
  • owner: string
  • repo: string

ReposListBranchesForHeadCommitResponse

ReposListBranchesForHeadCommitResponse: Array<ReposListBranchesForHeadCommitResponseItem>

ReposListBranchesForHeadCommitResponseItem

ReposListBranchesForHeadCommitResponseItem: object

Type declaration

ReposListBranchesForHeadCommitResponseItemCommit

ReposListBranchesForHeadCommitResponseItemCommit: object

Type declaration

  • sha: string
  • url: string

ReposListBranchesParams

ReposListBranchesParams: object

Type declaration

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

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • Optional protected?: undefined | false | true

    Setting to true returns only protected branches. When set to false, only unprotected branches are returned. Omitting this parameter returns all branches.

  • repo: string

ReposListBranchesResponse

ReposListBranchesResponse: Array<ReposListBranchesResponseItem>

ReposListBranchesResponseItem

ReposListBranchesResponseItem: object

Type declaration

ReposListBranchesResponseItemCommit

ReposListBranchesResponseItemCommit: object

Type declaration

  • sha: string
  • url: string

ReposListBranchesResponseItemProtection

ReposListBranchesResponseItemProtection: object

Type declaration

ReposListBranchesResponseItemProtectionRequiredStatusChecks

ReposListBranchesResponseItemProtectionRequiredStatusChecks: object

Type declaration

  • contexts: Array<string>
  • enforcement_level: string

ReposListCollaboratorsParams

ReposListCollaboratorsParams: 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
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ReposListCollaboratorsResponse

ReposListCollaboratorsResponse: Array<ReposListCollaboratorsResponseItem>

ReposListCollaboratorsResponseItem

ReposListCollaboratorsResponseItem: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • permissions: ReposListCollaboratorsResponseItemPermissions
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListCollaboratorsResponseItemPermissions

ReposListCollaboratorsResponseItemPermissions: object

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

ReposListCommentsForCommitParams

ReposListCommentsForCommitParams: object

Type declaration

  • commit_sha: string
  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ReposListCommentsForCommitParamsDeprecatedRef

ReposListCommentsForCommitParamsDeprecatedRef: object

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • ref: string
    deprecated

    "ref" parameter renamed to "commit_sha"

  • repo: string

ReposListCommentsForCommitResponse

ReposListCommentsForCommitResponse: Array<ReposListCommentsForCommitResponseItem>

ReposListCommentsForCommitResponseItem

ReposListCommentsForCommitResponseItem: 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: ReposListCommentsForCommitResponseItemUser

ReposListCommentsForCommitResponseItemUser

ReposListCommentsForCommitResponseItemUser: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListCommitCommentsParams

ReposListCommitCommentsParams: object

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ReposListCommitCommentsResponse

ReposListCommitCommentsResponse: Array<ReposListCommitCommentsResponseItem>

ReposListCommitCommentsResponseItem

ReposListCommitCommentsResponseItem: 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: ReposListCommitCommentsResponseItemUser

ReposListCommitCommentsResponseItemUser

ReposListCommitCommentsResponseItemUser: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListCommitsParams

ReposListCommitsParams: object

Type declaration

  • Optional author?: undefined | string

    GitHub login or email address by which to filter by commit author.

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional path?: undefined | string

    Only commits containing this file path will be returned.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string
  • Optional sha?: undefined | string

    SHA or branch to start listing commits from. Default: the repository’s default branch (usually master).

  • Optional since?: undefined | string

    Only commits after this date will be returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

  • Optional until?: undefined | string

    Only commits before this date will be returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

ReposListCommitsResponse

ReposListCommitsResponse: Array<ReposListCommitsResponseItem>

ReposListCommitsResponseItem

ReposListCommitsResponseItem: object

Type declaration

ReposListCommitsResponseItemAuthor

ReposListCommitsResponseItemAuthor: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListCommitsResponseItemCommit

ReposListCommitsResponseItemCommit: object

Type declaration

ReposListCommitsResponseItemCommitAuthor

ReposListCommitsResponseItemCommitAuthor: object

Type declaration

  • date: string
  • email: string
  • name: string

ReposListCommitsResponseItemCommitCommitter

ReposListCommitsResponseItemCommitCommitter: object

Type declaration

  • date: string
  • email: string
  • name: string

ReposListCommitsResponseItemCommitTree

ReposListCommitsResponseItemCommitTree: object

Type declaration

  • sha: string
  • url: string

ReposListCommitsResponseItemCommitVerification

ReposListCommitsResponseItemCommitVerification: object

Type declaration

  • payload: null
  • reason: string
  • signature: null
  • verified: boolean

ReposListCommitsResponseItemCommitter

ReposListCommitsResponseItemCommitter: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListCommitsResponseItemParentsItem

ReposListCommitsResponseItemParentsItem: object

Type declaration

  • sha: string
  • url: string

ReposListContributorsParams

ReposListContributorsParams: object

Type declaration

  • Optional anon?: undefined | string

    Set to 1 or true to include anonymous contributors in results.

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ReposListContributorsResponse

ReposListContributorsResponse: Array<ReposListContributorsResponseItem>

ReposListContributorsResponseItem

ReposListContributorsResponseItem: 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

ReposListDeployKeysParams

ReposListDeployKeysParams: object

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ReposListDeployKeysResponse

ReposListDeployKeysResponse: Array<ReposListDeployKeysResponseItem>

ReposListDeployKeysResponseItem

ReposListDeployKeysResponseItem: object

Type declaration

  • created_at: string
  • id: number
  • key: string
  • read_only: boolean
  • title: string
  • url: string
  • verified: boolean

ReposListDeploymentStatusesParams

ReposListDeploymentStatusesParams: object

Type declaration

  • deployment_id: number
  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ReposListDeploymentStatusesResponse

ReposListDeploymentStatusesResponse: Array<ReposListDeploymentStatusesResponseItem>

ReposListDeploymentStatusesResponseItem

ReposListDeploymentStatusesResponseItem: object

Type declaration

  • created_at: string
  • creator: ReposListDeploymentStatusesResponseItemCreator
  • deployment_url: string
  • description: string
  • environment: string
  • environment_url: string
  • id: number
  • log_url: string
  • node_id: string
  • repository_url: string
  • state: string
  • target_url: string
  • updated_at: string
  • url: string

ReposListDeploymentStatusesResponseItemCreator

ReposListDeploymentStatusesResponseItemCreator: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListDeploymentsParams

ReposListDeploymentsParams: object

Type declaration

  • Optional environment?: undefined | string

    The name of the environment that was deployed to (e.g., staging or production).

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • Optional ref?: undefined | string

    The name of the ref. This can be a branch, tag, or SHA.

  • repo: string
  • Optional sha?: undefined | string

    The SHA recorded at creation time.

  • Optional task?: undefined | string

    The name of the task for the deployment (e.g., deploy or deploy:migrations).

ReposListDeploymentsResponse

ReposListDeploymentsResponse: Array<ReposListDeploymentsResponseItem>

ReposListDeploymentsResponseItem

ReposListDeploymentsResponseItem: object

Type declaration

ReposListDeploymentsResponseItemCreator

ReposListDeploymentsResponseItemCreator: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListDeploymentsResponseItemPayload

ReposListDeploymentsResponseItemPayload: object

Type declaration

  • deploy: string

ReposListDownloadsParams

ReposListDownloadsParams: object

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ReposListDownloadsResponse

ReposListDownloadsResponse: Array<ReposListDownloadsResponseItem>

ReposListDownloadsResponseItem

ReposListDownloadsResponseItem: object

Type declaration

  • content_type: string
  • description: string
  • download_count: number
  • html_url: string
  • id: number
  • name: string
  • size: number
  • url: string

ReposListForOrgParams

ReposListForOrgParams: object

Type declaration

  • Optional direction?: "asc" | "desc"

    Can be one of asc or desc. Default: when using full_name: asc, otherwise desc

  • org: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • Optional sort?: "created" | "updated" | "pushed" | "full_name"

    Can be one of created, updated, pushed, full_name.

  • Optional type?: "all" | "public" | "private" | "forks" | "sources" | "member"

    Can be one of all, public, private, forks, sources, member.

ReposListForOrgResponse

ReposListForOrgResponse: Array<ReposListForOrgResponseItem>

ReposListForOrgResponseItem

ReposListForOrgResponseItem: 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: ReposListForOrgResponseItemLicense
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: ReposListForOrgResponseItemOwner
  • permissions: ReposListForOrgResponseItemPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

ReposListForOrgResponseItemLicense

ReposListForOrgResponseItemLicense: object

Type declaration

  • key: string
  • name: string
  • node_id: string
  • spdx_id: string
  • url: string

ReposListForOrgResponseItemOwner

ReposListForOrgResponseItemOwner: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListForOrgResponseItemPermissions

ReposListForOrgResponseItemPermissions: object

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

ReposListForUserParams

ReposListForUserParams: object

Type declaration

  • Optional direction?: "asc" | "desc"

    Can be one of asc or desc. Default: asc when using full_name, otherwise desc

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • Optional sort?: "created" | "updated" | "pushed" | "full_name"

    Can be one of created, updated, pushed, full_name.

  • Optional type?: "all" | "owner" | "member"

    Can be one of all, owner, member.

  • username: string

ReposListForksParams

ReposListForksParams: object

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string
  • Optional sort?: "newest" | "oldest" | "stargazers"

    The sort order. Can be either newest, oldest, or stargazers.

ReposListForksResponse

ReposListForksResponse: Array<ReposListForksResponseItem>

ReposListForksResponseItem

ReposListForksResponseItem: 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: ReposListForksResponseItemLicense
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: ReposListForksResponseItemOwner
  • permissions: ReposListForksResponseItemPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

ReposListForksResponseItemLicense

ReposListForksResponseItemLicense: object

Type declaration

  • key: string
  • name: string
  • node_id: string
  • spdx_id: string
  • url: string

ReposListForksResponseItemOwner

ReposListForksResponseItemOwner: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListForksResponseItemPermissions

ReposListForksResponseItemPermissions: object

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

ReposListHooksParams

ReposListHooksParams: object

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ReposListHooksResponse

ReposListHooksResponse: Array<ReposListHooksResponseItem>

ReposListHooksResponseItem

ReposListHooksResponseItem: object

Type declaration

ReposListHooksResponseItemConfig

ReposListHooksResponseItemConfig: object

Type declaration

  • content_type: string
  • insecure_ssl: string
  • url: string

ReposListHooksResponseItemLastResponse

ReposListHooksResponseItemLastResponse: object

Type declaration

  • code: null
  • message: null
  • status: string

ReposListInvitationsForAuthenticatedUserParams

ReposListInvitationsForAuthenticatedUserParams: object

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

ReposListInvitationsForAuthenticatedUserResponse

ReposListInvitationsForAuthenticatedUserResponse: Array<ReposListInvitationsForAuthenticatedUserResponseItem>

ReposListInvitationsForAuthenticatedUserResponseItem

ReposListInvitationsForAuthenticatedUserResponseItem: object

Type declaration

ReposListInvitationsForAuthenticatedUserResponseItemInvitee

ReposListInvitationsForAuthenticatedUserResponseItemInvitee: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListInvitationsForAuthenticatedUserResponseItemInviter

ReposListInvitationsForAuthenticatedUserResponseItemInviter: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListInvitationsForAuthenticatedUserResponseItemRepository

ReposListInvitationsForAuthenticatedUserResponseItemRepository: 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: ReposListInvitationsForAuthenticatedUserResponseItemRepositoryOwner
  • private: boolean
  • pulls_url: string
  • releases_url: string
  • ssh_url: string
  • stargazers_url: string
  • statuses_url: string
  • subscribers_url: string
  • subscription_url: string
  • tags_url: string
  • teams_url: string
  • trees_url: string
  • url: string

ReposListInvitationsForAuthenticatedUserResponseItemRepositoryOwner

ReposListInvitationsForAuthenticatedUserResponseItemRepositoryOwner: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListInvitationsParams

ReposListInvitationsParams: object

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ReposListInvitationsResponse

ReposListInvitationsResponse: Array<ReposListInvitationsResponseItem>

ReposListInvitationsResponseItem

ReposListInvitationsResponseItem: object

Type declaration

ReposListInvitationsResponseItemInvitee

ReposListInvitationsResponseItemInvitee: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListInvitationsResponseItemInviter

ReposListInvitationsResponseItemInviter: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListInvitationsResponseItemRepository

ReposListInvitationsResponseItemRepository: 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: ReposListInvitationsResponseItemRepositoryOwner
  • private: boolean
  • pulls_url: string
  • releases_url: string
  • ssh_url: string
  • stargazers_url: string
  • statuses_url: string
  • subscribers_url: string
  • subscription_url: string
  • tags_url: string
  • teams_url: string
  • trees_url: string
  • url: string

ReposListInvitationsResponseItemRepositoryOwner

ReposListInvitationsResponseItemRepositoryOwner: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListLanguagesParams

ReposListLanguagesParams: object

Type declaration

  • owner: string
  • repo: string

ReposListLanguagesResponse

ReposListLanguagesResponse: object

Type declaration

  • C: number
  • Python: number

ReposListPagesBuildsParams

ReposListPagesBuildsParams: object

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ReposListPagesBuildsResponse

ReposListPagesBuildsResponse: Array<ReposListPagesBuildsResponseItem>

ReposListPagesBuildsResponseItem

ReposListPagesBuildsResponseItem: object

Type declaration

ReposListPagesBuildsResponseItemError

ReposListPagesBuildsResponseItemError: object

Type declaration

  • message: null

ReposListPagesBuildsResponseItemPusher

ReposListPagesBuildsResponseItemPusher: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListParams

ReposListParams: object

Type declaration

  • Optional affiliation?: undefined | string

    Comma-separated list of values. Can include: * owner: Repositories that are owned by the authenticated user. * collaborator: Repositories that the user has been added to as a collaborator. * organization_member: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.

  • Optional direction?: "asc" | "desc"

    Can be one of asc or desc. Default: asc when using full_name, otherwise desc

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • Optional sort?: "created" | "updated" | "pushed" | "full_name"

    Can be one of created, updated, pushed, full_name.

  • Optional type?: "all" | "owner" | "public" | "private" | "member"

    Can be one of all, owner, public, private, member. Default: all

    Will cause a 422 error if used in the same request as visibility or affiliation. Will cause a 422 error if used in the same request as visibility or affiliation.

  • Optional visibility?: "all" | "public" | "private"

    Can be one of all, public, or private.

ReposListProtectedBranchRequiredStatusChecksContextsParams

ReposListProtectedBranchRequiredStatusChecksContextsParams: object

Type declaration

  • branch: string
  • owner: string
  • repo: string

ReposListProtectedBranchRequiredStatusChecksContextsResponse

ReposListProtectedBranchRequiredStatusChecksContextsResponse: Array<string>

ReposListProtectedBranchTeamRestrictionsParams

ReposListProtectedBranchTeamRestrictionsParams: object

Type declaration

  • branch: string
  • owner: string
  • repo: string

ReposListProtectedBranchTeamRestrictionsResponse

ReposListProtectedBranchTeamRestrictionsResponse: Array<ReposListProtectedBranchTeamRestrictionsResponseItem>

ReposListProtectedBranchTeamRestrictionsResponseItem

ReposListProtectedBranchTeamRestrictionsResponseItem: 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

ReposListProtectedBranchUserRestrictionsParams

ReposListProtectedBranchUserRestrictionsParams: object

Type declaration

  • branch: string
  • owner: string
  • repo: string

ReposListProtectedBranchUserRestrictionsResponse

ReposListProtectedBranchUserRestrictionsResponse: Array<ReposListProtectedBranchUserRestrictionsResponseItem>

ReposListProtectedBranchUserRestrictionsResponseItem

ReposListProtectedBranchUserRestrictionsResponseItem: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListPublicParams

ReposListPublicParams: object

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • Optional since?: undefined | string

    The integer ID of the last Repository that you've seen.

ReposListPublicResponse

ReposListPublicResponse: Array<ReposListPublicResponseItem>

ReposListPublicResponseItem

ReposListPublicResponseItem: 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: ReposListPublicResponseItemOwner
  • private: boolean
  • pulls_url: string
  • releases_url: string
  • ssh_url: string
  • stargazers_url: string
  • statuses_url: string
  • subscribers_url: string
  • subscription_url: string
  • tags_url: string
  • teams_url: string
  • trees_url: string
  • url: string

ReposListPublicResponseItemOwner

ReposListPublicResponseItemOwner: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListPullRequestsAssociatedWithCommitParams

ReposListPullRequestsAssociatedWithCommitParams: object

Type declaration

  • commit_sha: string
  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ReposListPullRequestsAssociatedWithCommitResponse

ReposListPullRequestsAssociatedWithCommitResponse: Array<ReposListPullRequestsAssociatedWithCommitResponseItem>

ReposListPullRequestsAssociatedWithCommitResponseItem

ReposListPullRequestsAssociatedWithCommitResponseItem: object

Type declaration

ReposListPullRequestsAssociatedWithCommitResponseItemAssignee

ReposListPullRequestsAssociatedWithCommitResponseItemAssignee: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListPullRequestsAssociatedWithCommitResponseItemAssigneesItem

ReposListPullRequestsAssociatedWithCommitResponseItemAssigneesItem: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListPullRequestsAssociatedWithCommitResponseItemBase

ReposListPullRequestsAssociatedWithCommitResponseItemBase: object

Type declaration

ReposListPullRequestsAssociatedWithCommitResponseItemBaseRepo

ReposListPullRequestsAssociatedWithCommitResponseItemBaseRepo: 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: ReposListPullRequestsAssociatedWithCommitResponseItemBaseRepoOwner
  • permissions: ReposListPullRequestsAssociatedWithCommitResponseItemBaseRepoPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

ReposListPullRequestsAssociatedWithCommitResponseItemBaseRepoOwner

ReposListPullRequestsAssociatedWithCommitResponseItemBaseRepoOwner: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListPullRequestsAssociatedWithCommitResponseItemBaseRepoPermissions

ReposListPullRequestsAssociatedWithCommitResponseItemBaseRepoPermissions: object

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

ReposListPullRequestsAssociatedWithCommitResponseItemBaseUser

ReposListPullRequestsAssociatedWithCommitResponseItemBaseUser: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListPullRequestsAssociatedWithCommitResponseItemHead

ReposListPullRequestsAssociatedWithCommitResponseItemHead: object

Type declaration

ReposListPullRequestsAssociatedWithCommitResponseItemHeadRepo

ReposListPullRequestsAssociatedWithCommitResponseItemHeadRepo: 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: ReposListPullRequestsAssociatedWithCommitResponseItemHeadRepoOwner
  • permissions: ReposListPullRequestsAssociatedWithCommitResponseItemHeadRepoPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

ReposListPullRequestsAssociatedWithCommitResponseItemHeadRepoOwner

ReposListPullRequestsAssociatedWithCommitResponseItemHeadRepoOwner: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListPullRequestsAssociatedWithCommitResponseItemHeadRepoPermissions

ReposListPullRequestsAssociatedWithCommitResponseItemHeadRepoPermissions: object

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

ReposListPullRequestsAssociatedWithCommitResponseItemHeadUser

ReposListPullRequestsAssociatedWithCommitResponseItemHeadUser: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListPullRequestsAssociatedWithCommitResponseItemLabelsItem

ReposListPullRequestsAssociatedWithCommitResponseItemLabelsItem: object

Type declaration

  • color: string
  • default: boolean
  • description: string
  • id: number
  • name: string
  • node_id: string
  • url: string

ReposListPullRequestsAssociatedWithCommitResponseItemLinks

ReposListPullRequestsAssociatedWithCommitResponseItemLinks: object

Type declaration

ReposListPullRequestsAssociatedWithCommitResponseItemLinksComments

ReposListPullRequestsAssociatedWithCommitResponseItemLinksComments: object

Type declaration

  • href: string

ReposListPullRequestsAssociatedWithCommitResponseItemLinksCommits

ReposListPullRequestsAssociatedWithCommitResponseItemLinksCommits: object

Type declaration

  • href: string

ReposListPullRequestsAssociatedWithCommitResponseItemLinksHtml

ReposListPullRequestsAssociatedWithCommitResponseItemLinksHtml: object

Type declaration

  • href: string

ReposListPullRequestsAssociatedWithCommitResponseItemLinksIssue

ReposListPullRequestsAssociatedWithCommitResponseItemLinksIssue: object

Type declaration

  • href: string

ReposListPullRequestsAssociatedWithCommitResponseItemLinksReviewComment

ReposListPullRequestsAssociatedWithCommitResponseItemLinksReviewComment: object

Type declaration

  • href: string

ReposListPullRequestsAssociatedWithCommitResponseItemLinksReviewComments

ReposListPullRequestsAssociatedWithCommitResponseItemLinksReviewComments: object

Type declaration

  • href: string

ReposListPullRequestsAssociatedWithCommitResponseItemLinksSelf

ReposListPullRequestsAssociatedWithCommitResponseItemLinksSelf: object

Type declaration

  • href: string

ReposListPullRequestsAssociatedWithCommitResponseItemLinksStatuses

ReposListPullRequestsAssociatedWithCommitResponseItemLinksStatuses: object

Type declaration

  • href: string

ReposListPullRequestsAssociatedWithCommitResponseItemMilestone

ReposListPullRequestsAssociatedWithCommitResponseItemMilestone: object

Type declaration

ReposListPullRequestsAssociatedWithCommitResponseItemMilestoneCreator

ReposListPullRequestsAssociatedWithCommitResponseItemMilestoneCreator: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListPullRequestsAssociatedWithCommitResponseItemRequestedReviewersItem

ReposListPullRequestsAssociatedWithCommitResponseItemRequestedReviewersItem: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListPullRequestsAssociatedWithCommitResponseItemRequestedTeamsItem

ReposListPullRequestsAssociatedWithCommitResponseItemRequestedTeamsItem: 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

ReposListPullRequestsAssociatedWithCommitResponseItemUser

ReposListPullRequestsAssociatedWithCommitResponseItemUser: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListReleasesParams

ReposListReleasesParams: object

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ReposListReleasesResponse

ReposListReleasesResponse: Array<ReposListReleasesResponseItem>

ReposListReleasesResponseItem

ReposListReleasesResponseItem: object

Type declaration

  • assets: Array<ReposListReleasesResponseItemAssetsItem>
  • assets_url: string
  • author: ReposListReleasesResponseItemAuthor
  • body: string
  • created_at: string
  • draft: boolean
  • html_url: string
  • id: number
  • name: string
  • node_id: string
  • prerelease: boolean
  • published_at: string
  • tag_name: string
  • tarball_url: string
  • target_commitish: string
  • upload_url: string
  • url: string
  • zipball_url: string

ReposListReleasesResponseItemAssetsItem

ReposListReleasesResponseItemAssetsItem: 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: ReposListReleasesResponseItemAssetsItemUploader
  • url: string

ReposListReleasesResponseItemAssetsItemUploader

ReposListReleasesResponseItemAssetsItemUploader: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListReleasesResponseItemAuthor

ReposListReleasesResponseItemAuthor: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListStatusesForRefParams

ReposListStatusesForRefParams: object

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • ref: string
  • repo: string

ReposListStatusesForRefResponse

ReposListStatusesForRefResponse: Array<ReposListStatusesForRefResponseItem>

ReposListStatusesForRefResponseItem

ReposListStatusesForRefResponseItem: object

Type declaration

  • avatar_url: string
  • context: string
  • created_at: string
  • creator: ReposListStatusesForRefResponseItemCreator
  • description: string
  • id: number
  • node_id: string
  • state: string
  • target_url: string
  • updated_at: string
  • url: string

ReposListStatusesForRefResponseItemCreator

ReposListStatusesForRefResponseItemCreator: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposListTagsParams

ReposListTagsParams: object

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ReposListTagsResponse

ReposListTagsResponse: Array<ReposListTagsResponseItem>

ReposListTagsResponseItem

ReposListTagsResponseItem: object

Type declaration

ReposListTagsResponseItemCommit

ReposListTagsResponseItemCommit: object

Type declaration

  • sha: string
  • url: string

ReposListTeamsParams

ReposListTeamsParams: object

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ReposListTeamsResponse

ReposListTeamsResponse: Array<ReposListTeamsResponseItem>

ReposListTeamsResponseItem

ReposListTeamsResponseItem: 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

ReposListTeamsWithAccessToProtectedBranchParams

ReposListTeamsWithAccessToProtectedBranchParams: object

Type declaration

  • branch: string
  • owner: string
  • repo: string

ReposListTeamsWithAccessToProtectedBranchResponse

ReposListTeamsWithAccessToProtectedBranchResponse: Array<ReposListTeamsWithAccessToProtectedBranchResponseItem>

ReposListTeamsWithAccessToProtectedBranchResponseItem

ReposListTeamsWithAccessToProtectedBranchResponseItem: 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

ReposListTopicsParams

ReposListTopicsParams: object

Type declaration

  • owner: string
  • repo: string

ReposListTopicsResponse

ReposListTopicsResponse: object

Type declaration

  • names: Array<string>

ReposListUsersWithAccessToProtectedBranchParams

ReposListUsersWithAccessToProtectedBranchParams: object

Type declaration

  • branch: string
  • owner: string
  • repo: string

ReposListUsersWithAccessToProtectedBranchResponse

ReposListUsersWithAccessToProtectedBranchResponse: Array<ReposListUsersWithAccessToProtectedBranchResponseItem>

ReposListUsersWithAccessToProtectedBranchResponseItem

ReposListUsersWithAccessToProtectedBranchResponseItem: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposMergeParams

ReposMergeParams: object

Type declaration

  • base: string

    The name of the base branch that the head will be merged into.

  • Optional commit_message?: undefined | string

    Commit message to use for the merge commit. If omitted, a default message will be used.

  • head: string

    The head to merge. This can be a branch name or a commit SHA1.

  • owner: string
  • repo: string

ReposMergeResponse

ReposMergeResponse: object

Type declaration

ReposMergeResponseAuthor

ReposMergeResponseAuthor: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposMergeResponseCommit

ReposMergeResponseCommit: object

Type declaration

ReposMergeResponseCommitAuthor

ReposMergeResponseCommitAuthor: object

Type declaration

  • date: string
  • email: string
  • name: string

ReposMergeResponseCommitCommitter

ReposMergeResponseCommitCommitter: object

Type declaration

  • date: string
  • email: string
  • name: string

ReposMergeResponseCommitTree

ReposMergeResponseCommitTree: object

Type declaration

  • sha: string
  • url: string

ReposMergeResponseCommitVerification

ReposMergeResponseCommitVerification: object

Type declaration

  • payload: null
  • reason: string
  • signature: null
  • verified: boolean

ReposMergeResponseCommitter

ReposMergeResponseCommitter: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposMergeResponseParentsItem

ReposMergeResponseParentsItem: object

Type declaration

  • sha: string
  • url: string

ReposPingHookParams

ReposPingHookParams: object

Type declaration

  • hook_id: number
  • owner: string
  • repo: string

ReposRemoveBranchProtectionParams

ReposRemoveBranchProtectionParams: object

Type declaration

  • branch: string
  • owner: string
  • repo: string

ReposRemoveCollaboratorParams

ReposRemoveCollaboratorParams: object

Type declaration

  • owner: string
  • repo: string
  • username: string

ReposRemoveDeployKeyParams

ReposRemoveDeployKeyParams: object

Type declaration

  • key_id: number
  • owner: string
  • repo: string

ReposRemoveProtectedBranchAdminEnforcementParams

ReposRemoveProtectedBranchAdminEnforcementParams: object

Type declaration

  • branch: string
  • owner: string
  • repo: string

ReposRemoveProtectedBranchAppRestrictionsParams

ReposRemoveProtectedBranchAppRestrictionsParams: object

Type declaration

  • apps: string[]
  • branch: string
  • owner: string
  • repo: string

ReposRemoveProtectedBranchAppRestrictionsResponse

ReposRemoveProtectedBranchAppRestrictionsResponse: Array<ReposRemoveProtectedBranchAppRestrictionsResponseItem>

ReposRemoveProtectedBranchAppRestrictionsResponseItem

ReposRemoveProtectedBranchAppRestrictionsResponseItem: object

Type declaration

ReposRemoveProtectedBranchAppRestrictionsResponseItemOwner

ReposRemoveProtectedBranchAppRestrictionsResponseItemOwner: 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

ReposRemoveProtectedBranchAppRestrictionsResponseItemPermissions

ReposRemoveProtectedBranchAppRestrictionsResponseItemPermissions: object

Type declaration

  • contents: string
  • issues: string
  • metadata: string
  • single_file: string

ReposRemoveProtectedBranchPullRequestReviewEnforcementParams

ReposRemoveProtectedBranchPullRequestReviewEnforcementParams: object

Type declaration

  • branch: string
  • owner: string
  • repo: string

ReposRemoveProtectedBranchRequiredSignaturesParams

ReposRemoveProtectedBranchRequiredSignaturesParams: object

Type declaration

  • branch: string
  • owner: string
  • repo: string

ReposRemoveProtectedBranchRequiredStatusChecksContextsParams

ReposRemoveProtectedBranchRequiredStatusChecksContextsParams: object

Type declaration

  • branch: string
  • contexts: string[]
  • owner: string
  • repo: string

ReposRemoveProtectedBranchRequiredStatusChecksContextsResponse

ReposRemoveProtectedBranchRequiredStatusChecksContextsResponse: Array<string>

ReposRemoveProtectedBranchRequiredStatusChecksParams

ReposRemoveProtectedBranchRequiredStatusChecksParams: object

Type declaration

  • branch: string
  • owner: string
  • repo: string

ReposRemoveProtectedBranchRestrictionsParams

ReposRemoveProtectedBranchRestrictionsParams: object

Type declaration

  • branch: string
  • owner: string
  • repo: string

ReposRemoveProtectedBranchTeamRestrictionsParams

ReposRemoveProtectedBranchTeamRestrictionsParams: object

Type declaration

  • branch: string
  • owner: string
  • repo: string
  • teams: string[]

ReposRemoveProtectedBranchTeamRestrictionsResponse

ReposRemoveProtectedBranchTeamRestrictionsResponse: Array<ReposRemoveProtectedBranchTeamRestrictionsResponseItem>

ReposRemoveProtectedBranchTeamRestrictionsResponseItem

ReposRemoveProtectedBranchTeamRestrictionsResponseItem: 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

ReposRemoveProtectedBranchUserRestrictionsParams

ReposRemoveProtectedBranchUserRestrictionsParams: object

Type declaration

  • branch: string
  • owner: string
  • repo: string
  • users: string[]

ReposRemoveProtectedBranchUserRestrictionsResponse

ReposRemoveProtectedBranchUserRestrictionsResponse: Array<ReposRemoveProtectedBranchUserRestrictionsResponseItem>

ReposRemoveProtectedBranchUserRestrictionsResponseItem

ReposRemoveProtectedBranchUserRestrictionsResponseItem: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposReplaceProtectedBranchAppRestrictionsParams

ReposReplaceProtectedBranchAppRestrictionsParams: object

Type declaration

  • apps: string[]
  • branch: string
  • owner: string
  • repo: string

ReposReplaceProtectedBranchAppRestrictionsResponse

ReposReplaceProtectedBranchAppRestrictionsResponse: Array<ReposReplaceProtectedBranchAppRestrictionsResponseItem>

ReposReplaceProtectedBranchAppRestrictionsResponseItem

ReposReplaceProtectedBranchAppRestrictionsResponseItem: object

Type declaration

ReposReplaceProtectedBranchAppRestrictionsResponseItemOwner

ReposReplaceProtectedBranchAppRestrictionsResponseItemOwner: 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

ReposReplaceProtectedBranchAppRestrictionsResponseItemPermissions

ReposReplaceProtectedBranchAppRestrictionsResponseItemPermissions: object

Type declaration

  • contents: string
  • issues: string
  • metadata: string
  • single_file: string

ReposReplaceProtectedBranchRequiredStatusChecksContextsParams

ReposReplaceProtectedBranchRequiredStatusChecksContextsParams: object

Type declaration

  • branch: string
  • contexts: string[]
  • owner: string
  • repo: string

ReposReplaceProtectedBranchRequiredStatusChecksContextsResponse

ReposReplaceProtectedBranchRequiredStatusChecksContextsResponse: Array<string>

ReposReplaceProtectedBranchTeamRestrictionsParams

ReposReplaceProtectedBranchTeamRestrictionsParams: object

Type declaration

  • branch: string
  • owner: string
  • repo: string
  • teams: string[]

ReposReplaceProtectedBranchTeamRestrictionsResponse

ReposReplaceProtectedBranchTeamRestrictionsResponse: Array<ReposReplaceProtectedBranchTeamRestrictionsResponseItem>

ReposReplaceProtectedBranchTeamRestrictionsResponseItem

ReposReplaceProtectedBranchTeamRestrictionsResponseItem: 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

ReposReplaceProtectedBranchUserRestrictionsParams

ReposReplaceProtectedBranchUserRestrictionsParams: object

Type declaration

  • branch: string
  • owner: string
  • repo: string
  • users: string[]

ReposReplaceProtectedBranchUserRestrictionsResponse

ReposReplaceProtectedBranchUserRestrictionsResponse: Array<ReposReplaceProtectedBranchUserRestrictionsResponseItem>

ReposReplaceProtectedBranchUserRestrictionsResponseItem

ReposReplaceProtectedBranchUserRestrictionsResponseItem: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposReplaceTopicsParams

ReposReplaceTopicsParams: object

Type declaration

  • names: string[]

    An array of topics to add to the repository. Pass one or more topics to replace the set of existing topics. Send an empty array ([]) to clear all topics from the repository. Note: Topic names cannot contain uppercase letters.

  • owner: string
  • repo: string

ReposReplaceTopicsResponse

ReposReplaceTopicsResponse: object

Type declaration

  • names: Array<string>

ReposRequestPageBuildParams

ReposRequestPageBuildParams: object

Type declaration

  • owner: string
  • repo: string

ReposRequestPageBuildResponse

ReposRequestPageBuildResponse: object

Type declaration

  • status: string
  • url: string

ReposRetrieveCommunityProfileMetricsParams

ReposRetrieveCommunityProfileMetricsParams: object

Type declaration

  • owner: string
  • repo: string

ReposRetrieveCommunityProfileMetricsResponse

ReposRetrieveCommunityProfileMetricsResponse: object

Type declaration

ReposRetrieveCommunityProfileMetricsResponseFiles

ReposRetrieveCommunityProfileMetricsResponseFiles: object

Type declaration

ReposRetrieveCommunityProfileMetricsResponseFilesCodeOfConduct

ReposRetrieveCommunityProfileMetricsResponseFilesCodeOfConduct: object

Type declaration

  • html_url: string
  • key: string
  • name: string
  • url: string

ReposRetrieveCommunityProfileMetricsResponseFilesContributing

ReposRetrieveCommunityProfileMetricsResponseFilesContributing: object

Type declaration

  • html_url: string
  • url: string

ReposRetrieveCommunityProfileMetricsResponseFilesIssueTemplate

ReposRetrieveCommunityProfileMetricsResponseFilesIssueTemplate: object

Type declaration

  • html_url: string
  • url: string

ReposRetrieveCommunityProfileMetricsResponseFilesLicense

ReposRetrieveCommunityProfileMetricsResponseFilesLicense: object

Type declaration

  • html_url: string
  • key: string
  • name: string
  • spdx_id: string
  • url: string

ReposRetrieveCommunityProfileMetricsResponseFilesPullRequestTemplate

ReposRetrieveCommunityProfileMetricsResponseFilesPullRequestTemplate: object

Type declaration

  • html_url: string
  • url: string

ReposRetrieveCommunityProfileMetricsResponseFilesReadme

ReposRetrieveCommunityProfileMetricsResponseFilesReadme: object

Type declaration

  • html_url: string
  • url: string

ReposTestPushHookParams

ReposTestPushHookParams: object

Type declaration

  • hook_id: number
  • owner: string
  • repo: string

ReposTransferParams

ReposTransferParams: object

Type declaration

  • Optional new_owner?: undefined | string

    Required: The username or organization name the repository will be transferred to.

  • owner: string
  • repo: string
  • Optional team_ids?: number[]

    ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.

ReposTransferResponse

ReposTransferResponse: 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: ReposTransferResponseOwner
  • permissions: ReposTransferResponsePermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

ReposTransferResponseOwner

ReposTransferResponseOwner: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposTransferResponsePermissions

ReposTransferResponsePermissions: object

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

ReposUpdateBranchProtectionParams

ReposUpdateBranchProtectionParams: object

Type declaration

  • branch: string
  • enforce_admins: boolean | null

    Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

  • owner: string
  • repo: string
  • 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 this branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

ReposUpdateBranchProtectionParamsRequiredPullRequestReviews

ReposUpdateBranchProtectionParamsRequiredPullRequestReviews: object

Type declaration

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[]

ReposUpdateBranchProtectionResponse

ReposUpdateBranchProtectionResponse: object

Type declaration

ReposUpdateBranchProtectionResponseEnforceAdmins

ReposUpdateBranchProtectionResponseEnforceAdmins: object

Type declaration

  • enabled: boolean
  • url: string

ReposUpdateBranchProtectionResponseRequiredPullRequestReviews

ReposUpdateBranchProtectionResponseRequiredPullRequestReviews: object

Type declaration

ReposUpdateBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictions

ReposUpdateBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictions: object

Type declaration

ReposUpdateBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictionsTeamsItem

ReposUpdateBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictionsTeamsItem: 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

ReposUpdateBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictionsUsersItem

ReposUpdateBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictionsUsersItem: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposUpdateBranchProtectionResponseRequiredStatusChecks

ReposUpdateBranchProtectionResponseRequiredStatusChecks: object

Type declaration

  • contexts: Array<string>
  • contexts_url: string
  • strict: boolean
  • url: string

ReposUpdateBranchProtectionResponseRestrictions

ReposUpdateBranchProtectionResponseRestrictions: object

Type declaration

ReposUpdateBranchProtectionResponseRestrictionsAppsItem

ReposUpdateBranchProtectionResponseRestrictionsAppsItem: object

Type declaration

ReposUpdateBranchProtectionResponseRestrictionsAppsItemOwner

ReposUpdateBranchProtectionResponseRestrictionsAppsItemOwner: 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

ReposUpdateBranchProtectionResponseRestrictionsAppsItemPermissions

ReposUpdateBranchProtectionResponseRestrictionsAppsItemPermissions: object

Type declaration

  • contents: string
  • issues: string
  • metadata: string
  • single_file: string

ReposUpdateBranchProtectionResponseRestrictionsTeamsItem

ReposUpdateBranchProtectionResponseRestrictionsTeamsItem: 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

ReposUpdateBranchProtectionResponseRestrictionsUsersItem

ReposUpdateBranchProtectionResponseRestrictionsUsersItem: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposUpdateCommitCommentParams

ReposUpdateCommitCommentParams: object

Type declaration

  • body: string

    The contents of the comment

  • comment_id: number
  • owner: string
  • repo: string

ReposUpdateCommitCommentResponse

ReposUpdateCommitCommentResponse: 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: ReposUpdateCommitCommentResponseUser

ReposUpdateCommitCommentResponseUser

ReposUpdateCommitCommentResponseUser: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposUpdateFileParams

ReposUpdateFileParams: object

Type declaration

  • Optional author?: ReposUpdateFileParamsAuthor

    The author of the file. Default: The committer or the authenticated user if you omit committer.

  • Optional branch?: undefined | string

    The branch name. Default: the repository’s default branch (usually master)

  • Optional committer?: ReposUpdateFileParamsCommitter

    The person that committed the file. Default: the authenticated user.

  • content: string

    The new file content, using Base64 encoding.

  • message: string

    The commit message.

  • owner: string
  • path: string
  • repo: string
  • Optional sha?: undefined | string

    Required if you are updating a file. The blob SHA of the file being replaced.

ReposUpdateFileParamsAuthor

ReposUpdateFileParamsAuthor: object

Type declaration

  • email: string
  • name: string

ReposUpdateFileParamsCommitter

ReposUpdateFileParamsCommitter: object

Type declaration

  • email: string
  • name: string

ReposUpdateFileResponse

ReposUpdateFileResponse: object

Type declaration

ReposUpdateFileResponseCommit

ReposUpdateFileResponseCommit: object

Type declaration

ReposUpdateFileResponseCommitAuthor

ReposUpdateFileResponseCommitAuthor: object

Type declaration

  • date: string
  • email: string
  • name: string

ReposUpdateFileResponseCommitCommitter

ReposUpdateFileResponseCommitCommitter: object

Type declaration

  • date: string
  • email: string
  • name: string

ReposUpdateFileResponseCommitParentsItem

ReposUpdateFileResponseCommitParentsItem: object

Type declaration

  • html_url: string
  • sha: string
  • url: string

ReposUpdateFileResponseCommitTree

ReposUpdateFileResponseCommitTree: object

Type declaration

  • sha: string
  • url: string

ReposUpdateFileResponseCommitVerification

ReposUpdateFileResponseCommitVerification: object

Type declaration

  • payload: null
  • reason: string
  • signature: null
  • verified: boolean

ReposUpdateFileResponseContent

ReposUpdateFileResponseContent: object

Type declaration

  • _links: ReposUpdateFileResponseContentLinks
  • download_url: string
  • git_url: string
  • html_url: string
  • name: string
  • path: string
  • sha: string
  • size: number
  • type: string
  • url: string

ReposUpdateFileResponseContentLinks

ReposUpdateFileResponseContentLinks: object

Type declaration

  • git: string
  • html: string
  • self: string

ReposUpdateHookParams

ReposUpdateHookParams: object

Type declaration

  • Optional active?: undefined | false | true

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

  • Optional add_events?: string[]

    Determines a list of events to be added to the list of events that the Hook triggers for.

  • Optional config?: ReposUpdateHookParamsConfig

    Key/value pairs to provide settings for this webhook. These are defined below.

  • Optional events?: string[]

    Determines what events the hook is triggered for. This replaces the entire array of events.

  • hook_id: number
  • owner: string
  • Optional remove_events?: string[]

    Determines a list of events to be removed from the list of events that the Hook triggers for.

  • repo: string

ReposUpdateHookParamsConfig

ReposUpdateHookParamsConfig: object

Type declaration

  • Optional content_type?: undefined | string
  • Optional insecure_ssl?: undefined | string
  • Optional secret?: undefined | string
  • url: string

ReposUpdateHookResponse

ReposUpdateHookResponse: object

Type declaration

ReposUpdateHookResponseConfig

ReposUpdateHookResponseConfig: object

Type declaration

  • content_type: string
  • insecure_ssl: string
  • url: string

ReposUpdateHookResponseLastResponse

ReposUpdateHookResponseLastResponse: object

Type declaration

  • code: null
  • message: null
  • status: string

ReposUpdateInformationAboutPagesSiteParams

ReposUpdateInformationAboutPagesSiteParams: object

Type declaration

  • Optional cname?: undefined | string

    Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see "Using a custom domain with GitHub Pages."

  • owner: string
  • repo: string
  • Optional source?: ""gh-pages"" | ""master"" | ""master /docs""

    Update the source for the repository. Must include the branch name, and may optionally specify the subdirectory /docs. Possible values are "gh-pages", "master", and "master /docs".

ReposUpdateInvitationParams

ReposUpdateInvitationParams: object

Type declaration

  • invitation_id: number
  • owner: string
  • Optional permissions?: "read" | "write" | "admin"

    The permissions that the associated user will have on the repository. Valid values are read, write, and admin.

  • repo: string

ReposUpdateInvitationResponse

ReposUpdateInvitationResponse: object

Type declaration

ReposUpdateInvitationResponseInvitee

ReposUpdateInvitationResponseInvitee: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposUpdateInvitationResponseInviter

ReposUpdateInvitationResponseInviter: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposUpdateInvitationResponseRepository

ReposUpdateInvitationResponseRepository: 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: ReposUpdateInvitationResponseRepositoryOwner
  • private: boolean
  • pulls_url: string
  • releases_url: string
  • ssh_url: string
  • stargazers_url: string
  • statuses_url: string
  • subscribers_url: string
  • subscription_url: string
  • tags_url: string
  • teams_url: string
  • trees_url: string
  • url: string

ReposUpdateInvitationResponseRepositoryOwner

ReposUpdateInvitationResponseRepositoryOwner: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposUpdateParams

ReposUpdateParams: object

Type declaration

  • Optional allow_merge_commit?: undefined | false | true

    Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

  • Optional allow_rebase_merge?: undefined | false | true

    Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

  • Optional allow_squash_merge?: undefined | false | true

    Either true to allow squash-merging pull requests, or false to prevent squash-merging.

  • Optional archived?: undefined | false | true

    true to archive this repository. Note: You cannot unarchive repositories through the API.

  • Optional default_branch?: undefined | string

    Updates the default branch for this repository.

  • Optional description?: undefined | string

    A short description of the repository.

  • Optional has_issues?: undefined | false | true

    Either true to enable issues for this repository or false to disable them.

  • Optional has_projects?: undefined | false | true

    Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

  • Optional has_wiki?: undefined | false | true

    Either true to enable the wiki for this repository or false to disable it.

  • Optional homepage?: undefined | string

    A URL with more information about the repository.

  • Optional is_template?: undefined | false | true

    Either true to make this repo available as a template repository or false to prevent it.

  • Optional name?: undefined | string

    The name of the repository.

  • owner: string
  • Optional private?: undefined | false | true

    Either true to make the repository private or false to make it public. Creating private repositories requires a paid GitHub account. Default: false. Note: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private. Note: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.

  • repo: string

ReposUpdateProtectedBranchPullRequestReviewEnforcementParams

ReposUpdateProtectedBranchPullRequestReviewEnforcementParams: object

Type declaration

  • branch: string
  • Optional dismiss_stale_reviews?: undefined | false | true

    Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

  • Optional dismissal_restrictions?: ReposUpdateProtectedBranchPullRequestReviewEnforcementParamsDismissalRestrictions

    Specify which users and teams can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

  • owner: string
  • repo: string
  • Optional require_code_owner_reviews?: undefined | false | true

    Blocks merging pull requests until code owners have reviewed.

  • Optional required_approving_review_count?: undefined | number

    Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6.

ReposUpdateProtectedBranchPullRequestReviewEnforcementParamsDismissalRestrictions

ReposUpdateProtectedBranchPullRequestReviewEnforcementParamsDismissalRestrictions: object

Type declaration

  • Optional teams?: string[]
  • Optional users?: string[]

ReposUpdateProtectedBranchPullRequestReviewEnforcementResponse

ReposUpdateProtectedBranchPullRequestReviewEnforcementResponse: object

Type declaration

ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictions

ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictions: object

Type declaration

ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictionsTeamsItem

ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictionsTeamsItem: 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

ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictionsUsersItem

ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictionsUsersItem: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposUpdateProtectedBranchRequiredStatusChecksParams

ReposUpdateProtectedBranchRequiredStatusChecksParams: object

Type declaration

  • branch: string
  • Optional contexts?: string[]

    The list of status checks to require in order to merge into this branch

  • owner: string
  • repo: string
  • Optional strict?: undefined | false | true

    Require branches to be up to date before merging.

ReposUpdateProtectedBranchRequiredStatusChecksResponse

ReposUpdateProtectedBranchRequiredStatusChecksResponse: object

Type declaration

  • contexts: Array<string>
  • contexts_url: string
  • strict: boolean
  • url: string

ReposUpdateReleaseAssetParams

ReposUpdateReleaseAssetParams: object

Type declaration

  • asset_id: number
  • Optional label?: undefined | string

    An alternate short description of the asset. Used in place of the filename.

  • Optional name?: undefined | string

    The file name of the asset.

  • owner: string
  • repo: string

ReposUpdateReleaseAssetResponse

ReposUpdateReleaseAssetResponse: 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: ReposUpdateReleaseAssetResponseUploader
  • url: string

ReposUpdateReleaseAssetResponseUploader

ReposUpdateReleaseAssetResponseUploader: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposUpdateReleaseParams

ReposUpdateReleaseParams: object

Type declaration

  • Optional body?: undefined | string

    Text describing the contents of the tag.

  • Optional draft?: undefined | false | true

    true makes the release a draft, and false publishes the release.

  • Optional name?: undefined | string

    The name of the release.

  • owner: string
  • Optional prerelease?: undefined | false | true

    true to identify the release as a prerelease, false to identify the release as a full release.

  • release_id: number
  • repo: string
  • Optional tag_name?: undefined | string

    The name of the tag.

  • Optional target_commitish?: undefined | string

    Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

ReposUpdateReleaseResponse

ReposUpdateReleaseResponse: object

Type declaration

  • assets: Array<ReposUpdateReleaseResponseAssetsItem>
  • assets_url: string
  • author: ReposUpdateReleaseResponseAuthor
  • body: string
  • created_at: string
  • draft: boolean
  • html_url: string
  • id: number
  • name: string
  • node_id: string
  • prerelease: boolean
  • published_at: string
  • tag_name: string
  • tarball_url: string
  • target_commitish: string
  • upload_url: string
  • url: string
  • zipball_url: string

ReposUpdateReleaseResponseAssetsItem

ReposUpdateReleaseResponseAssetsItem: 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: ReposUpdateReleaseResponseAssetsItemUploader
  • url: string

ReposUpdateReleaseResponseAssetsItemUploader

ReposUpdateReleaseResponseAssetsItemUploader: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposUpdateReleaseResponseAuthor

ReposUpdateReleaseResponseAuthor: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposUpdateResponse

ReposUpdateResponse: 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: ReposUpdateResponseOrganization
  • owner: ReposUpdateResponseOwner
  • parent: ReposUpdateResponseParent
  • permissions: ReposUpdateResponsePermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • source: ReposUpdateResponseSource
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

ReposUpdateResponseOrganization

ReposUpdateResponseOrganization: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposUpdateResponseOwner

ReposUpdateResponseOwner: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposUpdateResponseParent

ReposUpdateResponseParent: 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: ReposUpdateResponseParentOwner
  • permissions: ReposUpdateResponseParentPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

ReposUpdateResponseParentOwner

ReposUpdateResponseParentOwner: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposUpdateResponseParentPermissions

ReposUpdateResponseParentPermissions: object

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

ReposUpdateResponsePermissions

ReposUpdateResponsePermissions: object

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

ReposUpdateResponseSource

ReposUpdateResponseSource: 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: ReposUpdateResponseSourceOwner
  • permissions: ReposUpdateResponseSourcePermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

ReposUpdateResponseSourceOwner

ReposUpdateResponseSourceOwner: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

ReposUpdateResponseSourcePermissions

ReposUpdateResponseSourcePermissions: object

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

ReposUploadReleaseAssetParams

ReposUploadReleaseAssetParams: object

Type declaration

  • file: string | object
  • headers: ReposUploadReleaseAssetParamsHeaders
  • Optional label?: undefined | string

    An alternate short description of the asset. Used in place of the filename. This should be set in a URI query parameter.

  • name: string

    The file name of the asset. This should be set in a URI query parameter.

  • url: string

    The upload_url key returned from creating or getting a release

ReposUploadReleaseAssetParamsHeaders

ReposUploadReleaseAssetParamsHeaders: object

Type declaration

  • content-length: number
  • content-type: string

ReposUploadReleaseAssetResponse

ReposUploadReleaseAssetResponse: object

Type declaration

ReposUploadReleaseAssetResponseValue

ReposUploadReleaseAssetResponseValue: 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: ReposUploadReleaseAssetResponseValueUploader
  • url: string

ReposUploadReleaseAssetResponseValueUploader

ReposUploadReleaseAssetResponseValueUploader: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: 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?: undefined | string

    Avoid setting accept, use mediaFormat.{format|previews} instead.

  • Optional authorization?: undefined | string

    Use authorization to send authenticated request, remember token / bearer prefixes. Example: token 1234567890abcdef1234567890abcdef12345678

  • Optional user-agent?: undefined | string

    user-agent is set do a default and can be overwritten as needed.

RequestMethod

RequestMethod: "DELETE" | "GET" | "HEAD" | "PATCH" | "POST" | "PUT"

SearchCodeParams

SearchCodeParams: 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?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • q: string

    The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see Constructing a search query. See "Searching code" for a detailed list of qualifiers.

  • Optional sort?: undefined | "indexed"

    Sorts the results of your query. Can only be indexed, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: best match

SearchCodeResponse

SearchCodeResponse: object

Type declaration

SearchCodeResponseItemsItem

SearchCodeResponseItemsItem: object

Type declaration

SearchCodeResponseItemsItemRepository

SearchCodeResponseItemsItemRepository: 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: SearchCodeResponseItemsItemRepositoryOwner
  • private: boolean
  • pulls_url: string
  • stargazers_url: string
  • statuses_url: string
  • subscribers_url: string
  • subscription_url: string
  • tags_url: string
  • teams_url: string
  • trees_url: string
  • url: string

SearchCodeResponseItemsItemRepositoryOwner

SearchCodeResponseItemsItemRepositoryOwner: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

SearchCommitsParams

SearchCommitsParams: 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?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • q: string

    The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see Constructing a search query. See "Searching commits" for a detailed list of qualifiers.

  • Optional sort?: "author-date" | "committer-date"

    Sorts the results of your query by author-date or committer-date. Default: best match

SearchCommitsResponse

SearchCommitsResponse: object

Type declaration

SearchCommitsResponseItemsItem

SearchCommitsResponseItemsItem: object

Type declaration

SearchCommitsResponseItemsItemAuthor

SearchCommitsResponseItemsItemAuthor: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

SearchCommitsResponseItemsItemCommit

SearchCommitsResponseItemsItemCommit: object

Type declaration

SearchCommitsResponseItemsItemCommitAuthor

SearchCommitsResponseItemsItemCommitAuthor: object

Type declaration

  • date: string
  • email: string
  • name: string

SearchCommitsResponseItemsItemCommitCommitter

SearchCommitsResponseItemsItemCommitCommitter: object

Type declaration

  • date: string
  • email: string
  • name: string

SearchCommitsResponseItemsItemCommitTree

SearchCommitsResponseItemsItemCommitTree: object

Type declaration

  • sha: string
  • url: string

SearchCommitsResponseItemsItemCommitter

SearchCommitsResponseItemsItemCommitter: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

SearchCommitsResponseItemsItemParentsItem

SearchCommitsResponseItemsItemParentsItem: object

Type declaration

  • html_url: string
  • sha: string
  • url: string

SearchCommitsResponseItemsItemRepository

SearchCommitsResponseItemsItemRepository: 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: SearchCommitsResponseItemsItemRepositoryOwner
  • private: boolean
  • pulls_url: string
  • releases_url: string
  • stargazers_url: string
  • statuses_url: string
  • subscribers_url: string
  • subscription_url: string
  • tags_url: string
  • teams_url: string
  • trees_url: string
  • url: string

SearchCommitsResponseItemsItemRepositoryOwner

SearchCommitsResponseItemsItemRepositoryOwner: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

SearchIssuesAndPullRequestsParams

SearchIssuesAndPullRequestsParams: 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?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • q: string

    The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see Constructing a search query. See "Searching issues and pull requests" for a detailed list of qualifiers.

  • Optional sort?: "comments" | "reactions" | "reactions-+1" | "reactions--1" | "reactions-smile" | "reactions-thinking_face" | "reactions-heart" | "reactions-tada" | "interactions" | "created" | "updated"

    Sorts the results of your query by the number of comments, reactions, reactions-+1, reactions--1, reactions-smile, reactions-thinking_face, reactions-heart, reactions-tada, or interactions. You can also sort results by how recently the items were created or updated, Default: best match

SearchIssuesAndPullRequestsResponse

SearchIssuesAndPullRequestsResponse: object

Type declaration

SearchIssuesAndPullRequestsResponseItemsItem

SearchIssuesAndPullRequestsResponseItemsItem: object

Type declaration

SearchIssuesAndPullRequestsResponseItemsItemLabelsItem

SearchIssuesAndPullRequestsResponseItemsItemLabelsItem: object

Type declaration

  • color: string
  • id: number
  • name: string
  • node_id: string
  • url: string

SearchIssuesAndPullRequestsResponseItemsItemPullRequest

SearchIssuesAndPullRequestsResponseItemsItemPullRequest: object

Type declaration

  • diff_url: null
  • html_url: null
  • patch_url: null

SearchIssuesAndPullRequestsResponseItemsItemUser

SearchIssuesAndPullRequestsResponseItemsItemUser: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: 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

SearchIssuesParams

SearchIssuesParams: 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?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • q: string

    The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see Constructing a search query. See "Searching issues and pull requests" for a detailed list of qualifiers.

  • Optional sort?: "comments" | "reactions" | "reactions-+1" | "reactions--1" | "reactions-smile" | "reactions-thinking_face" | "reactions-heart" | "reactions-tada" | "interactions" | "created" | "updated"

    Sorts the results of your query by the number of comments, reactions, reactions-+1, reactions--1, reactions-smile, reactions-thinking_face, reactions-heart, reactions-tada, or interactions. You can also sort results by how recently the items were created or updated, Default: best match

SearchIssuesResponse

SearchIssuesResponse: object

Type declaration

SearchIssuesResponseItemsItem

SearchIssuesResponseItemsItem: object

Type declaration

SearchIssuesResponseItemsItemLabelsItem

SearchIssuesResponseItemsItemLabelsItem: object

Type declaration

  • color: string
  • id: number
  • name: string
  • node_id: string
  • url: string

SearchIssuesResponseItemsItemPullRequest

SearchIssuesResponseItemsItemPullRequest: object

Type declaration

  • diff_url: null
  • html_url: null
  • patch_url: null

SearchIssuesResponseItemsItemUser

SearchIssuesResponseItemsItemUser: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

SearchLabelsParams

SearchLabelsParams: 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

SearchLabelsResponse

SearchLabelsResponse: object

Type declaration

SearchLabelsResponseItemsItem

SearchLabelsResponseItemsItem: object

Type declaration

  • color: string
  • default: boolean
  • description: string
  • id: number
  • name: string
  • node_id: string
  • score: number
  • url: string

SearchReposParams

SearchReposParams: 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?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • q: string

    The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see Constructing a search query. See "Searching for repositories" for a detailed list of qualifiers.

  • Optional sort?: "stars" | "forks" | "help-wanted-issues" | "updated"

    Sorts the results of your query by number of stars, forks, or help-wanted-issues or how recently the items were updated. Default: best match

SearchReposResponse

SearchReposResponse: object

Type declaration

SearchReposResponseItemsItem

SearchReposResponseItemsItem: 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: SearchReposResponseItemsItemOwner
  • private: boolean
  • pushed_at: string
  • score: number
  • size: number
  • stargazers_count: number
  • updated_at: string
  • url: string
  • watchers_count: number

SearchReposResponseItemsItemOwner

SearchReposResponseItemsItemOwner: object

Type declaration

  • avatar_url: string
  • gravatar_id: string
  • id: number
  • login: string
  • node_id: string
  • received_events_url: string
  • type: string
  • url: string

SearchTopicsParams

SearchTopicsParams: 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.

SearchTopicsResponse

SearchTopicsResponse: object

Type declaration

SearchTopicsResponseItemsItem

SearchTopicsResponseItemsItem: 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

SearchUsersParams

SearchUsersParams: 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?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • q: string

    The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see Constructing a search query. See "Searching users" for a detailed list of qualifiers.

  • Optional sort?: "followers" | "repositories" | "joined"

    Sorts the results of your query by number of followers or repositories, or when the person joined GitHub. Default: best match

SearchUsersResponse

SearchUsersResponse: object

Type declaration

SearchUsersResponseItemsItem

SearchUsersResponseItemsItem: 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

TeamsAddMemberParams

TeamsAddMemberParams: object

Type declaration

  • team_id: number
  • username: string

TeamsAddMemberResponse

TeamsAddMemberResponse: object

Type declaration

TeamsAddMemberResponseErrorsItem

TeamsAddMemberResponseErrorsItem: object

Type declaration

  • code: string
  • field: string
  • resource: string

TeamsAddOrUpdateMembershipParams

TeamsAddOrUpdateMembershipParams: 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
  • username: string

TeamsAddOrUpdateMembershipResponse

TeamsAddOrUpdateMembershipResponse: object

Type declaration

  • role: string
  • state: string
  • url: string

TeamsAddOrUpdateProjectParams

TeamsAddOrUpdateProjectParams: object

Type declaration

  • Optional permission?: "read" | "write" | "admin"

    The permission to grant to the team for this project. Can be one of: * read - team members can read, but not write to or administer this project. * write - team members can read and write, but not administer this project. * admin - team members can read, write and administer this project. Default: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs." Note: If you pass the hellcat-preview media type, you can promote—but not demote—a permission attribute inherited from a parent team.

  • project_id: number
  • team_id: number

TeamsAddOrUpdateProjectResponse

TeamsAddOrUpdateProjectResponse: object

Type declaration

  • documentation_url: string
  • message: string

TeamsAddOrUpdateRepoParams

TeamsAddOrUpdateRepoParams: object

Type declaration

  • owner: string
  • Optional permission?: "pull" | "push" | "admin"

    The permission to grant the team on this repository. Can be one of: * pull - team members can pull, but not push to or administer this repository. * push - team members can pull and push, but not administer this repository. * admin - team members can pull, push and administer this repository.

    If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository. Note: If you pass the hellcat-preview media type, you can promote—but not demote—a permission attribute inherited through a parent team.

  • repo: string
  • team_id: number

TeamsCheckManagesRepoParams

TeamsCheckManagesRepoParams: object

Type declaration

  • owner: string
  • repo: string
  • team_id: number

TeamsCheckManagesRepoResponse

TeamsCheckManagesRepoResponse: 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: TeamsCheckManagesRepoResponseOwner
  • permissions: TeamsCheckManagesRepoResponsePermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

TeamsCheckManagesRepoResponseOwner

TeamsCheckManagesRepoResponseOwner: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

TeamsCheckManagesRepoResponsePermissions

TeamsCheckManagesRepoResponsePermissions: object

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

TeamsCreateDiscussionCommentParams

TeamsCreateDiscussionCommentParams: object

Type declaration

  • body: string

    The discussion comment's body text.

  • discussion_number: number
  • team_id: number

TeamsCreateDiscussionCommentResponse

TeamsCreateDiscussionCommentResponse: object

Type declaration

TeamsCreateDiscussionCommentResponseAuthor

TeamsCreateDiscussionCommentResponseAuthor: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

TeamsCreateDiscussionCommentResponseReactions

TeamsCreateDiscussionCommentResponseReactions: object

Type declaration

  • +1: number
  • -1: number
  • confused: number
  • heart: number
  • hooray: number
  • laugh: number
  • total_count: number
  • url: string

TeamsCreateDiscussionParams

TeamsCreateDiscussionParams: object

Type declaration

  • body: string

    The discussion post's body text.

  • Optional private?: undefined | false | true

    Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.

  • team_id: number
  • title: string

    The discussion post's title.

TeamsCreateDiscussionResponse

TeamsCreateDiscussionResponse: object

Type declaration

  • author: TeamsCreateDiscussionResponseAuthor
  • body: string
  • body_html: string
  • body_version: string
  • comments_count: number
  • comments_url: string
  • created_at: string
  • html_url: string
  • last_edited_at: null
  • node_id: string
  • number: number
  • pinned: boolean
  • private: boolean
  • reactions: TeamsCreateDiscussionResponseReactions
  • team_url: string
  • title: string
  • updated_at: string
  • url: string

TeamsCreateDiscussionResponseAuthor

TeamsCreateDiscussionResponseAuthor: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

TeamsCreateDiscussionResponseReactions

TeamsCreateDiscussionResponseReactions: object

Type declaration

  • +1: number
  • -1: number
  • confused: number
  • heart: number
  • hooray: number
  • laugh: number
  • total_count: number
  • url: string

TeamsCreateParams

TeamsCreateParams: object

Type declaration

  • Optional description?: undefined | string

    The description of the team.

  • Optional maintainers?: string[]

    The logins of organization members to add as maintainers of the team.

  • name: string

    The name of the team.

  • org: string
  • Optional parent_team_id?: undefined | number

    The ID of a team to set as the parent team. Note: You must pass the hellcat-preview media type to use this parameter.

  • 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 Note: You must pass the hellcat-preview media type to set privacy default to closed for child teams.

  • Optional repo_names?: string[]

    The full name (e.g., "organization-name/repository-name") of repositories to add the team to.

TeamsCreateParamsDeprecatedPermission

TeamsCreateParamsDeprecatedPermission: object

Type declaration

  • Optional description?: undefined | string

    The description of the team.

  • Optional maintainers?: string[]

    The logins of organization members to add as maintainers of the team.

  • name: string

    The name of the team.

  • org: string
  • Optional parent_team_id?: undefined | number

    The ID of a team to set as the parent team. Note: You must pass the hellcat-preview media type to use this parameter.

  • Optional permission?: undefined | string

    Deprecated. The permission that new repositories will be added to the team with when none is specified. Can be one of: * pull - team members can pull, but not push to or administer newly-added repositories. * push - team members can pull and push, but not administer newly-added repositories. * admin - team members can pull, push and administer newly-added repositories.

    deprecated

    "permission" parameter has been deprecated and will be removed in future

  • Optional privacy?: "secret" | "closed"

    The level of privacy this team should have. The options are: For a non-nested team: * secret - only visible to organization owners and members of this team. * closed - visible to all members of this organization. Default: secret For a parent or child team: * closed - visible to all members of this organization. Default for child team: closed Note: You must pass the hellcat-preview media type to set privacy default to closed for child teams.

  • Optional repo_names?: string[]

    The full name (e.g., "organization-name/repository-name") of repositories to add the team to.

TeamsCreateResponse

TeamsCreateResponse: 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: TeamsCreateResponseOrganization
  • parent: null
  • permission: string
  • privacy: string
  • repos_count: number
  • repositories_url: string
  • slug: string
  • updated_at: string
  • url: string

TeamsCreateResponseOrganization

TeamsCreateResponseOrganization: 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

TeamsDeleteDiscussionCommentParams

TeamsDeleteDiscussionCommentParams: object

Type declaration

  • comment_number: number
  • discussion_number: number
  • team_id: number

TeamsDeleteDiscussionParams

TeamsDeleteDiscussionParams: object

Type declaration

  • discussion_number: number
  • team_id: number

TeamsDeleteParams

TeamsDeleteParams: object

Type declaration

  • team_id: number

TeamsGetByNameParams

TeamsGetByNameParams: object

Type declaration

  • org: string
  • team_slug: string

TeamsGetByNameResponse

TeamsGetByNameResponse: 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: TeamsGetByNameResponseOrganization
  • parent: null
  • permission: string
  • privacy: string
  • repos_count: number
  • repositories_url: string
  • slug: string
  • updated_at: string
  • url: string

TeamsGetByNameResponseOrganization

TeamsGetByNameResponseOrganization: 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

TeamsGetDiscussionCommentParams

TeamsGetDiscussionCommentParams: object

Type declaration

  • comment_number: number
  • discussion_number: number
  • team_id: number

TeamsGetDiscussionCommentResponse

TeamsGetDiscussionCommentResponse: object

Type declaration

TeamsGetDiscussionCommentResponseAuthor

TeamsGetDiscussionCommentResponseAuthor: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

TeamsGetDiscussionCommentResponseReactions

TeamsGetDiscussionCommentResponseReactions: object

Type declaration

  • +1: number
  • -1: number
  • confused: number
  • heart: number
  • hooray: number
  • laugh: number
  • total_count: number
  • url: string

TeamsGetDiscussionParams

TeamsGetDiscussionParams: object

Type declaration

  • discussion_number: number
  • team_id: number

TeamsGetDiscussionResponse

TeamsGetDiscussionResponse: object

Type declaration

  • author: TeamsGetDiscussionResponseAuthor
  • body: string
  • body_html: string
  • body_version: string
  • comments_count: number
  • comments_url: string
  • created_at: string
  • html_url: string
  • last_edited_at: null
  • node_id: string
  • number: number
  • pinned: boolean
  • private: boolean
  • reactions: TeamsGetDiscussionResponseReactions
  • team_url: string
  • title: string
  • updated_at: string
  • url: string

TeamsGetDiscussionResponseAuthor

TeamsGetDiscussionResponseAuthor: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

TeamsGetDiscussionResponseReactions

TeamsGetDiscussionResponseReactions: object

Type declaration

  • +1: number
  • -1: number
  • confused: number
  • heart: number
  • hooray: number
  • laugh: number
  • total_count: number
  • url: string

TeamsGetMemberParams

TeamsGetMemberParams: object

Type declaration

  • team_id: number
  • username: string

TeamsGetMembershipParams

TeamsGetMembershipParams: object

Type declaration

  • team_id: number
  • username: string

TeamsGetMembershipResponse

TeamsGetMembershipResponse: object

Type declaration

  • role: string
  • state: string
  • url: string

TeamsGetParams

TeamsGetParams: object

Type declaration

  • team_id: number

TeamsGetResponse

TeamsGetResponse: 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: TeamsGetResponseOrganization
  • parent: null
  • permission: string
  • privacy: string
  • repos_count: number
  • repositories_url: string
  • slug: string
  • updated_at: string
  • url: string

TeamsGetResponseOrganization

TeamsGetResponseOrganization: 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

TeamsListChildParams

TeamsListChildParams: object

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • team_id: number

TeamsListChildResponse

TeamsListChildResponse: Array<TeamsListChildResponseItem>

TeamsListChildResponseItem

TeamsListChildResponseItem: object

Type declaration

  • description: string
  • id: number
  • members_url: string
  • name: string
  • node_id: string
  • parent: TeamsListChildResponseItemParent
  • permission: string
  • privacy: string
  • repositories_url: string
  • slug: string
  • url: string

TeamsListChildResponseItemParent

TeamsListChildResponseItemParent: 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

TeamsListDiscussionCommentsParams

TeamsListDiscussionCommentsParams: 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
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • team_id: number

TeamsListDiscussionCommentsResponse

TeamsListDiscussionCommentsResponse: Array<TeamsListDiscussionCommentsResponseItem>

TeamsListDiscussionCommentsResponseItem

TeamsListDiscussionCommentsResponseItem: object

Type declaration

TeamsListDiscussionCommentsResponseItemAuthor

TeamsListDiscussionCommentsResponseItemAuthor: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

TeamsListDiscussionCommentsResponseItemReactions

TeamsListDiscussionCommentsResponseItemReactions: object

Type declaration

  • +1: number
  • -1: number
  • confused: number
  • heart: number
  • hooray: number
  • laugh: number
  • total_count: number
  • url: string

TeamsListDiscussionsParams

TeamsListDiscussionsParams: 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?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • team_id: number

TeamsListDiscussionsResponse

TeamsListDiscussionsResponse: Array<TeamsListDiscussionsResponseItem>

TeamsListDiscussionsResponseItem

TeamsListDiscussionsResponseItem: object

Type declaration

TeamsListDiscussionsResponseItemAuthor

TeamsListDiscussionsResponseItemAuthor: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

TeamsListDiscussionsResponseItemReactions

TeamsListDiscussionsResponseItemReactions: object

Type declaration

  • +1: number
  • -1: number
  • confused: number
  • heart: number
  • hooray: number
  • laugh: number
  • total_count: number
  • url: string

TeamsListForAuthenticatedUserParams

TeamsListForAuthenticatedUserParams: object

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

TeamsListForAuthenticatedUserResponse

TeamsListForAuthenticatedUserResponse: Array<TeamsListForAuthenticatedUserResponseItem>

TeamsListForAuthenticatedUserResponseItem

TeamsListForAuthenticatedUserResponseItem: 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: TeamsListForAuthenticatedUserResponseItemOrganization
  • parent: null
  • permission: string
  • privacy: string
  • repos_count: number
  • repositories_url: string
  • slug: string
  • updated_at: string
  • url: string

TeamsListForAuthenticatedUserResponseItemOrganization

TeamsListForAuthenticatedUserResponseItemOrganization: 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

TeamsListMembersParams

TeamsListMembersParams: object

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • Optional role?: "member" | "maintainer" | "all"

    Filters members returned by their role in the team. Can be one of: * member - normal members of the team. * maintainer - team maintainers. * all - all members of the team.

  • team_id: number

TeamsListMembersResponse

TeamsListMembersResponse: Array<TeamsListMembersResponseItem>

TeamsListMembersResponseItem

TeamsListMembersResponseItem: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

TeamsListParams

TeamsListParams: object

Type declaration

  • org: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

TeamsListPendingInvitationsParams

TeamsListPendingInvitationsParams: object

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • team_id: number

TeamsListPendingInvitationsResponse

TeamsListPendingInvitationsResponse: Array<TeamsListPendingInvitationsResponseItem>

TeamsListPendingInvitationsResponseItem

TeamsListPendingInvitationsResponseItem: object

Type declaration

TeamsListPendingInvitationsResponseItemInviter

TeamsListPendingInvitationsResponseItemInviter: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

TeamsListProjectsParams

TeamsListProjectsParams: object

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • team_id: number

TeamsListProjectsResponse

TeamsListProjectsResponse: Array<TeamsListProjectsResponseItem>

TeamsListProjectsResponseItem

TeamsListProjectsResponseItem: object

Type declaration

TeamsListProjectsResponseItemCreator

TeamsListProjectsResponseItemCreator: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

TeamsListProjectsResponseItemPermissions

TeamsListProjectsResponseItemPermissions: object

Type declaration

  • admin: boolean
  • read: boolean
  • write: boolean

TeamsListReposParams

TeamsListReposParams: object

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • team_id: number

TeamsListReposResponse

TeamsListReposResponse: Array<TeamsListReposResponseItem>

TeamsListReposResponseItem

TeamsListReposResponseItem: 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: TeamsListReposResponseItemLicense
  • merges_url: string
  • milestones_url: string
  • mirror_url: string
  • name: string
  • network_count: number
  • node_id: string
  • notifications_url: string
  • open_issues_count: number
  • owner: TeamsListReposResponseItemOwner
  • permissions: TeamsListReposResponseItemPermissions
  • private: boolean
  • pulls_url: string
  • pushed_at: string
  • releases_url: string
  • size: number
  • ssh_url: string
  • stargazers_count: number
  • stargazers_url: string
  • statuses_url: string
  • subscribers_count: number
  • subscribers_url: string
  • subscription_url: string
  • svn_url: string
  • tags_url: string
  • teams_url: string
  • template_repository: null
  • topics: Array<string>
  • trees_url: string
  • updated_at: string
  • url: string
  • watchers_count: number

TeamsListReposResponseItemLicense

TeamsListReposResponseItemLicense: object

Type declaration

  • key: string
  • name: string
  • node_id: string
  • spdx_id: string
  • url: string

TeamsListReposResponseItemOwner

TeamsListReposResponseItemOwner: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

TeamsListReposResponseItemPermissions

TeamsListReposResponseItemPermissions: object

Type declaration

  • admin: boolean
  • pull: boolean
  • push: boolean

TeamsListResponse

TeamsListResponse: Array<TeamsListResponseItem>

TeamsListResponseItem

TeamsListResponseItem: 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

TeamsRemoveMemberParams

TeamsRemoveMemberParams: object

Type declaration

  • team_id: number
  • username: string

TeamsRemoveMembershipParams

TeamsRemoveMembershipParams: object

Type declaration

  • team_id: number
  • username: string

TeamsRemoveProjectParams

TeamsRemoveProjectParams: object

Type declaration

  • project_id: number
  • team_id: number

TeamsRemoveRepoParams

TeamsRemoveRepoParams: object

Type declaration

  • owner: string
  • repo: string
  • team_id: number

TeamsReviewProjectParams

TeamsReviewProjectParams: object

Type declaration

  • project_id: number
  • team_id: number

TeamsReviewProjectResponse

TeamsReviewProjectResponse: object

Type declaration

TeamsReviewProjectResponseCreator

TeamsReviewProjectResponseCreator: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

TeamsReviewProjectResponsePermissions

TeamsReviewProjectResponsePermissions: object

Type declaration

  • admin: boolean
  • read: boolean
  • write: boolean

TeamsUpdateDiscussionCommentParams

TeamsUpdateDiscussionCommentParams: object

Type declaration

  • body: string

    The discussion comment's body text.

  • comment_number: number
  • discussion_number: number
  • team_id: number

TeamsUpdateDiscussionCommentResponse

TeamsUpdateDiscussionCommentResponse: object

Type declaration

TeamsUpdateDiscussionCommentResponseAuthor

TeamsUpdateDiscussionCommentResponseAuthor: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

TeamsUpdateDiscussionCommentResponseReactions

TeamsUpdateDiscussionCommentResponseReactions: object

Type declaration

  • +1: number
  • -1: number
  • confused: number
  • heart: number
  • hooray: number
  • laugh: number
  • total_count: number
  • url: string

TeamsUpdateDiscussionParams

TeamsUpdateDiscussionParams: object

Type declaration

  • Optional body?: undefined | string

    The discussion post's body text.

  • discussion_number: number
  • team_id: number
  • Optional title?: undefined | string

    The discussion post's title.

TeamsUpdateDiscussionResponse

TeamsUpdateDiscussionResponse: object

Type declaration

  • author: TeamsUpdateDiscussionResponseAuthor
  • body: string
  • body_html: string
  • body_version: string
  • comments_count: number
  • comments_url: string
  • created_at: string
  • html_url: string
  • last_edited_at: string
  • node_id: string
  • number: number
  • pinned: boolean
  • private: boolean
  • reactions: TeamsUpdateDiscussionResponseReactions
  • team_url: string
  • title: string
  • updated_at: string
  • url: string

TeamsUpdateDiscussionResponseAuthor

TeamsUpdateDiscussionResponseAuthor: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

TeamsUpdateDiscussionResponseReactions

TeamsUpdateDiscussionResponseReactions: object

Type declaration

  • +1: number
  • -1: number
  • confused: number
  • heart: number
  • hooray: number
  • laugh: number
  • total_count: number
  • url: string

TeamsUpdateParams

TeamsUpdateParams: object

Type declaration

  • Optional description?: undefined | string

    The description of the team.

  • name: string

    The name of the team.

  • Optional parent_team_id?: undefined | number

    The ID of a team to set as the parent team. Note: You must pass the hellcat-preview media type to use this parameter.

  • Optional privacy?: "secret" | "closed"

    The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. The options are: For a non-nested team: * secret - only visible to organization owners and members of this team. * closed - visible to all members of this organization. For a parent or child team: * closed - visible to all members of this organization.

  • team_id: number

TeamsUpdateParamsDeprecatedPermission

TeamsUpdateParamsDeprecatedPermission: object

Type declaration

  • Optional description?: undefined | string

    The description of the team.

  • name: string

    The name of the team.

  • Optional parent_team_id?: undefined | number

    The ID of a team to set as the parent team. Note: You must pass the hellcat-preview media type to use this parameter.

  • Optional permission?: undefined | string

    Deprecated. The permission that new repositories will be added to the team with when none is specified. Can be one of: * pull - team members can pull, but not push to or administer newly-added repositories. * push - team members can pull and push, but not administer newly-added repositories. * admin - team members can pull, push and administer newly-added repositories.

    deprecated

    "permission" parameter has been deprecated and will be removed in future

  • Optional privacy?: "secret" | "closed"

    The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. The options are: For a non-nested team: * secret - only visible to organization owners and members of this team. * closed - visible to all members of this organization. For a parent or child team: * closed - visible to all members of this organization.

  • team_id: number

TeamsUpdateResponse

TeamsUpdateResponse: 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: TeamsUpdateResponseOrganization
  • parent: null
  • permission: string
  • privacy: string
  • repos_count: number
  • repositories_url: string
  • slug: string
  • updated_at: string
  • url: string

TeamsUpdateResponseOrganization

TeamsUpdateResponseOrganization: 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

UsersAddEmailsParams

UsersAddEmailsParams: 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.

UsersAddEmailsResponse

UsersAddEmailsResponse: Array<UsersAddEmailsResponseItem>

UsersAddEmailsResponseItem

UsersAddEmailsResponseItem: object

Type declaration

  • email: string
  • primary: boolean
  • verified: boolean
  • visibility: string | null

UsersBlockParams

UsersBlockParams: object

Type declaration

  • username: string

UsersCheckBlockedParams

UsersCheckBlockedParams: object

Type declaration

  • username: string

UsersCheckFollowingForUserParams

UsersCheckFollowingForUserParams: object

Type declaration

  • target_user: string
  • username: string

UsersCheckFollowingParams

UsersCheckFollowingParams: object

Type declaration

  • username: string

UsersCreateGpgKeyParams

UsersCreateGpgKeyParams: object

Type declaration

  • Optional armored_public_key?: undefined | string

    Your GPG key, generated in ASCII-armored format. See "Generating a new GPG key" for help creating a GPG key.

UsersCreateGpgKeyResponse

UsersCreateGpgKeyResponse: object

Type declaration

UsersCreateGpgKeyResponseEmailsItem

UsersCreateGpgKeyResponseEmailsItem: object

Type declaration

  • email: string
  • verified: boolean

UsersCreateGpgKeyResponseSubkeysItem

UsersCreateGpgKeyResponseSubkeysItem: 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>

UsersCreatePublicKeyParams

UsersCreatePublicKeyParams: object

Type declaration

  • Optional key?: undefined | string

    The public SSH key to add to your GitHub account. See "Generating a new SSH key" for guidance on how to create a public SSH key.

  • Optional title?: undefined | string

    A descriptive name for the new key. Use a name that will help you recognize this key in your GitHub account. For example, if you're using a personal Mac, you might call this key "Personal MacBook Air".

UsersCreatePublicKeyResponse

UsersCreatePublicKeyResponse: object

Type declaration

  • created_at: string
  • id: number
  • key: string
  • read_only: boolean
  • title: string
  • url: string
  • verified: boolean

UsersDeleteEmailsParams

UsersDeleteEmailsParams: 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.

UsersDeleteGpgKeyParams

UsersDeleteGpgKeyParams: object

Type declaration

  • gpg_key_id: number

UsersDeletePublicKeyParams

UsersDeletePublicKeyParams: object

Type declaration

  • key_id: number

UsersFollowParams

UsersFollowParams: object

Type declaration

  • username: string

UsersGetAuthenticatedResponse

UsersGetAuthenticatedResponse: object

Type declaration

  • avatar_url: string
  • bio: string
  • blog: string
  • Optional collaborators?: undefined | number
  • company: string
  • created_at: string
  • Optional disk_usage?: undefined | number
  • email: string
  • events_url: string
  • followers: number
  • followers_url: string
  • following: number
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • hireable: boolean
  • html_url: string
  • id: number
  • location: string
  • login: string
  • name: string
  • node_id: string
  • organizations_url: string
  • Optional owned_private_repos?: undefined | number
  • Optional plan?: UsersGetAuthenticatedResponsePlan
  • Optional private_gists?: undefined | number
  • public_gists: number
  • public_repos: number
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • Optional total_private_repos?: undefined | number
  • Optional two_factor_authentication?: undefined | false | true
  • type: string
  • updated_at: string
  • url: string

UsersGetAuthenticatedResponsePlan

UsersGetAuthenticatedResponsePlan: object

Type declaration

  • collaborators: number
  • name: string
  • private_repos: number
  • space: number

UsersGetByUsernameParams

UsersGetByUsernameParams: object

Type declaration

  • username: string

UsersGetByUsernameResponse

UsersGetByUsernameResponse: 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?: UsersGetByUsernameResponsePlan
  • public_gists: number
  • public_repos: number
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • updated_at: string
  • url: string

UsersGetByUsernameResponsePlan

UsersGetByUsernameResponsePlan: object

Type declaration

  • collaborators: number
  • name: string
  • private_repos: number
  • space: number

UsersGetContextForUserParams

UsersGetContextForUserParams: object

Type declaration

  • Optional subject_id?: undefined | string

    Uses the ID for the subject_type you specified. Required when using subject_type.

  • Optional subject_type?: "organization" | "repository" | "issue" | "pull_request"

    Identifies which additional information you'd like to receive about the person's hovercard. Can be organization, repository, issue, pull_request. Required when using subject_id.

  • username: string

UsersGetContextForUserResponse

UsersGetContextForUserResponse: object

Type declaration

UsersGetContextForUserResponseContextsItem

UsersGetContextForUserResponseContextsItem: object

Type declaration

  • message: string
  • octicon: string

UsersGetGpgKeyParams

UsersGetGpgKeyParams: object

Type declaration

  • gpg_key_id: number

UsersGetGpgKeyResponse

UsersGetGpgKeyResponse: object

Type declaration

UsersGetGpgKeyResponseEmailsItem

UsersGetGpgKeyResponseEmailsItem: object

Type declaration

  • email: string
  • verified: boolean

UsersGetGpgKeyResponseSubkeysItem

UsersGetGpgKeyResponseSubkeysItem: 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>

UsersGetPublicKeyParams

UsersGetPublicKeyParams: object

Type declaration

  • key_id: number

UsersGetPublicKeyResponse

UsersGetPublicKeyResponse: object

Type declaration

  • created_at: string
  • id: number
  • key: string
  • read_only: boolean
  • title: string
  • url: string
  • verified: boolean

UsersListBlockedResponse

UsersListBlockedResponse: Array<UsersListBlockedResponseItem>

UsersListBlockedResponseItem

UsersListBlockedResponseItem: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

UsersListEmailsParams

UsersListEmailsParams: object

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

UsersListEmailsResponse

UsersListEmailsResponse: Array<UsersListEmailsResponseItem>

UsersListEmailsResponseItem

UsersListEmailsResponseItem: object

Type declaration

  • email: string
  • primary: boolean
  • verified: boolean
  • visibility: string

UsersListFollowersForAuthenticatedUserParams

UsersListFollowersForAuthenticatedUserParams: object

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

UsersListFollowersForAuthenticatedUserResponse

UsersListFollowersForAuthenticatedUserResponse: Array<UsersListFollowersForAuthenticatedUserResponseItem>

UsersListFollowersForAuthenticatedUserResponseItem

UsersListFollowersForAuthenticatedUserResponseItem: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

UsersListFollowersForUserParams

UsersListFollowersForUserParams: object

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • username: string

UsersListFollowersForUserResponse

UsersListFollowersForUserResponse: Array<UsersListFollowersForUserResponseItem>

UsersListFollowersForUserResponseItem

UsersListFollowersForUserResponseItem: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

UsersListFollowingForAuthenticatedUserParams

UsersListFollowingForAuthenticatedUserParams: object

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

UsersListFollowingForAuthenticatedUserResponse

UsersListFollowingForAuthenticatedUserResponse: Array<UsersListFollowingForAuthenticatedUserResponseItem>

UsersListFollowingForAuthenticatedUserResponseItem

UsersListFollowingForAuthenticatedUserResponseItem: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

UsersListFollowingForUserParams

UsersListFollowingForUserParams: object

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • username: string

UsersListFollowingForUserResponse

UsersListFollowingForUserResponse: Array<UsersListFollowingForUserResponseItem>

UsersListFollowingForUserResponseItem

UsersListFollowingForUserResponseItem: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

UsersListGpgKeysForUserParams

UsersListGpgKeysForUserParams: object

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • username: string

UsersListGpgKeysForUserResponse

UsersListGpgKeysForUserResponse: Array<UsersListGpgKeysForUserResponseItem>

UsersListGpgKeysForUserResponseItem

UsersListGpgKeysForUserResponseItem: object

Type declaration

UsersListGpgKeysForUserResponseItemEmailsItem

UsersListGpgKeysForUserResponseItemEmailsItem: object

Type declaration

  • email: string
  • verified: boolean

UsersListGpgKeysForUserResponseItemSubkeysItem

UsersListGpgKeysForUserResponseItemSubkeysItem: 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>

UsersListGpgKeysParams

UsersListGpgKeysParams: object

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

UsersListGpgKeysResponse

UsersListGpgKeysResponse: Array<UsersListGpgKeysResponseItem>

UsersListGpgKeysResponseItem

UsersListGpgKeysResponseItem: object

Type declaration

UsersListGpgKeysResponseItemEmailsItem

UsersListGpgKeysResponseItemEmailsItem: object

Type declaration

  • email: string
  • verified: boolean

UsersListGpgKeysResponseItemSubkeysItem

UsersListGpgKeysResponseItemSubkeysItem: 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>

UsersListParams

UsersListParams: object

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • Optional since?: undefined | string

    The integer ID of the last User that you've seen.

UsersListPublicEmailsParams

UsersListPublicEmailsParams: object

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

UsersListPublicEmailsResponse

UsersListPublicEmailsResponse: Array<UsersListPublicEmailsResponseItem>

UsersListPublicEmailsResponseItem

UsersListPublicEmailsResponseItem: object

Type declaration

  • email: string
  • primary: boolean
  • verified: boolean
  • visibility: string

UsersListPublicKeysForUserParams

UsersListPublicKeysForUserParams: object

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • username: string

UsersListPublicKeysForUserResponse

UsersListPublicKeysForUserResponse: Array<UsersListPublicKeysForUserResponseItem>

UsersListPublicKeysForUserResponseItem

UsersListPublicKeysForUserResponseItem: object

Type declaration

  • id: number
  • key: string

UsersListPublicKeysParams

UsersListPublicKeysParams: object

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

UsersListPublicKeysResponse

UsersListPublicKeysResponse: Array<UsersListPublicKeysResponseItem>

UsersListPublicKeysResponseItem

UsersListPublicKeysResponseItem: object

Type declaration

  • created_at: string
  • id: number
  • key: string
  • read_only: boolean
  • title: string
  • url: string
  • verified: boolean

UsersListResponse

UsersListResponse: Array<UsersListResponseItem>

UsersListResponseItem

UsersListResponseItem: object

Type declaration

  • avatar_url: string
  • events_url: string
  • followers_url: string
  • following_url: string
  • gists_url: string
  • gravatar_id: string
  • html_url: string
  • id: number
  • login: string
  • node_id: string
  • organizations_url: string
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • type: string
  • url: string

UsersTogglePrimaryEmailVisibilityParams

UsersTogglePrimaryEmailVisibilityParams: 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.

UsersTogglePrimaryEmailVisibilityResponse

UsersTogglePrimaryEmailVisibilityResponse: Array<UsersTogglePrimaryEmailVisibilityResponseItem>

UsersTogglePrimaryEmailVisibilityResponseItem

UsersTogglePrimaryEmailVisibilityResponseItem: object

Type declaration

  • email: string
  • primary: boolean
  • verified: boolean
  • visibility: string

UsersUnblockParams

UsersUnblockParams: object

Type declaration

  • username: string

UsersUnfollowParams

UsersUnfollowParams: object

Type declaration

  • username: string

UsersUpdateAuthenticatedParams

UsersUpdateAuthenticatedParams: object

Type declaration

  • Optional bio?: undefined | string

    The new short biography of the user.

  • Optional blog?: undefined | string

    The new blog URL of the user.

  • Optional company?: undefined | string

    The new company of the user.

  • Optional email?: undefined | string

    The publicly visible email address of the user.

  • Optional hireable?: undefined | false | true

    The new hiring availability of the user.

  • Optional location?: undefined | string

    The new location of the user.

  • Optional name?: undefined | string

    The new name of the user.

UsersUpdateAuthenticatedResponse

UsersUpdateAuthenticatedResponse: 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: UsersUpdateAuthenticatedResponsePlan
  • private_gists: number
  • public_gists: number
  • public_repos: number
  • received_events_url: string
  • repos_url: string
  • site_admin: boolean
  • starred_url: string
  • subscriptions_url: string
  • total_private_repos: number
  • two_factor_authentication: boolean
  • type: string
  • updated_at: string
  • url: string

UsersUpdateAuthenticatedResponsePlan

UsersUpdateAuthenticatedResponsePlan: object

Type declaration

  • collaborators: number
  • name: string
  • private_repos: number
  • space: number

date

date: string

json

json: any

Constructors

constructor

  • new GitHubAPI(options?: Octokit.Options): GitHubAPI

  • Parameters

    • Optional options: Octokit.Options

    Returns GitHubAPI

Properties

activity

activity: object

Type declaration

  • checkStarringRepo: object

    Requires for the user to be authenticated.

      • (params?: RequestOptions & Octokit.ActivityCheckStarringRepoParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.ActivityCheckStarringRepoParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • deleteRepoSubscription: object

    This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, set the repository's subscription manually.

      • (params?: RequestOptions & Octokit.ActivityDeleteRepoSubscriptionParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.ActivityDeleteRepoSubscriptionParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • deleteThreadSubscription: object

    Mutes all future notifications for a conversation until you comment on the thread or get @mentioned.

      • (params?: RequestOptions & Octokit.ActivityDeleteThreadSubscriptionParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.ActivityDeleteThreadSubscriptionParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • getRepoSubscription: object
      • (params?: RequestOptions & Octokit.ActivityGetRepoSubscriptionParams): Promise<Response<Octokit.ActivityGetRepoSubscriptionResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ActivityGetRepoSubscriptionParams

        Returns Promise<Response<Octokit.ActivityGetRepoSubscriptionResponse>>

    • endpoint: Endpoint
  • getThread: object
      • (params?: RequestOptions & Octokit.ActivityGetThreadParams): Promise<Response<Octokit.ActivityGetThreadResponse>>

      • Parameters

        Returns Promise<Response<Octokit.ActivityGetThreadResponse>>

    • endpoint: Endpoint
  • getThreadSubscription: object

    This checks to see if the current user is subscribed to a thread. You can also get a repository subscription.

    Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were @mentioned, or manually subscribe to a thread.

      • (params?: RequestOptions & Octokit.ActivityGetThreadSubscriptionParams): Promise<Response<Octokit.ActivityGetThreadSubscriptionResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ActivityGetThreadSubscriptionParams

        Returns Promise<Response<Octokit.ActivityGetThreadSubscriptionResponse>>

    • endpoint: Endpoint
  • listEventsForOrg: object

    This is the user's organization dashboard. You must be authenticated as the user to view this.

      • (params?: RequestOptions & Octokit.ActivityListEventsForOrgParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.ActivityListEventsForOrgParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • listEventsForUser: object

    If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.

      • (params?: RequestOptions & Octokit.ActivityListEventsForUserParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.ActivityListEventsForUserParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • listFeeds: object

    GitHub provides several timeline resources in Atom format. The Feeds API lists all the feeds available to the authenticated user:

    • Timeline: The GitHub global public timeline
    • User: The public timeline for any user, using URI template
    • Current user public: The public timeline for the authenticated user
    • Current user: The private timeline for the authenticated user
    • Current user actor: The private timeline for activity created by the authenticated user
    • Current user organizations: The private timeline for the organizations the authenticated user is a member of.
    • Security advisories: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub.

    Note: Private feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.

  • listNotifications: object

    List all notifications for the current user, sorted by most recently updated.

    The following example uses the since parameter to list notifications that have been updated after the specified time.

      • (params?: RequestOptions & Octokit.ActivityListNotificationsParams): Promise<Response<Octokit.ActivityListNotificationsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ActivityListNotificationsParams

        Returns Promise<Response<Octokit.ActivityListNotificationsResponse>>

    • endpoint: Endpoint
  • listNotificationsForRepo: object

    List all notifications for the current user.

      • (params?: RequestOptions & Octokit.ActivityListNotificationsForRepoParams): Promise<Response<Octokit.ActivityListNotificationsForRepoResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ActivityListNotificationsForRepoParams

        Returns Promise<Response<Octokit.ActivityListNotificationsForRepoResponse>>

    • endpoint: Endpoint
  • listPublicEvents: object

    We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.

      • (params?: RequestOptions & Octokit.ActivityListPublicEventsParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.ActivityListPublicEventsParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • listPublicEventsForOrg: object
      • (params?: RequestOptions & Octokit.ActivityListPublicEventsForOrgParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.ActivityListPublicEventsForOrgParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • listPublicEventsForRepoNetwork: object
      • (params?: RequestOptions & Octokit.ActivityListPublicEventsForRepoNetworkParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.ActivityListPublicEventsForRepoNetworkParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • listPublicEventsForUser: object
      • (params?: RequestOptions & Octokit.ActivityListPublicEventsForUserParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.ActivityListPublicEventsForUserParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • listReceivedEventsForUser: object

    These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.

      • (params?: RequestOptions & Octokit.ActivityListReceivedEventsForUserParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.ActivityListReceivedEventsForUserParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • listReceivedPublicEventsForUser: object
      • (params?: RequestOptions & Octokit.ActivityListReceivedPublicEventsForUserParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.ActivityListReceivedPublicEventsForUserParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • listRepoEvents: object
      • (params?: RequestOptions & Octokit.ActivityListRepoEventsParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.ActivityListRepoEventsParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • listReposStarredByAuthenticatedUser: object

    You can also find out when stars were created by passing the following custom media type via the Accept header:

      • (params?: RequestOptions & Octokit.ActivityListReposStarredByAuthenticatedUserParams): Promise<Response<Octokit.ActivityListReposStarredByAuthenticatedUserResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ActivityListReposStarredByAuthenticatedUserParams

        Returns Promise<Response<Octokit.ActivityListReposStarredByAuthenticatedUserResponse>>

    • endpoint: Endpoint
  • listReposStarredByUser: object

    You can also find out when stars were created by passing the following custom media type via the Accept header:

      • (params?: RequestOptions & Octokit.ActivityListReposStarredByUserParams): Promise<Response<Octokit.ActivityListReposStarredByUserResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ActivityListReposStarredByUserParams

        Returns Promise<Response<Octokit.ActivityListReposStarredByUserResponse>>

    • endpoint: Endpoint
  • listReposWatchedByUser: object
      • (params?: RequestOptions & Octokit.ActivityListReposWatchedByUserParams): Promise<Response<Octokit.ActivityListReposWatchedByUserResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ActivityListReposWatchedByUserParams

        Returns Promise<Response<Octokit.ActivityListReposWatchedByUserResponse>>

    • endpoint: Endpoint
  • listStargazersForRepo: object

    You can also find out when stars were created by passing the following custom media type via the Accept header:

      • (params?: RequestOptions & Octokit.ActivityListStargazersForRepoParams): Promise<Response<Octokit.ActivityListStargazersForRepoResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ActivityListStargazersForRepoParams

        Returns Promise<Response<Octokit.ActivityListStargazersForRepoResponse>>

    • endpoint: Endpoint
  • listWatchedReposForAuthenticatedUser: object
      • (params?: RequestOptions & Octokit.ActivityListWatchedReposForAuthenticatedUserParams): Promise<Response<Octokit.ActivityListWatchedReposForAuthenticatedUserResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ActivityListWatchedReposForAuthenticatedUserParams

        Returns Promise<Response<Octokit.ActivityListWatchedReposForAuthenticatedUserResponse>>

    • endpoint: Endpoint
  • listWatchersForRepo: object
      • (params?: RequestOptions & Octokit.ActivityListWatchersForRepoParams): Promise<Response<Octokit.ActivityListWatchersForRepoResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ActivityListWatchersForRepoParams

        Returns Promise<Response<Octokit.ActivityListWatchersForRepoResponse>>

    • endpoint: Endpoint
  • markAsRead: object

    Marks a notification as "read" removes it from the default view on GitHub. If the number of notifications is too large to complete in one request, you will receive a 202 Accepted status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the List your notifications endpoint and pass the query parameter all=false.

      • (params?: RequestOptions & Octokit.ActivityMarkAsReadParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • markNotificationsAsReadForRepo: object

    Marks all notifications in a repository as "read" removes them from the default view on GitHub. If the number of notifications is too large to complete in one request, you will receive a 202 Accepted status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the List your notifications in a repository endpoint and pass the query parameter all=false.

      • (params?: RequestOptions & Octokit.ActivityMarkNotificationsAsReadForRepoParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.ActivityMarkNotificationsAsReadForRepoParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • markThreadAsRead: object
      • (params?: RequestOptions & Octokit.ActivityMarkThreadAsReadParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.ActivityMarkThreadAsReadParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • setRepoSubscription: object

    If you would like to watch a repository, set subscribed to true. If you would like to ignore notifications made within a repository, set ignored to true. If you would like to stop watching a repository, delete the repository's subscription completely.

      • (params?: RequestOptions & Octokit.ActivitySetRepoSubscriptionParams): Promise<Response<Octokit.ActivitySetRepoSubscriptionResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ActivitySetRepoSubscriptionParams

        Returns Promise<Response<Octokit.ActivitySetRepoSubscriptionResponse>>

    • endpoint: Endpoint
  • setThreadSubscription: object

    This lets you subscribe or unsubscribe from a conversation.

      • (params?: RequestOptions & Octokit.ActivitySetThreadSubscriptionParams): Promise<Response<Octokit.ActivitySetThreadSubscriptionResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ActivitySetThreadSubscriptionParams

        Returns Promise<Response<Octokit.ActivitySetThreadSubscriptionResponse>>

    • endpoint: Endpoint
  • starRepo: object

    Requires for the user to be authenticated.

    Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."

      • (params?: RequestOptions & Octokit.ActivityStarRepoParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • unstarRepo: object

    Requires for the user to be authenticated.

      • (params?: RequestOptions & Octokit.ActivityUnstarRepoParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint

apps

apps: object

Type declaration

  • addRepoToInstallation: object

    Add a single repository to an installation. The authenticated user must have admin access to the repository.

    You must use a personal access token (which you can create via the command line or the OAuth Authorizations API) or Basic Authentication to access this endpoint.

      • (params?: RequestOptions & Octokit.AppsAddRepoToInstallationParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.AppsAddRepoToInstallationParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • checkAccountIsAssociatedWithAny: object

    Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

    GitHub Apps must use a JWT to access this endpoint. OAuth Apps must use basic authentication with their client ID and client secret to access this endpoint.

      • (params?: RequestOptions & Octokit.AppsCheckAccountIsAssociatedWithAnyParams): Promise<Response<Octokit.AppsCheckAccountIsAssociatedWithAnyResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.AppsCheckAccountIsAssociatedWithAnyParams

        Returns Promise<Response<Octokit.AppsCheckAccountIsAssociatedWithAnyResponse>>

    • endpoint: Endpoint
  • checkAccountIsAssociatedWithAnyStubbed: object

    Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

    GitHub Apps must use a JWT to access this endpoint. OAuth Apps must use basic authentication with their client ID and client secret to access this endpoint.

      • (params?: RequestOptions & Octokit.AppsCheckAccountIsAssociatedWithAnyStubbedParams): Promise<Response<Octokit.AppsCheckAccountIsAssociatedWithAnyStubbedResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.AppsCheckAccountIsAssociatedWithAnyStubbedParams

        Returns Promise<Response<Octokit.AppsCheckAccountIsAssociatedWithAnyStubbedResponse>>

    • endpoint: Endpoint
  • createContentAttachment: object

    Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id of the content reference from the content_reference event to create an attachment.

    The app must create a content attachment within six hours of the content reference URL being posted. See "Using content attachments" for details about content attachments.

    You must use an installation access token to access this endpoint.

    This example creates a content attachment for the domain https://errors.ai/.

      • (params?: RequestOptions & Octokit.AppsCreateContentAttachmentParams): Promise<Response<Octokit.AppsCreateContentAttachmentResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.AppsCreateContentAttachmentParams

        Returns Promise<Response<Octokit.AppsCreateContentAttachmentResponse>>

    • endpoint: Endpoint
  • createFromManifest: object

    Use this endpoint to complete the handshake necessary when implementing the GitHub App Manifest flow. When you create a GitHub App with the manifest flow, you receive a temporary code used to retrieve the GitHub App's id, pem (private key), and webhook_secret.

      • (params?: RequestOptions & Octokit.AppsCreateFromManifestParams): Promise<Response<Octokit.AppsCreateFromManifestResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.AppsCreateFromManifestParams

        Returns Promise<Response<Octokit.AppsCreateFromManifestResponse>>

    • endpoint: Endpoint
  • createInstallationToken: object

    Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of 401 - Unauthorized, and requires creating a new installation token.

    By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the repository_ids when creating the token. When you omit repository_ids, the response does not contain the repositories key.

    You must use a JWT to access this endpoint.

    This example grants the token "Read and write" permission to issues and "Read" permission to contents, and restricts the token's access to the repository with an id of 1296269.

      • (params?: RequestOptions & Octokit.AppsCreateInstallationTokenParams): Promise<Response<Octokit.AppsCreateInstallationTokenResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.AppsCreateInstallationTokenParams

        Returns Promise<Response<Octokit.AppsCreateInstallationTokenResponse>>

    • endpoint: Endpoint
  • deleteInstallation: object

    Uninstalls a GitHub App on a user, organization, or business account.

    You must use a JWT to access this endpoint.

      • (params?: RequestOptions & Octokit.AppsDeleteInstallationParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.AppsDeleteInstallationParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • findOrgInstallation: object

    Enables an authenticated GitHub App to find the organization's installation information.

    You must use a JWT to access this endpoint.

    deprecated

    octokit.apps.findOrgInstallation() has been renamed to octokit.apps.getOrgInstallation() (2019-04-10)

      • (params?: RequestOptions & Octokit.AppsFindOrgInstallationParams): Promise<Response<Octokit.AppsFindOrgInstallationResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.AppsFindOrgInstallationParams

        Returns Promise<Response<Octokit.AppsFindOrgInstallationResponse>>

    • endpoint: Endpoint
  • findRepoInstallation: object

    Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.

    You must use a JWT to access this endpoint.

    deprecated

    octokit.apps.findRepoInstallation() has been renamed to octokit.apps.getRepoInstallation() (2019-04-10)

      • (params?: RequestOptions & Octokit.AppsFindRepoInstallationParams): Promise<Response<Octokit.AppsFindRepoInstallationResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.AppsFindRepoInstallationParams

        Returns Promise<Response<Octokit.AppsFindRepoInstallationResponse>>

    • endpoint: Endpoint
  • findUserInstallation: object

    Enables an authenticated GitHub App to find the user’s installation information.

    You must use a JWT to access this endpoint.

    deprecated

    octokit.apps.findUserInstallation() has been renamed to octokit.apps.getUserInstallation() (2019-04-10)

      • (params?: RequestOptions & Octokit.AppsFindUserInstallationParams): Promise<Response<Octokit.AppsFindUserInstallationResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.AppsFindUserInstallationParams

        Returns Promise<Response<Octokit.AppsFindUserInstallationResponse>>

    • endpoint: Endpoint
  • getAuthenticated: object

    Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the installations_count in the response. For more details about your app's installations, see the "List installations" endpoint.

    You must use a JWT to access this endpoint.

  • getBySlug: object

    Note: The :app_slug is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/:app_slug).

    If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a personal access token or an installation access token to access this endpoint.

  • getInstallation: object

    You must use a JWT to access this endpoint.

      • (params?: RequestOptions & Octokit.AppsGetInstallationParams): Promise<Response<Octokit.AppsGetInstallationResponse>>

      • Parameters

        Returns Promise<Response<Octokit.AppsGetInstallationResponse>>

    • endpoint: Endpoint
  • getOrgInstallation: object

    Enables an authenticated GitHub App to find the organization's installation information.

    You must use a JWT to access this endpoint.

      • (params?: RequestOptions & Octokit.AppsGetOrgInstallationParams): Promise<Response<Octokit.AppsGetOrgInstallationResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.AppsGetOrgInstallationParams

        Returns Promise<Response<Octokit.AppsGetOrgInstallationResponse>>

    • endpoint: Endpoint
  • getRepoInstallation: object

    Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.

    You must use a JWT to access this endpoint.

      • (params?: RequestOptions & Octokit.AppsGetRepoInstallationParams): Promise<Response<Octokit.AppsGetRepoInstallationResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.AppsGetRepoInstallationParams

        Returns Promise<Response<Octokit.AppsGetRepoInstallationResponse>>

    • endpoint: Endpoint
  • getUserInstallation: object

    Enables an authenticated GitHub App to find the user’s installation information.

    You must use a JWT to access this endpoint.

      • (params?: RequestOptions & Octokit.AppsGetUserInstallationParams): Promise<Response<Octokit.AppsGetUserInstallationResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.AppsGetUserInstallationParams

        Returns Promise<Response<Octokit.AppsGetUserInstallationResponse>>

    • endpoint: Endpoint
  • listAccountsUserOrOrgOnPlan: object

    Returns any accounts associated with a plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

    GitHub Apps must use a JWT to access this endpoint. OAuth Apps must use basic authentication with their client ID and client secret to access this endpoint.

      • (params?: RequestOptions & Octokit.AppsListAccountsUserOrOrgOnPlanParams): Promise<Response<Octokit.AppsListAccountsUserOrOrgOnPlanResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.AppsListAccountsUserOrOrgOnPlanParams

        Returns Promise<Response<Octokit.AppsListAccountsUserOrOrgOnPlanResponse>>

    • endpoint: Endpoint
  • listAccountsUserOrOrgOnPlanStubbed: object

    Returns any accounts associated with a plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

    GitHub Apps must use a JWT to access this endpoint. OAuth Apps must use basic authentication with their client ID and client secret to access this endpoint.

      • (params?: RequestOptions & Octokit.AppsListAccountsUserOrOrgOnPlanStubbedParams): Promise<Response<Octokit.AppsListAccountsUserOrOrgOnPlanStubbedResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.AppsListAccountsUserOrOrgOnPlanStubbedParams

        Returns Promise<Response<Octokit.AppsListAccountsUserOrOrgOnPlanStubbedResponse>>

    • endpoint: Endpoint
  • listInstallationReposForAuthenticatedUser: object

    List repositories that the authenticated user has explicit permission (:read, :write, or :admin) to access for an installation.

    The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

    You must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint.

    The access the user has to each repository is included in the hash under the permissions key.

      • (params?: RequestOptions & Octokit.AppsListInstallationReposForAuthenticatedUserParams): Promise<Response<Octokit.AppsListInstallationReposForAuthenticatedUserResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.AppsListInstallationReposForAuthenticatedUserParams

        Returns Promise<Response<Octokit.AppsListInstallationReposForAuthenticatedUserResponse>>

    • endpoint: Endpoint
  • listInstallations: object

    You must use a JWT to access this endpoint.

    The permissions the installation has are included under the permissions key.

      • (params?: RequestOptions & Octokit.AppsListInstallationsParams): Promise<Response<Octokit.AppsListInstallationsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.AppsListInstallationsParams

        Returns Promise<Response<Octokit.AppsListInstallationsResponse>>

    • endpoint: Endpoint
  • listInstallationsForAuthenticatedUser: object

    Lists installations of your GitHub App that the authenticated user has explicit permission (:read, :write, or :admin) to access.

    You must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint.

    The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

    You can find the permissions for the installation under the permissions key.

      • (params?: RequestOptions & Octokit.AppsListInstallationsForAuthenticatedUserParams): Promise<Response<Octokit.AppsListInstallationsForAuthenticatedUserResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.AppsListInstallationsForAuthenticatedUserParams

        Returns Promise<Response<Octokit.AppsListInstallationsForAuthenticatedUserResponse>>

    • endpoint: Endpoint
  • listMarketplacePurchasesForAuthenticatedUser: object

    Returns only active subscriptions. You must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an OAuth token.

      • (params?: RequestOptions & Octokit.AppsListMarketplacePurchasesForAuthenticatedUserParams): Promise<Response<Octokit.AppsListMarketplacePurchasesForAuthenticatedUserResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.AppsListMarketplacePurchasesForAuthenticatedUserParams

        Returns Promise<Response<Octokit.AppsListMarketplacePurchasesForAuthenticatedUserResponse>>

    • endpoint: Endpoint
  • listMarketplacePurchasesForAuthenticatedUserStubbed: object

    Returns only active subscriptions. You must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an OAuth token.

      • (params?: RequestOptions & Octokit.AppsListMarketplacePurchasesForAuthenticatedUserStubbedParams): Promise<Response<Octokit.AppsListMarketplacePurchasesForAuthenticatedUserStubbedResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.AppsListMarketplacePurchasesForAuthenticatedUserStubbedParams

        Returns Promise<Response<Octokit.AppsListMarketplacePurchasesForAuthenticatedUserStubbedResponse>>

    • endpoint: Endpoint
  • listPlans: object

    GitHub Apps must use a JWT to access this endpoint. OAuth Apps must use basic authentication with their client ID and client secret to access this endpoint.

  • listPlansStubbed: object

    GitHub Apps must use a JWT to access this endpoint. OAuth Apps must use basic authentication with their client ID and client secret to access this endpoint.

      • (params?: RequestOptions & Octokit.AppsListPlansStubbedParams): Promise<Response<Octokit.AppsListPlansStubbedResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.AppsListPlansStubbedParams

        Returns Promise<Response<Octokit.AppsListPlansStubbedResponse>>

    • endpoint: Endpoint
  • listRepos: object

    List repositories that an installation can access.

    You must use an installation access token to access this endpoint.

  • removeRepoFromInstallation: object

    Remove a single repository from an installation. The authenticated user must have admin access to the repository.

    You must use a personal access token (which you can create via the command line or the OAuth Authorizations API) or Basic Authentication to access this endpoint.

      • (params?: RequestOptions & Octokit.AppsRemoveRepoFromInstallationParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.AppsRemoveRepoFromInstallationParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint

checks

checks: object

Type declaration

  • create: object

    Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

    Creates a new check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to create check runs.

  • createSuite: object

    Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

    By default, check suites are automatically created when you create a check run. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "Set preferences for check suites on a repository". Your GitHub App must have the checks:write permission to create check suites.

      • (params?: RequestOptions & Octokit.ChecksCreateSuiteParams): Promise<Response<Octokit.ChecksCreateSuiteResponse>>

      • Parameters

        Returns Promise<Response<Octokit.ChecksCreateSuiteResponse>>

    • endpoint: Endpoint
  • get: object

    Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

    Gets a single check run using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.

  • getSuite: object

    Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

    Gets a single check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.

      • Parameters

        Returns Promise<Response<Octokit.ChecksGetSuiteResponse>>

    • endpoint: Endpoint
  • listAnnotations: object

    Lists annotations for a check run using the annotation id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the repo scope to get annotations for a check run in a private repository.

      • (params?: RequestOptions & Octokit.ChecksListAnnotationsParams): Promise<Response<Octokit.ChecksListAnnotationsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ChecksListAnnotationsParams

        Returns Promise<Response<Octokit.ChecksListAnnotationsResponse>>

    • endpoint: Endpoint
  • listForRef: object

    Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

    Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.

      • (params?: RequestOptions & Octokit.ChecksListForRefParams): Promise<Response<Octokit.ChecksListForRefResponse>>

      • Parameters

        Returns Promise<Response<Octokit.ChecksListForRefResponse>>

    • endpoint: Endpoint
  • listForSuite: object

    Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

    Lists check runs for a check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.

      • (params?: RequestOptions & Octokit.ChecksListForSuiteParams): Promise<Response<Octokit.ChecksListForSuiteResponse>>

      • Parameters

        Returns Promise<Response<Octokit.ChecksListForSuiteResponse>>

    • endpoint: Endpoint
  • listSuitesForRef: object

    Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

    Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.

      • (params?: RequestOptions & Octokit.ChecksListSuitesForRefParams): Promise<Response<Octokit.ChecksListSuitesForRefResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ChecksListSuitesForRefParams

        Returns Promise<Response<Octokit.ChecksListSuitesForRefResponse>>

    • endpoint: Endpoint
  • rerequestSuite: object

    Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the check_suite webhook event with the action rerequested. When a check suite is rerequested, its status is reset to queued and the conclusion is cleared.

    To rerequest a check suite, your GitHub App must have the checks:read permission on a private repository or pull access to a public repository.

      • (params?: RequestOptions & Octokit.ChecksRerequestSuiteParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.ChecksRerequestSuiteParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • setSuitesPreferences: object

    Changes the default automatic flow when creating check suites. By default, the CheckSuiteEvent is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually Create a check suite. You must have admin permissions in the repository to set preferences for check suites.

      • (params?: RequestOptions & Octokit.ChecksSetSuitesPreferencesParams): Promise<Response<Octokit.ChecksSetSuitesPreferencesResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ChecksSetSuitesPreferencesParams

        Returns Promise<Response<Octokit.ChecksSetSuitesPreferencesResponse>>

    • endpoint: Endpoint
  • update: object

    Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

    Updates a check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to edit check runs.

codesOfConduct

codesOfConduct: object

Type declaration

  • getConductCode: object
      • (params?: RequestOptions & Octokit.CodesOfConductGetConductCodeParams): Promise<Response<Octokit.CodesOfConductGetConductCodeResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.CodesOfConductGetConductCodeParams

        Returns Promise<Response<Octokit.CodesOfConductGetConductCodeResponse>>

    • endpoint: Endpoint
  • getForRepo: object

    This method returns the contents of the repository's code of conduct file, if one is detected.

      • (params?: RequestOptions & Octokit.CodesOfConductGetForRepoParams): Promise<Response<Octokit.CodesOfConductGetForRepoResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.CodesOfConductGetForRepoParams

        Returns Promise<Response<Octokit.CodesOfConductGetForRepoResponse>>

    • endpoint: Endpoint
  • listConductCodes: object

emojis

emojis: object

Type declaration

gists

gists: object

Type declaration

  • checkIsStarred: object
      • (params?: RequestOptions & Octokit.GistsCheckIsStarredParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • create: object

    Allows you to add a new gist with one or more files.

    Note: Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.

  • createComment: object
      • (params?: RequestOptions & Octokit.GistsCreateCommentParams): Promise<Response<Octokit.GistsCreateCommentResponse>>

      • Parameters

        Returns Promise<Response<Octokit.GistsCreateCommentResponse>>

    • endpoint: Endpoint
  • delete: object
      • (params?: RequestOptions & Octokit.GistsDeleteParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • deleteComment: object
      • (params?: RequestOptions & Octokit.GistsDeleteCommentParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • fork: object

    Note: This was previously /gists/:gist_id/fork.

  • get: object
  • getComment: object
      • (params?: RequestOptions & Octokit.GistsGetCommentParams): Promise<Response<Octokit.GistsGetCommentResponse>>

      • Parameters

        Returns Promise<Response<Octokit.GistsGetCommentResponse>>

    • endpoint: Endpoint
  • getRevision: object
      • (params?: RequestOptions & Octokit.GistsGetRevisionParams): Promise<Response<Octokit.GistsGetRevisionResponse>>

      • Parameters

        Returns Promise<Response<Octokit.GistsGetRevisionResponse>>

    • endpoint: Endpoint
  • list: object
  • listComments: object
      • (params?: RequestOptions & Octokit.GistsListCommentsParams): Promise<Response<Octokit.GistsListCommentsResponse>>

      • Parameters

        Returns Promise<Response<Octokit.GistsListCommentsResponse>>

    • endpoint: Endpoint
  • listCommits: object
      • (params?: RequestOptions & Octokit.GistsListCommitsParams): Promise<Response<Octokit.GistsListCommitsResponse>>

      • Parameters

        Returns Promise<Response<Octokit.GistsListCommitsResponse>>

    • endpoint: Endpoint
  • listForks: object

      • Parameters

        Returns Promise<Response<Octokit.GistsListForksResponse>>

    • endpoint: Endpoint
  • listPublic: object

    List all public gists sorted by most recently updated to least recently updated.

    Note: With pagination, you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.

      • (params?: RequestOptions & Octokit.GistsListPublicParams): Promise<Response<Octokit.GistsListPublicResponse>>

      • Parameters

        Returns Promise<Response<Octokit.GistsListPublicResponse>>

    • endpoint: Endpoint
  • listPublicForUser: object
      • (params?: RequestOptions & Octokit.GistsListPublicForUserParams): Promise<Response<Octokit.GistsListPublicForUserResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.GistsListPublicForUserParams

        Returns Promise<Response<Octokit.GistsListPublicForUserResponse>>

    • endpoint: Endpoint
  • listStarred: object

    List the authenticated user's starred gists:

      • (params?: RequestOptions & Octokit.GistsListStarredParams): Promise<Response<Octokit.GistsListStarredResponse>>

      • Parameters

        Returns Promise<Response<Octokit.GistsListStarredResponse>>

    • endpoint: Endpoint
  • star: object

    Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."

      • (params?: RequestOptions & Octokit.GistsStarParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • unstar: object
      • (params?: RequestOptions & Octokit.GistsUnstarParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • update: object

    Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.

  • updateComment: object
      • (params?: RequestOptions & Octokit.GistsUpdateCommentParams): Promise<Response<Octokit.GistsUpdateCommentResponse>>

      • Parameters

        Returns Promise<Response<Octokit.GistsUpdateCommentResponse>>

    • endpoint: Endpoint

git

git: object

Type declaration

  • createBlob: object
  • createCommit: object

    Creates a new Git commit object.

    In this example, the payload of the signature would be:

    Signature verification object

    The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:

    These are the possible values for reason in the verification object:

    Value Description
    expired_key The key that made the signature is expired.
    not_signing_key The "signing" flag is not among the usage flags in the GPG key that made the signature.
    gpgverify_error There was an error communicating with the signature verification service.
    gpgverify_unavailable The signature verification service is currently unavailable.
    unsigned The object does not include a signature.
    unknown_signature_type A non-PGP signature was found in the commit.
    no_user No user was associated with the committer email address in the commit.
    unverified_email The committer email address in the commit was associated with a user, but the email address is not verified on her/his account.
    bad_email The committer email address in the commit is not included in the identities of the PGP key that made the signature.
    unknown_key The key that made the signature has not been registered with any user's account.
    malformed_signature There was an error parsing the signature.
    invalid The signature could not be cryptographically verified using the key whose key-id was found in the signature.
    valid None of the above errors applied, so the signature is considered to be verified.
      • (params?: RequestOptions & Octokit.GitCreateCommitParams): Promise<Response<Octokit.GitCreateCommitResponse>>

      • Parameters

        Returns Promise<Response<Octokit.GitCreateCommitResponse>>

    • endpoint: Endpoint
  • createRef: object

    Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.

  • createTag: object

    Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then create the refs/tags/[tag] reference. If you want to create a lightweight tag, you only have to create the tag reference - this call would be unnecessary.

    Signature verification object

    The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:

    These are the possible values for reason in the verification object:

    Value Description
    expired_key The key that made the signature is expired.
    not_signing_key The "signing" flag is not among the usage flags in the GPG key that made the signature.
    gpgverify_error There was an error communicating with the signature verification service.
    gpgverify_unavailable The signature verification service is currently unavailable.
    unsigned The object does not include a signature.
    unknown_signature_type A non-PGP signature was found in the commit.
    no_user No user was associated with the committer email address in the commit.
    unverified_email The committer email address in the commit was associated with a user, but the email address is not verified on her/his account.
    bad_email The committer email address in the commit is not included in the identities of the PGP key that made the signature.
    unknown_key The key that made the signature has not been registered with any user's account.
    malformed_signature There was an error parsing the signature.
    invalid The signature could not be cryptographically verified using the key whose key-id was found in the signature.
    valid None of the above errors applied, so the signature is considered to be verified.
  • createTree: object

    The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.

    If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "Create a commit" and "Update a reference."

  • deleteRef: object
    DELETE /repos/octocat/Hello-World/git/refs/heads/feature-a
    DELETE /repos/octocat/Hello-World/git/refs/tags/v1.0
      • (params?: RequestOptions & Octokit.GitDeleteRefParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • getBlob: object

    The content in the response will always be Base64 encoded.

    Note: This API supports blobs up to 100 megabytes in size.

  • getCommit: object

    Gets a Git commit object.

    Signature verification object

    The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:

    These are the possible values for reason in the verification object:

    Value Description
    expired_key The key that made the signature is expired.
    not_signing_key The "signing" flag is not among the usage flags in the GPG key that made the signature.
    gpgverify_error There was an error communicating with the signature verification service.
    gpgverify_unavailable The signature verification service is currently unavailable.
    unsigned The object does not include a signature.
    unknown_signature_type A non-PGP signature was found in the commit.
    no_user No user was associated with the committer email address in the commit.
    unverified_email The committer email address in the commit was associated with a user, but the email address is not verified on her/his account.
    bad_email The committer email address in the commit is not included in the identities of the PGP key that made the signature.
    unknown_key The key that made the signature has not been registered with any user's account.
    malformed_signature There was an error parsing the signature.
    invalid The signature could not be cryptographically verified using the key whose key-id was found in the signature.
    valid None of the above errors applied, so the signature is considered to be verified.
  • getRef: object

    Returns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.

    Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "Checking mergeability of pull requests".

    To get the reference for a branch named skunkworkz/featureA, the endpoint route is:

  • getTag: object

    Signature verification object

    The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:

    These are the possible values for reason in the verification object:

    Value Description
    expired_key The key that made the signature is expired.
    not_signing_key The "signing" flag is not among the usage flags in the GPG key that made the signature.
    gpgverify_error There was an error communicating with the signature verification service.
    gpgverify_unavailable The signature verification service is currently unavailable.
    unsigned The object does not include a signature.
    unknown_signature_type A non-PGP signature was found in the commit.
    no_user No user was associated with the committer email address in the commit.
    unverified_email The committer email address in the commit was associated with a user, but the email address is not verified on her/his account.
    bad_email The committer email address in the commit is not included in the identities of the PGP key that made the signature.
    unknown_key The key that made the signature has not been registered with any user's account.
    malformed_signature There was an error parsing the signature.
    invalid The signature could not be cryptographically verified using the key whose key-id was found in the signature.
    valid None of the above errors applied, so the signature is considered to be verified.
  • getTree: object

    If truncated is true, the number of items in the tree array exceeded our maximum limit. If you need to fetch more items, you can clone the repository and iterate over the Git data locally.

      • (params?: RequestOptions & Octokit.GitGetTreeParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • listMatchingRefs: object

    Returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.

    When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.

    Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "Checking mergeability of pull requests".

    If you request matching references for a branch named feature but the branch feature doesn't exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.

      • (params?: RequestOptions & Octokit.GitListMatchingRefsParams): Promise<Response<Octokit.GitListMatchingRefsResponse>>

      • Parameters

        Returns Promise<Response<Octokit.GitListMatchingRefsResponse>>

    • endpoint: Endpoint
  • listRefs: object

    Returns an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags. If there are no references to list, a 404 is returned.

      • (params?: RequestOptions & Octokit.GitListRefsParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • updateRef: object

gitignore

gitignore: object

Type declaration

graphql

graphql: Graphql

hook

hook: object

Type declaration

  • after: function
    • after(name: string, callback: function): void

    • Parameters

      • name: string
      • callback: function
          • (response: Response<any>, options: Octokit.HookOptions): void

          • Parameters

            • response: Response<any>
            • options: Octokit.HookOptions

            Returns void

      Returns void

  • before: function
    • before(name: string, callback: function): void

    • Parameters

      • name: string
      • callback: function
          • (options: Octokit.HookOptions): void

          • Parameters

            • options: Octokit.HookOptions

            Returns void

      Returns void

  • error: function
    • error(name: string, callback: function): void

    • Parameters

      • name: string
      • callback: function
          • (error: Octokit.HookError, options: Octokit.HookOptions): void

          • Parameters

            • error: Octokit.HookError
            • options: Octokit.HookOptions

            Returns void

      Returns void

  • wrap: function
    • wrap(name: string, callback: function): void

    • Parameters

      • name: string
      • callback: function
          • (request: function, options: Octokit.HookOptions): void

          • Parameters

            • request: function
                • (options: Octokit.HookOptions): Promise<Response<any>>

                • Parameters

                  • options: Octokit.HookOptions

                  Returns Promise<Response<any>>

            • options: Octokit.HookOptions

            Returns void

      Returns void

interactions

interactions: object

Type declaration

  • addOrUpdateRestrictionsForOrg: object

    Temporarily restricts interactions to certain GitHub users in any public repository in the given organization. You must be an organization owner to set these restrictions.

      • (params?: RequestOptions & Octokit.InteractionsAddOrUpdateRestrictionsForOrgParams): Promise<Response<Octokit.InteractionsAddOrUpdateRestrictionsForOrgResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.InteractionsAddOrUpdateRestrictionsForOrgParams

        Returns Promise<Response<Octokit.InteractionsAddOrUpdateRestrictionsForOrgResponse>>

    • endpoint: Endpoint
  • addOrUpdateRestrictionsForRepo: object

    Temporarily restricts interactions to certain GitHub users within the given repository. You must have owner or admin access to set restrictions.

      • (params?: RequestOptions & Octokit.InteractionsAddOrUpdateRestrictionsForRepoParams): Promise<Response<Octokit.InteractionsAddOrUpdateRestrictionsForRepoResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.InteractionsAddOrUpdateRestrictionsForRepoParams

        Returns Promise<Response<Octokit.InteractionsAddOrUpdateRestrictionsForRepoResponse>>

    • endpoint: Endpoint
  • getRestrictionsForOrg: object

    Shows which group of GitHub users can interact with this organization and when the restriction expires. If there are no restrictions, you will see an empty response.

      • (params?: RequestOptions & Octokit.InteractionsGetRestrictionsForOrgParams): Promise<Response<Octokit.InteractionsGetRestrictionsForOrgResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.InteractionsGetRestrictionsForOrgParams

        Returns Promise<Response<Octokit.InteractionsGetRestrictionsForOrgResponse>>

    • endpoint: Endpoint
  • getRestrictionsForRepo: object

    Shows which group of GitHub users can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response.

      • (params?: RequestOptions & Octokit.InteractionsGetRestrictionsForRepoParams): Promise<Response<Octokit.InteractionsGetRestrictionsForRepoResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.InteractionsGetRestrictionsForRepoParams

        Returns Promise<Response<Octokit.InteractionsGetRestrictionsForRepoResponse>>

    • endpoint: Endpoint
  • removeRestrictionsForOrg: object

    Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions.

      • (params?: RequestOptions & Octokit.InteractionsRemoveRestrictionsForOrgParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.InteractionsRemoveRestrictionsForOrgParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • removeRestrictionsForRepo: object

    Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions.

      • (params?: RequestOptions & Octokit.InteractionsRemoveRestrictionsForRepoParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.InteractionsRemoveRestrictionsForRepoParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint

issues

issues: object

Type declaration

  • addAssignees: object

    Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.

    This example adds two assignees to the existing octocat assignee.

      • (params?: RequestOptions & Octokit.IssuesAddAssigneesParamsDeprecatedNumber): Promise<Response<Octokit.IssuesAddAssigneesResponse>>
      • (params?: RequestOptions & Octokit.IssuesAddAssigneesParams): Promise<Response<Octokit.IssuesAddAssigneesResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.IssuesAddAssigneesParamsDeprecatedNumber

        Returns Promise<Response<Octokit.IssuesAddAssigneesResponse>>

      • Parameters

        Returns Promise<Response<Octokit.IssuesAddAssigneesResponse>>

    • endpoint: Endpoint
  • addLabels: object
      • (params?: RequestOptions & Octokit.IssuesAddLabelsParamsDeprecatedNumber): Promise<Response<Octokit.IssuesAddLabelsResponse>>
      • (params?: RequestOptions & Octokit.IssuesAddLabelsParams): Promise<Response<Octokit.IssuesAddLabelsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.IssuesAddLabelsParamsDeprecatedNumber

        Returns Promise<Response<Octokit.IssuesAddLabelsResponse>>

      • Parameters

        Returns Promise<Response<Octokit.IssuesAddLabelsResponse>>

    • endpoint: Endpoint
  • checkAssignee: object

    Checks if a user has permission to be assigned to an issue in this repository.

    If the assignee can be assigned to issues in the repository, a 204 header with no content is returned.

    Otherwise a 404 status code is returned.

      • (params?: RequestOptions & Octokit.IssuesCheckAssigneeParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • create: object

    Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

    This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

      • (params?: RequestOptions & Octokit.IssuesCreateParamsDeprecatedAssignee): Promise<Response<Octokit.IssuesCreateResponse>>
      • (params?: RequestOptions & Octokit.IssuesCreateParams): Promise<Response<Octokit.IssuesCreateResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.IssuesCreateParamsDeprecatedAssignee

        Returns Promise<Response<Octokit.IssuesCreateResponse>>

      • Parameters

        Returns Promise<Response<Octokit.IssuesCreateResponse>>

    • endpoint: Endpoint
  • createComment: object

    This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

      • (params?: RequestOptions & Octokit.IssuesCreateCommentParamsDeprecatedNumber): Promise<Response<Octokit.IssuesCreateCommentResponse>>
      • (params?: RequestOptions & Octokit.IssuesCreateCommentParams): Promise<Response<Octokit.IssuesCreateCommentResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.IssuesCreateCommentParamsDeprecatedNumber

        Returns Promise<Response<Octokit.IssuesCreateCommentResponse>>

      • Parameters

        Returns Promise<Response<Octokit.IssuesCreateCommentResponse>>

    • endpoint: Endpoint
  • createLabel: object
      • (params?: RequestOptions & Octokit.IssuesCreateLabelParams): Promise<Response<Octokit.IssuesCreateLabelResponse>>

      • Parameters

        Returns Promise<Response<Octokit.IssuesCreateLabelResponse>>

    • endpoint: Endpoint
  • createMilestone: object
      • (params?: RequestOptions & Octokit.IssuesCreateMilestoneParams): Promise<Response<Octokit.IssuesCreateMilestoneResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.IssuesCreateMilestoneParams

        Returns Promise<Response<Octokit.IssuesCreateMilestoneResponse>>

    • endpoint: Endpoint
  • deleteComment: object
      • (params?: RequestOptions & Octokit.IssuesDeleteCommentParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • deleteLabel: object
      • (params?: RequestOptions & Octokit.IssuesDeleteLabelParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • deleteMilestone: object
      • (params?: RequestOptions & Octokit.IssuesDeleteMilestoneParamsDeprecatedNumber): Promise<Octokit.AnyResponse>
      • (params?: RequestOptions & Octokit.IssuesDeleteMilestoneParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.IssuesDeleteMilestoneParamsDeprecatedNumber

        Returns Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.IssuesDeleteMilestoneParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • get: object

    The API returns a 301 Moved Permanently status if the issue was transferred to another repository. If the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API returns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read access, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe to the issues webhook.

    Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key.

    Be aware that the id of a pull request returned from "Issues" endpoints will be an issue id. To find out the pull request id, use the "List pull requests" endpoint.

      • Parameters

        • Optional params: RequestOptions & Octokit.IssuesGetParamsDeprecatedNumber

        Returns Promise<Response<Octokit.IssuesGetResponse>>

      • Parameters

        Returns Promise<Response<Octokit.IssuesGetResponse>>

    • endpoint: Endpoint
  • getComment: object
      • (params?: RequestOptions & Octokit.IssuesGetCommentParams): Promise<Response<Octokit.IssuesGetCommentResponse>>

      • Parameters

        Returns Promise<Response<Octokit.IssuesGetCommentResponse>>

    • endpoint: Endpoint
  • getEvent: object

      • Parameters

        Returns Promise<Response<Octokit.IssuesGetEventResponse>>

    • endpoint: Endpoint
  • getLabel: object

      • Parameters

        Returns Promise<Response<Octokit.IssuesGetLabelResponse>>

    • endpoint: Endpoint
  • getMilestone: object
      • (params?: RequestOptions & Octokit.IssuesGetMilestoneParamsDeprecatedNumber): Promise<Response<Octokit.IssuesGetMilestoneResponse>>
      • (params?: RequestOptions & Octokit.IssuesGetMilestoneParams): Promise<Response<Octokit.IssuesGetMilestoneResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.IssuesGetMilestoneParamsDeprecatedNumber

        Returns Promise<Response<Octokit.IssuesGetMilestoneResponse>>

      • Parameters

        Returns Promise<Response<Octokit.IssuesGetMilestoneResponse>>

    • endpoint: Endpoint
  • list: object

    Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key.

    Be aware that the id of a pull request returned from "Issues" endpoints will be an issue id. To find out the pull request id, use the "List pull requests" endpoint.

  • listAssignees: object

    Lists the available assignees for issues in a repository.

      • (params?: RequestOptions & Octokit.IssuesListAssigneesParams): Promise<Response<Octokit.IssuesListAssigneesResponse>>

      • Parameters

        Returns Promise<Response<Octokit.IssuesListAssigneesResponse>>

    • endpoint: Endpoint
  • listComments: object

    Issue Comments are ordered by ascending ID.

      • (params?: RequestOptions & Octokit.IssuesListCommentsParamsDeprecatedNumber): Promise<Response<Octokit.IssuesListCommentsResponse>>
      • (params?: RequestOptions & Octokit.IssuesListCommentsParams): Promise<Response<Octokit.IssuesListCommentsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.IssuesListCommentsParamsDeprecatedNumber

        Returns Promise<Response<Octokit.IssuesListCommentsResponse>>

      • Parameters

        Returns Promise<Response<Octokit.IssuesListCommentsResponse>>

    • endpoint: Endpoint
  • listCommentsForRepo: object

    By default, Issue Comments are ordered by ascending ID.

      • (params?: RequestOptions & Octokit.IssuesListCommentsForRepoParams): Promise<Response<Octokit.IssuesListCommentsForRepoResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.IssuesListCommentsForRepoParams

        Returns Promise<Response<Octokit.IssuesListCommentsForRepoResponse>>

    • endpoint: Endpoint
  • listEvents: object
      • (params?: RequestOptions & Octokit.IssuesListEventsParamsDeprecatedNumber): Promise<Response<Octokit.IssuesListEventsResponse>>
      • (params?: RequestOptions & Octokit.IssuesListEventsParams): Promise<Response<Octokit.IssuesListEventsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.IssuesListEventsParamsDeprecatedNumber

        Returns Promise<Response<Octokit.IssuesListEventsResponse>>

      • Parameters

        Returns Promise<Response<Octokit.IssuesListEventsResponse>>

    • endpoint: Endpoint
  • listEventsForRepo: object
      • (params?: RequestOptions & Octokit.IssuesListEventsForRepoParams): Promise<Response<Octokit.IssuesListEventsForRepoResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.IssuesListEventsForRepoParams

        Returns Promise<Response<Octokit.IssuesListEventsForRepoResponse>>

    • endpoint: Endpoint
  • listEventsForTimeline: object
      • (params?: RequestOptions & Octokit.IssuesListEventsForTimelineParamsDeprecatedNumber): Promise<Response<Octokit.IssuesListEventsForTimelineResponse>>
      • (params?: RequestOptions & Octokit.IssuesListEventsForTimelineParams): Promise<Response<Octokit.IssuesListEventsForTimelineResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.IssuesListEventsForTimelineParamsDeprecatedNumber

        Returns Promise<Response<Octokit.IssuesListEventsForTimelineResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.IssuesListEventsForTimelineParams

        Returns Promise<Response<Octokit.IssuesListEventsForTimelineResponse>>

    • endpoint: Endpoint
  • listForAuthenticatedUser: object

    Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key.

    Be aware that the id of a pull request returned from "Issues" endpoints will be an issue id. To find out the pull request id, use the "List pull requests" endpoint.

      • (params?: RequestOptions & Octokit.IssuesListForAuthenticatedUserParams): Promise<Response<Octokit.IssuesListForAuthenticatedUserResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.IssuesListForAuthenticatedUserParams

        Returns Promise<Response<Octokit.IssuesListForAuthenticatedUserResponse>>

    • endpoint: Endpoint
  • listForOrg: object

    Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key.

    Be aware that the id of a pull request returned from "Issues" endpoints will be an issue id. To find out the pull request id, use the "List pull requests" endpoint.

      • (params?: RequestOptions & Octokit.IssuesListForOrgParams): Promise<Response<Octokit.IssuesListForOrgResponse>>

      • Parameters

        Returns Promise<Response<Octokit.IssuesListForOrgResponse>>

    • endpoint: Endpoint
  • listForRepo: object

    Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key.

    Be aware that the id of a pull request returned from "Issues" endpoints will be an issue id. To find out the pull request id, use the "List pull requests" endpoint.

      • (params?: RequestOptions & Octokit.IssuesListForRepoParams): Promise<Response<Octokit.IssuesListForRepoResponse>>

      • Parameters

        Returns Promise<Response<Octokit.IssuesListForRepoResponse>>

    • endpoint: Endpoint
  • listLabelsForMilestone: object
      • (params?: RequestOptions & Octokit.IssuesListLabelsForMilestoneParamsDeprecatedNumber): Promise<Response<Octokit.IssuesListLabelsForMilestoneResponse>>
      • (params?: RequestOptions & Octokit.IssuesListLabelsForMilestoneParams): Promise<Response<Octokit.IssuesListLabelsForMilestoneResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.IssuesListLabelsForMilestoneParamsDeprecatedNumber

        Returns Promise<Response<Octokit.IssuesListLabelsForMilestoneResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.IssuesListLabelsForMilestoneParams

        Returns Promise<Response<Octokit.IssuesListLabelsForMilestoneResponse>>

    • endpoint: Endpoint
  • listLabelsForRepo: object
      • (params?: RequestOptions & Octokit.IssuesListLabelsForRepoParams): Promise<Response<Octokit.IssuesListLabelsForRepoResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.IssuesListLabelsForRepoParams

        Returns Promise<Response<Octokit.IssuesListLabelsForRepoResponse>>

    • endpoint: Endpoint
  • listLabelsOnIssue: object
      • (params?: RequestOptions & Octokit.IssuesListLabelsOnIssueParamsDeprecatedNumber): Promise<Response<Octokit.IssuesListLabelsOnIssueResponse>>
      • (params?: RequestOptions & Octokit.IssuesListLabelsOnIssueParams): Promise<Response<Octokit.IssuesListLabelsOnIssueResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.IssuesListLabelsOnIssueParamsDeprecatedNumber

        Returns Promise<Response<Octokit.IssuesListLabelsOnIssueResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.IssuesListLabelsOnIssueParams

        Returns Promise<Response<Octokit.IssuesListLabelsOnIssueResponse>>

    • endpoint: Endpoint
  • listMilestonesForRepo: object
      • (params?: RequestOptions & Octokit.IssuesListMilestonesForRepoParams): Promise<Response<Octokit.IssuesListMilestonesForRepoResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.IssuesListMilestonesForRepoParams

        Returns Promise<Response<Octokit.IssuesListMilestonesForRepoResponse>>

    • endpoint: Endpoint
  • lock: object

    Users with push access can lock an issue or pull request's conversation.

    Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."

      • (params?: RequestOptions & Octokit.IssuesLockParamsDeprecatedNumber): Promise<Octokit.AnyResponse>
      • (params?: RequestOptions & Octokit.IssuesLockParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.IssuesLockParamsDeprecatedNumber

        Returns Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • removeAssignees: object

    Removes one or more assignees from an issue.

    This example removes two of three assignees, leaving the octocat assignee.

      • (params?: RequestOptions & Octokit.IssuesRemoveAssigneesParamsDeprecatedNumber): Promise<Response<Octokit.IssuesRemoveAssigneesResponse>>
      • (params?: RequestOptions & Octokit.IssuesRemoveAssigneesParams): Promise<Response<Octokit.IssuesRemoveAssigneesResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.IssuesRemoveAssigneesParamsDeprecatedNumber

        Returns Promise<Response<Octokit.IssuesRemoveAssigneesResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.IssuesRemoveAssigneesParams

        Returns Promise<Response<Octokit.IssuesRemoveAssigneesResponse>>

    • endpoint: Endpoint
  • removeLabel: object

    Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a 404 Not Found status if the label does not exist.

      • (params?: RequestOptions & Octokit.IssuesRemoveLabelParamsDeprecatedNumber): Promise<Response<Octokit.IssuesRemoveLabelResponse>>
      • (params?: RequestOptions & Octokit.IssuesRemoveLabelParams): Promise<Response<Octokit.IssuesRemoveLabelResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.IssuesRemoveLabelParamsDeprecatedNumber

        Returns Promise<Response<Octokit.IssuesRemoveLabelResponse>>

      • Parameters

        Returns Promise<Response<Octokit.IssuesRemoveLabelResponse>>

    • endpoint: Endpoint
  • removeLabels: object
      • (params?: RequestOptions & Octokit.IssuesRemoveLabelsParamsDeprecatedNumber): Promise<Octokit.AnyResponse>
      • (params?: RequestOptions & Octokit.IssuesRemoveLabelsParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.IssuesRemoveLabelsParamsDeprecatedNumber

        Returns Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • replaceLabels: object
      • (params?: RequestOptions & Octokit.IssuesReplaceLabelsParamsDeprecatedNumber): Promise<Response<Octokit.IssuesReplaceLabelsResponse>>
      • (params?: RequestOptions & Octokit.IssuesReplaceLabelsParams): Promise<Response<Octokit.IssuesReplaceLabelsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.IssuesReplaceLabelsParamsDeprecatedNumber

        Returns Promise<Response<Octokit.IssuesReplaceLabelsResponse>>

      • Parameters

        Returns Promise<Response<Octokit.IssuesReplaceLabelsResponse>>

    • endpoint: Endpoint
  • unlock: object

    Users with push access can unlock an issue's conversation.

      • (params?: RequestOptions & Octokit.IssuesUnlockParamsDeprecatedNumber): Promise<Octokit.AnyResponse>
      • (params?: RequestOptions & Octokit.IssuesUnlockParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.IssuesUnlockParamsDeprecatedNumber

        Returns Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • update: object

    Issue owners and users with push access can edit an issue.

      • (params?: RequestOptions & Octokit.IssuesUpdateParamsDeprecatedNumber): Promise<Response<Octokit.IssuesUpdateResponse>>
      • (params?: RequestOptions & Octokit.IssuesUpdateParamsDeprecatedAssignee): Promise<Response<Octokit.IssuesUpdateResponse>>
      • (params?: RequestOptions & Octokit.IssuesUpdateParams): Promise<Response<Octokit.IssuesUpdateResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.IssuesUpdateParamsDeprecatedNumber

        Returns Promise<Response<Octokit.IssuesUpdateResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.IssuesUpdateParamsDeprecatedAssignee

        Returns Promise<Response<Octokit.IssuesUpdateResponse>>

      • Parameters

        Returns Promise<Response<Octokit.IssuesUpdateResponse>>

    • endpoint: Endpoint
  • updateComment: object
      • (params?: RequestOptions & Octokit.IssuesUpdateCommentParams): Promise<Response<Octokit.IssuesUpdateCommentResponse>>

      • Parameters

        Returns Promise<Response<Octokit.IssuesUpdateCommentResponse>>

    • endpoint: Endpoint
  • updateLabel: object
      • (params?: RequestOptions & Octokit.IssuesUpdateLabelParams): Promise<Response<Octokit.IssuesUpdateLabelResponse>>

      • Parameters

        Returns Promise<Response<Octokit.IssuesUpdateLabelResponse>>

    • endpoint: Endpoint
  • updateMilestone: object
      • (params?: RequestOptions & Octokit.IssuesUpdateMilestoneParamsDeprecatedNumber): Promise<Response<Octokit.IssuesUpdateMilestoneResponse>>
      • (params?: RequestOptions & Octokit.IssuesUpdateMilestoneParams): Promise<Response<Octokit.IssuesUpdateMilestoneResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.IssuesUpdateMilestoneParamsDeprecatedNumber

        Returns Promise<Response<Octokit.IssuesUpdateMilestoneResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.IssuesUpdateMilestoneParams

        Returns Promise<Response<Octokit.IssuesUpdateMilestoneResponse>>

    • endpoint: Endpoint

licenses

licenses: object

Type declaration

log

log: Log

markdown

markdown: object

Type declaration

  • render: object
      • (params?: RequestOptions & Octokit.MarkdownRenderParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • renderRaw: object

    You must send Markdown as plain text (using a Content-Type header of text/plain or text/x-markdown) to this endpoint, rather than using JSON format. In raw mode, GitHub Flavored Markdown is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less.

      • (params?: RequestOptions & Octokit.MarkdownRenderRawParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint

meta

meta: object

Type declaration

migrations

migrations: object

Type declaration

  • cancelImport: object

    Stop an import for a repository.

      • (params?: RequestOptions & Octokit.MigrationsCancelImportParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.MigrationsCancelImportParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • deleteArchiveForAuthenticatedUser: object

    Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the Get a list of user migrations and Get the status of a user migration endpoints, will continue to be available even after an archive is deleted.

      • (params?: RequestOptions & Octokit.MigrationsDeleteArchiveForAuthenticatedUserParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.MigrationsDeleteArchiveForAuthenticatedUserParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • deleteArchiveForOrg: object

    Deletes a previous migration archive. Migration archives are automatically deleted after seven days.

      • (params?: RequestOptions & Octokit.MigrationsDeleteArchiveForOrgParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.MigrationsDeleteArchiveForOrgParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • getArchiveForAuthenticatedUser: object

    Fetches the URL to download the migration archive as a tar.gz file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects:

    • attachments
    • bases
    • commit_comments
    • issue_comments
    • issue_events
    • issues
    • milestones
    • organizations
    • projects
    • protected_branches
    • pull_request_reviews
    • pull_requests
    • releases
    • repositories
    • review_comments
    • schema
    • users

    The archive will also contain an attachments directory that includes all attachment files uploaded to GitHub.com and a repositories directory that contains the repository's Git data.

      • (params?: RequestOptions & Octokit.MigrationsGetArchiveForAuthenticatedUserParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.MigrationsGetArchiveForAuthenticatedUserParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • getArchiveForOrg: object

    Fetches the URL to a migration archive.

      • (params?: RequestOptions & Octokit.MigrationsGetArchiveForOrgParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.MigrationsGetArchiveForOrgParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • getCommitAuthors: object

    Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username hubot into something like hubot <hubot@12341234-abab-fefe-8787-fedcba987654>.

    This API method and the "Map a commit author" method allow you to provide correct Git author information.

      • (params?: RequestOptions & Octokit.MigrationsGetCommitAuthorsParams): Promise<Response<Octokit.MigrationsGetCommitAuthorsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.MigrationsGetCommitAuthorsParams

        Returns Promise<Response<Octokit.MigrationsGetCommitAuthorsResponse>>

    • endpoint: Endpoint
  • getImportProgress: object

    View the progress of an import.

    Import status

    This section includes details about the possible values of the status field of the Import Progress response.

    An import that does not have errors will progress through these steps:

    • detecting - the "detection" step of the import is in progress because the request did not include a vcs parameter. The import is identifying the type of source control present at the URL.
    • importing - the "raw" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include commit_count (the total number of raw commits that will be imported) and percent (0 - 100, the current progress through the import).
    • mapping - the "rewrite" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.
    • pushing - the "push" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include push_percent, which is the percent value reported by git push when it is "Writing objects".
    • complete - the import is complete, and the repository is ready on GitHub.

    If there are problems, you will see one of these in the status field:

    • auth_failed - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the Update Existing Import section.
    • error - the import encountered an error. The import progress response will include the failed_step and an error message. Contact GitHub Support for more information.
    • detection_needs_auth - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the Update Existing Import section.
    • detection_found_nothing - the importer didn't recognize any source control at the URL. To resolve, Cancel the import and retry with the correct URL.
    • detection_found_multiple - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a project_choices field with the possible project choices as values. To update project choice, please see the Update Existing Import section.

    The project_choices field

    When multiple projects are found at the provided URL, the response hash will include a project_choices field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.

    Git LFS related fields

    This section includes details about Git LFS related fields that may be present in the Import Progress response.

    • use_lfs - describes whether the import has been opted in or out of using Git LFS. The value can be opt_in, opt_out, or undecided if no action has been taken.
    • has_large_files - the boolean value describing whether files larger than 100MB were found during the importing step.
    • large_files_size - the total size in gigabytes of files larger than 100MB found in the originating repository.
    • large_files_count - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a "Get Large Files" request.
      • (params?: RequestOptions & Octokit.MigrationsGetImportProgressParams): Promise<Response<Octokit.MigrationsGetImportProgressResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.MigrationsGetImportProgressParams

        Returns Promise<Response<Octokit.MigrationsGetImportProgressResponse>>

    • endpoint: Endpoint
  • getLargeFiles: object

    List files larger than 100MB found during the import

      • (params?: RequestOptions & Octokit.MigrationsGetLargeFilesParams): Promise<Response<Octokit.MigrationsGetLargeFilesResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.MigrationsGetLargeFilesParams

        Returns Promise<Response<Octokit.MigrationsGetLargeFilesResponse>>

    • endpoint: Endpoint
  • getStatusForAuthenticatedUser: object

    Fetches a single user migration. The response includes the state of the migration, which can be one of the following values:

    • pending - the migration hasn't started yet.
    • exporting - the migration is in progress.
    • exported - the migration finished successfully.
    • failed - the migration failed.

    Once the migration has been exported you can download the migration archive.

      • (params?: RequestOptions & Octokit.MigrationsGetStatusForAuthenticatedUserParams): Promise<Response<Octokit.MigrationsGetStatusForAuthenticatedUserResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.MigrationsGetStatusForAuthenticatedUserParams

        Returns Promise<Response<Octokit.MigrationsGetStatusForAuthenticatedUserResponse>>

    • endpoint: Endpoint
  • getStatusForOrg: object

    Fetches the status of a migration.

    The state of a migration can be one of the following values:

    • pending, which means the migration hasn't started yet.
    • exporting, which means the migration is in progress.
    • exported, which means the migration finished successfully.
    • failed, which means the migration failed.
      • (params?: RequestOptions & Octokit.MigrationsGetStatusForOrgParams): Promise<Response<Octokit.MigrationsGetStatusForOrgResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.MigrationsGetStatusForOrgParams

        Returns Promise<Response<Octokit.MigrationsGetStatusForOrgResponse>>

    • endpoint: Endpoint
  • listForAuthenticatedUser: object

    Lists all migrations a user has started.

      • (params?: RequestOptions & Octokit.MigrationsListForAuthenticatedUserParams): Promise<Response<Octokit.MigrationsListForAuthenticatedUserResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.MigrationsListForAuthenticatedUserParams

        Returns Promise<Response<Octokit.MigrationsListForAuthenticatedUserResponse>>

    • endpoint: Endpoint
  • listForOrg: object

    Lists the most recent migrations.

      • (params?: RequestOptions & Octokit.MigrationsListForOrgParams): Promise<Response<Octokit.MigrationsListForOrgResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.MigrationsListForOrgParams

        Returns Promise<Response<Octokit.MigrationsListForOrgResponse>>

    • endpoint: Endpoint
  • mapCommitAuthor: object

    Update an author's identity for the import. Your application can continue updating authors any time before you push new commits to the repository.

      • (params?: RequestOptions & Octokit.MigrationsMapCommitAuthorParams): Promise<Response<Octokit.MigrationsMapCommitAuthorResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.MigrationsMapCommitAuthorParams

        Returns Promise<Response<Octokit.MigrationsMapCommitAuthorResponse>>

    • endpoint: Endpoint
  • setLfsPreference: object

    You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability is powered by Git LFS. You can learn more about our LFS feature and working with large files on our help site.

      • (params?: RequestOptions & Octokit.MigrationsSetLfsPreferenceParams): Promise<Response<Octokit.MigrationsSetLfsPreferenceResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.MigrationsSetLfsPreferenceParams

        Returns Promise<Response<Octokit.MigrationsSetLfsPreferenceResponse>>

    • endpoint: Endpoint
  • startForAuthenticatedUser: object

    Initiates the generation of a user migration archive.

      • (params?: RequestOptions & Octokit.MigrationsStartForAuthenticatedUserParams): Promise<Response<Octokit.MigrationsStartForAuthenticatedUserResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.MigrationsStartForAuthenticatedUserParams

        Returns Promise<Response<Octokit.MigrationsStartForAuthenticatedUserResponse>>

    • endpoint: Endpoint
  • startForOrg: object

    Initiates the generation of a migration archive.

      • (params?: RequestOptions & Octokit.MigrationsStartForOrgParams): Promise<Response<Octokit.MigrationsStartForOrgResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.MigrationsStartForOrgParams

        Returns Promise<Response<Octokit.MigrationsStartForOrgResponse>>

    • endpoint: Endpoint
  • startImport: object

    Start a source import to a GitHub repository using GitHub Importer.

      • (params?: RequestOptions & Octokit.MigrationsStartImportParams): Promise<Response<Octokit.MigrationsStartImportResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.MigrationsStartImportParams

        Returns Promise<Response<Octokit.MigrationsStartImportResponse>>

    • endpoint: Endpoint
  • unlockRepoForAuthenticatedUser: object

    Unlocks a repository. You can lock repositories when you start a user migration. Once the migration is complete you can unlock each repository to begin using it again or delete the repository if you no longer need the source data. Returns a status of 404 Not Found if the repository is not locked.

      • (params?: RequestOptions & Octokit.MigrationsUnlockRepoForAuthenticatedUserParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.MigrationsUnlockRepoForAuthenticatedUserParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • unlockRepoForOrg: object

    Unlocks a repository that was locked for migration. You should unlock each migrated repository and delete them when the migration is complete and you no longer need the source data.

      • (params?: RequestOptions & Octokit.MigrationsUnlockRepoForOrgParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.MigrationsUnlockRepoForOrgParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • updateImport: object

    An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API request. If no parameters are provided, the import will be restarted.

    Some servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will have the status detection_found_multiple and the Import Progress response will include a project_choices array. You can select the project to import by providing one of the objects in the project_choices array in the update request.

    The following example demonstrates the workflow for updating an import with "project1" as the project choice. Given a project_choices array like such:

    To restart an import, no parameters are provided in the update request.

      • (params?: RequestOptions & Octokit.MigrationsUpdateImportParams): Promise<Response<Octokit.MigrationsUpdateImportResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.MigrationsUpdateImportParams

        Returns Promise<Response<Octokit.MigrationsUpdateImportResponse>>

    • endpoint: Endpoint

oauthAuthorizations

oauthAuthorizations: object

Type declaration

  • checkAuthorization: object

    OAuth applications can use a special API method for checking OAuth token validity without running afoul of normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use Basic Authentication when accessing it, where the username is the OAuth application client_id and the password is its client_secret. Invalid tokens will return 404 NOT FOUND.

      • (params?: RequestOptions & Octokit.OauthAuthorizationsCheckAuthorizationParams): Promise<Response<Octokit.OauthAuthorizationsCheckAuthorizationResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.OauthAuthorizationsCheckAuthorizationParams

        Returns Promise<Response<Octokit.OauthAuthorizationsCheckAuthorizationResponse>>

    • endpoint: Endpoint
  • createAuthorization: object

    Creates OAuth tokens using Basic Authentication. If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "Working with two-factor authentication."

    You can use this endpoint to create multiple OAuth tokens instead of implementing the web flow.

    To create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use fingerprint to differentiate between them.

    You can also create tokens on GitHub from the personal access tokens settings page. Read more about these tokens in the GitHub Help documentation.

    Organizations that enforce SAML SSO require personal access tokens to be whitelisted. Read more about whitelisting tokens in the GitHub Help documentation.

      • (params?: RequestOptions & Octokit.OauthAuthorizationsCreateAuthorizationParams): Promise<Response<Octokit.OauthAuthorizationsCreateAuthorizationResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.OauthAuthorizationsCreateAuthorizationParams

        Returns Promise<Response<Octokit.OauthAuthorizationsCreateAuthorizationResponse>>

    • endpoint: Endpoint
  • deleteAuthorization: object
      • (params?: RequestOptions & Octokit.OauthAuthorizationsDeleteAuthorizationParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.OauthAuthorizationsDeleteAuthorizationParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • deleteGrant: object

    Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on the application authorizations settings screen within GitHub.

      • (params?: RequestOptions & Octokit.OauthAuthorizationsDeleteGrantParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.OauthAuthorizationsDeleteGrantParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • getAuthorization: object
      • (params?: RequestOptions & Octokit.OauthAuthorizationsGetAuthorizationParams): Promise<Response<Octokit.OauthAuthorizationsGetAuthorizationResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.OauthAuthorizationsGetAuthorizationParams

        Returns Promise<Response<Octokit.OauthAuthorizationsGetAuthorizationResponse>>

    • endpoint: Endpoint
  • getGrant: object
      • (params?: RequestOptions & Octokit.OauthAuthorizationsGetGrantParams): Promise<Response<Octokit.OauthAuthorizationsGetGrantResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.OauthAuthorizationsGetGrantParams

        Returns Promise<Response<Octokit.OauthAuthorizationsGetGrantResponse>>

    • endpoint: Endpoint
  • getOrCreateAuthorizationForApp: object

    Creates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.

    If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "Working with two-factor authentication."

      • (params?: RequestOptions & Octokit.OauthAuthorizationsGetOrCreateAuthorizationForAppParams): Promise<Response<Octokit.OauthAuthorizationsGetOrCreateAuthorizationForAppResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.OauthAuthorizationsGetOrCreateAuthorizationForAppParams

        Returns Promise<Response<Octokit.OauthAuthorizationsGetOrCreateAuthorizationForAppResponse>>

    • endpoint: Endpoint
  • getOrCreateAuthorizationForAppAndFingerprint: object

    This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. fingerprint is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.

    If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "Working with two-factor authentication."

      • (params?: RequestOptions & Octokit.OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintParams): Promise<Response<Octokit.OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintParams

        Returns Promise<Response<Octokit.OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintResponse>>

    • endpoint: Endpoint
  • getOrCreateAuthorizationForAppFingerprint: object

    This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. fingerprint is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.

    If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "Working with two-factor authentication."

    deprecated

    octokit.oauthAuthorizations.getOrCreateAuthorizationForAppFingerprint() has been renamed to octokit.oauthAuthorizations.getOrCreateAuthorizationForAppAndFingerprint() (2018-12-27)

      • (params?: RequestOptions & Octokit.OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintParams): Promise<Response<Octokit.OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintParams

        Returns Promise<Response<Octokit.OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintResponse>>

    • endpoint: Endpoint
  • listAuthorizations: object
      • (params?: RequestOptions & Octokit.OauthAuthorizationsListAuthorizationsParams): Promise<Response<Octokit.OauthAuthorizationsListAuthorizationsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.OauthAuthorizationsListAuthorizationsParams

        Returns Promise<Response<Octokit.OauthAuthorizationsListAuthorizationsResponse>>

    • endpoint: Endpoint
  • listGrants: object

    You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the list your authorizations API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on the application authorizations settings screen within GitHub. The scopes returned are the union of scopes authorized for the application. For example, if an application has one token with repo scope and another token with user scope, the grant will return ["repo", "user"].

      • (params?: RequestOptions & Octokit.OauthAuthorizationsListGrantsParams): Promise<Response<Octokit.OauthAuthorizationsListGrantsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.OauthAuthorizationsListGrantsParams

        Returns Promise<Response<Octokit.OauthAuthorizationsListGrantsResponse>>

    • endpoint: Endpoint
  • resetAuthorization: object

    OAuth applications can use this API method to reset a valid OAuth token without end user involvement. Applications must save the "token" property in the response, because changes take effect immediately. You must use Basic Authentication when accessing it, where the username is the OAuth application client_id and the password is its client_secret. Invalid tokens will return 404 NOT FOUND.

      • (params?: RequestOptions & Octokit.OauthAuthorizationsResetAuthorizationParams): Promise<Response<Octokit.OauthAuthorizationsResetAuthorizationResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.OauthAuthorizationsResetAuthorizationParams

        Returns Promise<Response<Octokit.OauthAuthorizationsResetAuthorizationResponse>>

    • endpoint: Endpoint
  • revokeAuthorizationForApplication: object

    OAuth application owners can revoke a single token for an OAuth application. You must use Basic Authentication for this method, where the username is the OAuth application client_id and the password is its client_secret.

      • (params?: RequestOptions & Octokit.OauthAuthorizationsRevokeAuthorizationForApplicationParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.OauthAuthorizationsRevokeAuthorizationForApplicationParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • revokeGrantForApplication: object

    OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use Basic Authentication for this method, where the username is the OAuth application client_id and the password is its client_secret. You must also provide a valid token as :access_token and the grant for the token's owner will be deleted.

    Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on the application authorizations settings screen within GitHub.

      • (params?: RequestOptions & Octokit.OauthAuthorizationsRevokeGrantForApplicationParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.OauthAuthorizationsRevokeGrantForApplicationParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • updateAuthorization: object

    If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "Working with two-factor authentication."

    You can only send one of these scope keys at a time.

      • (params?: RequestOptions & Octokit.OauthAuthorizationsUpdateAuthorizationParams): Promise<Response<Octokit.OauthAuthorizationsUpdateAuthorizationResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.OauthAuthorizationsUpdateAuthorizationParams

        Returns Promise<Response<Octokit.OauthAuthorizationsUpdateAuthorizationResponse>>

    • endpoint: Endpoint

orgs

orgs: object

Type declaration

  • addOrUpdateMembership: object

    Only authenticated organization owners can add a member to the organization or update the member's role.

    • If the authenticated user is adding a member to the organization, the invited user will receive an email inviting them to the organization. The user's membership status will be pending until they accept the invitation.

    • Authenticated users can update a user's membership by passing the role parameter. If the authenticated user changes a member's role to admin, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to member, no email will be sent.

    Rate limits

    To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.

      • (params?: RequestOptions & Octokit.OrgsAddOrUpdateMembershipParams): Promise<Response<Octokit.OrgsAddOrUpdateMembershipResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.OrgsAddOrUpdateMembershipParams

        Returns Promise<Response<Octokit.OrgsAddOrUpdateMembershipResponse>>

    • endpoint: Endpoint
  • blockUser: object
      • (params?: RequestOptions & Octokit.OrgsBlockUserParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • checkBlockedUser: object

    If the user is blocked:

    If the user is not blocked:

      • (params?: RequestOptions & Octokit.OrgsCheckBlockedUserParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.OrgsCheckBlockedUserParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • checkMembership: object

    Check if a user is, publicly or privately, a member of the organization.

      • (params?: RequestOptions & Octokit.OrgsCheckMembershipParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • checkPublicMembership: object
      • (params?: RequestOptions & Octokit.OrgsCheckPublicMembershipParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.OrgsCheckPublicMembershipParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • concealMembership: object
      • (params?: RequestOptions & Octokit.OrgsConcealMembershipParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.OrgsConcealMembershipParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • convertMemberToOutsideCollaborator: object

    When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "Converting an organization member to an outside collaborator".

      • (params?: RequestOptions & Octokit.OrgsConvertMemberToOutsideCollaboratorParams): Promise<Response<Octokit.OrgsConvertMemberToOutsideCollaboratorResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.OrgsConvertMemberToOutsideCollaboratorParams

        Returns Promise<Response<Octokit.OrgsConvertMemberToOutsideCollaboratorResponse>>

    • endpoint: Endpoint
  • createHook: object

    Here's how you can create a hook that posts payloads in JSON format:

      • Parameters

        Returns Promise<Response<Octokit.OrgsCreateHookResponse>>

    • endpoint: Endpoint
  • createInvitation: object

    Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.

    This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

      • (params?: RequestOptions & Octokit.OrgsCreateInvitationParams): Promise<Response<Octokit.OrgsCreateInvitationResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.OrgsCreateInvitationParams

        Returns Promise<Response<Octokit.OrgsCreateInvitationResponse>>

    • endpoint: Endpoint
  • deleteHook: object
      • (params?: RequestOptions & Octokit.OrgsDeleteHookParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • get: object

    To see many of the organization response values, you need to be an authenticated organization owner with the admin:org scope. When the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication.

    GitHub Apps with the Organization plan permission can use this endpoint to retrieve information about an organization's GitHub plan. See "Authenticating with GitHub Apps" for details. For an example response, see "Response with GitHub plan information."

  • getHook: object
  • getMembership: object

    In order to get a user's membership with an organization, the authenticated user must be an organization member.

      • (params?: RequestOptions & Octokit.OrgsGetMembershipParams): Promise<Response<Octokit.OrgsGetMembershipResponse>>

      • Parameters

        Returns Promise<Response<Octokit.OrgsGetMembershipResponse>>

    • endpoint: Endpoint
  • getMembershipForAuthenticatedUser: object
      • (params?: RequestOptions & Octokit.OrgsGetMembershipForAuthenticatedUserParams): Promise<Response<Octokit.OrgsGetMembershipForAuthenticatedUserResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.OrgsGetMembershipForAuthenticatedUserParams

        Returns Promise<Response<Octokit.OrgsGetMembershipForAuthenticatedUserResponse>>

    • endpoint: Endpoint
  • list: object

    Lists all organizations, in the order that they were created on GitHub.

    Note: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.

  • listBlockedUsers: object

    List the users blocked by an organization.

      • (params?: RequestOptions & Octokit.OrgsListBlockedUsersParams): Promise<Response<Octokit.OrgsListBlockedUsersResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.OrgsListBlockedUsersParams

        Returns Promise<Response<Octokit.OrgsListBlockedUsersResponse>>

    • endpoint: Endpoint
  • listForAuthenticatedUser: object

    List organizations for the authenticated user.

    OAuth scope requirements

    This only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with read:org scope, you can publicize your organization membership with user scope, etc.). Therefore, this API requires at least user or read:org scope. OAuth requests with insufficient scope receive a 403 Forbidden response.

      • (params?: RequestOptions & Octokit.OrgsListForAuthenticatedUserParams): Promise<Response<Octokit.OrgsListForAuthenticatedUserResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.OrgsListForAuthenticatedUserParams

        Returns Promise<Response<Octokit.OrgsListForAuthenticatedUserResponse>>

    • endpoint: Endpoint
  • listForUser: object

    List public organization memberships for the specified user.

    This method only lists public memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the List your organizations API instead.

      • (params?: RequestOptions & Octokit.OrgsListForUserParams): Promise<Response<Octokit.OrgsListForUserResponse>>

      • Parameters

        Returns Promise<Response<Octokit.OrgsListForUserResponse>>

    • endpoint: Endpoint
  • listHooks: object
  • listInstallations: object

    Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with admin:read scope to use this endpoint.

      • (params?: RequestOptions & Octokit.OrgsListInstallationsParams): Promise<Response<Octokit.OrgsListInstallationsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.OrgsListInstallationsParams

        Returns Promise<Response<Octokit.OrgsListInstallationsResponse>>

    • endpoint: Endpoint
  • listInvitationTeams: object

    List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner.

      • (params?: RequestOptions & Octokit.OrgsListInvitationTeamsParams): Promise<Response<Octokit.OrgsListInvitationTeamsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.OrgsListInvitationTeamsParams

        Returns Promise<Response<Octokit.OrgsListInvitationTeamsResponse>>

    • endpoint: Endpoint
  • listMembers: object

    List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.

      • (params?: RequestOptions & Octokit.OrgsListMembersParams): Promise<Response<Octokit.OrgsListMembersResponse>>

      • Parameters

        Returns Promise<Response<Octokit.OrgsListMembersResponse>>

    • endpoint: Endpoint
  • listMemberships: object
      • (params?: RequestOptions & Octokit.OrgsListMembershipsParams): Promise<Response<Octokit.OrgsListMembershipsResponse>>

      • Parameters

        Returns Promise<Response<Octokit.OrgsListMembershipsResponse>>

    • endpoint: Endpoint
  • listOutsideCollaborators: object

    List all users who are outside collaborators of an organization.

      • (params?: RequestOptions & Octokit.OrgsListOutsideCollaboratorsParams): Promise<Response<Octokit.OrgsListOutsideCollaboratorsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.OrgsListOutsideCollaboratorsParams

        Returns Promise<Response<Octokit.OrgsListOutsideCollaboratorsResponse>>

    • endpoint: Endpoint
  • listPendingInvitations: object

    The return hash contains a role field which refers to the Organization Invitation role and will be one of the following values: direct_member, admin, billing_manager, hiring_manager, or reinstate. If the invitee is not a GitHub member, the login field in the return hash will be null.

      • (params?: RequestOptions & Octokit.OrgsListPendingInvitationsParams): Promise<Response<Octokit.OrgsListPendingInvitationsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.OrgsListPendingInvitationsParams

        Returns Promise<Response<Octokit.OrgsListPendingInvitationsResponse>>

    • endpoint: Endpoint
  • listPublicMembers: object

    Members of an organization can choose to have their membership publicized or not.

      • (params?: RequestOptions & Octokit.OrgsListPublicMembersParams): Promise<Response<Octokit.OrgsListPublicMembersResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.OrgsListPublicMembersParams

        Returns Promise<Response<Octokit.OrgsListPublicMembersResponse>>

    • endpoint: Endpoint
  • pingHook: object

    This will trigger a ping event to be sent to the hook.

      • (params?: RequestOptions & Octokit.OrgsPingHookParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • publicizeMembership: object

    The user can publicize their own membership. (A user cannot publicize the membership for another user.)

    Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."

      • (params?: RequestOptions & Octokit.OrgsPublicizeMembershipParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.OrgsPublicizeMembershipParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • removeMember: object

    Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.

      • (params?: RequestOptions & Octokit.OrgsRemoveMemberParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • removeMembership: object

    In order to remove a user's membership with an organization, the authenticated user must be an organization owner.

    If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.

      • (params?: RequestOptions & Octokit.OrgsRemoveMembershipParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.OrgsRemoveMembershipParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • removeOutsideCollaborator: object

    Removing a user from this list will remove them from all the organization's repositories.

      • (params?: RequestOptions & Octokit.OrgsRemoveOutsideCollaboratorParams): Promise<Response<Octokit.OrgsRemoveOutsideCollaboratorResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.OrgsRemoveOutsideCollaboratorParams

        Returns Promise<Response<Octokit.OrgsRemoveOutsideCollaboratorResponse>>

    • endpoint: Endpoint
  • unblockUser: object
      • (params?: RequestOptions & Octokit.OrgsUnblockUserParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • update: object

    Note: The new members_allowed_repository_creation_type replaces the functionality of members_can_create_repositories.

    Setting members_allowed_repository_creation_type will override the value of members_can_create_repositories in the following ways:

    • Setting members_allowed_repository_creation_type to all or private sets members_can_create_repositories to true.
    • Setting members_allowed_repository_creation_type to none sets members_can_create_repositories to false.
    • If you omit members_allowed_repository_creation_type, members_can_create_repositories is not modified.
  • updateHook: object

      • Parameters

        Returns Promise<Response<Octokit.OrgsUpdateHookResponse>>

    • endpoint: Endpoint
  • updateMembership: object
      • (params?: RequestOptions & Octokit.OrgsUpdateMembershipParams): Promise<Response<Octokit.OrgsUpdateMembershipResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.OrgsUpdateMembershipParams

        Returns Promise<Response<Octokit.OrgsUpdateMembershipResponse>>

    • endpoint: Endpoint

paginate

paginate: Paginate

projects

projects: object

Type declaration

  • addCollaborator: object

    Adds a collaborator to a an organization project and sets their permission level. You must be an organization owner or a project admin to add a collaborator.

      • (params?: RequestOptions & Octokit.ProjectsAddCollaboratorParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.ProjectsAddCollaboratorParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • createCard: object

    Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key.

    Be aware that the id of a pull request returned from "Issues" endpoints will be an issue id. To find out the pull request id, use the "List pull requests" endpoint.

      • (params?: RequestOptions & Octokit.ProjectsCreateCardParams): Promise<Response<Octokit.ProjectsCreateCardResponse>>

      • Parameters

        Returns Promise<Response<Octokit.ProjectsCreateCardResponse>>

    • endpoint: Endpoint
  • createColumn: object
      • (params?: RequestOptions & Octokit.ProjectsCreateColumnParams): Promise<Response<Octokit.ProjectsCreateColumnResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ProjectsCreateColumnParams

        Returns Promise<Response<Octokit.ProjectsCreateColumnResponse>>

    • endpoint: Endpoint
  • createForAuthenticatedUser: object
      • (params?: RequestOptions & Octokit.ProjectsCreateForAuthenticatedUserParams): Promise<Response<Octokit.ProjectsCreateForAuthenticatedUserResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ProjectsCreateForAuthenticatedUserParams

        Returns Promise<Response<Octokit.ProjectsCreateForAuthenticatedUserResponse>>

    • endpoint: Endpoint
  • createForOrg: object

    Creates an organization project board. Returns a 404 Not Found status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

      • (params?: RequestOptions & Octokit.ProjectsCreateForOrgParams): Promise<Response<Octokit.ProjectsCreateForOrgResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ProjectsCreateForOrgParams

        Returns Promise<Response<Octokit.ProjectsCreateForOrgResponse>>

    • endpoint: Endpoint
  • createForRepo: object

    Creates a repository project board. Returns a 404 Not Found status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

      • (params?: RequestOptions & Octokit.ProjectsCreateForRepoParams): Promise<Response<Octokit.ProjectsCreateForRepoResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ProjectsCreateForRepoParams

        Returns Promise<Response<Octokit.ProjectsCreateForRepoResponse>>

    • endpoint: Endpoint
  • delete: object

    Deletes a project board. Returns a 404 Not Found status if projects are disabled.

      • (params?: RequestOptions & Octokit.ProjectsDeleteParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • deleteCard: object
      • (params?: RequestOptions & Octokit.ProjectsDeleteCardParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • deleteColumn: object
      • (params?: RequestOptions & Octokit.ProjectsDeleteColumnParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.ProjectsDeleteColumnParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • get: object

    Gets a project by its id. Returns a 404 Not Found status if projects are disabled. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

  • getCard: object
      • (params?: RequestOptions & Octokit.ProjectsGetCardParams): Promise<Response<Octokit.ProjectsGetCardResponse>>

      • Parameters

        Returns Promise<Response<Octokit.ProjectsGetCardResponse>>

    • endpoint: Endpoint
  • getColumn: object
      • (params?: RequestOptions & Octokit.ProjectsGetColumnParams): Promise<Response<Octokit.ProjectsGetColumnResponse>>

      • Parameters

        Returns Promise<Response<Octokit.ProjectsGetColumnResponse>>

    • endpoint: Endpoint
  • listCards: object
      • (params?: RequestOptions & Octokit.ProjectsListCardsParams): Promise<Response<Octokit.ProjectsListCardsResponse>>

      • Parameters

        Returns Promise<Response<Octokit.ProjectsListCardsResponse>>

    • endpoint: Endpoint
  • listCollaborators: object

    Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project admin to list collaborators.

      • (params?: RequestOptions & Octokit.ProjectsListCollaboratorsParams): Promise<Response<Octokit.ProjectsListCollaboratorsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ProjectsListCollaboratorsParams

        Returns Promise<Response<Octokit.ProjectsListCollaboratorsResponse>>

    • endpoint: Endpoint
  • listColumns: object
      • (params?: RequestOptions & Octokit.ProjectsListColumnsParams): Promise<Response<Octokit.ProjectsListColumnsResponse>>

      • Parameters

        Returns Promise<Response<Octokit.ProjectsListColumnsResponse>>

    • endpoint: Endpoint
  • listForOrg: object

    Lists the projects in an organization. Returns a 404 Not Found status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

    s

      • (params?: RequestOptions & Octokit.ProjectsListForOrgParams): Promise<Response<Octokit.ProjectsListForOrgResponse>>

      • Parameters

        Returns Promise<Response<Octokit.ProjectsListForOrgResponse>>

    • endpoint: Endpoint
  • listForRepo: object

    Lists the projects in a repository. Returns a 404 Not Found status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

      • (params?: RequestOptions & Octokit.ProjectsListForRepoParams): Promise<Response<Octokit.ProjectsListForRepoResponse>>

      • Parameters

        Returns Promise<Response<Octokit.ProjectsListForRepoResponse>>

    • endpoint: Endpoint
  • listForUser: object
      • (params?: RequestOptions & Octokit.ProjectsListForUserParams): Promise<Response<Octokit.ProjectsListForUserResponse>>

      • Parameters

        Returns Promise<Response<Octokit.ProjectsListForUserResponse>>

    • endpoint: Endpoint
  • moveCard: object
      • (params?: RequestOptions & Octokit.ProjectsMoveCardParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • moveColumn: object
      • (params?: RequestOptions & Octokit.ProjectsMoveColumnParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • removeCollaborator: object

    Removes a collaborator from an organization project. You must be an organization owner or a project admin to remove a collaborator.

      • (params?: RequestOptions & Octokit.ProjectsRemoveCollaboratorParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.ProjectsRemoveCollaboratorParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • reviewUserPermissionLevel: object

    Returns the collaborator's permission level for an organization project. Possible values for the permission key: admin, write, read, none. You must be an organization owner or a project admin to review a user's permission level.

      • (params?: RequestOptions & Octokit.ProjectsReviewUserPermissionLevelParams): Promise<Response<Octokit.ProjectsReviewUserPermissionLevelResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ProjectsReviewUserPermissionLevelParams

        Returns Promise<Response<Octokit.ProjectsReviewUserPermissionLevelResponse>>

    • endpoint: Endpoint
  • update: object

    Updates a project board's information. Returns a 404 Not Found status if projects are disabled. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

      • Parameters

        Returns Promise<Response<Octokit.ProjectsUpdateResponse>>

    • endpoint: Endpoint
  • updateCard: object
      • (params?: RequestOptions & Octokit.ProjectsUpdateCardParams): Promise<Response<Octokit.ProjectsUpdateCardResponse>>

      • Parameters

        Returns Promise<Response<Octokit.ProjectsUpdateCardResponse>>

    • endpoint: Endpoint
  • updateColumn: object
      • (params?: RequestOptions & Octokit.ProjectsUpdateColumnParams): Promise<Response<Octokit.ProjectsUpdateColumnResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ProjectsUpdateColumnParams

        Returns Promise<Response<Octokit.ProjectsUpdateColumnResponse>>

    • endpoint: Endpoint

pulls

pulls: object

Type declaration

  • checkIfMerged: object
      • (params?: RequestOptions & Octokit.PullsCheckIfMergedParamsDeprecatedNumber): Promise<Octokit.AnyResponse>
      • (params?: RequestOptions & Octokit.PullsCheckIfMergedParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.PullsCheckIfMergedParamsDeprecatedNumber

        Returns Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • create: object

    Draft pull requests are available in public repositories with GitHub Free and GitHub Pro, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's billing plans in the GitHub Help documentation.

    To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

    You can create a new pull request.

    This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

  • createComment: object

    Note: Multi-line comments on pull requests are currently in public beta and subject to change.

    Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see "Comments." We recommend creating a review comment using line, side, and optionally start_line and start_side if your comment applies to more than one line in the pull request diff.

    You can still create a review comment using the position parameter. When you use position, the line, side, start_line, and start_side parameters are not required. For more information, see Multi-line comment summary.

    Note: The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

    This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

    Multi-line comment summary

    Note: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.

    Use the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.

    If you use the comfort-fade preview header, your response will show:

    • For multi-line comments, values for start_line, original_start_line, start_side, line, original_line, and side.
    • For single-line comments, values for line, original_line, and side and a null value for start_line, original_start_line, and start_side.

    If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:

    • For multi-line comments, the last line of the comment range for the position attribute.
    • For single-line comments, the diff-positioned way of referencing comments for the position attribute. For more information, see position in the input parameters table.
      • (params?: RequestOptions & Octokit.PullsCreateCommentParamsDeprecatedNumber): Promise<Response<Octokit.PullsCreateCommentResponse>>
      • (params?: RequestOptions & Octokit.PullsCreateCommentParamsDeprecatedInReplyTo): Promise<Response<Octokit.PullsCreateCommentResponse>>
      • (params?: RequestOptions & Octokit.PullsCreateCommentParams): Promise<Response<Octokit.PullsCreateCommentResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.PullsCreateCommentParamsDeprecatedNumber

        Returns Promise<Response<Octokit.PullsCreateCommentResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.PullsCreateCommentParamsDeprecatedInReplyTo

        Returns Promise<Response<Octokit.PullsCreateCommentResponse>>

      • Parameters

        Returns Promise<Response<Octokit.PullsCreateCommentResponse>>

    • endpoint: Endpoint
  • createCommentReply: object

    Note: Multi-line comments on pull requests are currently in public beta and subject to change.

    Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see "Comments." We recommend creating a review comment using line, side, and optionally start_line and start_side if your comment applies to more than one line in the pull request diff.

    You can still create a review comment using the position parameter. When you use position, the line, side, start_line, and start_side parameters are not required. For more information, see Multi-line comment summary.

    Note: The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

    This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

    Multi-line comment summary

    Note: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.

    Use the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.

    If you use the comfort-fade preview header, your response will show:

    • For multi-line comments, values for start_line, original_start_line, start_side, line, original_line, and side.
    • For single-line comments, values for line, original_line, and side and a null value for start_line, original_start_line, and start_side.

    If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:

    • For multi-line comments, the last line of the comment range for the position attribute.
    • For single-line comments, the diff-positioned way of referencing comments for the position attribute. For more information, see position in the input parameters table.
    deprecated

    octokit.pulls.createCommentReply() has been renamed to octokit.pulls.createComment() (2019-09-09)

      • (params?: RequestOptions & Octokit.PullsCreateCommentReplyParamsDeprecatedNumber): Promise<Response<Octokit.PullsCreateCommentReplyResponse>>
      • (params?: RequestOptions & Octokit.PullsCreateCommentReplyParamsDeprecatedInReplyTo): Promise<Response<Octokit.PullsCreateCommentReplyResponse>>
      • (params?: RequestOptions & Octokit.PullsCreateCommentReplyParams): Promise<Response<Octokit.PullsCreateCommentReplyResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.PullsCreateCommentReplyParamsDeprecatedNumber

        Returns Promise<Response<Octokit.PullsCreateCommentReplyResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.PullsCreateCommentReplyParamsDeprecatedInReplyTo

        Returns Promise<Response<Octokit.PullsCreateCommentReplyResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.PullsCreateCommentReplyParams

        Returns Promise<Response<Octokit.PullsCreateCommentReplyResponse>>

    • endpoint: Endpoint
  • createFromIssue: object
      • (params?: RequestOptions & Octokit.PullsCreateFromIssueParams): Promise<Response<Octokit.PullsCreateFromIssueResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.PullsCreateFromIssueParams

        Returns Promise<Response<Octokit.PullsCreateFromIssueResponse>>

    • endpoint: Endpoint
  • createReview: object

    This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

    Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API v3 offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.

    The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

      • (params?: RequestOptions & Octokit.PullsCreateReviewParamsDeprecatedNumber): Promise<Response<Octokit.PullsCreateReviewResponse>>
      • (params?: RequestOptions & Octokit.PullsCreateReviewParams): Promise<Response<Octokit.PullsCreateReviewResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.PullsCreateReviewParamsDeprecatedNumber

        Returns Promise<Response<Octokit.PullsCreateReviewResponse>>

      • Parameters

        Returns Promise<Response<Octokit.PullsCreateReviewResponse>>

    • endpoint: Endpoint
  • createReviewCommentReply: object

    Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.

    This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

      • (params?: RequestOptions & Octokit.PullsCreateReviewCommentReplyParams): Promise<Response<Octokit.PullsCreateReviewCommentReplyResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.PullsCreateReviewCommentReplyParams

        Returns Promise<Response<Octokit.PullsCreateReviewCommentReplyResponse>>

    • endpoint: Endpoint
  • createReviewRequest: object

    This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

      • (params?: RequestOptions & Octokit.PullsCreateReviewRequestParamsDeprecatedNumber): Promise<Response<Octokit.PullsCreateReviewRequestResponse>>
      • (params?: RequestOptions & Octokit.PullsCreateReviewRequestParams): Promise<Response<Octokit.PullsCreateReviewRequestResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.PullsCreateReviewRequestParamsDeprecatedNumber

        Returns Promise<Response<Octokit.PullsCreateReviewRequestResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.PullsCreateReviewRequestParams

        Returns Promise<Response<Octokit.PullsCreateReviewRequestResponse>>

    • endpoint: Endpoint
  • deleteComment: object

    Deletes a review comment.

      • (params?: RequestOptions & Octokit.PullsDeleteCommentParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • deletePendingReview: object
      • (params?: RequestOptions & Octokit.PullsDeletePendingReviewParamsDeprecatedNumber): Promise<Response<Octokit.PullsDeletePendingReviewResponse>>
      • (params?: RequestOptions & Octokit.PullsDeletePendingReviewParams): Promise<Response<Octokit.PullsDeletePendingReviewResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.PullsDeletePendingReviewParamsDeprecatedNumber

        Returns Promise<Response<Octokit.PullsDeletePendingReviewResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.PullsDeletePendingReviewParams

        Returns Promise<Response<Octokit.PullsDeletePendingReviewResponse>>

    • endpoint: Endpoint
  • deleteReviewRequest: object
      • (params?: RequestOptions & Octokit.PullsDeleteReviewRequestParamsDeprecatedNumber): Promise<Octokit.AnyResponse>
      • (params?: RequestOptions & Octokit.PullsDeleteReviewRequestParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.PullsDeleteReviewRequestParamsDeprecatedNumber

        Returns Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.PullsDeleteReviewRequestParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • dismissReview: object

    Note: To dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.

      • (params?: RequestOptions & Octokit.PullsDismissReviewParamsDeprecatedNumber): Promise<Response<Octokit.PullsDismissReviewResponse>>
      • (params?: RequestOptions & Octokit.PullsDismissReviewParams): Promise<Response<Octokit.PullsDismissReviewResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.PullsDismissReviewParamsDeprecatedNumber

        Returns Promise<Response<Octokit.PullsDismissReviewResponse>>

      • Parameters

        Returns Promise<Response<Octokit.PullsDismissReviewResponse>>

    • endpoint: Endpoint
  • get: object

    Draft pull requests are available in public repositories with GitHub Free and GitHub Pro, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's billing plans in the GitHub Help documentation.

    Lists details of a pull request by providing its number.

    When you get, create, or edit a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see "Checking mergeability of pull requests".

    The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.

    The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:

    • If merged as a merge commit, merge_commit_sha represents the SHA of the merge commit.
    • If merged via a squash, merge_commit_sha represents the SHA of the squashed commit on the base branch.
    • If rebased, merge_commit_sha represents the commit that the base branch was updated to.

    Pass the appropriate media type to fetch diff and patch formats.

      • Parameters

        • Optional params: RequestOptions & Octokit.PullsGetParamsDeprecatedNumber

        Returns Promise<Response<Octokit.PullsGetResponse>>

      • Parameters

        Returns Promise<Response<Octokit.PullsGetResponse>>

    • endpoint: Endpoint
  • getComment: object

    Note: Multi-line comments on pull requests are currently in public beta and subject to change.

    Provides details for a review comment.

    Multi-line comment summary

    Note: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.

    Use the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.

    If you use the comfort-fade preview header, your response will show:

    • For multi-line comments, values for start_line, original_start_line, start_side, line, original_line, and side.
    • For single-line comments, values for line, original_line, and side and a null value for start_line, original_start_line, and start_side.

    If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:

    • For multi-line comments, the last line of the comment range for the position attribute.
    • For single-line comments, the diff-positioned way of referencing comments for the position attribute. For more information, see position in the input parameters table.

    The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

      • (params?: RequestOptions & Octokit.PullsGetCommentParams): Promise<Response<Octokit.PullsGetCommentResponse>>

      • Parameters

        Returns Promise<Response<Octokit.PullsGetCommentResponse>>

    • endpoint: Endpoint
  • getCommentsForReview: object
      • (params?: RequestOptions & Octokit.PullsGetCommentsForReviewParamsDeprecatedNumber): Promise<Response<Octokit.PullsGetCommentsForReviewResponse>>
      • (params?: RequestOptions & Octokit.PullsGetCommentsForReviewParams): Promise<Response<Octokit.PullsGetCommentsForReviewResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.PullsGetCommentsForReviewParamsDeprecatedNumber

        Returns Promise<Response<Octokit.PullsGetCommentsForReviewResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.PullsGetCommentsForReviewParams

        Returns Promise<Response<Octokit.PullsGetCommentsForReviewResponse>>

    • endpoint: Endpoint
  • getReview: object
      • (params?: RequestOptions & Octokit.PullsGetReviewParamsDeprecatedNumber): Promise<Response<Octokit.PullsGetReviewResponse>>
      • (params?: RequestOptions & Octokit.PullsGetReviewParams): Promise<Response<Octokit.PullsGetReviewResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.PullsGetReviewParamsDeprecatedNumber

        Returns Promise<Response<Octokit.PullsGetReviewResponse>>

      • Parameters

        Returns Promise<Response<Octokit.PullsGetReviewResponse>>

    • endpoint: Endpoint
  • list: object

    Draft pull requests are available in public repositories with GitHub Free and GitHub Pro, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's billing plans in the GitHub Help documentation.

  • listComments: object

    Note: Multi-line comments on pull requests are currently in public beta and subject to change.

    Lists review comments for a pull request. By default, review comments are in ascending order by ID.

    Multi-line comment summary

    Note: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.

    Use the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.

    If you use the comfort-fade preview header, your response will show:

    • For multi-line comments, values for start_line, original_start_line, start_side, line, original_line, and side.
    • For single-line comments, values for line, original_line, and side and a null value for start_line, original_start_line, and start_side.

    If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:

    • For multi-line comments, the last line of the comment range for the position attribute.
    • For single-line comments, the diff-positioned way of referencing comments for the position attribute. For more information, see position in the input parameters table.

    The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

      • (params?: RequestOptions & Octokit.PullsListCommentsParamsDeprecatedNumber): Promise<Response<Octokit.PullsListCommentsResponse>>
      • (params?: RequestOptions & Octokit.PullsListCommentsParams): Promise<Response<Octokit.PullsListCommentsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.PullsListCommentsParamsDeprecatedNumber

        Returns Promise<Response<Octokit.PullsListCommentsResponse>>

      • Parameters

        Returns Promise<Response<Octokit.PullsListCommentsResponse>>

    • endpoint: Endpoint
  • listCommentsForRepo: object

    Note: Multi-line comments on pull requests are currently in public beta and subject to change.

    Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.

    Multi-line comment summary

    Note: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.

    Use the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.

    If you use the comfort-fade preview header, your response will show:

    • For multi-line comments, values for start_line, original_start_line, start_side, line, original_line, and side.
    • For single-line comments, values for line, original_line, and side and a null value for start_line, original_start_line, and start_side.

    If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:

    • For multi-line comments, the last line of the comment range for the position attribute.
    • For single-line comments, the diff-positioned way of referencing comments for the position attribute. For more information, see position in the input parameters table.

    The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

      • (params?: RequestOptions & Octokit.PullsListCommentsForRepoParams): Promise<Response<Octokit.PullsListCommentsForRepoResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.PullsListCommentsForRepoParams

        Returns Promise<Response<Octokit.PullsListCommentsForRepoResponse>>

    • endpoint: Endpoint
  • listCommits: object

    Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the Commit List API.

      • (params?: RequestOptions & Octokit.PullsListCommitsParamsDeprecatedNumber): Promise<Response<Octokit.PullsListCommitsResponse>>
      • (params?: RequestOptions & Octokit.PullsListCommitsParams): Promise<Response<Octokit.PullsListCommitsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.PullsListCommitsParamsDeprecatedNumber

        Returns Promise<Response<Octokit.PullsListCommitsResponse>>

      • Parameters

        Returns Promise<Response<Octokit.PullsListCommitsResponse>>

    • endpoint: Endpoint
  • listFiles: object

    Note: The response includes a maximum of 300 files.

      • (params?: RequestOptions & Octokit.PullsListFilesParamsDeprecatedNumber): Promise<Response<Octokit.PullsListFilesResponse>>
      • (params?: RequestOptions & Octokit.PullsListFilesParams): Promise<Response<Octokit.PullsListFilesResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.PullsListFilesParamsDeprecatedNumber

        Returns Promise<Response<Octokit.PullsListFilesResponse>>

      • Parameters

        Returns Promise<Response<Octokit.PullsListFilesResponse>>

    • endpoint: Endpoint
  • listReviewRequests: object
      • (params?: RequestOptions & Octokit.PullsListReviewRequestsParamsDeprecatedNumber): Promise<Response<Octokit.PullsListReviewRequestsResponse>>
      • (params?: RequestOptions & Octokit.PullsListReviewRequestsParams): Promise<Response<Octokit.PullsListReviewRequestsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.PullsListReviewRequestsParamsDeprecatedNumber

        Returns Promise<Response<Octokit.PullsListReviewRequestsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.PullsListReviewRequestsParams

        Returns Promise<Response<Octokit.PullsListReviewRequestsResponse>>

    • endpoint: Endpoint
  • listReviews: object

    The list of reviews returns in chronological order.

      • (params?: RequestOptions & Octokit.PullsListReviewsParamsDeprecatedNumber): Promise<Response<Octokit.PullsListReviewsResponse>>
      • (params?: RequestOptions & Octokit.PullsListReviewsParams): Promise<Response<Octokit.PullsListReviewsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.PullsListReviewsParamsDeprecatedNumber

        Returns Promise<Response<Octokit.PullsListReviewsResponse>>

      • Parameters

        Returns Promise<Response<Octokit.PullsListReviewsResponse>>

    • endpoint: Endpoint
  • merge: object

    This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

      • Parameters

        • Optional params: RequestOptions & Octokit.PullsMergeParamsDeprecatedNumber

        Returns Promise<Response<Octokit.PullsMergeResponse>>

      • Parameters

        Returns Promise<Response<Octokit.PullsMergeResponse>>

    • endpoint: Endpoint
  • submitReview: object
      • (params?: RequestOptions & Octokit.PullsSubmitReviewParamsDeprecatedNumber): Promise<Response<Octokit.PullsSubmitReviewResponse>>
      • (params?: RequestOptions & Octokit.PullsSubmitReviewParams): Promise<Response<Octokit.PullsSubmitReviewResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.PullsSubmitReviewParamsDeprecatedNumber

        Returns Promise<Response<Octokit.PullsSubmitReviewResponse>>

      • Parameters

        Returns Promise<Response<Octokit.PullsSubmitReviewResponse>>

    • endpoint: Endpoint
  • update: object

    Draft pull requests are available in public repositories with GitHub Free and GitHub Pro, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's billing plans in the GitHub Help documentation.

    To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

      • (params?: RequestOptions & Octokit.PullsUpdateParamsDeprecatedNumber): Promise<Response<Octokit.PullsUpdateResponse>>
      • (params?: RequestOptions & Octokit.PullsUpdateParams): Promise<Response<Octokit.PullsUpdateResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.PullsUpdateParamsDeprecatedNumber

        Returns Promise<Response<Octokit.PullsUpdateResponse>>

      • Parameters

        Returns Promise<Response<Octokit.PullsUpdateResponse>>

    • endpoint: Endpoint
  • updateBranch: object

    Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.

      • (params?: RequestOptions & Octokit.PullsUpdateBranchParams): Promise<Response<Octokit.PullsUpdateBranchResponse>>

      • Parameters

        Returns Promise<Response<Octokit.PullsUpdateBranchResponse>>

    • endpoint: Endpoint
  • updateComment: object

    Note: Multi-line comments on pull requests are currently in public beta and subject to change.

    Enables you to edit a review comment.

    Multi-line comment summary

    Note: New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the blog post for full details.

    Use the comfort-fade preview header and the line parameter to show multi-line comment-supported fields in the response.

    If you use the comfort-fade preview header, your response will show:

    • For multi-line comments, values for start_line, original_start_line, start_side, line, original_line, and side.
    • For single-line comments, values for line, original_line, and side and a null value for start_line, original_start_line, and start_side.

    If you don't use the comfort-fade preview header, multi-line and single-line comments will appear the same way in the response with a single position attribute. Your response will show:

    • For multi-line comments, the last line of the comment range for the position attribute.
    • For single-line comments, the diff-positioned way of referencing comments for the position attribute. For more information, see position in the input parameters table.
      • (params?: RequestOptions & Octokit.PullsUpdateCommentParams): Promise<Response<Octokit.PullsUpdateCommentResponse>>

      • Parameters

        Returns Promise<Response<Octokit.PullsUpdateCommentResponse>>

    • endpoint: Endpoint
  • updateReview: object

    Update the review summary comment with new text.

      • (params?: RequestOptions & Octokit.PullsUpdateReviewParamsDeprecatedNumber): Promise<Response<Octokit.PullsUpdateReviewResponse>>
      • (params?: RequestOptions & Octokit.PullsUpdateReviewParams): Promise<Response<Octokit.PullsUpdateReviewResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.PullsUpdateReviewParamsDeprecatedNumber

        Returns Promise<Response<Octokit.PullsUpdateReviewResponse>>

      • Parameters

        Returns Promise<Response<Octokit.PullsUpdateReviewResponse>>

    • endpoint: Endpoint

query

query: Graphql
deprecated

.query() is deprecated, use .graphql() instead

rateLimit

rateLimit: object

Type declaration

  • get: object

    Note: Accessing this endpoint does not count against your REST API rate limit.

    Understanding your rate limit status

    The Search API has a custom rate limit, separate from the rate limit governing the rest of the REST API. The GraphQL API also has a custom rate limit that is separate from and calculated differently than rate limits in the REST API.

    For these reasons, the Rate Limit API response categorizes your rate limit. Under resources, you'll see four objects:

    • The core object provides your rate limit status for all non-search-related resources in the REST API.
    • The search object provides your rate limit status for the Search API.
    • The graphql object provides your rate limit status for the GraphQL API.
    • The integration_manifest object provides your rate limit status for the GitHub App Manifest code conversion endpoint.

    For more information on the headers and values in the rate limit response, see "Rate limiting."

    The rate object (shown at the bottom of the response above) is deprecated.

    If you're writing new API client code or updating existing code, you should use the core object instead of the rate object. The core object contains the same information that is present in the rate object.

reactions

reactions: object

Type declaration

  • createForCommitComment: object

    Create a reaction to a commit comment. A response with a Status: 200 OK means that you already added the reaction type to this commit comment.

      • (params?: RequestOptions & Octokit.ReactionsCreateForCommitCommentParams): Promise<Response<Octokit.ReactionsCreateForCommitCommentResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReactionsCreateForCommitCommentParams

        Returns Promise<Response<Octokit.ReactionsCreateForCommitCommentResponse>>

    • endpoint: Endpoint
  • createForIssue: object

    Create a reaction to an issue. A response with a Status: 200 OK means that you already added the reaction type to this issue.

      • (params?: RequestOptions & Octokit.ReactionsCreateForIssueParamsDeprecatedNumber): Promise<Response<Octokit.ReactionsCreateForIssueResponse>>
      • (params?: RequestOptions & Octokit.ReactionsCreateForIssueParams): Promise<Response<Octokit.ReactionsCreateForIssueResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReactionsCreateForIssueParamsDeprecatedNumber

        Returns Promise<Response<Octokit.ReactionsCreateForIssueResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReactionsCreateForIssueParams

        Returns Promise<Response<Octokit.ReactionsCreateForIssueResponse>>

    • endpoint: Endpoint
  • createForIssueComment: object

    Create a reaction to an issue comment. A response with a Status: 200 OK means that you already added the reaction type to this issue comment.

      • (params?: RequestOptions & Octokit.ReactionsCreateForIssueCommentParams): Promise<Response<Octokit.ReactionsCreateForIssueCommentResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReactionsCreateForIssueCommentParams

        Returns Promise<Response<Octokit.ReactionsCreateForIssueCommentResponse>>

    • endpoint: Endpoint
  • createForPullRequestReviewComment: object

    Create a reaction to a pull request review comment. A response with a Status: 200 OK means that you already added the reaction type to this pull request review comment.

      • (params?: RequestOptions & Octokit.ReactionsCreateForPullRequestReviewCommentParams): Promise<Response<Octokit.ReactionsCreateForPullRequestReviewCommentResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReactionsCreateForPullRequestReviewCommentParams

        Returns Promise<Response<Octokit.ReactionsCreateForPullRequestReviewCommentResponse>>

    • endpoint: Endpoint
  • createForTeamDiscussion: object

    Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with a Status: 200 OK means that you already added the reaction type to this team discussion.

      • (params?: RequestOptions & Octokit.ReactionsCreateForTeamDiscussionParams): Promise<Response<Octokit.ReactionsCreateForTeamDiscussionResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReactionsCreateForTeamDiscussionParams

        Returns Promise<Response<Octokit.ReactionsCreateForTeamDiscussionResponse>>

    • endpoint: Endpoint
  • createForTeamDiscussionComment: object

    Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with a Status: 200 OK means that you already added the reaction type to this team discussion comment.

      • (params?: RequestOptions & Octokit.ReactionsCreateForTeamDiscussionCommentParams): Promise<Response<Octokit.ReactionsCreateForTeamDiscussionCommentResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReactionsCreateForTeamDiscussionCommentParams

        Returns Promise<Response<Octokit.ReactionsCreateForTeamDiscussionCommentResponse>>

    • endpoint: Endpoint
  • delete: object

    OAuth access tokens require the write:discussion scope, when deleting a team discussion or team discussion comment.

      • (params?: RequestOptions & Octokit.ReactionsDeleteParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • listForCommitComment: object

    List the reactions to a commit comment.

      • (params?: RequestOptions & Octokit.ReactionsListForCommitCommentParams): Promise<Response<Octokit.ReactionsListForCommitCommentResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReactionsListForCommitCommentParams

        Returns Promise<Response<Octokit.ReactionsListForCommitCommentResponse>>

    • endpoint: Endpoint
  • listForIssue: object

    List the reactions to an issue.

      • (params?: RequestOptions & Octokit.ReactionsListForIssueParamsDeprecatedNumber): Promise<Response<Octokit.ReactionsListForIssueResponse>>
      • (params?: RequestOptions & Octokit.ReactionsListForIssueParams): Promise<Response<Octokit.ReactionsListForIssueResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReactionsListForIssueParamsDeprecatedNumber

        Returns Promise<Response<Octokit.ReactionsListForIssueResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReactionsListForIssueParams

        Returns Promise<Response<Octokit.ReactionsListForIssueResponse>>

    • endpoint: Endpoint
  • listForIssueComment: object

    List the reactions to an issue comment.

      • (params?: RequestOptions & Octokit.ReactionsListForIssueCommentParams): Promise<Response<Octokit.ReactionsListForIssueCommentResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReactionsListForIssueCommentParams

        Returns Promise<Response<Octokit.ReactionsListForIssueCommentResponse>>

    • endpoint: Endpoint
  • listForPullRequestReviewComment: object

    List the reactions to a pull request review comment.

      • (params?: RequestOptions & Octokit.ReactionsListForPullRequestReviewCommentParams): Promise<Response<Octokit.ReactionsListForPullRequestReviewCommentResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReactionsListForPullRequestReviewCommentParams

        Returns Promise<Response<Octokit.ReactionsListForPullRequestReviewCommentResponse>>

    • endpoint: Endpoint
  • listForTeamDiscussion: object

    List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.

      • (params?: RequestOptions & Octokit.ReactionsListForTeamDiscussionParams): Promise<Response<Octokit.ReactionsListForTeamDiscussionResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReactionsListForTeamDiscussionParams

        Returns Promise<Response<Octokit.ReactionsListForTeamDiscussionResponse>>

    • endpoint: Endpoint
  • listForTeamDiscussionComment: object

    List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.

      • (params?: RequestOptions & Octokit.ReactionsListForTeamDiscussionCommentParams): Promise<Response<Octokit.ReactionsListForTeamDiscussionCommentResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReactionsListForTeamDiscussionCommentParams

        Returns Promise<Response<Octokit.ReactionsListForTeamDiscussionCommentResponse>>

    • endpoint: Endpoint

repos

repos: object

Type declaration

  • acceptInvitation: object
      • (params?: RequestOptions & Octokit.ReposAcceptInvitationParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposAcceptInvitationParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • addCollaborator: object

    This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

    Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."

    The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.

    Rate limits

    To prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.

      • (params?: RequestOptions & Octokit.ReposAddCollaboratorParams): Promise<Response<Octokit.ReposAddCollaboratorResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposAddCollaboratorParams

        Returns Promise<Response<Octokit.ReposAddCollaboratorResponse>>

    • endpoint: Endpoint
  • addDeployKey: object

    Here's how you can create a read-only deploy key:

      • (params?: RequestOptions & Octokit.ReposAddDeployKeyParams): Promise<Response<Octokit.ReposAddDeployKeyResponse>>

      • Parameters

        Returns Promise<Response<Octokit.ReposAddDeployKeyResponse>>

    • endpoint: Endpoint
  • addProtectedBranchAdminEnforcement: object

    Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's billing plans in the GitHub Help documentation.

    Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.

      • (params?: RequestOptions & Octokit.ReposAddProtectedBranchAdminEnforcementParams): Promise<Response<Octokit.ReposAddProtectedBranchAdminEnforcementResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposAddProtectedBranchAdminEnforcementParams

        Returns Promise<Response<Octokit.ReposAddProtectedBranchAdminEnforcementResponse>>

    • endpoint: Endpoint
  • addProtectedBranchAppRestrictions: object

    Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's billing plans in the GitHub Help documentation.

    Grants the specified apps push access for this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

    Type Description
    array The GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
      • (params?: RequestOptions & Octokit.ReposAddProtectedBranchAppRestrictionsParams): Promise<Response<Octokit.ReposAddProtectedBranchAppRestrictionsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposAddProtectedBranchAppRestrictionsParams

        Returns Promise<Response<Octokit.ReposAddProtectedBranchAppRestrictionsResponse>>

    • endpoint: Endpoint
  • addProtectedBranchRequiredSignatures: object

    Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's billing plans in the GitHub Help documentation.

    When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.

      • (params?: RequestOptions & Octokit.ReposAddProtectedBranchRequiredSignaturesParams): Promise<Response<Octokit.ReposAddProtectedBranchRequiredSignaturesResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposAddProtectedBranchRequiredSignaturesParams

        Returns Promise<Response<Octokit.ReposAddProtectedBranchRequiredSignaturesResponse>>

    • endpoint: Endpoint
  • addProtectedBranchRequiredStatusChecksContexts: object

    Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's billing plans in the GitHub Help documentation.

      • (params?: RequestOptions & Octokit.ReposAddProtectedBranchRequiredStatusChecksContextsParams): Promise<Response<Octokit.ReposAddProtectedBranchRequiredStatusChecksContextsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposAddProtectedBranchRequiredStatusChecksContextsParams

        Returns Promise<Response<Octokit.ReposAddProtectedBranchRequiredStatusChecksContextsResponse>>

    • endpoint: Endpoint
  • addProtectedBranchTeamRestrictions: object

    Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's billing plans in the GitHub Help documentation.

    Grants the specified teams push access for this branch. If you pass the hellcat-preview media type, you can also give push access to child teams.

    Type Description
    array The teams that can have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
      • (params?: RequestOptions & Octokit.ReposAddProtectedBranchTeamRestrictionsParams): Promise<Response<Octokit.ReposAddProtectedBranchTeamRestrictionsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposAddProtectedBranchTeamRestrictionsParams

        Returns Promise<Response<Octokit.ReposAddProtectedBranchTeamRestrictionsResponse>>

    • endpoint: Endpoint
  • addProtectedBranchUserRestrictions: object

    Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's billing plans in the GitHub Help documentation.

    Grants the specified people push access for this branch.

    Type Description
    array Usernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
      • (params?: RequestOptions & Octokit.ReposAddProtectedBranchUserRestrictionsParams): Promise<Response<Octokit.ReposAddProtectedBranchUserRestrictionsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposAddProtectedBranchUserRestrictionsParams

        Returns Promise<Response<Octokit.ReposAddProtectedBranchUserRestrictionsResponse>>

    • endpoint: Endpoint
  • checkCollaborator: object

    For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.

    If you pass the hellcat-preview media type, team members will include the members of child teams.

      • (params?: RequestOptions & Octokit.ReposCheckCollaboratorParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposCheckCollaboratorParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • checkVulnerabilityAlerts: object

    Shows whether vulnerability alerts are enabled or disabled for a repository. The authenticated user must have admin access to the repository. For more information, see "About security alerts for vulnerable dependencies" in the GitHub Help documentation.

      • (params?: RequestOptions & Octokit.ReposCheckVulnerabilityAlertsParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposCheckVulnerabilityAlertsParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • compareCommits: object

    Both :base and :head must be branch names in :repo. To compare branches across other repositories in the same network as :repo, use the format <USERNAME>:branch.

    The response from the API is equivalent to running the git log base..head command; however, commits are returned in chronological order. Pass the appropriate media type to fetch diff and patch formats.

    The response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a renamed status have a previous_filename field showing the previous filename of the file, and files with a modified status have a patch field showing the changes made to the file.

    Working with large comparisons

    The response will include a comparison of up to 250 commits. If you are working with a larger commit range, you can use the Commit List API to enumerate all commits in the range.

    For comparisons with extremely large diffs, you may receive an error response indicating that the diff took too long to generate. You can typically resolve this error by using a smaller commit range.

    Signature verification object

    The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:

    These are the possible values for reason in the verification object:

    Value Description
    expired_key The key that made the signature is expired.
    not_signing_key The "signing" flag is not among the usage flags in the GPG key that made the signature.
    gpgverify_error There was an error communicating with the signature verification service.
    gpgverify_unavailable The signature verification service is currently unavailable.
    unsigned The object does not include a signature.
    unknown_signature_type A non-PGP signature was found in the commit.
    no_user No user was associated with the committer email address in the commit.
    unverified_email The committer email address in the commit was associated with a user, but the email address is not verified on her/his account.
    bad_email The committer email address in the commit is not included in the identities of the PGP key that made the signature.
    unknown_key The key that made the signature has not been registered with any user's account.
    malformed_signature There was an error parsing the signature.
    invalid The signature could not be cryptographically verified using the key whose key-id was found in the signature.
    valid None of the above errors applied, so the signature is considered to be verified.
      • (params?: RequestOptions & Octokit.ReposCompareCommitsParams): Promise<Response<Octokit.ReposCompareCommitsResponse>>

      • Parameters

        Returns Promise<Response<Octokit.ReposCompareCommitsResponse>>

    • endpoint: Endpoint
  • createCommitComment: object

    Create a comment for a commit using its :commit_sha.

    This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

      • (params?: RequestOptions & Octokit.ReposCreateCommitCommentParamsDeprecatedSha): Promise<Response<Octokit.ReposCreateCommitCommentResponse>>
      • (params?: RequestOptions & Octokit.ReposCreateCommitCommentParamsDeprecatedLine): Promise<Response<Octokit.ReposCreateCommitCommentResponse>>
      • (params?: RequestOptions & Octokit.ReposCreateCommitCommentParams): Promise<Response<Octokit.ReposCreateCommitCommentResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposCreateCommitCommentParamsDeprecatedSha

        Returns Promise<Response<Octokit.ReposCreateCommitCommentResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposCreateCommitCommentParamsDeprecatedLine

        Returns Promise<Response<Octokit.ReposCreateCommitCommentResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposCreateCommitCommentParams

        Returns Promise<Response<Octokit.ReposCreateCommitCommentResponse>>

    • endpoint: Endpoint
  • createDeployment: object

    Deployments offer a few configurable parameters with sane defaults.

    The ref parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them before we merge a pull request.

    The environment parameter allows deployments to be issued to different runtime environments. Teams often have multiple environments for verifying their applications, such as production, staging, and qa. This parameter makes it easier to track which environments have requested deployments. The default environment is production.

    The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If the ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds, the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will return a failure response.

    By default, commit statuses for every submitted context must be in a success state. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do not require any contexts or create any commit statuses, the deployment will always succeed.

    The payload parameter is available for any extra information that a deployment system might need. It is a JSON text field that will be passed on when a deployment event is dispatched.

    The task parameter is used by the deployment system to allow different execution paths. In the web world this might be deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an application with debugging enabled.

    Users with repo or repo_deployment scopes can create a deployment for a given ref:

    A simple example putting the user and room into the payload to notify back to chat networks.

    A more advanced example specifying required commit statuses and bypassing auto-merging.

    You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating a deployment. This auto-merge happens when:

    • Auto-merge option is enabled in the repository
    • Topic branch does not include the latest changes on the base branch, which is masterin the response example
    • There are no merge conflicts

    If there are no new commits in the base branch, a new request to create a deployment should give a successful response.

    This error happens when the auto_merge option is enabled and when the default branch (in this case master), can't be merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.

    This error happens when the required_contexts parameter indicates that one or more contexts need to have a success status for the commit to be deployed, but one or more of the required contexts do not have a state of success.

      • (params?: RequestOptions & Octokit.ReposCreateDeploymentParams): Promise<Response<Octokit.ReposCreateDeploymentResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposCreateDeploymentParams

        Returns Promise<Response<Octokit.ReposCreateDeploymentResponse>>

    • endpoint: Endpoint
  • createDeploymentStatus: object

    Users with push access can create deployment statuses for a given deployment.

    GitHub Apps require read & write access to "Deployments" and read-only access to "Repo contents" (for private repos). OAuth Apps require the repo_deployment scope.

      • (params?: RequestOptions & Octokit.ReposCreateDeploymentStatusParams): Promise<Response<Octokit.ReposCreateDeploymentStatusResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposCreateDeploymentStatusParams

        Returns Promise<Response<Octokit.ReposCreateDeploymentStatusResponse>>

    • endpoint: Endpoint
  • createDispatchEvent: object

    You can use this endpoint to trigger a webhook event called repository_dispatch when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the repository_dispatch event occurs. For an example repository_dispatch webhook payload, see "RepositoryDispatchEvent."

    The client_payload parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the client_payload can include a message that a user would like to send using a GitHub Actions workflow. Or the client_payload can be used as a test to debug your workflow. For a test example, see the input example.

    To give you write access to the repository, you must use a personal access token with the repo scope. For more information, see "Creating a personal access token for the command line" in the GitHub Help documentation.

    This input example shows how you can use the client_payload as a test to debug your workflow.

      • (params?: RequestOptions & Octokit.ReposCreateDispatchEventParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposCreateDispatchEventParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • createFile: object

    Creates a new file or updates an existing file in a repository.

    deprecated

    octokit.repos.createFile() has been renamed to octokit.repos.createOrUpdateFile() (2019-06-07)

      • (params?: RequestOptions & Octokit.ReposCreateFileParams): Promise<Response<Octokit.ReposCreateFileResponse>>

      • Parameters

        Returns Promise<Response<Octokit.ReposCreateFileResponse>>

    • endpoint: Endpoint
  • createForAuthenticatedUser: object

    Creates a new repository for the authenticated user.

    OAuth scope requirements

    When using OAuth, authorizations must include:

    • public_repo scope or repo scope to create a public repository
    • repo scope to create a private repository
      • (params?: RequestOptions & Octokit.ReposCreateForAuthenticatedUserParams): Promise<Response<Octokit.ReposCreateForAuthenticatedUserResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposCreateForAuthenticatedUserParams

        Returns Promise<Response<Octokit.ReposCreateForAuthenticatedUserResponse>>

    • endpoint: Endpoint
  • createFork: object

    Create a fork for the authenticated user.

    Note: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact GitHub Support.

      • (params?: RequestOptions & Octokit.ReposCreateForkParams): Promise<Response<Octokit.ReposCreateForkResponse>>

      • Parameters

        Returns Promise<Response<Octokit.ReposCreateForkResponse>>

    • endpoint: Endpoint
  • createHook: object

    Repositories can have multiple webhooks installed. Each webhook should have a unique config. Multiple webhooks can share the same config as long as those webhooks do not have any events that overlap.

    Here's how you can create a hook that posts payloads in JSON format:

      • (params?: RequestOptions & Octokit.ReposCreateHookParams): Promise<Response<Octokit.ReposCreateHookResponse>>

      • Parameters

        Returns Promise<Response<Octokit.ReposCreateHookResponse>>

    • endpoint: Endpoint
  • createInOrg: object

    Creates a new repository for the authenticated user.

    OAuth scope requirements

    When using OAuth, authorizations must include:

    • public_repo scope or repo scope to create a public repository
    • repo scope to create a private repository
      • (params?: RequestOptions & Octokit.ReposCreateInOrgParams): Promise<Response<Octokit.ReposCreateInOrgResponse>>

      • Parameters

        Returns Promise<Response<Octokit.ReposCreateInOrgResponse>>

    • endpoint: Endpoint
  • createOrUpdateFile: object

    Creates a new file or updates an existing file in a repository.

      • (params?: RequestOptions & Octokit.ReposCreateOrUpdateFileParams): Promise<Response<Octokit.ReposCreateOrUpdateFileResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposCreateOrUpdateFileParams

        Returns Promise<Response<Octokit.ReposCreateOrUpdateFileResponse>>

    • endpoint: Endpoint
  • createRelease: object

    Users with push access to the repository can create a release.

    This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

      • (params?: RequestOptions & Octokit.ReposCreateReleaseParams): Promise<Response<Octokit.ReposCreateReleaseResponse>>

      • Parameters

        Returns Promise<Response<Octokit.ReposCreateReleaseResponse>>

    • endpoint: Endpoint
  • createStatus: object

    Users with push access in a repository can create commit statuses for a given SHA.

    Note: there is a limit of 1000 statuses per sha and context within a repository. Attempts to create more than 1000 statuses will result in a validation error.

      • (params?: RequestOptions & Octokit.ReposCreateStatusParams): Promise<Response<Octokit.ReposCreateStatusResponse>>

      • Parameters

        Returns Promise<Response<Octokit.ReposCreateStatusResponse>>

    • endpoint: Endpoint
  • createUsingTemplate: object

    Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the GET /repos/:owner/:repo endpoint and check that the is_template key is true.

    OAuth scope requirements

    When using OAuth, authorizations must include:

    • public_repo scope or repo scope to create a public repository
    • repo scope to create a private repository

    `

      • (params?: RequestOptions & Octokit.ReposCreateUsingTemplateParams): Promise<Response<Octokit.ReposCreateUsingTemplateResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposCreateUsingTemplateParams

        Returns Promise<Response<Octokit.ReposCreateUsingTemplateResponse>>

    • endpoint: Endpoint
  • declineInvitation: object
      • (params?: RequestOptions & Octokit.ReposDeclineInvitationParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposDeclineInvitationParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • delete: object

    Deleting a repository requires admin access. If OAuth is used, the delete_repo scope is required.

    If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response:

  • deleteCommitComment: object
      • (params?: RequestOptions & Octokit.ReposDeleteCommitCommentParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposDeleteCommitCommentParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • deleteDownload: object
      • (params?: RequestOptions & Octokit.ReposDeleteDownloadParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • deleteFile: object

    Deletes a file in a repository.

    You can provide an additional committer parameter, which is an object containing information about the committer. Or, you can provide an author parameter, which is an object containing information about the author.

    The author section is optional and is filled in with the committer information if omitted. If the committer information is omitted, the authenticated user's information is used.

    You must provide values for both name and email, whether you choose to use author or committer. Otherwise, you'll receive a 422 status code.

      • (params?: RequestOptions & Octokit.ReposDeleteFileParams): Promise<Response<Octokit.ReposDeleteFileResponse>>

      • Parameters

        Returns Promise<Response<Octokit.ReposDeleteFileResponse>>

    • endpoint: Endpoint
  • deleteHook: object
      • (params?: RequestOptions & Octokit.ReposDeleteHookParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • deleteInvitation: object
      • (params?: RequestOptions & Octokit.ReposDeleteInvitationParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposDeleteInvitationParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • deleteRelease: object

    Users with push access to the repository can delete a release.

      • (params?: RequestOptions & Octokit.ReposDeleteReleaseParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • deleteReleaseAsset: object
      • (params?: RequestOptions & Octokit.ReposDeleteReleaseAssetParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposDeleteReleaseAssetParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • disableAutomatedSecurityFixes: object

    Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "Configuring automated security fixes" in the GitHub Help documentation.

      • (params?: RequestOptions & Octokit.ReposDisableAutomatedSecurityFixesParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposDisableAutomatedSecurityFixesParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • disablePagesSite: object
      • (params?: RequestOptions & Octokit.ReposDisablePagesSiteParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposDisablePagesSiteParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • disableVulnerabilityAlerts: object

    Disables vulnerability alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "About security alerts for vulnerable dependencies" in the GitHub Help documentation.

      • (params?: RequestOptions & Octokit.ReposDisableVulnerabilityAlertsParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposDisableVulnerabilityAlertsParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • enableAutomatedSecurityFixes: object

    Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "Configuring automated security fixes" in the GitHub Help documentation.

      • (params?: RequestOptions & Octokit.ReposEnableAutomatedSecurityFixesParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposEnableAutomatedSecurityFixesParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • enablePagesSite: object
      • (params?: RequestOptions & Octokit.ReposEnablePagesSiteParams): Promise<Response<Octokit.ReposEnablePagesSiteResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposEnablePagesSiteParams

        Returns Promise<Response<Octokit.ReposEnablePagesSiteResponse>>

    • endpoint: Endpoint
  • enableVulnerabilityAlerts: object

    Enables vulnerability alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "About security alerts for vulnerable dependencies" in the GitHub Help documentation.

      • (params?: RequestOptions & Octokit.ReposEnableVulnerabilityAlertsParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposEnableVulnerabilityAlertsParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • get: object

    The parent and source objects are present when the repository is a fork. parent is the repository this repository was forked from, source is the ultimate source for the network.

  • getAppsWithAccessToProtectedBranch: object

    Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's billing plans in the GitHub Help documentation.

    Lists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

      • (params?: RequestOptions & Octokit.ReposGetAppsWithAccessToProtectedBranchParams): Promise<Response<Octokit.ReposGetAppsWithAccessToProtectedBranchResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposGetAppsWithAccessToProtectedBranchParams

        Returns Promise<Response<Octokit.ReposGetAppsWithAccessToProtectedBranchResponse>>

    • endpoint: Endpoint
  • getArchiveLink: object

    Gets a redirect URL to download an archive for a repository. The :archive_format can be either tarball or zipball. The :ref must be a valid Git reference. If you omit :ref, the repository’s default branch (usually master) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use the Location header to make a second GET request.

    Note: For private repositories, these links are temporary and expire after five minutes.

    To follow redirects with curl, use the -L switch:

      • (params?: RequestOptions & Octokit.ReposGetArchiveLinkParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • getBranch: object

      • Parameters

        Returns Promise<Response<Octokit.ReposGetBranchResponse>>

    • endpoint: Endpoint
  • getBranchProtection: object

    Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's billing plans in the GitHub Help documentation.

      • (params?: RequestOptions & Octokit.ReposGetBranchProtectionParams): Promise<Response<Octokit.ReposGetBranchProtectionResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposGetBranchProtectionParams

        Returns Promise<Response<Octokit.ReposGetBranchProtectionResponse>>

    • endpoint: Endpoint
  • getClones: object

    Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.

      • Parameters

        Returns Promise<Response<Octokit.ReposGetClonesResponse>>

    • endpoint: Endpoint
  • getCodeFrequencyStats: object

    Returns a weekly aggregate of the number of additions and deletions pushed to a repository.

      • (params?: RequestOptions & Octokit.ReposGetCodeFrequencyStatsParams): Promise<Response<Octokit.ReposGetCodeFrequencyStatsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposGetCodeFrequencyStatsParams

        Returns Promise<Response<Octokit.ReposGetCodeFrequencyStatsResponse>>

    • endpoint: Endpoint
  • getCollaboratorPermissionLevel: object

    Possible values for the permission key: admin, write, read, none.

      • (params?: RequestOptions & Octokit.ReposGetCollaboratorPermissionLevelParams): Promise<Response<Octokit.ReposGetCollaboratorPermissionLevelResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposGetCollaboratorPermissionLevelParams

        Returns Promise<Response<Octokit.ReposGetCollaboratorPermissionLevelResponse>>

    • endpoint: Endpoint
  • getCombinedStatusForRef: object

    Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.

    The most recent status for each context is returned, up to 100. This field paginates if there are over 100 contexts.

    Additionally, a combined state is returned. The state is one of:

    • failure if any of the contexts report as error or failure
    • pending if there are no statuses or a context is pending
    • success if the latest status for all contexts is success
      • (params?: RequestOptions & Octokit.ReposGetCombinedStatusForRefParams): Promise<Response<Octokit.ReposGetCombinedStatusForRefResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposGetCombinedStatusForRefParams

        Returns Promise<Response<Octokit.ReposGetCombinedStatusForRefResponse>>

    • endpoint: Endpoint
  • getCommit: object

    Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.

    You can pass the appropriate media type to fetch diff and patch formats. Diffs with binary data will have no patch property.

    To return only the SHA-1 hash of the commit reference, you can provide the sha custom media type in the Accept header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.

    Signature verification object

    The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:

    These are the possible values for reason in the verification object:

    Value Description
    expired_key The key that made the signature is expired.
    not_signing_key The "signing" flag is not among the usage flags in the GPG key that made the signature.
    gpgverify_error There was an error communicating with the signature verification service.
    gpgverify_unavailable The signature verification service is currently unavailable.
    unsigned The object does not include a signature.
    unknown_signature_type A non-PGP signature was found in the commit.
    no_user No user was associated with the committer email address in the commit.
    unverified_email The committer email address in the commit was associated with a user, but the email address is not verified on her/his account.
    bad_email The committer email address in the commit is not included in the identities of the PGP key that made the signature.
    unknown_key The key that made the signature has not been registered with any user's account.
    malformed_signature There was an error parsing the signature.
    invalid The signature could not be cryptographically verified using the key whose key-id was found in the signature.
    valid None of the above errors applied, so the signature is considered to be verified.
      • (params?: RequestOptions & Octokit.ReposGetCommitParamsDeprecatedSha): Promise<Response<Octokit.ReposGetCommitResponse>>
      • (params?: RequestOptions & Octokit.ReposGetCommitParamsDeprecatedCommitSha): Promise<Response<Octokit.ReposGetCommitResponse>>
      • (params?: RequestOptions & Octokit.ReposGetCommitParams): Promise<Response<Octokit.ReposGetCommitResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposGetCommitParamsDeprecatedSha

        Returns Promise<Response<Octokit.ReposGetCommitResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposGetCommitParamsDeprecatedCommitSha

        Returns Promise<Response<Octokit.ReposGetCommitResponse>>

      • Parameters

        Returns Promise<Response<Octokit.ReposGetCommitResponse>>

    • endpoint: Endpoint
  • getCommitActivityStats: object

    Returns the last year of commit activity grouped by week. The days array is a group of commits per day, starting on Sunday.

      • (params?: RequestOptions & Octokit.ReposGetCommitActivityStatsParams): Promise<Response<Octokit.ReposGetCommitActivityStatsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposGetCommitActivityStatsParams

        Returns Promise<Response<Octokit.ReposGetCommitActivityStatsResponse>>

    • endpoint: Endpoint
  • getCommitComment: object
      • (params?: RequestOptions & Octokit.ReposGetCommitCommentParams): Promise<Response<Octokit.ReposGetCommitCommentResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposGetCommitCommentParams

        Returns Promise<Response<Octokit.ReposGetCommitCommentResponse>>

    • endpoint: Endpoint
  • getCommitRefSha: object

    Note: To access this endpoint, you must provide a custom media type in the Accept header:

    application/vnd.github.VERSION.sha

    Returns the SHA-1 of the commit reference. You must have read access for the repository to get the SHA-1 of a commit reference. You can use this endpoint to check if a remote reference's SHA-1 is the same as your local reference's SHA-1 by providing the local SHA-1 reference as the ETag.

    deprecated

    "Get the SHA-1 of a commit reference" will be removed. Use "Get a single commit" instead with media type format set to "sha" instead.

      • (params?: RequestOptions & Octokit.ReposGetCommitRefShaParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposGetCommitRefShaParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • getContents: object

    Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit :path, you will receive the contents of all files in the repository.

    Files and symlinks support a custom media type for retrieving the raw content or rendered HTML (when supported). All content types support a custom media type to ensure the content is returned in a consistent object format.

    Note:

    • To get a repository's contents recursively, you can recursively get the tree.
    • This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees API.
    • This API supports files up to 1 megabyte in size.

    The response will be an array of objects, one object for each item in the directory.

    When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value should be "submodule". This behavior exists in API v3 for backwards compatibility purposes. In the next major version of the API, the type will be returned as "submodule".

    If the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the API responds with the content of the file (in the format shown above).

    Otherwise, the API responds with an object describing the symlink itself:

    The submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit.

    If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links["git"]) and the github.com URLs (html_url and _links["html"]) will have null values.

      • (params?: RequestOptions & Octokit.ReposGetContentsParams): Promise<Response<Octokit.ReposGetContentsResponse>>

      • Parameters

        Returns Promise<Response<Octokit.ReposGetContentsResponse>>

    • endpoint: Endpoint
  • getContributorsStats: object
    • total - The Total number of commits authored by the contributor.

    Weekly Hash (weeks array):

    • w - Start of the week, given as a Unix timestamp.
    • a - Number of additions
    • d - Number of deletions
    • c - Number of commits
      • (params?: RequestOptions & Octokit.ReposGetContributorsStatsParams): Promise<Response<Octokit.ReposGetContributorsStatsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposGetContributorsStatsParams

        Returns Promise<Response<Octokit.ReposGetContributorsStatsResponse>>

    • endpoint: Endpoint
  • getDeployKey: object
      • (params?: RequestOptions & Octokit.ReposGetDeployKeyParams): Promise<Response<Octokit.ReposGetDeployKeyResponse>>

      • Parameters

        Returns Promise<Response<Octokit.ReposGetDeployKeyResponse>>

    • endpoint: Endpoint
  • getDeployment: object
      • (params?: RequestOptions & Octokit.ReposGetDeploymentParams): Promise<Response<Octokit.ReposGetDeploymentResponse>>

      • Parameters

        Returns Promise<Response<Octokit.ReposGetDeploymentResponse>>

    • endpoint: Endpoint
  • getDeploymentStatus: object

    Users with pull access can view a deployment status for a deployment:

      • (params?: RequestOptions & Octokit.ReposGetDeploymentStatusParams): Promise<Response<Octokit.ReposGetDeploymentStatusResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposGetDeploymentStatusParams

        Returns Promise<Response<Octokit.ReposGetDeploymentStatusResponse>>

    • endpoint: Endpoint
  • getDownload: object
      • (params?: RequestOptions & Octokit.ReposGetDownloadParams): Promise<Response<Octokit.ReposGetDownloadResponse>>

      • Parameters

        Returns Promise<Response<Octokit.ReposGetDownloadResponse>>

    • endpoint: Endpoint
  • getHook: object
  • getLatestPagesBuild: object
      • (params?: RequestOptions & Octokit.ReposGetLatestPagesBuildParams): Promise<Response<Octokit.ReposGetLatestPagesBuildResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposGetLatestPagesBuildParams

        Returns Promise<Response<Octokit.ReposGetLatestPagesBuildResponse>>

    • endpoint: Endpoint
  • getLatestRelease: object

    View the latest published full release for the repository.

    The latest release is the most recent non-prerelease, non-draft release, sorted by the created_at attribute. The created_at attribute is the date of the commit used for the release, and not the date when the release was drafted or published.

      • (params?: RequestOptions & Octokit.ReposGetLatestReleaseParams): Promise<Response<Octokit.ReposGetLatestReleaseResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposGetLatestReleaseParams

        Returns Promise<Response<Octokit.ReposGetLatestReleaseResponse>>

    • endpoint: Endpoint
  • getPages: object
  • getPagesBuild: object
      • (params?: RequestOptions & Octokit.ReposGetPagesBuildParams): Promise<Response<Octokit.ReposGetPagesBuildResponse>>

      • Parameters

        Returns Promise<Response<Octokit.ReposGetPagesBuildResponse>>

    • endpoint: Endpoint
  • getParticipationStats: object

    Returns the total commit counts for the owner and total commit counts in all. all is everyone combined, including the owner in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract owner from all.

    The array order is oldest week (index 0) to most recent week.

      • (params?: RequestOptions & Octokit.ReposGetParticipationStatsParams): Promise<Response<Octokit.ReposGetParticipationStatsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposGetParticipationStatsParams

        Returns Promise<Response<Octokit.ReposGetParticipationStatsResponse>>

    • endpoint: Endpoint
  • getProtectedBranchAdminEnforcement: object

    Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's billing plans in the GitHub Help documentation.

      • (params?: RequestOptions & Octokit.ReposGetProtectedBranchAdminEnforcementParams): Promise<Response<Octokit.ReposGetProtectedBranchAdminEnforcementResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposGetProtectedBranchAdminEnforcementParams

        Returns Promise<Response<Octokit.ReposGetProtectedBranchAdminEnforcementResponse>>

    • endpoint: Endpoint
  • getProtectedBranchPullRequestReviewEnforcement: object

    Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's billing plans in the GitHub Help documentation.

      • (params?: RequestOptions & Octokit.ReposGetProtectedBranchPullRequestReviewEnforcementParams): Promise<Response<Octokit.ReposGetProtectedBranchPullRequestReviewEnforcementResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposGetProtectedBranchPullRequestReviewEnforcementParams

        Returns Promise<Response<Octokit.ReposGetProtectedBranchPullRequestReviewEnforcementResponse>>

    • endpoint: Endpoint
  • getProtectedBranchRequiredSignatures: object

    Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's billing plans in the GitHub Help documentation.

    When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of true indicates you must sign commits on this branch. For more information, see Signing commits with GPG in GitHub Help.

    Note: You must enable branch protection to require signed commits.

      • (params?: RequestOptions & Octokit.ReposGetProtectedBranchRequiredSignaturesParams): Promise<Response<Octokit.ReposGetProtectedBranchRequiredSignaturesResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposGetProtectedBranchRequiredSignaturesParams

        Returns Promise<Response<Octokit.ReposGetProtectedBranchRequiredSignaturesResponse>>

    • endpoint: Endpoint
  • getProtectedBranchRequiredStatusChecks: object

    Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's billing plans in the GitHub Help documentation.

      • (params?: RequestOptions & Octokit.ReposGetProtectedBranchRequiredStatusChecksParams): Promise<Response<Octokit.ReposGetProtectedBranchRequiredStatusChecksResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposGetProtectedBranchRequiredStatusChecksParams

        Returns Promise<Response<Octokit.ReposGetProtectedBranchRequiredStatusChecksResponse>>

    • endpoint: Endpoint
  • getProtectedBranchRestrictions: object

    Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's billing plans in the GitHub Help documentation.

    Lists who has access to this protected branch. {{#note}}

    Note: Users, apps, and teams restrictions are only available for organization-owned repositories.

      • (params?: RequestOptions & Octokit.ReposGetProtectedBranchRestrictionsParams): Promise<Response<Octokit.ReposGetProtectedBranchRestrictionsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposGetProtectedBranchRestrictionsParams

        Returns Promise<Response<Octokit.ReposGetProtectedBranchRestrictionsResponse>>

    • endpoint: Endpoint
  • getPunchCardStats: object

    Each array contains the day number, hour number, and number of commits:

    • 0-6: Sunday - Saturday
    • 0-23: Hour of day
    • Number of commits

    For example, [2, 14, 25] indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.

      • (params?: RequestOptions & Octokit.ReposGetPunchCardStatsParams): Promise<Response<Octokit.ReposGetPunchCardStatsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposGetPunchCardStatsParams

        Returns Promise<Response<Octokit.ReposGetPunchCardStatsResponse>>

    • endpoint: Endpoint
  • getReadme: object

    Gets the preferred README for a repository.

    READMEs support custom media types for retrieving the raw content or rendered HTML.

      • Parameters

        Returns Promise<Response<Octokit.ReposGetReadmeResponse>>

    • endpoint: Endpoint
  • getRelease: object

    Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource.

      • (params?: RequestOptions & Octokit.ReposGetReleaseParams): Promise<Response<Octokit.ReposGetReleaseResponse>>

      • Parameters

        Returns Promise<Response<Octokit.ReposGetReleaseResponse>>

    • endpoint: Endpoint
  • getReleaseAsset: object

    To download the asset's binary content, set the Accept header of the request to application/octet-stream. The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a 200 or 302 response.

      • (params?: RequestOptions & Octokit.ReposGetReleaseAssetParams): Promise<Response<Octokit.ReposGetReleaseAssetResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposGetReleaseAssetParams

        Returns Promise<Response<Octokit.ReposGetReleaseAssetResponse>>

    • endpoint: Endpoint
  • getReleaseByTag: object

    Get a published release with the specified tag.

      • (params?: RequestOptions & Octokit.ReposGetReleaseByTagParams): Promise<Response<Octokit.ReposGetReleaseByTagResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposGetReleaseByTagParams

        Returns Promise<Response<Octokit.ReposGetReleaseByTagResponse>>

    • endpoint: Endpoint
  • getTeamsWithAccessToProtectedBranch: object

    Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's billing plans in the GitHub Help documentation.

    Lists the teams who have push access to this branch. If you pass the hellcat-preview media type, the list includes child teams.

      • (params?: RequestOptions & Octokit.ReposGetTeamsWithAccessToProtectedBranchParams): Promise<Response<Octokit.ReposGetTeamsWithAccessToProtectedBranchResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposGetTeamsWithAccessToProtectedBranchParams

        Returns Promise<Response<Octokit.ReposGetTeamsWithAccessToProtectedBranchResponse>>

    • endpoint: Endpoint
  • getTopPaths: object

    Get the top 10 popular contents over the last 14 days.

      • (params?: RequestOptions & Octokit.ReposGetTopPathsParams): Promise<Response<Octokit.ReposGetTopPathsResponse>>

      • Parameters

        Returns Promise<Response<Octokit.ReposGetTopPathsResponse>>

    • endpoint: Endpoint
  • getTopReferrers: object

    Get the top 10 referrers over the last 14 days.

      • (params?: RequestOptions & Octokit.ReposGetTopReferrersParams): Promise<Response<Octokit.ReposGetTopReferrersResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposGetTopReferrersParams

        Returns Promise<Response<Octokit.ReposGetTopReferrersResponse>>

    • endpoint: Endpoint
  • getUsersWithAccessToProtectedBranch: object

    Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's billing plans in the GitHub Help documentation.

    Lists the people who have push access to this branch.

      • (params?: RequestOptions & Octokit.ReposGetUsersWithAccessToProtectedBranchParams): Promise<Response<Octokit.ReposGetUsersWithAccessToProtectedBranchResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposGetUsersWithAccessToProtectedBranchParams

        Returns Promise<Response<Octokit.ReposGetUsersWithAccessToProtectedBranchResponse>>

    • endpoint: Endpoint
  • getViews: object

    Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.

  • list: object

    Lists repositories that the authenticated user has explicit permission (:read, :write, or :admin) to access.

    The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

      • (params?: RequestOptions & Octokit.ReposListParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • listAppsWithAccessToProtectedBranch: object

    Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's billing plans in the GitHub Help documentation.

    Lists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

    deprecated

    octokit.repos.listAppsWithAccessToProtectedBranch() has been renamed to octokit.repos.getAppsWithAccessToProtectedBranch() (2019-09-13)

      • (params?: RequestOptions & Octokit.ReposListAppsWithAccessToProtectedBranchParams): Promise<Response<Octokit.ReposListAppsWithAccessToProtectedBranchResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposListAppsWithAccessToProtectedBranchParams

        Returns Promise<Response<Octokit.ReposListAppsWithAccessToProtectedBranchResponse>>

    • endpoint: Endpoint
  • listAssetsForRelease: object
      • (params?: RequestOptions & Octokit.ReposListAssetsForReleaseParams): Promise<Response<Octokit.ReposListAssetsForReleaseResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposListAssetsForReleaseParams

        Returns Promise<Response<Octokit.ReposListAssetsForReleaseResponse>>

    • endpoint: Endpoint
  • listBranches: object
      • (params?: RequestOptions & Octokit.ReposListBranchesParams): Promise<Response<Octokit.ReposListBranchesResponse>>

      • Parameters

        Returns Promise<Response<Octokit.ReposListBranchesResponse>>

    • endpoint: Endpoint
  • listBranchesForHeadCommit: object

    Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's billing plans in the GitHub Help documentation.

    Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch.

      • (params?: RequestOptions & Octokit.ReposListBranchesForHeadCommitParams): Promise<Response<Octokit.ReposListBranchesForHeadCommitResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposListBranchesForHeadCommitParams

        Returns Promise<Response<Octokit.ReposListBranchesForHeadCommitResponse>>

    • endpoint: Endpoint
  • listCollaborators: object

    For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.

    If you pass the hellcat-preview media type, team members will include the members of child teams.

      • (params?: RequestOptions & Octokit.ReposListCollaboratorsParams): Promise<Response<Octokit.ReposListCollaboratorsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposListCollaboratorsParams

        Returns Promise<Response<Octokit.ReposListCollaboratorsResponse>>

    • endpoint: Endpoint
  • listCommentsForCommit: object

    Use the :commit_sha to specify the commit that will have its comments listed.

      • (params?: RequestOptions & Octokit.ReposListCommentsForCommitParamsDeprecatedRef): Promise<Response<Octokit.ReposListCommentsForCommitResponse>>
      • (params?: RequestOptions & Octokit.ReposListCommentsForCommitParams): Promise<Response<Octokit.ReposListCommentsForCommitResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposListCommentsForCommitParamsDeprecatedRef

        Returns Promise<Response<Octokit.ReposListCommentsForCommitResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposListCommentsForCommitParams

        Returns Promise<Response<Octokit.ReposListCommentsForCommitResponse>>

    • endpoint: Endpoint
  • listCommitComments: object

    Commit Comments use these custom media types. You can read more about the use of media types in the API here.

    Comments are ordered by ascending ID.

      • (params?: RequestOptions & Octokit.ReposListCommitCommentsParams): Promise<Response<Octokit.ReposListCommitCommentsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposListCommitCommentsParams

        Returns Promise<Response<Octokit.ReposListCommitCommentsResponse>>

    • endpoint: Endpoint
  • listCommits: object

    Signature verification object

    The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:

    These are the possible values for reason in the verification object:

    Value Description
    expired_key The key that made the signature is expired.
    not_signing_key The "signing" flag is not among the usage flags in the GPG key that made the signature.
    gpgverify_error There was an error communicating with the signature verification service.
    gpgverify_unavailable The signature verification service is currently unavailable.
    unsigned The object does not include a signature.
    unknown_signature_type A non-PGP signature was found in the commit.
    no_user No user was associated with the committer email address in the commit.
    unverified_email The committer email address in the commit was associated with a user, but the email address is not verified on her/his account.
    bad_email The committer email address in the commit is not included in the identities of the PGP key that made the signature.
    unknown_key The key that made the signature has not been registered with any user's account.
    malformed_signature There was an error parsing the signature.
    invalid The signature could not be cryptographically verified using the key whose key-id was found in the signature.
    valid None of the above errors applied, so the signature is considered to be verified.
      • (params?: RequestOptions & Octokit.ReposListCommitsParams): Promise<Response<Octokit.ReposListCommitsResponse>>

      • Parameters

        Returns Promise<Response<Octokit.ReposListCommitsResponse>>

    • endpoint: Endpoint
  • listContributors: object

    Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.

    GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.

      • (params?: RequestOptions & Octokit.ReposListContributorsParams): Promise<Response<Octokit.ReposListContributorsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposListContributorsParams

        Returns Promise<Response<Octokit.ReposListContributorsResponse>>

    • endpoint: Endpoint
  • listDeployKeys: object
      • (params?: RequestOptions & Octokit.ReposListDeployKeysParams): Promise<Response<Octokit.ReposListDeployKeysResponse>>

      • Parameters

        Returns Promise<Response<Octokit.ReposListDeployKeysResponse>>

    • endpoint: Endpoint
  • listDeploymentStatuses: object

    Users with pull access can view deployment statuses for a deployment:

      • (params?: RequestOptions & Octokit.ReposListDeploymentStatusesParams): Promise<Response<Octokit.ReposListDeploymentStatusesResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposListDeploymentStatusesParams

        Returns Promise<Response<Octokit.ReposListDeploymentStatusesResponse>>

    • endpoint: Endpoint
  • listDeployments: object

    Simple filtering of deployments is available via query parameters:

      • (params?: RequestOptions & Octokit.ReposListDeploymentsParams): Promise<Response<Octokit.ReposListDeploymentsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposListDeploymentsParams

        Returns Promise<Response<Octokit.ReposListDeploymentsResponse>>

    • endpoint: Endpoint
  • listDownloads: object
      • (params?: RequestOptions & Octokit.ReposListDownloadsParams): Promise<Response<Octokit.ReposListDownloadsResponse>>

      • Parameters

        Returns Promise<Response<Octokit.ReposListDownloadsResponse>>

    • endpoint: Endpoint
  • listForOrg: object

    Lists repositories for the specified organization.

      • (params?: RequestOptions & Octokit.ReposListForOrgParams): Promise<Response<Octokit.ReposListForOrgResponse>>

      • Parameters

        Returns Promise<Response<Octokit.ReposListForOrgResponse>>

    • endpoint: Endpoint
  • listForUser: object

    Lists public repositories for the specified user.

      • (params?: RequestOptions & Octokit.ReposListForUserParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • listForks: object

      • Parameters

        Returns Promise<Response<Octokit.ReposListForksResponse>>

    • endpoint: Endpoint
  • listHooks: object

      • Parameters

        Returns Promise<Response<Octokit.ReposListHooksResponse>>

    • endpoint: Endpoint
  • listInvitations: object

    When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.

      • (params?: RequestOptions & Octokit.ReposListInvitationsParams): Promise<Response<Octokit.ReposListInvitationsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposListInvitationsParams

        Returns Promise<Response<Octokit.ReposListInvitationsResponse>>

    • endpoint: Endpoint
  • listInvitationsForAuthenticatedUser: object

    When authenticating as a user, this endpoint will list all currently open repository invitations for that user.

      • (params?: RequestOptions & Octokit.ReposListInvitationsForAuthenticatedUserParams): Promise<Response<Octokit.ReposListInvitationsForAuthenticatedUserResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposListInvitationsForAuthenticatedUserParams

        Returns Promise<Response<Octokit.ReposListInvitationsForAuthenticatedUserResponse>>

    • endpoint: Endpoint
  • listLanguages: object

    Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.

      • (params?: RequestOptions & Octokit.ReposListLanguagesParams): Promise<Response<Octokit.ReposListLanguagesResponse>>

      • Parameters

        Returns Promise<Response<Octokit.ReposListLanguagesResponse>>

    • endpoint: Endpoint
  • listPagesBuilds: object
      • (params?: RequestOptions & Octokit.ReposListPagesBuildsParams): Promise<Response<Octokit.ReposListPagesBuildsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposListPagesBuildsParams

        Returns Promise<Response<Octokit.ReposListPagesBuildsResponse>>

    • endpoint: Endpoint
  • listProtectedBranchRequiredStatusChecksContexts: object

    Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's billing plans in the GitHub Help documentation.

      • (params?: RequestOptions & Octokit.ReposListProtectedBranchRequiredStatusChecksContextsParams): Promise<Response<Octokit.ReposListProtectedBranchRequiredStatusChecksContextsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposListProtectedBranchRequiredStatusChecksContextsParams

        Returns Promise<Response<Octokit.ReposListProtectedBranchRequiredStatusChecksContextsResponse>>

    • endpoint: Endpoint
  • listProtectedBranchTeamRestrictions: object

    Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's billing plans in the GitHub Help documentation.

    Lists the teams who have push access to this branch. If you pass the hellcat-preview media type, the list includes child teams.

    deprecated

    octokit.repos.listProtectedBranchTeamRestrictions() has been renamed to octokit.repos.getTeamsWithAccessToProtectedBranch() (2019-09-09)

      • (params?: RequestOptions & Octokit.ReposListProtectedBranchTeamRestrictionsParams): Promise<Response<Octokit.ReposListProtectedBranchTeamRestrictionsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposListProtectedBranchTeamRestrictionsParams

        Returns Promise<Response<Octokit.ReposListProtectedBranchTeamRestrictionsResponse>>

    • endpoint: Endpoint
  • listProtectedBranchUserRestrictions: object

    Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's billing plans in the GitHub Help documentation.

    Lists the people who have push access to this branch.

    deprecated

    octokit.repos.listProtectedBranchUserRestrictions() has been renamed to octokit.repos.getUsersWithAccessToProtectedBranch() (2019-09-09)

      • (params?: RequestOptions & Octokit.ReposListProtectedBranchUserRestrictionsParams): Promise<Response<Octokit.ReposListProtectedBranchUserRestrictionsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposListProtectedBranchUserRestrictionsParams

        Returns Promise<Response<Octokit.ReposListProtectedBranchUserRestrictionsResponse>>

    • endpoint: Endpoint
  • listPublic: object

    Lists all public repositories in the order that they were created.

    Note: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of repositories.

      • (params?: RequestOptions & Octokit.ReposListPublicParams): Promise<Response<Octokit.ReposListPublicResponse>>

      • Parameters

        Returns Promise<Response<Octokit.ReposListPublicResponse>>

    • endpoint: Endpoint
  • listPullRequestsAssociatedWithCommit: object

    Lists all pull requests containing the provided commit SHA, which can be from any point in the commit history. The results will include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the List pull requests endpoint.

      • (params?: RequestOptions & Octokit.ReposListPullRequestsAssociatedWithCommitParams): Promise<Response<Octokit.ReposListPullRequestsAssociatedWithCommitResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposListPullRequestsAssociatedWithCommitParams

        Returns Promise<Response<Octokit.ReposListPullRequestsAssociatedWithCommitResponse>>

    • endpoint: Endpoint
  • listReleases: object

    This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the Repository Tags API.

    Information about published releases are available to everyone. Only users with push access will receive listings for draft releases.

      • (params?: RequestOptions & Octokit.ReposListReleasesParams): Promise<Response<Octokit.ReposListReleasesResponse>>

      • Parameters

        Returns Promise<Response<Octokit.ReposListReleasesResponse>>

    • endpoint: Endpoint
  • listStatusesForRef: object

    Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one.

    This resource is also available via a legacy route: GET /repos/:owner/:repo/statuses/:ref.

      • (params?: RequestOptions & Octokit.ReposListStatusesForRefParams): Promise<Response<Octokit.ReposListStatusesForRefResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposListStatusesForRefParams

        Returns Promise<Response<Octokit.ReposListStatusesForRefResponse>>

    • endpoint: Endpoint
  • listTags: object
  • listTeams: object

      • Parameters

        Returns Promise<Response<Octokit.ReposListTeamsResponse>>

    • endpoint: Endpoint
  • listTeamsWithAccessToProtectedBranch: object

    Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's billing plans in the GitHub Help documentation.

    Lists the teams who have push access to this branch. If you pass the hellcat-preview media type, the list includes child teams.

    deprecated

    octokit.repos.listTeamsWithAccessToProtectedBranch() has been renamed to octokit.repos.getTeamsWithAccessToProtectedBranch() (2019-09-13)

      • (params?: RequestOptions & Octokit.ReposListTeamsWithAccessToProtectedBranchParams): Promise<Response<Octokit.ReposListTeamsWithAccessToProtectedBranchResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposListTeamsWithAccessToProtectedBranchParams

        Returns Promise<Response<Octokit.ReposListTeamsWithAccessToProtectedBranchResponse>>

    • endpoint: Endpoint
  • listTopics: object
      • (params?: RequestOptions & Octokit.ReposListTopicsParams): Promise<Response<Octokit.ReposListTopicsResponse>>

      • Parameters

        Returns Promise<Response<Octokit.ReposListTopicsResponse>>

    • endpoint: Endpoint
  • listUsersWithAccessToProtectedBranch: object

    Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's billing plans in the GitHub Help documentation.

    Lists the people who have push access to this branch.

    deprecated

    octokit.repos.listUsersWithAccessToProtectedBranch() has been renamed to octokit.repos.getUsersWithAccessToProtectedBranch() (2019-09-13)

      • (params?: RequestOptions & Octokit.ReposListUsersWithAccessToProtectedBranchParams): Promise<Response<Octokit.ReposListUsersWithAccessToProtectedBranchResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposListUsersWithAccessToProtectedBranchParams

        Returns Promise<Response<Octokit.ReposListUsersWithAccessToProtectedBranchResponse>>

    • endpoint: Endpoint
  • merge: object
  • pingHook: object

    This will trigger a ping event to be sent to the hook.

      • (params?: RequestOptions & Octokit.ReposPingHookParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • removeBranchProtection: object

    Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's billing plans in the GitHub Help documentation.

      • (params?: RequestOptions & Octokit.ReposRemoveBranchProtectionParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposRemoveBranchProtectionParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • removeCollaborator: object
      • (params?: RequestOptions & Octokit.ReposRemoveCollaboratorParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposRemoveCollaboratorParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • removeDeployKey: object
      • (params?: RequestOptions & Octokit.ReposRemoveDeployKeyParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposRemoveDeployKeyParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • removeProtectedBranchAdminEnforcement: object

    Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's billing plans in the GitHub Help documentation.

    Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.

      • (params?: RequestOptions & Octokit.ReposRemoveProtectedBranchAdminEnforcementParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposRemoveProtectedBranchAdminEnforcementParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • removeProtectedBranchAppRestrictions: object

    Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's billing plans in the GitHub Help documentation.

    Removes the ability of an app to push to this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

    Type Description
    array The GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
      • (params?: RequestOptions & Octokit.ReposRemoveProtectedBranchAppRestrictionsParams): Promise<Response<Octokit.ReposRemoveProtectedBranchAppRestrictionsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposRemoveProtectedBranchAppRestrictionsParams

        Returns Promise<Response<Octokit.ReposRemoveProtectedBranchAppRestrictionsResponse>>

    • endpoint: Endpoint
  • removeProtectedBranchPullRequestReviewEnforcement: object

    Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's billing plans in the GitHub Help documentation.

      • (params?: RequestOptions & Octokit.ReposRemoveProtectedBranchPullRequestReviewEnforcementParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposRemoveProtectedBranchPullRequestReviewEnforcementParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • removeProtectedBranchRequiredSignatures: object

    Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's billing plans in the GitHub Help documentation.

    When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.

      • (params?: RequestOptions & Octokit.ReposRemoveProtectedBranchRequiredSignaturesParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposRemoveProtectedBranchRequiredSignaturesParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • removeProtectedBranchRequiredStatusChecks: object

    Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's billing plans in the GitHub Help documentation.

      • (params?: RequestOptions & Octokit.ReposRemoveProtectedBranchRequiredStatusChecksParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposRemoveProtectedBranchRequiredStatusChecksParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • removeProtectedBranchRequiredStatusChecksContexts: object

    Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's billing plans in the GitHub Help documentation.

      • (params?: RequestOptions & Octokit.ReposRemoveProtectedBranchRequiredStatusChecksContextsParams): Promise<Response<Octokit.ReposRemoveProtectedBranchRequiredStatusChecksContextsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposRemoveProtectedBranchRequiredStatusChecksContextsParams

        Returns Promise<Response<Octokit.ReposRemoveProtectedBranchRequiredStatusChecksContextsResponse>>

    • endpoint: Endpoint
  • removeProtectedBranchRestrictions: object

    Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's billing plans in the GitHub Help documentation.

    Disables the ability to restrict who can push to this branch.

      • (params?: RequestOptions & Octokit.ReposRemoveProtectedBranchRestrictionsParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposRemoveProtectedBranchRestrictionsParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • removeProtectedBranchTeamRestrictions: object

    Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's billing plans in the GitHub Help documentation.

    Removes the ability of a team to push to this branch. If you pass the hellcat-preview media type, you can include child teams.

    Type Description
    array Teams that should no longer have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
      • (params?: RequestOptions & Octokit.ReposRemoveProtectedBranchTeamRestrictionsParams): Promise<Response<Octokit.ReposRemoveProtectedBranchTeamRestrictionsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposRemoveProtectedBranchTeamRestrictionsParams

        Returns Promise<Response<Octokit.ReposRemoveProtectedBranchTeamRestrictionsResponse>>

    • endpoint: Endpoint
  • removeProtectedBranchUserRestrictions: object

    Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's billing plans in the GitHub Help documentation.

    Removes the ability of a user to push to this branch.

    Type Description
    array Usernames of the people who should no longer have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
      • (params?: RequestOptions & Octokit.ReposRemoveProtectedBranchUserRestrictionsParams): Promise<Response<Octokit.ReposRemoveProtectedBranchUserRestrictionsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposRemoveProtectedBranchUserRestrictionsParams

        Returns Promise<Response<Octokit.ReposRemoveProtectedBranchUserRestrictionsResponse>>

    • endpoint: Endpoint
  • replaceProtectedBranchAppRestrictions: object

    Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's billing plans in the GitHub Help documentation.

    Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

    Type Description
    array The GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
      • (params?: RequestOptions & Octokit.ReposReplaceProtectedBranchAppRestrictionsParams): Promise<Response<Octokit.ReposReplaceProtectedBranchAppRestrictionsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposReplaceProtectedBranchAppRestrictionsParams

        Returns Promise<Response<Octokit.ReposReplaceProtectedBranchAppRestrictionsResponse>>

    • endpoint: Endpoint
  • replaceProtectedBranchRequiredStatusChecksContexts: object

    Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's billing plans in the GitHub Help documentation.

      • (params?: RequestOptions & Octokit.ReposReplaceProtectedBranchRequiredStatusChecksContextsParams): Promise<Response<Octokit.ReposReplaceProtectedBranchRequiredStatusChecksContextsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposReplaceProtectedBranchRequiredStatusChecksContextsParams

        Returns Promise<Response<Octokit.ReposReplaceProtectedBranchRequiredStatusChecksContextsResponse>>

    • endpoint: Endpoint
  • replaceProtectedBranchTeamRestrictions: object

    Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's billing plans in the GitHub Help documentation.

    Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. If you pass the hellcat-preview media type, you can include child teams.

    Type Description
    array The teams that can have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
      • (params?: RequestOptions & Octokit.ReposReplaceProtectedBranchTeamRestrictionsParams): Promise<Response<Octokit.ReposReplaceProtectedBranchTeamRestrictionsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposReplaceProtectedBranchTeamRestrictionsParams

        Returns Promise<Response<Octokit.ReposReplaceProtectedBranchTeamRestrictionsResponse>>

    • endpoint: Endpoint
  • replaceProtectedBranchUserRestrictions: object

    Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's billing plans in the GitHub Help documentation.

    Replaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.

    Type Description
    array Usernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
      • (params?: RequestOptions & Octokit.ReposReplaceProtectedBranchUserRestrictionsParams): Promise<Response<Octokit.ReposReplaceProtectedBranchUserRestrictionsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposReplaceProtectedBranchUserRestrictionsParams

        Returns Promise<Response<Octokit.ReposReplaceProtectedBranchUserRestrictionsResponse>>

    • endpoint: Endpoint
  • replaceTopics: object
      • (params?: RequestOptions & Octokit.ReposReplaceTopicsParams): Promise<Response<Octokit.ReposReplaceTopicsResponse>>

      • Parameters

        Returns Promise<Response<Octokit.ReposReplaceTopicsResponse>>

    • endpoint: Endpoint
  • requestPageBuild: object

    You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.

    Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.

      • (params?: RequestOptions & Octokit.ReposRequestPageBuildParams): Promise<Response<Octokit.ReposRequestPageBuildResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposRequestPageBuildParams

        Returns Promise<Response<Octokit.ReposRequestPageBuildResponse>>

    • endpoint: Endpoint
  • retrieveCommunityProfileMetrics: object

    This endpoint will return all community profile metrics, including an overall health score, repository description, the presence of documentation, detected code of conduct, detected license, and the presence of ISSUE_TEMPLATE, PULL_REQUEST_TEMPLATE, README, and CONTRIBUTING files.

      • (params?: RequestOptions & Octokit.ReposRetrieveCommunityProfileMetricsParams): Promise<Response<Octokit.ReposRetrieveCommunityProfileMetricsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposRetrieveCommunityProfileMetricsParams

        Returns Promise<Response<Octokit.ReposRetrieveCommunityProfileMetricsResponse>>

    • endpoint: Endpoint
  • testPushHook: object

    This will trigger the hook with the latest push to the current repository if the hook is subscribed to push events. If the hook is not subscribed to push events, the server will respond with 204 but no test POST will be generated.

    Note: Previously /repos/:owner/:repo/hooks/:hook_id/test

      • (params?: RequestOptions & Octokit.ReposTestPushHookParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • transfer: object

    A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original owner, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see about repository transfers.

  • update: object

    Note: To edit a repository's topics, use the topics endpoint.

  • updateBranchProtection: object

    Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's billing plans in the GitHub Help documentation.

    Protecting a branch requires admin or owner permissions to the repository.

    Note: Passing new arrays of users and teams replaces their previous values.

    Note: The list of users, apps, and teams in total is limited to 100 items.

      • (params?: RequestOptions & Octokit.ReposUpdateBranchProtectionParams): Promise<Response<Octokit.ReposUpdateBranchProtectionResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposUpdateBranchProtectionParams

        Returns Promise<Response<Octokit.ReposUpdateBranchProtectionResponse>>

    • endpoint: Endpoint
  • updateCommitComment: object
      • (params?: RequestOptions & Octokit.ReposUpdateCommitCommentParams): Promise<Response<Octokit.ReposUpdateCommitCommentResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposUpdateCommitCommentParams

        Returns Promise<Response<Octokit.ReposUpdateCommitCommentResponse>>

    • endpoint: Endpoint
  • updateFile: object

    Creates a new file or updates an existing file in a repository.

    deprecated

    octokit.repos.updateFile() has been renamed to octokit.repos.createOrUpdateFile() (2019-06-07)

      • (params?: RequestOptions & Octokit.ReposUpdateFileParams): Promise<Response<Octokit.ReposUpdateFileResponse>>

      • Parameters

        Returns Promise<Response<Octokit.ReposUpdateFileResponse>>

    • endpoint: Endpoint
  • updateHook: object
      • (params?: RequestOptions & Octokit.ReposUpdateHookParams): Promise<Response<Octokit.ReposUpdateHookResponse>>

      • Parameters

        Returns Promise<Response<Octokit.ReposUpdateHookResponse>>

    • endpoint: Endpoint
  • updateInformationAboutPagesSite: object
      • (params?: RequestOptions & Octokit.ReposUpdateInformationAboutPagesSiteParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposUpdateInformationAboutPagesSiteParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • updateInvitation: object
      • (params?: RequestOptions & Octokit.ReposUpdateInvitationParams): Promise<Response<Octokit.ReposUpdateInvitationResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposUpdateInvitationParams

        Returns Promise<Response<Octokit.ReposUpdateInvitationResponse>>

    • endpoint: Endpoint
  • updateProtectedBranchPullRequestReviewEnforcement: object

    Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's billing plans in the GitHub Help documentation.

    Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.

    Note: Passing new arrays of users and teams replaces their previous values.

      • (params?: RequestOptions & Octokit.ReposUpdateProtectedBranchPullRequestReviewEnforcementParams): Promise<Response<Octokit.ReposUpdateProtectedBranchPullRequestReviewEnforcementResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposUpdateProtectedBranchPullRequestReviewEnforcementParams

        Returns Promise<Response<Octokit.ReposUpdateProtectedBranchPullRequestReviewEnforcementResponse>>

    • endpoint: Endpoint
  • updateProtectedBranchRequiredStatusChecks: object

    Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's billing plans in the GitHub Help documentation.

    Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.

      • (params?: RequestOptions & Octokit.ReposUpdateProtectedBranchRequiredStatusChecksParams): Promise<Response<Octokit.ReposUpdateProtectedBranchRequiredStatusChecksResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposUpdateProtectedBranchRequiredStatusChecksParams

        Returns Promise<Response<Octokit.ReposUpdateProtectedBranchRequiredStatusChecksResponse>>

    • endpoint: Endpoint
  • updateRelease: object

    Users with push access to the repository can edit a release.

      • (params?: RequestOptions & Octokit.ReposUpdateReleaseParams): Promise<Response<Octokit.ReposUpdateReleaseResponse>>

      • Parameters

        Returns Promise<Response<Octokit.ReposUpdateReleaseResponse>>

    • endpoint: Endpoint
  • updateReleaseAsset: object

    Users with push access to the repository can edit a release asset.

      • (params?: RequestOptions & Octokit.ReposUpdateReleaseAssetParams): Promise<Response<Octokit.ReposUpdateReleaseAssetResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposUpdateReleaseAssetParams

        Returns Promise<Response<Octokit.ReposUpdateReleaseAssetResponse>>

    • endpoint: Endpoint
  • uploadReleaseAsset: object

    This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in the response of the Create a release endpoint to upload a release asset.

    You need to use an HTTP client which supports SNI to make calls to this endpoint.

    Most libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:

    application/zip

    GitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example, you'll still need to pass your authentication to be able to upload an asset.

      • (params?: RequestOptions & Octokit.ReposUploadReleaseAssetParams): Promise<Response<Octokit.ReposUploadReleaseAssetResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.ReposUploadReleaseAssetParams

        Returns Promise<Response<Octokit.ReposUploadReleaseAssetResponse>>

    • endpoint: Endpoint

request

request: Request

search

search: object

Type declaration

  • code: object

    Find file contents via various criteria. This method returns up to 100 results per page.

    When searching for code, you can get text match metadata for the file content and file path fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

    Note: You must authenticate to search for code across all public repositories.

    Considerations for code search

    Due to the complexity of searching code, there are a few restrictions on how searches are performed:

    • Only the default branch is considered. In most cases, this will be the master branch.
    • Only files smaller than 384 KB are searchable.
    • You must always include at least one search term when searching source code. For example, searching for language:go is not valid, while amazing language:go is.

    Suppose you want to find the definition of the addClass function inside jQuery. Your query would look something like this:

    Here, we're searching for the keyword addClass within a file's contents. We're making sure that we're only looking in files where the language is JavaScript. And we're scoping the search to the repo:jquery/jquery repository.

  • commits: object

    Find commits via various criteria. This method returns up to 100 results per page.

    When searching for commits, you can get text match metadata for the message field when you provide the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

    Considerations for commit search

    Only the default branch is considered. In most cases, this will be the master branch.

    Suppose you want to find commits related to CSS in the octocat/Spoon-Knife repository. Your query would look something like this:

  • issues: object

    Find issues by state and keyword. This method returns up to 100 results per page.

    When searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

    Let's say you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.

    In this query, we're searching for the keyword windows, within any open issue that's labeled as bug. The search runs across repositories whose primary language is Python. We’re sorting by creation date in ascending order, so that the oldest issues appear first in the search results.

    deprecated

    octokit.search.issues() has been renamed to octokit.search.issuesAndPullRequests() (2018-12-27)

  • issuesAndPullRequests: object

    Find issues by state and keyword. This method returns up to 100 results per page.

    When searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

    Let's say you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.

    In this query, we're searching for the keyword windows, within any open issue that's labeled as bug. The search runs across repositories whose primary language is Python. We’re sorting by creation date in ascending order, so that the oldest issues appear first in the search results.

      • (params?: RequestOptions & Octokit.SearchIssuesAndPullRequestsParams): Promise<Response<Octokit.SearchIssuesAndPullRequestsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.SearchIssuesAndPullRequestsParams

        Returns Promise<Response<Octokit.SearchIssuesAndPullRequestsResponse>>

    • endpoint: Endpoint
  • labels: object

    Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results per page.

    When searching for labels, you can get text match metadata for the label name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

    Suppose you want to find labels in the linguist repository that match bug, defect, or enhancement. Your query might look like this:

    The labels that best match for the query appear first in the search results.

  • repos: object

    Find repositories via various criteria. This method returns up to 100 results per page.

    When searching for repositories, you can get text match metadata for the name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

    Suppose you want to search for popular Tetris repositories written in Assembly. Your query might look like this.

    You can search for multiple topics by adding more topic: instances, and including the mercy-preview header. For example:

    In this request, we're searching for repositories with the word tetris in the name, the description, or the README. We're limiting the results to only find repositories where the primary language is Assembly. We're sorting by stars in descending order, so that the most popular repositories appear first in the search results.

  • topics: object

    Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results per page.

    When searching for topics, you can get text match metadata for the topic's short_description, description, name, or display_name field when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

    See "Searching topics" for a detailed list of qualifiers.

    Suppose you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:

    In this request, we're searching for topics with the keyword ruby, and we're limiting the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.

    Note: A search for featured Ruby topics only has 6 total results, so a Link header indicating pagination is not included in the response.

  • users: object

    Find users via various criteria. This method returns up to 100 results per page.

    When searching for users, you can get text match metadata for the issue login, email, and name fields when you pass the text-match media type. For more details about highlighting search results, see Text match metadata. For more details about how to receive highlighted search results, see Text match metadata.

    Imagine you're looking for a list of popular users. You might try out this query:

    Here, we're looking at users with the name Tom. We're only interested in those with more than 42 repositories, and only if they have over 1,000 followers.

teams

teams: object

Type declaration

  • addMember: object

    The "Add team member" API (described below) is deprecated.

    We recommend using the Add team membership API instead. It allows you to invite new organization members to your teams.

    Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

    To add someone to a team, the authenticated user must be a team maintainer in the team they're changing or be an owner of the organization that the team is associated with. The person being added to the team must be a member of the team's organization.

    Note: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "Synchronizing teams between your identity provider and GitHub."

    Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."

    deprecated

    octokit.teams.addMember() is deprecated, see https://developer.github.com/v3/teams/members/#add-team-member

      • Parameters

        Returns Promise<Response<Octokit.TeamsAddMemberResponse>>

    • endpoint: Endpoint
  • addOrUpdateMembership: object

    Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

    If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a maintainer of the team.

    Note: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "Synchronizing teams between your identity provider and GitHub."

    If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.

    If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a maintainer of the team.

      • (params?: RequestOptions & Octokit.TeamsAddOrUpdateMembershipParams): Promise<Response<Octokit.TeamsAddOrUpdateMembershipResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.TeamsAddOrUpdateMembershipParams

        Returns Promise<Response<Octokit.TeamsAddOrUpdateMembershipResponse>>

    • endpoint: Endpoint
  • addOrUpdateProject: object

    Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have admin permissions for the project. The project and team must be part of the same organization.

      • (params?: RequestOptions & Octokit.TeamsAddOrUpdateProjectParams): Promise<Response<Octokit.TeamsAddOrUpdateProjectResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.TeamsAddOrUpdateProjectParams

        Returns Promise<Response<Octokit.TeamsAddOrUpdateProjectResponse>>

    • endpoint: Endpoint
  • addOrUpdateRepo: object

    To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization.

    If you pass the hellcat-preview media type, you can modify repository permissions of child teams.

    Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."

      • (params?: RequestOptions & Octokit.TeamsAddOrUpdateRepoParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.TeamsAddOrUpdateRepoParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • checkManagesRepo: object

    Note: If you pass the hellcat-preview media type, repositories inherited through a parent team will be checked.

    You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the Accept header:

      • (params?: RequestOptions & Octokit.TeamsCheckManagesRepoParams): Promise<Response<Octokit.TeamsCheckManagesRepoResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.TeamsCheckManagesRepoParams

        Returns Promise<Response<Octokit.TeamsCheckManagesRepoResponse>>

    • endpoint: Endpoint
  • create: object

    To create a team, the authenticated user must be a member or owner of :org. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "Setting team creation permissions."

      • (params?: RequestOptions & Octokit.TeamsCreateParamsDeprecatedPermission): Promise<Response<Octokit.TeamsCreateResponse>>
      • (params?: RequestOptions & Octokit.TeamsCreateParams): Promise<Response<Octokit.TeamsCreateResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.TeamsCreateParamsDeprecatedPermission

        Returns Promise<Response<Octokit.TeamsCreateResponse>>

      • Parameters

        Returns Promise<Response<Octokit.TeamsCreateResponse>>

    • endpoint: Endpoint
  • createDiscussion: object

    Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.

    This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

      • (params?: RequestOptions & Octokit.TeamsCreateDiscussionParams): Promise<Response<Octokit.TeamsCreateDiscussionResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.TeamsCreateDiscussionParams

        Returns Promise<Response<Octokit.TeamsCreateDiscussionResponse>>

    • endpoint: Endpoint
  • createDiscussionComment: object

    Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.

    This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

      • (params?: RequestOptions & Octokit.TeamsCreateDiscussionCommentParams): Promise<Response<Octokit.TeamsCreateDiscussionCommentResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.TeamsCreateDiscussionCommentParams

        Returns Promise<Response<Octokit.TeamsCreateDiscussionCommentResponse>>

    • endpoint: Endpoint
  • delete: object

    To delete a team, the authenticated user must be a team maintainer or an owner of the org associated with the team.

    If you are an organization owner and you pass the hellcat-preview media type, deleting a parent team will delete all of its child teams as well.

      • (params?: RequestOptions & Octokit.TeamsDeleteParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • deleteDiscussion: object

    Delete a discussion from a team's page. OAuth access tokens require the write:discussion scope.

      • (params?: RequestOptions & Octokit.TeamsDeleteDiscussionParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.TeamsDeleteDiscussionParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • deleteDiscussionComment: object

    Deletes a comment on a team discussion. OAuth access tokens require the write:discussion scope.

      • (params?: RequestOptions & Octokit.TeamsDeleteDiscussionCommentParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.TeamsDeleteDiscussionCommentParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • get: object
  • getByName: object

    Gets a team using the team's slug. GitHub generates the slug from the team name.

      • Parameters

        Returns Promise<Response<Octokit.TeamsGetByNameResponse>>

    • endpoint: Endpoint
  • getDiscussion: object

    Get a specific discussion on a team's page. OAuth access tokens require the read:discussion scope.

      • (params?: RequestOptions & Octokit.TeamsGetDiscussionParams): Promise<Response<Octokit.TeamsGetDiscussionResponse>>

      • Parameters

        Returns Promise<Response<Octokit.TeamsGetDiscussionResponse>>

    • endpoint: Endpoint
  • getDiscussionComment: object

    Get a specific comment on a team discussion. OAuth access tokens require the read:discussion scope.

      • (params?: RequestOptions & Octokit.TeamsGetDiscussionCommentParams): Promise<Response<Octokit.TeamsGetDiscussionCommentResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.TeamsGetDiscussionCommentParams

        Returns Promise<Response<Octokit.TeamsGetDiscussionCommentResponse>>

    • endpoint: Endpoint
  • getMember: object

    The "Get team member" API (described below) is deprecated.

    We recommend using the Get team membership API instead. It allows you to get both active and pending memberships.

    To list members in a team, the team must be visible to the authenticated user.

    deprecated

    octokit.teams.getMember() is deprecated, see https://developer.github.com/v3/teams/members/#get-team-member

      • (params?: RequestOptions & Octokit.TeamsGetMemberParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • getMembership: object

    If you pass the hellcat-preview media type, team members will include the members of child teams.

    To get a user's membership with a team, the team must be visible to the authenticated user.

    Note: The role for organization owners returns as maintainer. For more information about maintainer roles, see Create team.

      • (params?: RequestOptions & Octokit.TeamsGetMembershipParams): Promise<Response<Octokit.TeamsGetMembershipResponse>>

      • Parameters

        Returns Promise<Response<Octokit.TeamsGetMembershipResponse>>

    • endpoint: Endpoint
  • list: object
  • listChild: object

    At this time, the hellcat-preview media type is required to use this endpoint.

      • Parameters

        Returns Promise<Response<Octokit.TeamsListChildResponse>>

    • endpoint: Endpoint
  • listDiscussionComments: object

    List all comments on a team discussion. OAuth access tokens require the read:discussion scope.

      • (params?: RequestOptions & Octokit.TeamsListDiscussionCommentsParams): Promise<Response<Octokit.TeamsListDiscussionCommentsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.TeamsListDiscussionCommentsParams

        Returns Promise<Response<Octokit.TeamsListDiscussionCommentsResponse>>

    • endpoint: Endpoint
  • listDiscussions: object

    List all discussions on a team's page. OAuth access tokens require the read:discussion scope.

      • (params?: RequestOptions & Octokit.TeamsListDiscussionsParams): Promise<Response<Octokit.TeamsListDiscussionsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.TeamsListDiscussionsParams

        Returns Promise<Response<Octokit.TeamsListDiscussionsResponse>>

    • endpoint: Endpoint
  • listForAuthenticatedUser: object

    List all of the teams across all of the organizations to which the authenticated user belongs. This method requires user, repo, or read:org scope when authenticating via OAuth.

      • (params?: RequestOptions & Octokit.TeamsListForAuthenticatedUserParams): Promise<Response<Octokit.TeamsListForAuthenticatedUserResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.TeamsListForAuthenticatedUserParams

        Returns Promise<Response<Octokit.TeamsListForAuthenticatedUserResponse>>

    • endpoint: Endpoint
  • listMembers: object

    If you pass the hellcat-preview media type, team members will include the members of child teams.

      • (params?: RequestOptions & Octokit.TeamsListMembersParams): Promise<Response<Octokit.TeamsListMembersResponse>>

      • Parameters

        Returns Promise<Response<Octokit.TeamsListMembersResponse>>

    • endpoint: Endpoint
  • listPendingInvitations: object

    The return hash contains a role field which refers to the Organization Invitation role and will be one of the following values: direct_member, admin, billing_manager, hiring_manager, or reinstate. If the invitee is not a GitHub member, the login field in the return hash will be null.

      • (params?: RequestOptions & Octokit.TeamsListPendingInvitationsParams): Promise<Response<Octokit.TeamsListPendingInvitationsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.TeamsListPendingInvitationsParams

        Returns Promise<Response<Octokit.TeamsListPendingInvitationsResponse>>

    • endpoint: Endpoint
  • listProjects: object

    Lists the organization projects for a team. If you pass the hellcat-preview media type, the response will include projects inherited from a parent team.

      • (params?: RequestOptions & Octokit.TeamsListProjectsParams): Promise<Response<Octokit.TeamsListProjectsResponse>>

      • Parameters

        Returns Promise<Response<Octokit.TeamsListProjectsResponse>>

    • endpoint: Endpoint
  • listRepos: object

    Note: If you pass the hellcat-preview media type, the response will include any repositories inherited through a parent team.

      • Parameters

        Returns Promise<Response<Octokit.TeamsListReposResponse>>

    • endpoint: Endpoint
  • removeMember: object

    The "Remove team member" API (described below) is deprecated.

    We recommend using the Remove team membership endpoint instead. It allows you to remove both active and pending memberships.

    Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

    To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.

    Note: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "Synchronizing teams between your identity provider and GitHub."

    deprecated

    octokit.teams.removeMember() is deprecated, see https://developer.github.com/v3/teams/members/#remove-team-member

      • (params?: RequestOptions & Octokit.TeamsRemoveMemberParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • removeMembership: object

    Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

    To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.

    Note: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "Synchronizing teams between your identity provider and GitHub."

      • (params?: RequestOptions & Octokit.TeamsRemoveMembershipParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.TeamsRemoveMembershipParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • removeProject: object

    Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have read access to both the team and project, or admin access to the team or project. Note: This endpoint removes the project from the team, but does not delete it.

      • (params?: RequestOptions & Octokit.TeamsRemoveProjectParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • removeRepo: object

    If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.

      • (params?: RequestOptions & Octokit.TeamsRemoveRepoParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • reviewProject: object

    Checks whether a team has read, write, or admin permissions for an organization project. If you pass the hellcat-preview media type, the response will include projects inherited from a parent team.

      • (params?: RequestOptions & Octokit.TeamsReviewProjectParams): Promise<Response<Octokit.TeamsReviewProjectResponse>>

      • Parameters

        Returns Promise<Response<Octokit.TeamsReviewProjectResponse>>

    • endpoint: Endpoint
  • update: object

    To edit a team, the authenticated user must either be an owner of the org that the team is associated with, or a maintainer of the team.

    Note: With nested teams, the privacy for parent teams cannot be secret.

      • (params?: RequestOptions & Octokit.TeamsUpdateParamsDeprecatedPermission): Promise<Response<Octokit.TeamsUpdateResponse>>
      • (params?: RequestOptions & Octokit.TeamsUpdateParams): Promise<Response<Octokit.TeamsUpdateResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.TeamsUpdateParamsDeprecatedPermission

        Returns Promise<Response<Octokit.TeamsUpdateResponse>>

      • Parameters

        Returns Promise<Response<Octokit.TeamsUpdateResponse>>

    • endpoint: Endpoint
  • updateDiscussion: object

    Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the write:discussion scope.

      • (params?: RequestOptions & Octokit.TeamsUpdateDiscussionParams): Promise<Response<Octokit.TeamsUpdateDiscussionResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.TeamsUpdateDiscussionParams

        Returns Promise<Response<Octokit.TeamsUpdateDiscussionResponse>>

    • endpoint: Endpoint
  • updateDiscussionComment: object

    Edits the body text of a discussion comment. OAuth access tokens require the write:discussion scope.

      • (params?: RequestOptions & Octokit.TeamsUpdateDiscussionCommentParams): Promise<Response<Octokit.TeamsUpdateDiscussionCommentResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.TeamsUpdateDiscussionCommentParams

        Returns Promise<Response<Octokit.TeamsUpdateDiscussionCommentResponse>>

    • endpoint: Endpoint

users

users: object

Type declaration

  • addEmails: object

    This endpoint is accessible with the user scope.

      • Parameters

        Returns Promise<Response<Octokit.UsersAddEmailsResponse>>

    • endpoint: Endpoint
  • block: object
      • (params?: RequestOptions & Octokit.UsersBlockParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • checkBlocked: object

    If the user is blocked:

    If the user is not blocked:

      • (params?: RequestOptions & Octokit.UsersCheckBlockedParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • checkFollowing: object
      • (params?: RequestOptions & Octokit.UsersCheckFollowingParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • checkFollowingForUser: object
      • (params?: RequestOptions & Octokit.UsersCheckFollowingForUserParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.UsersCheckFollowingForUserParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • createGpgKey: object

    Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least write:gpg_key scope.

      • (params?: RequestOptions & Octokit.UsersCreateGpgKeyParams): Promise<Response<Octokit.UsersCreateGpgKeyResponse>>

      • Parameters

        Returns Promise<Response<Octokit.UsersCreateGpgKeyResponse>>

    • endpoint: Endpoint
  • createPublicKey: object

    Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least write:public_key scope.

      • (params?: RequestOptions & Octokit.UsersCreatePublicKeyParams): Promise<Response<Octokit.UsersCreatePublicKeyResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.UsersCreatePublicKeyParams

        Returns Promise<Response<Octokit.UsersCreatePublicKeyResponse>>

    • endpoint: Endpoint
  • deleteEmails: object

    This endpoint is accessible with the user scope.

      • (params?: RequestOptions & Octokit.UsersDeleteEmailsParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • deleteGpgKey: object

    Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least admin:gpg_key scope.

      • (params?: RequestOptions & Octokit.UsersDeleteGpgKeyParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • deletePublicKey: object

    Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least admin:public_key scope.

      • (params?: RequestOptions & Octokit.UsersDeletePublicKeyParams): Promise<Octokit.AnyResponse>

      • Parameters

        • Optional params: RequestOptions & Octokit.UsersDeletePublicKeyParams

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • follow: object

    Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."

    Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the user:follow scope.

      • (params?: RequestOptions & Octokit.UsersFollowParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • getAuthenticated: object

    Lists public and private profile information when authenticated through basic auth or OAuth with the user scope.

    Lists public profile information when authenticated through OAuth without the user scope.

  • getByUsername: object

    Provides publicly available information about someone with a GitHub account.

    GitHub Apps with the Plan user permission can use this endpoint to retrieve information about a user's GitHub plan. The GitHub App must be authenticated as a user. See "Identifying and authorizing users for GitHub Apps" for details about authentication. For an example response, see "Response with GitHub plan information."

    The email key in the following response is the publicly visible email address from your GitHub profile page. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub. For more information, see Authentication.

    The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "Emails API".

      • (params?: RequestOptions & Octokit.UsersGetByUsernameParams): Promise<Response<Octokit.UsersGetByUsernameResponse>>

      • Parameters

        Returns Promise<Response<Octokit.UsersGetByUsernameResponse>>

    • endpoint: Endpoint
  • getContextForUser: object

    Provides hovercard information when authenticated through basic auth or OAuth with the repo scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.

    The subject_type and subject_id parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about octocat who owns the Spoon-Knife repository via cURL, it would look like this:

      • (params?: RequestOptions & Octokit.UsersGetContextForUserParams): Promise<Response<Octokit.UsersGetContextForUserResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.UsersGetContextForUserParams

        Returns Promise<Response<Octokit.UsersGetContextForUserResponse>>

    • endpoint: Endpoint
  • getGpgKey: object

    View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least read:gpg_key scope.

      • Parameters

        Returns Promise<Response<Octokit.UsersGetGpgKeyResponse>>

    • endpoint: Endpoint
  • getPublicKey: object

    View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least read:public_key scope.

      • (params?: RequestOptions & Octokit.UsersGetPublicKeyParams): Promise<Response<Octokit.UsersGetPublicKeyResponse>>

      • Parameters

        Returns Promise<Response<Octokit.UsersGetPublicKeyResponse>>

    • endpoint: Endpoint
  • list: object

    Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts.

    Note: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of users.

  • listBlocked: object

    List the users you've blocked on your personal account.

  • listEmails: object

    Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the user:email scope.

      • (params?: RequestOptions & Octokit.UsersListEmailsParams): Promise<Response<Octokit.UsersListEmailsResponse>>

      • Parameters

        Returns Promise<Response<Octokit.UsersListEmailsResponse>>

    • endpoint: Endpoint
  • listFollowersForAuthenticatedUser: object
      • (params?: RequestOptions & Octokit.UsersListFollowersForAuthenticatedUserParams): Promise<Response<Octokit.UsersListFollowersForAuthenticatedUserResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.UsersListFollowersForAuthenticatedUserParams

        Returns Promise<Response<Octokit.UsersListFollowersForAuthenticatedUserResponse>>

    • endpoint: Endpoint
  • listFollowersForUser: object
      • (params?: RequestOptions & Octokit.UsersListFollowersForUserParams): Promise<Response<Octokit.UsersListFollowersForUserResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.UsersListFollowersForUserParams

        Returns Promise<Response<Octokit.UsersListFollowersForUserResponse>>

    • endpoint: Endpoint
  • listFollowingForAuthenticatedUser: object
      • (params?: RequestOptions & Octokit.UsersListFollowingForAuthenticatedUserParams): Promise<Response<Octokit.UsersListFollowingForAuthenticatedUserResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.UsersListFollowingForAuthenticatedUserParams

        Returns Promise<Response<Octokit.UsersListFollowingForAuthenticatedUserResponse>>

    • endpoint: Endpoint
  • listFollowingForUser: object
      • (params?: RequestOptions & Octokit.UsersListFollowingForUserParams): Promise<Response<Octokit.UsersListFollowingForUserResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.UsersListFollowingForUserParams

        Returns Promise<Response<Octokit.UsersListFollowingForUserResponse>>

    • endpoint: Endpoint
  • listGpgKeys: object

    Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least read:gpg_key scope.

      • (params?: RequestOptions & Octokit.UsersListGpgKeysParams): Promise<Response<Octokit.UsersListGpgKeysResponse>>

      • Parameters

        Returns Promise<Response<Octokit.UsersListGpgKeysResponse>>

    • endpoint: Endpoint
  • listGpgKeysForUser: object

    Lists the GPG keys for a user. This information is accessible by anyone.

      • (params?: RequestOptions & Octokit.UsersListGpgKeysForUserParams): Promise<Response<Octokit.UsersListGpgKeysForUserResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.UsersListGpgKeysForUserParams

        Returns Promise<Response<Octokit.UsersListGpgKeysForUserResponse>>

    • endpoint: Endpoint
  • listPublicEmails: object

    Lists your publicly visible email address, which you can set with the Toggle primary email visibility endpoint. This endpoint is accessible with the user:email scope.

      • (params?: RequestOptions & Octokit.UsersListPublicEmailsParams): Promise<Response<Octokit.UsersListPublicEmailsResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.UsersListPublicEmailsParams

        Returns Promise<Response<Octokit.UsersListPublicEmailsResponse>>

    • endpoint: Endpoint
  • listPublicKeys: object

    Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least read:public_key scope.

      • (params?: RequestOptions & Octokit.UsersListPublicKeysParams): Promise<Response<Octokit.UsersListPublicKeysResponse>>

      • Parameters

        Returns Promise<Response<Octokit.UsersListPublicKeysResponse>>

    • endpoint: Endpoint
  • listPublicKeysForUser: object

    Lists the verified public SSH keys for a user. This is accessible by anyone.

      • (params?: RequestOptions & Octokit.UsersListPublicKeysForUserParams): Promise<Response<Octokit.UsersListPublicKeysForUserResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.UsersListPublicKeysForUserParams

        Returns Promise<Response<Octokit.UsersListPublicKeysForUserResponse>>

    • endpoint: Endpoint
  • togglePrimaryEmailVisibility: object

    Sets the visibility for your primary email addresses.

      • (params?: RequestOptions & Octokit.UsersTogglePrimaryEmailVisibilityParams): Promise<Response<Octokit.UsersTogglePrimaryEmailVisibilityResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.UsersTogglePrimaryEmailVisibilityParams

        Returns Promise<Response<Octokit.UsersTogglePrimaryEmailVisibilityResponse>>

    • endpoint: Endpoint
  • unblock: object
      • (params?: RequestOptions & Octokit.UsersUnblockParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • unfollow: object

    Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the user:follow scope.

      • (params?: RequestOptions & Octokit.UsersUnfollowParams): Promise<Octokit.AnyResponse>

      • Parameters

        Returns Promise<Octokit.AnyResponse>

    • endpoint: Endpoint
  • updateAuthenticated: object

    Note: If your email is set to private and you send an email parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API.

      • (params?: RequestOptions & Octokit.UsersUpdateAuthenticatedParams): Promise<Response<Octokit.UsersUpdateAuthenticatedResponse>>

      • Parameters

        • Optional params: RequestOptions & Octokit.UsersUpdateAuthenticatedParams

        Returns Promise<Response<Octokit.UsersUpdateAuthenticatedResponse>>

    • endpoint: Endpoint

Methods

authenticate

registerEndpoints

  • registerEndpoints(endpoints: object): void

Static plugin

  • plugin(plugin: Octokit.Plugin | Octokit.Plugin[]): Static

  • Parameters

    • plugin: Octokit.Plugin | Octokit.Plugin[]

    Returns Static

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc