API Reference GitHub REST API Client v0.0.9

modules

Modules

Provides API endpoints related to actions

Provides struct and type for ActionsBillingUsage

Provides struct and type for ActionsCacheList

Provides struct and type for ActionsCacheUsageByRepository

Provides struct and type for ActionsCacheUsageOrgEnterprise

Provides struct and type for ActionsCanApprovePullRequestReviews

Provides struct and type for ActionsDefaultWorkflowPermissions

Provides struct and type for ActionsEnabled

Provides struct and type for ActionsGetDefaultWorkflowPermissions

Provides struct and type for Job

Provides struct and type for ActionsOrganizationPermissions

Provides struct and type for ActionsPublicKey

Provides struct and type for ActionsRepositoryPermissions

Provides struct and type for ReviewCustomGatesCommentRequired

Provides struct and type for ReviewCustomGatesStateRequired

Provides struct and type for Runner

Provides struct and type for RunnerApplication

Provides struct and type for RunnerLabel

Provides struct and type for ActionsSecret

Provides struct and type for ActionsSetDefaultWorkflowPermissions

Provides struct and type for ActionsVariable

Provides struct and type for Workflow

Provides struct and type for ActionsWorkflowAccessToRepository

Provides struct and type for WorkflowRun

Provides struct and type for WorkflowRunUsage

Provides struct and type for WorkflowUsage

Provides API endpoints related to activity

Provides struct and type for Actor

Provides struct and type for AddedToProjectIssueEvent

Provides struct and type for AlertAutoDismissedAt

Provides struct and type for AlertCreatedAt

Provides struct and type for AlertDismissedAt

Provides struct and type for AlertFixedAt

Provides struct and type for AlertHtmlUrl

Provides struct and type for AlertInstancesUrl

Provides struct and type for AlertNumber

Provides struct and type for AlertUpdatedAt

Provides struct and type for AlertUrl

Provides struct and type for AllowedActions

Provides struct and type for ApiOverview

Provides struct and type for Integration

Provides struct and type for IntegrationInstallationRequest

Provides struct and type for AppPermissions

Provides API endpoints related to apps

Provides struct and type for Artifact

Provides struct and type for AssignedIssueEvent

Protocol for extracting API authentication tokens from application structs

Provides struct and type for AuthenticationToken

Provides struct and type for AuthorAssociation

Provides struct and type for Authorization

Provides struct and type for AutoMerge

Provides struct and type for Autolink

Provides struct and type for BaseGist

Provides struct and type for BasicError

Provides API endpoints related to billing

Provides struct and type for Blob

Provides struct and type for BranchProtection

Provides struct and type for BranchRestrictionPolicy

Provides struct and type for BranchShort

Provides struct and type for BranchWithProtection

Provides struct and type for CheckAnnotation

Provides struct and type for CheckRun

Provides struct and type for CheckSuite

Provides struct and type for CheckSuitePreference

Provides API endpoints related to checks

Provides struct and type for CloneTraffic

Provides struct and type for CodeFrequencyStat

Provides struct and types for CodeOfConduct, CodeOfConductSimple

Provides API endpoints related to code scanning

Provides struct and type for CodeScanningAlert

Provides struct and type for CodeScanningAlertClassification

Provides struct and type for CodeScanningAlertDismissedComment

Provides struct and type for CodeScanningAlertDismissedReason

Provides struct and type for CodeScanningAlertEnvironment

Provides struct and type for CodeScanningAlertInstance

Provides struct and type for CodeScanningAlertItems

Provides struct and type for CodeScanningAlertLocation

Provides struct and type for CodeScanningAlertRule

Provides struct and type for CodeScanningAlertRuleSummary

Provides struct and type for CodeScanningAlertSetState

Provides struct and type for CodeScanningAlertSeverity

Provides struct and type for CodeScanningAlertState

Provides struct and type for CodeScanningAnalysis

Provides struct and type for CodeScanningAnalysisAnalysisKey

Provides struct and type for CodeScanningAnalysisCategory

Provides struct and type for CodeScanningAnalysisCommitSha

Provides struct and type for CodeScanningAnalysisCreatedAt

Provides struct and type for CodeScanningAnalysisDeletion

Provides struct and type for CodeScanningAnalysisEnvironment

Provides struct and type for CodeScanningAnalysisSarifFile

Provides struct and type for CodeScanningAnalysisSarifId

Provides struct and type for CodeScanningAnalysisTool

Provides struct and type for CodeScanningAnalysisToolGuid

Provides struct and type for CodeScanningAnalysisToolName

Provides struct and type for CodeScanningAnalysisToolVersion

Provides struct and type for CodeScanningAnalysisUrl

Provides struct and type for CodeScanningCodeqlDatabase

Provides struct and type for CodeScanningDefaultSetup

Provides struct and type for CodeScanningDefaultSetupUpdate

Provides struct and type for CodeScanningDefaultSetupUpdateResponse

Provides struct and type for CodeScanningOrganizationAlertItems

Provides struct and type for CodeScanningRef

Provides struct and type for CodeScanningSarifsReceipt

Provides struct and type for CodeScanningSarifsStatus

Provides struct and type for CodeSearchResultItem

Provides struct and type for CodeownersErrors

Provides API endpoints related to codes of conduct

Provides struct and type for Codespace

Provides struct and type for CodespaceExportDetails

Provides struct and type for CodespaceMachine

Provides struct and type for CodespacesOrgSecret

Provides struct and type for CodespacesPublicKey

Provides struct and type for CodespacesSecret

Provides struct and type for CodespacesUserPublicKey

Provides struct and type for CodespaceWithFullRepository

Provides API endpoints related to codespaces

Provides struct and type for Collaborator

Provides struct and type for CombinedBillingUsage

Provides struct and type for CombinedCommitStatus

Provides struct and types for Commit, SimpleCommit

Provides struct and type for CommitActivity

Provides struct and type for CommitComment

Provides struct and type for CommitComparison

Provides struct and type for CommitSearchResultItem

Provides struct and type for SimpleCommitStatus

Provides struct and type for CommunityHealthFile

Provides struct and type for CommunityProfile

Configuration for the API client and plugins

Provides struct and type for ContentDirectory

Provides struct and type for ContentFile

Provides struct and type for ContentSubmodule

Provides struct and type for ContentSymlink

Provides struct and type for ContentTraffic

Provides struct and type for ContentTree

Provides struct and type for Contributor

Provides struct and type for ContributorActivity

Provides struct and type for ConvertedNoteToIssueIssueEvent

Provides struct and type for CustomDeploymentRuleApp

Provides struct and type for DemilestonedIssueEvent

Provides API endpoints related to dependabot

Provides struct and type for DependabotAlert

Provides struct and type for DependabotAlertPackage

Provides struct and type for DependabotAlertSecurityAdvisory

Provides struct and type for DependabotAlertSecurityVulnerability

Provides struct and type for DependabotAlertWithRepository

Provides struct and type for DependabotPublicKey

Provides struct and type for DependabotSecret

Provides struct and type for Dependency

Provides API endpoints related to dependency graph

Provides struct and type for DependencyGraphDiff

Provides struct and type for DependencyGraphSpdxSbom

Provides struct and type for DeployKey

Provides struct and types for Deployment, DeploymentSimple

Provides struct and type for DeploymentBranchPolicy

Provides struct and type for DeploymentBranchPolicyNamePattern

Provides struct and type for DeploymentBranchPolicySettings

Provides struct and type for DeploymentProtectionRule

Provides struct and type for DeploymentReviewerType

Provides struct and type for DeploymentStatus

Provides struct and type for DiffEntry

Provides struct and type for Email

Provides API endpoint related to emojis

Provides struct and type for EmptyObject

Provides struct and type for EnabledRepositories

Provides struct and type for Enterprise

Provides struct and type for Environment

Provides struct and type for EnvironmentApprovals

Exception struct used for communicating errors from the client

Provides struct and type for Event

Provides struct and type for Feed

Provides struct and type for FileCommit

Provides struct and type for GistSimple

Provides struct and type for GistComment

Provides struct and type for GistCommit

Provides struct and type for GistHistory

Provides API endpoints related to gists

Provides API endpoints related to git

Provides struct and type for GitCommit

Provides struct and type for GitignoreTemplate

Provides struct and type for GitRef

Provides struct and type for GitTag

Provides struct and type for GitTree

Provides struct and type for GitUser

Provides API endpoints related to gitignore

Provides struct and type for GpgKey

Provides struct and type for Hook

Provides struct and type for HookDelivery

Provides struct and type for HookDeliveryItem

Provides struct and type for HookResponse

Provides struct and type for Hovercard

Provides struct and type for Import

Provides struct and type for Installation

Provides struct and type for InstallationToken

Provides struct and type for InteractionExpiry

Provides struct and type for InteractionGroup

Provides struct and type for InteractionLimit

Provides struct and type for InteractionLimitResponse

Provides API endpoints related to interactions

Provides struct and type for Issue

Provides struct and type for IssueComment

Provides struct and type for IssueEvent

Provides struct and type for IssueEventDismissedReview

Provides struct and type for IssueEventForIssue

Provides struct and type for IssueEventLabel

Provides struct and type for IssueEventMilestone

Provides struct and type for IssueEventProjectCard

Provides struct and type for IssueEventRename

Provides struct and type for IssueSearchResultItem

Provides API endpoints related to issues

Provides struct and types for Key, KeySimple

Provides struct and type for Label

Provides struct and type for LabelSearchResultItem

Provides struct and type for LabeledIssueEvent

Provides struct and type for Language

Provides struct and types for License, LicenseSimple

Provides struct and type for LicenseContent

Provides API endpoints related to licenses

Provides struct and type for Link

Provides struct and type for LinkWithType

Provides struct and type for LockedIssueEvent

Provides struct and type for Manifest

Provides API endpoints related to markdown

Provides struct and type for MarketplaceAccount

Provides struct and type for MarketplaceListingPlan

Provides struct and type for MarketplacePurchase

Provides struct and type for MergedUpstream

Provides API endpoints related to meta

Provides struct and type for Metadata

Provides struct and type for Migration

Provides API endpoints related to migrations

Provides struct and type for Milestone

Provides struct and type for MilestonedIssueEvent

Provides struct and type for MovedColumnInProjectIssueEvent

Provides struct and type for OidcCustomSub

Provides struct and type for OidcCustomSubRepo

Provides API endpoints related to oidc

Defines a struct that tracks client requests

Provides struct and type for OrgHook

Provides struct and type for OrgMembership

Provides struct and type for OrgRulesetConditions

Provides struct and types for OrganizationFull, OrganizationSimple

Provides struct and type for OrganizationActionsSecret

Provides struct and type for OrganizationActionsVariable

Provides struct and type for OrganizationDependabotSecret

Provides struct and type for OrganizationInvitation

Provides struct and type for OrganizationProgrammaticAccessGrant

Provides struct and type for OrganizationProgrammaticAccessGrantRequest

Provides struct and type for OrganizationSecretScanningAlert

Provides API endpoints related to orgs

Provides struct and type for Package

Provides struct and type for PackageVersion

Provides API endpoints related to packages

Provides struct and type for PackagesBillingUsage

Provides struct and type for Page

Provides struct and type for PageBuild

Provides struct and type for PageBuildStatus

Provides struct and type for PageDeployment

Provides struct and type for PagesHealthCheck

Provides struct and type for PagesHttpsCertificate

Provides struct and type for PagesSourceHash

Provides struct and type for ParticipationStats

Provides struct and type for PendingDeployment

Plugins provide functionality for the API client

Use Redis to cache full API responses and perform conditional requests

Use Redis to cache redirect locations to avoid unexpected rate limits

Local client used for testing purposes

Transform map responses into well-typed structs

Provides struct and type for PorterAuthor

Provides struct and type for PorterLargeFile

Provides struct and type for PrivateVulnerabilityReportCreate

Provides struct and type for Project

Provides struct and type for ProjectCard

Provides struct and type for ProjectCollaboratorPermission

Provides struct and type for ProjectColumn

Provides API endpoints related to projects

Provides struct and type for ProtectedBranch

Provides struct and type for ProtectedBranchAdminEnforced

Provides struct and type for ProtectedBranchPullRequestReview

Provides struct and type for ProtectedBranchRequiredStatusCheck

Provides struct and types for PullRequest, PullRequestMinimal, PullRequestSimple

Provides struct and type for PullRequestMergeResult

Provides struct and type for PullRequestReview

Provides struct and type for PullRequestReviewComment

Provides struct and type for PullRequestReviewRequest

Provides API endpoints related to pulls

Provides API endpoint, struct, and type related to rate limit

Provides struct and type for RateLimitOverview

Provides struct and type for Reaction

Provides struct and type for ReactionRollup

Provides API endpoints related to reactions

Provides struct and type for ReferencedWorkflow

Provides struct and type for ReferrerTraffic

Provides struct and type for Release

Provides struct and type for ReleaseAsset

Provides struct and type for ReleaseNotesContent

Provides struct and type for RemovedFromProjectIssueEvent

Provides struct and type for RenamedIssueEvent

Provides struct and type for RepoCodespacesSecret

Provides struct and type for RepoRequiredWorkflow

Provides struct and type for RepoSearchResultItem

Provides API endpoints related to repos

Provides struct and types for FullRepository, MinimalRepository, Repository, SimpleRepository

Provides struct and type for RepositoryAdvisory

Provides struct and type for RepositoryAdvisoryCreate

Provides struct and type for RepositoryAdvisoryCredit

Provides struct and type for RepositoryAdvisoryUpdate

Provides struct and type for RepositoryAdvisoryVulnerability

Provides struct and type for RepositoryCollaboratorPermission

Provides struct and type for RepositoryInvitation

Provides struct and type for RepositoryRule

Provides struct and type for RepositoryRuleBranchNamePattern

Provides struct and type for RepositoryRuleCommitAuthorEmailPattern

Provides struct and type for RepositoryRuleCommitMessagePattern

Provides struct and type for RepositoryRuleCommitterEmailPattern

Provides struct and type for RepositoryRuleCreation

Provides struct and type for RepositoryRuleDeletion

Provides struct and type for RepositoryRuleEnforcement

Provides struct and type for RepositoryRuleNonFastForward

Provides struct and type for RepositoryRuleParamsStatusCheckConfiguration

Provides struct and type for RepositoryRulePullRequest

Provides struct and type for RepositoryRuleRequiredDeployments

Provides struct and type for RepositoryRuleRequiredLinearHistory

Provides struct and type for RepositoryRuleRequiredSignatures

Provides struct and type for RepositoryRuleRequiredStatusChecks

Provides struct and type for RepositoryRuleTagNamePattern

Provides struct and type for RepositoryRuleUpdate

Provides struct and type for RepositoryRuleset

Provides struct and type for RepositoryRulesetBypassActor

Provides struct and type for RepositoryRulesetConditions

Provides struct and type for RepositoryRulesetConditionsRepositoryNameTarget

Provides struct and type for RepositorySubscription

Provides struct and type for RequiredWorkflow

Provides struct and type for ReviewComment

Provides struct and type for ReviewDismissedIssueEvent

Provides struct and type for ReviewRequestRemovedIssueEvent

Provides struct and type for ReviewRequestedIssueEvent

Provides struct and type for Root

Provides struct and type for ScimError

Provides struct and type for SshSigningKey

Provides struct and type for ScopedInstallation

Provides API endpoints related to search

Provides struct and type for SearchResultTextMatches

Provides API endpoints related to secret scanning

Provides struct and type for SecretScanningAlert

Provides struct and type for SecretScanningAlertResolution

Provides struct and type for SecretScanningAlertResolutionComment

Provides struct and type for SecretScanningAlertState

Provides struct and type for SecretScanningLocation

Provides struct and type for SecretScanningLocationCommit

Provides struct and type for SecretScanningLocationIssueBody

Provides struct and type for SecretScanningLocationIssueComment

Provides struct and type for SecretScanningLocationIssueTitle

Provides API endpoints related to security advisories

Provides struct and type for SecurityAdvisoryCreditTypes

Provides struct and type for SecurityAdvisoryEcosystems

Provides struct and type for SecurityAndAnalysis

Provides struct and type for SelectedActions

Provides struct and type for SelectedActionsUrl

Provides struct and type for ShortBlob

Provides struct and type for ShortBranch

Provides struct and type for Snapshot

Provides struct and type for SocialAccount

Provides struct and type for Stargazer

Provides struct and type for StarredRepository

Provides struct and type for StateChangeIssueEvent

Provides struct and type for Status

Provides struct and type for StatusCheckPolicy

Provides struct and type for Tag

Provides struct and type for TagProtection

Provides struct and types for Team, TeamFull, TeamSimple

Provides struct and type for TeamDiscussion

Provides struct and type for TeamDiscussionComment

Provides struct and type for TeamMembership

Provides struct and type for TeamOrganization

Provides struct and type for TeamProject

Provides struct and type for TeamRepository

Provides API endpoints related to teams

Support for interacting with the client in a test environment

Internal representation of a mocked API call

Provides struct and type for Thread

Provides struct and type for ThreadSubscription

Provides struct and type for TimelineAssignedIssueEvent

Provides struct and type for TimelineCommentEvent

Provides struct and type for TimelineCommitCommentedEvent

Provides struct and type for TimelineCommittedEvent

Provides struct and type for TimelineCrossReferencedEvent

Provides struct and type for TimelineIssueEvents

Provides struct and type for TimelineLineCommentedEvent

Provides struct and type for TimelineReviewedEvent

Provides struct and type for TimelineUnassignedIssueEvent

Provides struct and type for Topic

Provides struct and type for TopicSearchResultItem

Provides struct and type for Traffic

Provides struct and type for UnassignedIssueEvent

Provides struct and type for UnlabeledIssueEvent

Provides struct and types for PrivateUser, PublicUser, SimpleUser

Provides struct and type for UserMarketplacePurchase

Provides struct and type for UserSearchResultItem

Provides API endpoints related to users

Provides struct and types for ValidationError, ValidationErrorSimple

Provides struct and type for Verification

Provides struct and type for ViewTraffic

Provides struct and type for WaitTimer

Provides struct and type for WebhookConfig

Provides struct and type for WebhookConfigContentType

Provides struct and type for WebhookConfigInsecureSsl

Provides struct and type for WebhookConfigSecret

Provides struct and type for WebhookConfigUrl