API Reference GitHub REST API Client v0.2.2
modules
Modules
Provides API endpoints related to actions
Provides struct and type for a Actions.BillingUsage
Provides struct and type for a Actions.CacheList
Provides struct and type for a Actions.CacheUsageByRepository
Provides struct and type for a Actions.CacheUsageOrgEnterprise
Provides struct and type for a Actions.GetDefaultWorkflowPermissions
Provides struct and type for a Actions.Job
Provides struct and type for a Actions.OIDCSubjectCustomizationForARepository
Provides struct and type for a Actions.OrganizationPermissions
Provides struct and type for a Actions.PublicKey
Provides struct and type for a Actions.RepositoryPermissions
Provides struct and type for a Actions.ReviewCustomGates.CommentRequired
Provides struct and type for a Actions.ReviewCustomGates.StateRequired
Provides struct and type for a Actions.Runner
Provides struct and type for a Actions.Runner.Application
Provides struct and type for a Actions.Runner.Label
Provides struct and type for a Actions.Secret
Provides struct and type for a Actions.SetDefaultWorkflowPermissions
Provides struct and type for a Actions.Variable
Provides struct and type for a Actions.Workflow
Provides struct and type for a Actions.Workflow.AccessToRepository
Provides struct and type for a Actions.Workflow.Run
Provides struct and type for a Actions.Workflow.RunUsage
Provides struct and type for a Actions.Workflow.Usage
Provides API endpoints related to activity
Provides struct and type for a Actor
Provides struct and type for a ApiOverview
Provides struct and type for a App
Provides struct and type for a App.InstallationRequest
Provides struct and type for a App.Permissions
Provides API endpoints related to apps
Provides struct and type for a Artifact
Protocol for extracting API authentication tokens from application structs
Optional caching process for GitHub App and Installation tokens
Provides struct and type for a AuthenticationToken
Provides struct and type for a Authorization
Provides struct and type for a AutoMerge
Provides struct and type for a Autolink
Provides struct and type for a BaseGist
Provides struct and type for a BasicError
Provides API endpoints related to billing
Provides struct and type for a Blob
Provides struct and type for a Branch.Protection
Provides struct and type for a Branch.RestrictionPolicy
Provides struct and type for a Branch.Short
Provides struct and type for a Branch.WithProtection
Provides struct and type for a Check.Annotation
Provides struct and type for a Check.AutomatedSecurityFixes
Provides struct and type for a Check.Run
Provides struct and type for a Check.Suite
Provides struct and type for a Check.SuitePreference
Provides API endpoints related to checks
Provides API endpoints related to classroom
Provides struct and type for a Classroom.AcceptedAssignment
Provides struct and types for a Classroom.Assignment
Provides struct and type for a Classroom.AssignmentGrade
Provides struct and type for a Classroom.Organization
Provides struct and type for a Classroom.Repository
Provides struct and type for a Classroom.User
Provides struct and type for a CloneTraffic
Provides struct and types for a CodeOfConduct
Provides API endpoints related to code scanning
Provides struct and type for a CodeScanning.Alert
Provides struct and type for a CodeScanning.AlertInstance
Provides struct and type for a CodeScanning.AlertItems
Provides struct and type for a CodeScanning.AlertLocation
Provides struct and type for a CodeScanning.AlertRule
Provides struct and type for a CodeScanning.AlertRuleSummary
Provides struct and type for a CodeScanning.Analysis
Provides struct and type for a CodeScanning.AnalysisDeletion
Provides struct and type for a CodeScanning.AnalysisTool
Provides struct and type for a CodeScanning.CodeqlDatabase
Provides struct and type for a CodeScanning.DefaultSetup
Provides struct and type for a CodeScanning.DefaultSetupUpdate
Provides struct and type for a CodeScanning.DefaultSetupUpdateResponse
Provides struct and type for a CodeScanning.OrganizationAlertItems
Provides struct and type for a CodeScanning.SarifsReceipt
Provides struct and type for a CodeScanning.SarifsStatus
Provides struct and type for a CodeSearchResultItem
Provides struct and type for a CodeownersErrors
Provides API endpoints related to codes of conduct
Provides struct and type for a Codespace
Provides struct and type for a Codespace.ExportDetails
Provides struct and type for a Codespace.Machine
Provides struct and type for a Codespace.OrgSecret
Provides struct and type for a Codespace.PublicKey
Provides struct and type for a Codespace.Secret
Provides struct and type for a Codespace.UserPublicKey
Provides struct and type for a Codespace.WithFullRepository
Provides API endpoints related to codespaces
Provides struct and type for a Collaborator
Provides struct and type for a CombinedBillingUsage
Provides struct and type for a CombinedCommitStatus
Provides struct and types for a Commit
Provides struct and type for a Commit.Activity
Provides struct and type for a Commit.Comment
Provides struct and type for a Commit.Comparison
Provides struct and type for a Commit.SearchResultItem
Provides struct and type for a Commit.Status
Provides struct and type for a CommunityHealthFile
Provides struct and type for a CommunityProfile
Configuration for the API client and plugins
Provides struct and type for a ContainerMetadata
Provides struct and type for a Content.File
Provides struct and type for a Content.Submodule
Provides struct and type for a Content.Symlink
Provides struct and type for a Content.Traffic
Provides struct and type for a Content.Tree
Provides struct and type for a Contributor
Provides struct and type for a ContributorActivity
Provides API endpoints related to copilot
Provides struct and type for a Copilot.OrganizationDetails
Provides struct and type for a Copilot.SeatBreakdown
Provides struct and type for a Copilot.SeatDetails
Provides struct and type for a CustomDeploymentRuleApp
Provides API endpoints related to dependabot
Provides struct and type for a Dependabot.Alert
Provides struct and type for a Dependabot.Alert.Package
Provides struct and type for a Dependabot.Alert.SecurityAdvisory
Provides struct and type for a Dependabot.Alert.SecurityVulnerability
Provides struct and type for a Dependabot.Alert.WithRepository
Provides struct and type for a Dependabot.PublicKey
Provides struct and type for a Dependabot.Secret
Provides API endpoints related to dependency graph
Provides struct and type for a DependencyGraph.SpdxSbom
Provides struct and type for a DeployKey
Provides struct and types for a Deployment
Provides struct and type for a Deployment.BranchPolicy
Provides struct and type for a Deployment.BranchPolicyNamePattern
Provides struct and type for a Deployment.BranchPolicyNamePatternWithType
Provides struct and type for a Deployment.BranchPolicySettings
Provides struct and type for a Deployment.ProtectionRule
Provides struct and type for a Deployment.Status
Provides struct and type for a DiffEntry
Provides struct and type for a DockerMetadata
Provides struct and type for a Email
Provides API endpoint related to emojis
Provides struct and type for a EmptyObject
Provides struct and type for a Enterprise
Provides struct and type for a Environment
Provides struct and type for a EnvironmentApprovals
Exception struct used for communicating errors from the client
Provides struct and type for a Event
Provides struct and type for a Feed
Provides struct and type for a FileCommit
Provides struct and types for a Gist
Provides struct and type for a Gist.Comment
Provides struct and type for a Gist.Commit
Provides API endpoints related to gists
Provides API endpoints related to git
Provides struct and type for a Git.Commit
Provides struct and type for a Git.IgnoreTemplate
Provides struct and type for a Git.Ref
Provides struct and type for a Git.Tag
Provides struct and type for a Git.Tree
Provides struct and type for a Git.User
Provides API endpoints related to gitignore
Provides struct and type for a GlobalAdvisory
Provides struct and type for a GpgKey
Provides struct and type for a Hook
Provides struct and type for a Hook.Delivery
Provides struct and type for a Hook.DeliveryItem
Provides struct and type for a Hook.Response
Provides struct and type for a Hovercard
Provides struct and type for a Import
Provides struct and types for a Installation
Provides struct and type for a Installation.Token
Provides struct and type for a Interaction.Limit
Provides struct and type for a Interaction.Limit.Response
Provides API endpoints related to interactions
Provides struct and type for a Issue
Provides struct and type for a Issue.Comment
Provides struct and type for a Issue.Event
Provides struct and type for a Issue.Event.AddedToProject
Provides struct and type for a Issue.Event.Assigned
Provides struct and type for a Issue.Event.ConvertedNoteToIssue
Provides struct and type for a Issue.Event.Demilestoned
Provides struct and type for a Issue.Event.Labeled
Provides struct and type for a Issue.Event.Locked
Provides struct and type for a Issue.Event.Milestoned
Provides struct and type for a Issue.Event.MovedColumnInProject
Provides struct and type for a Issue.Event.RemovedFromProject
Provides struct and type for a Issue.Event.Renamed
Provides struct and type for a Issue.Event.ReviewDismissed
Provides struct and type for a Issue.Event.ReviewRequestRemoved
Provides struct and type for a Issue.Event.ReviewRequested
Provides struct and type for a Issue.Event.StateChange
Provides struct and type for a Issue.Event.Unassigned
Provides struct and type for a Issue.Event.Unlabeled
Provides struct and type for a Issue.EventDismissedReview
Provides struct and type for a Issue.EventLabel
Provides struct and type for a Issue.EventMilestone
Provides struct and type for a Issue.EventProjectCard
Provides struct and type for a Issue.EventRename
Provides struct and type for a Issue.SearchResultItem
Provides API endpoints related to issues
Provides struct and types for a Key
Provides struct and type for a Label
Provides struct and type for a LabelSearchResultItem
Provides struct and type for a Language
Provides struct and types for a License
Provides struct and type for a License.Content
Provides API endpoints related to licenses
Provides struct and type for a Link
Provides struct and type for a LinkWithType
Provides API endpoints related to markdown
Provides struct and type for a Marketplace.Account
Provides struct and type for a Marketplace.ListingPlan
Provides struct and type for a Marketplace.Purchase
Provides struct and type for a MergedUpstream
Provides API endpoints related to meta
Provides struct and type for a Metadata
Provides struct and type for a Migration
Provides API endpoints related to migrations
Provides struct and type for a Milestone
Provides struct and type for a OIDCCustomSub
Provides struct and type for a OIDCCustomSubRepo
Provides API endpoints related to oidc
Defines a struct that tracks client requests
Provides struct and type for a OrgHook
Provides struct and type for a OrgMembership
Provides struct and types for a Organization
Provides struct and type for a Organization.ActionsSecret
Provides struct and type for a Organization.ActionsVariable
Provides struct and type for a Organization.DependabotSecret
Provides struct and type for a Organization.Invitation
Provides struct and type for a Organization.ProgrammaticAccessGrant
Provides struct and type for a Organization.ProgrammaticAccessGrant.Request
Provides struct and type for a Organization.SecretScanningAlert
Provides API endpoints related to orgs
Provides struct and type for a Package
Provides struct and type for a PackageVersion
Provides struct and type for a PackageVersionMetadata
Provides API endpoints related to packages
Provides struct and type for a PackagesBillingUsage
Provides struct and type for a Page
Provides struct and type for a Pages.Build
Provides struct and type for a Pages.BuildStatus
Provides struct and type for a Pages.Deployment
Provides struct and type for a Pages.HealthCheck
Provides struct and type for a Pages.HttpsCertificate
Provides struct and type for a Pages.SourceHash
Provides struct and type for a ParticipationStats
Provides struct and type for a PendingDeployment
Plugins provide functionality for the API client
OpenTelemetry bindings for all operation requests
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 a PorterAuthor
Provides struct and type for a PorterLargeFile
Provides struct and type for a PrivateVulnerabilityReport.Create
Provides struct and type for a Project
Provides struct and type for a Project.Card
Provides struct and type for a Project.CollaboratorPermission
Provides struct and type for a Project.Column
Provides API endpoints related to projects
Provides struct and type for a ProtectedBranch
Provides struct and type for a ProtectedBranch.AdminEnforced
Provides struct and type for a ProtectedBranch.PullRequestReview
Provides struct and type for a ProtectedBranch.RequiredStatusCheck
Provides struct and types for a PullRequest
Provides struct and type for a PullRequest.MergeResult
Provides struct and type for a PullRequest.Review
Provides struct and type for a PullRequest.ReviewComment
Provides struct and type for a PullRequest.ReviewRequest
Provides API endpoints related to pulls
Provides API endpoint related to rate limit
Provides struct and type for a RateLimit.Overview
Provides struct and type for a Reaction
Provides struct and type for a Reaction.Rollup
Provides API endpoints related to reactions
Provides struct and type for a ReferrerTraffic
Provides struct and type for a Release
Provides struct and type for a Release.Asset
Provides struct and type for a Release.NotesContent
Provides struct and type for a RepoCodespacesSecret
Provides struct and type for a RepoSearchResultItem
Provides API endpoints related to repos
Provides struct and types for a Repository
Provides struct and type for a Repository.Advisory
Provides struct and type for a Repository.Advisory.Create
Provides struct and type for a Repository.Advisory.Update
Provides struct and type for a Repository.CollaboratorPermission
Provides struct and type for a Repository.IdAndRefName
Provides struct and type for a Repository.Invitation
Provides struct and type for a Repository.NameAndRefName
Provides struct and type for a Repository.Rule.BranchNamePattern
Provides struct and type for a Repository.Rule.CommitAuthorEmailPattern
Provides struct and type for a Repository.Rule.CommitMessagePattern
Provides struct and type for a Repository.Rule.CommitterEmailPattern
Provides struct and type for a Repository.Rule.Creation
Provides struct and type for a Repository.Rule.Deletion
Provides struct and type for a Repository.Rule.NonFastForward
Provides struct and type for a Repository.Rule.ParamsStatusCheckConfiguration
Provides struct and type for a Repository.Rule.PullRequest
Provides struct and type for a Repository.Rule.RequiredDeployments
Provides struct and type for a Repository.Rule.RequiredLinearHistory
Provides struct and type for a Repository.Rule.RequiredSignatures
Provides struct and type for a Repository.Rule.RequiredStatusChecks
Provides struct and type for a Repository.Rule.TagNamePattern
Provides struct and type for a Repository.Rule.Update
Provides struct and type for a Repository.Ruleset
Provides struct and type for a Repository.Ruleset.BypassActor
Provides struct and type for a Repository.Ruleset.Conditions
Provides struct and type for a Repository.Subscription
Provides struct and type for a ReviewComment
Provides struct and type for a Root
Provides struct and type for a RuleSuite
Provides struct and type for a SCIM.Error
Provides struct and type for a SSHSigningKey
Provides API endpoints related to search
Provides API endpoints related to secret scanning
Provides struct and type for a SecretScanning.Alert
Provides struct and type for a SecretScanning.Location
Provides struct and type for a SecretScanning.LocationCommit
Provides struct and type for a SecretScanning.LocationIssueBody
Provides struct and type for a SecretScanning.LocationIssueComment
Provides struct and type for a SecretScanning.LocationIssueTitle
Provides API endpoints related to security advisories
Provides struct and type for a SecurityAndAnalysis
Provides struct and type for a SelectedActions
Provides struct and type for a ShortBlob
Provides struct and type for a ShortBranch
Provides struct and type for a Snapshot
Provides struct and type for a SocialAccount
Provides struct and type for a StarredRepository
Provides struct and type for a Status
Provides struct and type for a StatusCheckPolicy
Provides struct and type for a Tag
Provides struct and type for a TagProtection
Provides struct and types for a Team
Provides struct and type for a Team.Discussion
Provides struct and type for a Team.DiscussionComment
Provides struct and type for a Team.Membership
Provides struct and type for a Team.Organization
Provides struct and type for a Team.Project
Provides struct and type for a Team.Repository
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 a Thread
Provides struct and type for a ThreadSubscription
Provides struct and type for a Timeline.AssignedIssueEvent
Provides struct and type for a Timeline.CommentEvent
Provides struct and type for a Timeline.CommitCommentedEvent
Provides struct and type for a Timeline.CommittedEvent
Provides struct and type for a Timeline.CrossReferencedEvent
Provides struct and type for a Timeline.LineCommentedEvent
Provides struct and type for a Timeline.ReviewedEvent
Provides struct and type for a Timeline.UnassignedIssueEvent
Provides struct and type for a Topic
Provides struct and type for a TopicSearchResultItem
Provides struct and type for a Traffic
Provides struct and types for a User
Provides struct and type for a User.MarketplacePurchase
Provides struct and type for a User.SearchResultItem
Provides API endpoints related to users
Provides struct and types for a ValidationError
Provides struct and type for a Verification
Provides struct and type for a ViewTraffic
Helpers for validating and handling webhooks dispatched by GitHub
Provides struct and type for a Webhook.Config