The highest tagged major version isv76.

github

package

v29.0.3Latest Latest

This package is not in the latest version of its module.

Go to latest Published: Feb 10, 2020 License:BSD-3-ClauseImports:27Imported by:139

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/google/go-github

Documentation ¶

Overview¶

Package github provides a client for using the GitHub API.

Usage:

import "github.com/google/go-github/v29/github"// with go modules enabled (GO111MODULE=on or outside GOPATH)import "github.com/google/go-github/github"     // with go modules disabled

Construct a new GitHub client, then use the various services on the client toaccess different parts of the GitHub API. For example:

client := github.NewClient(nil)// list all organizations for user "willnorris"orgs, _, err := client.Organizations.List(ctx, "willnorris", nil)

Some API methods have optional parameters that can be passed. For example:

client := github.NewClient(nil)// list public repositories for org "github"opt := &github.RepositoryListByOrgOptions{Type: "public"}repos, _, err := client.Repositories.ListByOrg(ctx, "github", opt)

The services of a client divide the API into logical chunks and correspond tothe structure of the GitHub API documentation athttps://developer.github.com/v3/.

NOTE: Using thehttps://godoc.org/context package, one can easilypass cancelation signals and deadlines to various services of the client forhandling a request. In case there is no context available, then context.Background()can be used as a starting point.

For more sample code snippets, head over to thehttps://github.com/google/go-github/tree/master/example directory.

Authentication¶

The go-github library does not directly handle authentication. Instead, whencreating a new client, pass an http.Client that can handle authentication foryou. The easiest and recommended way to do this is using the golang.org/x/oauth2library, but you can always use any other library that provides an http.Client.If you have an OAuth2 access token (for example, a personal API token), you canuse it with the oauth2 library using:

import "golang.org/x/oauth2"func main() {ctx := context.Background()ts := oauth2.StaticTokenSource(&oauth2.Token{AccessToken: "... your access token ..."},)tc := oauth2.NewClient(ctx, ts)client := github.NewClient(tc)// list all repositories for the authenticated userrepos, _, err := client.Repositories.List(ctx, "", nil)}

Note that when using an authenticated Client, all calls made by the client willinclude the specified OAuth token. Therefore, authenticated clients shouldalmost never be shared between different users.

See the oauth2 docs for complete instructions on using that library.

For API methods that require HTTP Basic Authentication, use theBasicAuthTransport.

GitHub Apps authentication can be provided by thehttps://github.com/bradleyfalzon/ghinstallation package.

import "github.com/bradleyfalzon/ghinstallation"func main() {// Wrap the shared transport for use with the integration ID 1 authenticating with installation ID 99.itr, err := ghinstallation.NewKeyFromFile(http.DefaultTransport, 1, 99, "2016-10-19.private-key.pem")if err != nil {// Handle error.}// Use installation transport with clientclient := github.NewClient(&http.Client{Transport: itr})// Use client...}

Rate Limiting¶

GitHub imposes a rate limit on all API clients. Unauthenticated clients arelimited to 60 requests per hour, while authenticated clients can make up to5,000 requests per hour. The Search API has a custom rate limit. Unauthenticatedclients are limited to 10 requests per minute, while authenticated clientscan make up to 30 requests per minute. To receive the higher rate limit whenmaking calls that are not issued on behalf of a user,use UnauthenticatedRateLimitedTransport.

The returned Response.Rate value contains the rate limit informationfrom the most recent API call. If a recent enough response isn'tavailable, you can use RateLimits to fetch the most up-to-date ratelimit data for the client.

To detect an API rate limit error, you can check if its type is *github.RateLimitError:

repos, _, err := client.Repositories.List(ctx, "", nil)if _, ok := err.(*github.RateLimitError); ok {log.Println("hit rate limit")}

Learn more about GitHub rate limiting athttps://developer.github.com/v3/#rate-limiting.

Accepted Status¶

Some endpoints may return a 202 Accepted status code, meaning that theinformation required is not yet ready and was scheduled to be gathered onthe GitHub side. Methods known to behave like this are documented specifyingthis behavior.

To detect this condition of error, you can check if its type is*github.AcceptedError:

stats, _, err := client.Repositories.ListContributorsStats(ctx, org, repo)if _, ok := err.(*github.AcceptedError); ok {log.Println("scheduled on GitHub side")}

Conditional Requests¶

The GitHub API has good support for conditional requests which will helpprevent you from burning through your rate limit, as well as help speed up yourapplication. go-github does not handle conditional requests directly, but isinstead designed to work with a caching http.Transport. We recommend usinghttps://github.com/gregjones/httpcache for that.

Learn more about GitHub conditional requests athttps://developer.github.com/v3/#conditional-requests.

Creating and Updating Resources¶

All structs for GitHub resources use pointer values for all non-repeated fields.This allows distinguishing between unset fields and those set to a zero-value.Helper functions have been provided to easily create these pointers for string,bool, and int values. For example:

// create a new private repository named "foo"repo := &github.Repository{Name:    github.String("foo"),Private: github.Bool(true),}client.Repositories.Create(ctx, "", repo)

Users who have worked with protocol buffers should find this pattern familiar.

Pagination¶

All requests for resource collections (repos, pull requests, issues, etc.)support pagination. Pagination options are described in thegithub.ListOptions struct and passed to the list methods directly or as anembedded type of a more specific list options struct (for examplegithub.PullRequestListOptions). Pages information is available via thegithub.Response struct.

client := github.NewClient(nil)opt := &github.RepositoryListByOrgOptions{ListOptions: github.ListOptions{PerPage: 10},}// get all pages of resultsvar allRepos []*github.Repositoryfor {repos, resp, err := client.Repositories.ListByOrg(ctx, "github", opt)if err != nil {return err}allRepos = append(allRepos, repos...)if resp.NextPage == 0 {break}opt.Page = resp.NextPage}

Index¶

Examples¶

Constants¶

View Source

const (// Tarball specifies an archive in gzipped tar format.Tarball archiveFormat = "tarball"// Zipball specifies an archive in zip format.Zipball archiveFormat = "zipball")

Variables¶

This section is empty.

Functions¶

funcBool ¶

func Bool(vbool) *bool

Bool is a helper routine that allocates a new bool valueto store v and returns a pointer to it.

funcCheckResponse ¶

func CheckResponse(r *http.Response)error

CheckResponse checks the API response for errors, and returns them ifpresent. A response is considered an error if it has a status code outsidethe 200 range or equal to 202 Accepted.API error responses are expected to have responsebody, and a JSON response body that maps to ErrorResponse.

The error type will be *RateLimitError for rate limit exceeded errors,*AcceptedError for 202 Accepted status codes,and *TwoFactorAuthError for two-factor authentication errors.

funcDeliveryID ¶

func DeliveryID(r *http.Request)string

DeliveryID returns the unique delivery ID of webhook request r.

GitHub API docs:https://developer.github.com/v3/repos/hooks/#webhook-headers

funcInt ¶

func Int(vint) *int

Int is a helper routine that allocates a new int valueto store v and returns a pointer to it.

funcInt64 ¶

func Int64(vint64) *int64

Int64 is a helper routine that allocates a new int64 valueto store v and returns a pointer to it.

funcParseWebHook ¶

func ParseWebHook(messageTypestring, payload []byte) (interface{},error)

ParseWebHook parses the event payload. For recognized event types, avalue of the corresponding struct type will be returned (as returnedby Event.ParsePayload()). An error will be returned for unrecognized eventtypes.

Example usage:

func (s *GitHubEventMonitor) ServeHTTP(w http.ResponseWriter, r *http.Request) {  payload, err := github.ValidatePayload(r, s.webhookSecretKey)  if err != nil { ... }  event, err := github.ParseWebHook(github.WebHookType(r), payload)  if err != nil { ... }  switch event := event.(type) {  case *github.CommitCommentEvent:      processCommitCommentEvent(event)  case *github.CreateEvent:      processCreateEvent(event)  ...  }}

funcString ¶

func String(vstring) *string

String is a helper routine that allocates a new string valueto store v and returns a pointer to it.

funcStringify ¶

func Stringify(message interface{})string

Stringify attempts to create a reasonable string representation of types inthe GitHub library. It does things like resolve pointers to their valuesand omits struct fields with nil values.

funcValidatePayload ¶

func ValidatePayload(r *http.Request, secretToken []byte) (payload []byte, errerror)

ValidatePayload validates an incoming GitHub Webhook event requestand returns the (JSON) payload.The Content-Type header of the payload can be "application/json" or "application/x-www-form-urlencoded".If the Content-Type is neither then an error is returned.secretToken is the GitHub Webhook secret token.If your webhook does not contain a secret token, you can pass nil or an empty slice.This is intended for local development purposes only and all webhooks should ideally set up a secret token.

Example usage:

func (s *GitHubEventMonitor) ServeHTTP(w http.ResponseWriter, r *http.Request) {  payload, err := github.ValidatePayload(r, s.webhookSecretKey)  if err != nil { ... }  // Process payload...}

funcValidateSignature ¶

func ValidateSignature(signaturestring, payload, secretToken []byte)error

ValidateSignature validates the signature for the given payload.signature is the GitHub hash signature delivered in the X-Hub-Signature header.payload is the JSON payload sent by GitHub Webhooks.secretToken is the GitHub Webhook secret token.

GitHub API docs:https://developer.github.com/webhooks/securing/#validating-payloads-from-github

funcWebHookType ¶

func WebHookType(r *http.Request)string

WebHookType returns the event type of webhook request r.

GitHub API docs:https://developer.github.com/v3/repos/hooks/#webhook-headers

Types¶

typeAPIMeta ¶

type APIMeta struct {// An Array of IP addresses in CIDR format specifying the addresses// that incoming service hooks will originate from on GitHub.com.Hooks []string `json:"hooks,omitempty"`// An Array of IP addresses in CIDR format specifying the Git servers// for GitHub.com.Git []string `json:"git,omitempty"`// Whether authentication with username and password is supported.// (GitHub Enterprise instances using CAS or OAuth for authentication// will return false. Features like Basic Authentication with a// username and password, sudo mode, and two-factor authentication are// not supported on these servers.)VerifiablePasswordAuthentication *bool `json:"verifiable_password_authentication,omitempty"`// An array of IP addresses in CIDR format specifying the addresses// which serve GitHub Pages websites.Pages []string `json:"pages,omitempty"`// An Array of IP addresses specifying the addresses that source imports// will originate from on GitHub.com.Importer []string `json:"importer,omitempty"`}

APIMeta represents metadata about the GitHub API.

func (*APIMeta)GetVerifiablePasswordAuthentication ¶

func (a *APIMeta) GetVerifiablePasswordAuthentication()bool

GetVerifiablePasswordAuthentication returns the VerifiablePasswordAuthentication field if it's non-nil, zero value otherwise.

typeAbuseRateLimitError ¶

type AbuseRateLimitError struct {Response *http.Response// HTTP response that caused this errorMessagestring         `json:"message"`// error message// RetryAfter is provided with some abuse rate limit errors. If present,// it is the amount of time that the client should wait before retrying.// Otherwise, the client should try again later (after an unspecified amount of time).RetryAfter *time.Duration}

AbuseRateLimitError occurs when GitHub returns 403 Forbidden response with the"documentation_url" field value equal to "https://developer.github.com/v3/#abuse-rate-limits".

func (*AbuseRateLimitError)Error ¶

func (r *AbuseRateLimitError) Error()string

func (*AbuseRateLimitError)GetRetryAfter ¶

func (a *AbuseRateLimitError) GetRetryAfter()time.Duration

GetRetryAfter returns the RetryAfter field if it's non-nil, zero value otherwise.

typeAcceptedError ¶

type AcceptedError struct {// Raw contains the response body.Raw []byte}

AcceptedError occurs when GitHub returns 202 Accepted response with anempty body, which means a job was scheduled on the GitHub side to processthe information needed and cache it.Technically, 202 Accepted is not a real error, it's just used toindicate that results are not ready yet, but should be available soon.The request can be repeated after some time.

func (*AcceptedError)Error ¶

func (*AcceptedError) Error()string

typeActionsService ¶added inv29.0.3

type ActionsService service

ActionsService handles communication with the actions relatedmethods of the GitHub API.

GitHub API docs:https://developer.github.com/v3/actions/

func (*ActionsService)CreateOrUpdateSecret ¶added inv29.0.3

func (s *ActionsService) CreateOrUpdateSecret(ctxcontext.Context, owner, repostring, eSecret *EncryptedSecret) (*Response,error)

CreateOrUpdateSecret creates or updates a secret with an encrypted value.

GitHub API docs:https://developer.github.com/v3/actions/secrets/#create-or-update-a-secret-for-a-repository

func (*ActionsService)DeleteSecret ¶added inv29.0.3

func (s *ActionsService) DeleteSecret(ctxcontext.Context, owner, repo, namestring) (*Response,error)

DeleteSecret deletes a secret in a repository using the secret name.

GitHub API docs:https://developer.github.com/v3/actions/secrets/#delete-a-secret-from-a-repository

func (*ActionsService)GetPublicKey ¶added inv29.0.3

func (s *ActionsService) GetPublicKey(ctxcontext.Context, owner, repostring) (*PublicKey, *Response,error)

GetPublicKey gets a public key that should be used for secret encryption.

GitHub API docs:https://developer.github.com/v3/actions/secrets/#get-your-public-key

func (*ActionsService)GetSecret ¶added inv29.0.3

func (s *ActionsService) GetSecret(ctxcontext.Context, owner, repo, namestring) (*Secret, *Response,error)

GetSecret gets a single secret without revealing its encrypted value.

GitHub API docs:https://developer.github.com/v3/actions/secrets/#get-a-secret

func (*ActionsService)GetWorkflowByFileName ¶added inv29.0.3

func (s *ActionsService) GetWorkflowByFileName(ctxcontext.Context, owner, repo, workflowFileNamestring) (*Workflow, *Response,error)

GetWorkflowByFileName gets a specific workflow by file name.

GitHub API docs:https://developer.github.com/v3/actions/workflows/#get-a-workflow

func (*ActionsService)GetWorkflowByID ¶added inv29.0.3

func (s *ActionsService) GetWorkflowByID(ctxcontext.Context, owner, repostring, workflowIDint64) (*Workflow, *Response,error)

GetWorkflowByID gets a specific workflow by ID.

GitHub API docs:https://developer.github.com/v3/actions/workflows/#get-a-workflow

func (*ActionsService)ListSecrets ¶added inv29.0.3

func (s *ActionsService) ListSecrets(ctxcontext.Context, owner, repostring, opts *ListOptions) (*Secrets, *Response,error)

ListSecrets lists all secrets available in a repositorywithout revealing their encrypted values.

GitHub API docs:https://developer.github.com/v3/actions/secrets/#list-secrets-for-a-repository

func (*ActionsService)ListWorkflows ¶added inv29.0.3

func (s *ActionsService) ListWorkflows(ctxcontext.Context, owner, repostring, opts *ListOptions) (*Workflows, *Response,error)

ListWorkflows lists all workflows in a repository.

GitHub API docs:https://developer.github.com/v3/actions/workflows/#list-repository-workflows

typeActivityListStarredOptions ¶

type ActivityListStarredOptions struct {// How to sort the repository list. Possible values are: created, updated,// pushed, full_name. Default is "full_name".Sortstring `url:"sort,omitempty"`// Direction in which to sort repositories. Possible values are: asc, desc.// Default is "asc" when sort is "full_name", otherwise default is "desc".Directionstring `url:"direction,omitempty"`ListOptions}

ActivityListStarredOptions specifies the optional parameters to theActivityService.ListStarred method.

typeActivityService ¶

type ActivityService service

ActivityService handles communication with the activity relatedmethods of the GitHub API.

GitHub API docs:https://developer.github.com/v3/activity/

func (*ActivityService)DeleteRepositorySubscription ¶

func (s *ActivityService) DeleteRepositorySubscription(ctxcontext.Context, owner, repostring) (*Response,error)

DeleteRepositorySubscription deletes the subscription for the specifiedrepository for the authenticated user.

This is used to stop watching a repository. To control whether or not toreceive notifications from a repository, use SetRepositorySubscription.

GitHub API docs:https://developer.github.com/v3/activity/watching/#delete-a-repository-subscription

func (*ActivityService)DeleteThreadSubscription ¶

func (s *ActivityService) DeleteThreadSubscription(ctxcontext.Context, idstring) (*Response,error)

DeleteThreadSubscription deletes the subscription for the specified threadfor the authenticated user.

GitHub API docs:https://developer.github.com/v3/activity/notifications/#delete-a-thread-subscription

func (*ActivityService)GetRepositorySubscription ¶

func (s *ActivityService) GetRepositorySubscription(ctxcontext.Context, owner, repostring) (*Subscription, *Response,error)

GetRepositorySubscription returns the subscription for the specifiedrepository for the authenticated user. If the authenticated user is notwatching the repository, a nil Subscription is returned.

GitHub API docs:https://developer.github.com/v3/activity/watching/#get-a-repository-subscription

func (*ActivityService)GetThread ¶

func (s *ActivityService) GetThread(ctxcontext.Context, idstring) (*Notification, *Response,error)

GetThread gets the specified notification thread.

GitHub API docs:https://developer.github.com/v3/activity/notifications/#view-a-single-thread

func (*ActivityService)GetThreadSubscription ¶

func (s *ActivityService) GetThreadSubscription(ctxcontext.Context, idstring) (*Subscription, *Response,error)

GetThreadSubscription checks to see if the authenticated user is subscribedto a thread.

GitHub API docs:https://developer.github.com/v3/activity/notifications/#get-a-thread-subscription

func (*ActivityService)IsStarred ¶

func (s *ActivityService) IsStarred(ctxcontext.Context, owner, repostring) (bool, *Response,error)

IsStarred checks if a repository is starred by authenticated user.

GitHub API docs:https://developer.github.com/v3/activity/starring/#check-if-you-are-starring-a-repository

func (*ActivityService)ListEvents ¶

func (s *ActivityService) ListEvents(ctxcontext.Context, opts *ListOptions) ([]*Event, *Response,error)

ListEvents drinks from the firehose of all public events across GitHub.

GitHub API docs:https://developer.github.com/v3/activity/events/#list-public-events

func (*ActivityService)ListEventsForOrganization ¶

func (s *ActivityService) ListEventsForOrganization(ctxcontext.Context, orgstring, opts *ListOptions) ([]*Event, *Response,error)

ListEventsForOrganization lists public events for an organization.

GitHub API docs:https://developer.github.com/v3/activity/events/#list-public-events-for-an-organization

func (*ActivityService)ListEventsForRepoNetwork ¶

func (s *ActivityService) ListEventsForRepoNetwork(ctxcontext.Context, owner, repostring, opts *ListOptions) ([]*Event, *Response,error)

ListEventsForRepoNetwork lists public events for a network of repositories.

GitHub API docs:https://developer.github.com/v3/activity/events/#list-public-events-for-a-network-of-repositories

func (*ActivityService)ListEventsPerformedByUser ¶

func (s *ActivityService) ListEventsPerformedByUser(ctxcontext.Context, userstring, publicOnlybool, opts *ListOptions) ([]*Event, *Response,error)

ListEventsPerformedByUser lists the events performed by a user. If publicOnly istrue, only public events will be returned.

GitHub API docs:https://developer.github.com/v3/activity/events/#list-events-performed-by-a-user

func (*ActivityService)ListEventsReceivedByUser ¶

func (s *ActivityService) ListEventsReceivedByUser(ctxcontext.Context, userstring, publicOnlybool, opts *ListOptions) ([]*Event, *Response,error)

ListEventsReceivedByUser lists the events received by a user. If publicOnly istrue, only public events will be returned.

GitHub API docs:https://developer.github.com/v3/activity/events/#list-events-that-a-user-has-received

func (*ActivityService)ListFeeds ¶

func (s *ActivityService) ListFeeds(ctxcontext.Context) (*Feeds, *Response,error)

ListFeeds lists all the feeds available to the authenticated user.

GitHub provides several timeline resources in Atom format:

Timeline: The GitHub global public timelineUser: The public timeline for any user, using URI templateCurrent user public: The public timeline for the authenticated userCurrent user: The private timeline for the authenticated userCurrent user actor: The private timeline for activity created by the    authenticated userCurrent user organizations: The private timeline for the organizations    the authenticated user is a member of.

Note: Private feeds are only returned when authenticating via Basic Authsince current feed URIs use the older, non revocable auth tokens.

func (*ActivityService)ListIssueEventsForRepository ¶

func (s *ActivityService) ListIssueEventsForRepository(ctxcontext.Context, owner, repostring, opts *ListOptions) ([]*IssueEvent, *Response,error)

ListIssueEventsForRepository lists issue events for a repository.

GitHub API docs:https://developer.github.com/v3/activity/events/#list-issue-events-for-a-repository

func (*ActivityService)ListNotifications ¶

func (s *ActivityService) ListNotifications(ctxcontext.Context, opts *NotificationListOptions) ([]*Notification, *Response,error)

ListNotifications lists all notifications for the authenticated user.

GitHub API docs:https://developer.github.com/v3/activity/notifications/#list-your-notifications

func (*ActivityService)ListRepositoryEvents ¶

func (s *ActivityService) ListRepositoryEvents(ctxcontext.Context, owner, repostring, opts *ListOptions) ([]*Event, *Response,error)

ListRepositoryEvents lists events for a repository.

GitHub API docs:https://developer.github.com/v3/activity/events/#list-repository-events

func (*ActivityService)ListRepositoryNotifications ¶

func (s *ActivityService) ListRepositoryNotifications(ctxcontext.Context, owner, repostring, opts *NotificationListOptions) ([]*Notification, *Response,error)

ListRepositoryNotifications lists all notifications in a given repositoryfor the authenticated user.

GitHub API docs:https://developer.github.com/v3/activity/notifications/#list-your-notifications-in-a-repository

func (*ActivityService)ListStargazers ¶

func (s *ActivityService) ListStargazers(ctxcontext.Context, owner, repostring, opts *ListOptions) ([]*Stargazer, *Response,error)

ListStargazers lists people who have starred the specified repo.

GitHub API docs:https://developer.github.com/v3/activity/starring/#list-stargazers

func (*ActivityService)ListStarred ¶

func (s *ActivityService) ListStarred(ctxcontext.Context, userstring, opts *ActivityListStarredOptions) ([]*StarredRepository, *Response,error)

ListStarred lists all the repos starred by a user. Passing the empty stringwill list the starred repositories for the authenticated user.

GitHub API docs:https://developer.github.com/v3/activity/starring/#list-repositories-being-starred

func (*ActivityService)ListUserEventsForOrganization ¶

func (s *ActivityService) ListUserEventsForOrganization(ctxcontext.Context, org, userstring, opts *ListOptions) ([]*Event, *Response,error)

ListUserEventsForOrganization provides the user’s organization dashboard. Youmust be authenticated as the user to view this.

GitHub API docs:https://developer.github.com/v3/activity/events/#list-events-for-an-organization

func (*ActivityService)ListWatched ¶

func (s *ActivityService) ListWatched(ctxcontext.Context, userstring, opts *ListOptions) ([]*Repository, *Response,error)

ListWatched lists the repositories the specified user is watching. Passingthe empty string will fetch watched repos for the authenticated user.

GitHub API docs:https://developer.github.com/v3/activity/watching/#list-repositories-being-watched

func (*ActivityService)ListWatchers ¶

func (s *ActivityService) ListWatchers(ctxcontext.Context, owner, repostring, opts *ListOptions) ([]*User, *Response,error)

ListWatchers lists watchers of a particular repo.

GitHub API docs:https://developer.github.com/v3/activity/watching/#list-watchers

func (*ActivityService)MarkNotificationsRead ¶

func (s *ActivityService) MarkNotificationsRead(ctxcontext.Context, lastReadtime.Time) (*Response,error)

MarkNotificationsRead marks all notifications up to lastRead as read.

GitHub API docs:https://developer.github.com/v3/activity/notifications/#mark-as-read

func (*ActivityService)MarkRepositoryNotificationsRead ¶

func (s *ActivityService) MarkRepositoryNotificationsRead(ctxcontext.Context, owner, repostring, lastReadtime.Time) (*Response,error)

MarkRepositoryNotificationsRead marks all notifications up to lastRead inthe specified repository as read.

GitHub API docs:https://developer.github.com/v3/activity/notifications/#mark-notifications-as-read-in-a-repository

func (*ActivityService)MarkThreadRead ¶

func (s *ActivityService) MarkThreadRead(ctxcontext.Context, idstring) (*Response,error)

MarkThreadRead marks the specified thread as read.

GitHub API docs:https://developer.github.com/v3/activity/notifications/#mark-a-thread-as-read

func (*ActivityService)SetRepositorySubscription ¶

func (s *ActivityService) SetRepositorySubscription(ctxcontext.Context, owner, repostring, subscription *Subscription) (*Subscription, *Response,error)

SetRepositorySubscription sets the subscription for the specified repositoryfor the authenticated user.

To watch a repository, set subscription.Subscribed to true.To ignore notifications made within a repository, set subscription.Ignored to true.To stop watching a repository, use DeleteRepositorySubscription.

GitHub API docs:https://developer.github.com/v3/activity/watching/#set-a-repository-subscription

func (*ActivityService)SetThreadSubscription ¶

func (s *ActivityService) SetThreadSubscription(ctxcontext.Context, idstring, subscription *Subscription) (*Subscription, *Response,error)

SetThreadSubscription sets the subscription for the specified thread for theauthenticated user.

GitHub API docs:https://developer.github.com/v3/activity/notifications/#set-a-thread-subscription

func (*ActivityService)Star ¶

func (s *ActivityService) Star(ctxcontext.Context, owner, repostring) (*Response,error)

Star a repository as the authenticated user.

GitHub API docs:https://developer.github.com/v3/activity/starring/#star-a-repository

func (*ActivityService)Unstar ¶

func (s *ActivityService) Unstar(ctxcontext.Context, owner, repostring) (*Response,error)

Unstar a repository as the authenticated user.

GitHub API docs:https://developer.github.com/v3/activity/starring/#unstar-a-repository

typeAdminEnforcement ¶

type AdminEnforcement struct {URL     *string `json:"url,omitempty"`Enabledbool    `json:"enabled"`}

AdminEnforcement represents the configuration to enforce required status checks for repository administrators.

func (*AdminEnforcement)GetURL ¶

func (a *AdminEnforcement) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

typeAdminService ¶

type AdminService service

AdminService handles communication with the admin related methods of theGitHub API. These API routes are normally only accessible for GitHubEnterprise installations.

GitHub API docs:https://developer.github.com/v3/enterprise/

func (*AdminService)CreateOrg ¶

func (s *AdminService) CreateOrg(ctxcontext.Context, org *Organization, adminstring) (*Organization, *Response,error)

CreateOrg creates a new organization in GitHub Enterprise.

Note that only a subset of the org fields are used and org mustnot be nil.

GitHub Enterprise API docs:https://developer.github.com/enterprise/v3/enterprise-admin/orgs/#create-an-organization

func (*AdminService)CreateUser ¶

func (s *AdminService) CreateUser(ctxcontext.Context, login, emailstring) (*User, *Response,error)

CreateUser creates a new user in GitHub Enterprise.

GitHub Enterprise API docs:https://developer.github.com/enterprise/v3/enterprise-admin/users/#create-a-new-user

func (*AdminService)CreateUserImpersonation ¶

func (s *AdminService) CreateUserImpersonation(ctxcontext.Context, usernamestring, opts *ImpersonateUserOptions) (*UserAuthorization, *Response,error)

CreateUserImpersonation creates an impersonation OAuth token.

GitHub Enterprise API docs:https://developer.github.com/enterprise/v3/enterprise-admin/users/#create-an-impersonation-oauth-token

func (*AdminService)DeleteUser ¶

func (s *AdminService) DeleteUser(ctxcontext.Context, usernamestring) (*Response,error)

DeleteUser deletes a user in GitHub Enterprise.

GitHub Enterprise API docs:https://developer.github.com/enterprise/v3/enterprise-admin/users/#delete-a-user

func (*AdminService)DeleteUserImpersonation ¶

func (s *AdminService) DeleteUserImpersonation(ctxcontext.Context, usernamestring) (*Response,error)

DeleteUserImpersonation deletes an impersonation OAuth token.

GitHub Enterprise API docs:https://developer.github.com/enterprise/v3/enterprise-admin/users/#delete-an-impersonation-oauth-token

func (*AdminService)GetAdminStats ¶

func (s *AdminService) GetAdminStats(ctxcontext.Context) (*AdminStats, *Response,error)

GetAdminStats returns a variety of metrics about a GitHub Enterpriseinstallation.

Please note that this is only available to site administrators,otherwise it will error with a 404 not found (instead of 401 or 403).

GitHub API docs:https://developer.github.com/v3/enterprise-admin/admin_stats/

func (*AdminService)UpdateTeamLDAPMapping ¶

func (s *AdminService) UpdateTeamLDAPMapping(ctxcontext.Context, teamint64, mapping *TeamLDAPMapping) (*TeamLDAPMapping, *Response,error)

UpdateTeamLDAPMapping updates the mapping between a GitHub team and an LDAP group.

GitHub API docs:https://developer.github.com/v3/enterprise/ldap/#update-ldap-mapping-for-a-team

func (*AdminService)UpdateUserLDAPMapping ¶

func (s *AdminService) UpdateUserLDAPMapping(ctxcontext.Context, userstring, mapping *UserLDAPMapping) (*UserLDAPMapping, *Response,error)

UpdateUserLDAPMapping updates the mapping between a GitHub user and an LDAP user.

GitHub API docs:https://developer.github.com/v3/enterprise/ldap/#update-ldap-mapping-for-a-user

typeAdminStats ¶

type AdminStats struct {Issues     *IssueStats     `json:"issues,omitempty"`Hooks      *HookStats      `json:"hooks,omitempty"`Milestones *MilestoneStats `json:"milestones,omitempty"`Orgs       *OrgStats       `json:"orgs,omitempty"`Comments   *CommentStats   `json:"comments,omitempty"`Pages      *PageStats      `json:"pages,omitempty"`Users      *UserStats      `json:"users,omitempty"`Gists      *GistStats      `json:"gists,omitempty"`Pulls      *PullStats      `json:"pulls,omitempty"`Repos      *RepoStats      `json:"repos,omitempty"`}

AdminStats represents a variety of stats of a GitHub Enterpriseinstallation.

func (*AdminStats)GetComments ¶

func (a *AdminStats) GetComments() *CommentStats

GetComments returns the Comments field.

func (*AdminStats)GetGists ¶

func (a *AdminStats) GetGists() *GistStats

GetGists returns the Gists field.

func (*AdminStats)GetHooks ¶

func (a *AdminStats) GetHooks() *HookStats

GetHooks returns the Hooks field.

func (*AdminStats)GetIssues ¶

func (a *AdminStats) GetIssues() *IssueStats

GetIssues returns the Issues field.

func (*AdminStats)GetMilestones ¶

func (a *AdminStats) GetMilestones() *MilestoneStats

GetMilestones returns the Milestones field.

func (*AdminStats)GetOrgs ¶

func (a *AdminStats) GetOrgs() *OrgStats

GetOrgs returns the Orgs field.

func (*AdminStats)GetPages ¶

func (a *AdminStats) GetPages() *PageStats

GetPages returns the Pages field.

func (*AdminStats)GetPulls ¶

func (a *AdminStats) GetPulls() *PullStats

GetPulls returns the Pulls field.

func (*AdminStats)GetRepos ¶

func (a *AdminStats) GetRepos() *RepoStats

GetRepos returns the Repos field.

func (*AdminStats)GetUsers ¶

func (a *AdminStats) GetUsers() *UserStats

GetUsers returns the Users field.

func (AdminStats)String ¶

func (sAdminStats) String()string

typeAllowDeletions ¶added inv29.0.3

type AllowDeletions struct {Enabledbool `json:"enabled"`}

AllowDeletions represents the configuration to accept deletion of protected branches.

typeAllowForcePushes ¶added inv29.0.3

type AllowForcePushes struct {Enabledbool `json:"enabled"`}

AllowForcePushes represents the configuration to accept forced pushes on protected branches.

typeApp ¶

type App struct {ID          *int64                   `json:"id,omitempty"`Slug        *string                  `json:"slug,omitempty"`NodeID      *string                  `json:"node_id,omitempty"`Owner       *User                    `json:"owner,omitempty"`Name        *string                  `json:"name,omitempty"`Description *string                  `json:"description,omitempty"`ExternalURL *string                  `json:"external_url,omitempty"`HTMLURL     *string                  `json:"html_url,omitempty"`CreatedAt   *Timestamp               `json:"created_at,omitempty"`UpdatedAt   *Timestamp               `json:"updated_at,omitempty"`Permissions *InstallationPermissions `json:"permissions,omitempty"`Events      []string                 `json:"events,omitempty"`}

App represents a GitHub App.

func (*App)GetCreatedAt ¶

func (a *App) GetCreatedAt()Timestamp

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*App)GetDescription ¶

func (a *App) GetDescription()string

GetDescription returns the Description field if it's non-nil, zero value otherwise.

func (*App)GetExternalURL ¶

func (a *App) GetExternalURL()string

GetExternalURL returns the ExternalURL field if it's non-nil, zero value otherwise.

func (*App)GetHTMLURL ¶

func (a *App) GetHTMLURL()string

GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.

func (*App)GetID ¶

func (a *App) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*App)GetName ¶

func (a *App) GetName()string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (*App)GetNodeID ¶

func (a *App) GetNodeID()string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*App)GetOwner ¶

func (a *App) GetOwner() *User

GetOwner returns the Owner field.

func (*App)GetPermissions ¶

func (a *App) GetPermissions() *InstallationPermissions

GetPermissions returns the Permissions field.

func (*App)GetSlug ¶

func (a *App) GetSlug()string

GetSlug returns the Slug field if it's non-nil, zero value otherwise.

func (*App)GetUpdatedAt ¶

func (a *App) GetUpdatedAt()Timestamp

GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.

typeAppConfig ¶

type AppConfig struct {ID            *int64     `json:"id,omitempty"`NodeID        *string    `json:"node_id,omitempty"`Owner         *User      `json:"owner,omitempty"`Name          *string    `json:"name,omitempty"`Description   *string    `json:"description,omitempty"`ExternalURL   *string    `json:"external_url,omitempty"`HTMLURL       *string    `json:"html_url,omitempty"`CreatedAt     *Timestamp `json:"created_at,omitempty"`UpdatedAt     *Timestamp `json:"updated_at,omitempty"`ClientID      *string    `json:"client_id,omitempty"`ClientSecret  *string    `json:"client_secret,omitempty"`WebhookSecret *string    `json:"webhook_secret,omitempty"`PEM           *string    `json:"pem,omitempty"`}

AppConfig describes the configuration of a GitHub App.

func (*AppConfig)GetClientID ¶

func (a *AppConfig) GetClientID()string

GetClientID returns the ClientID field if it's non-nil, zero value otherwise.

func (*AppConfig)GetClientSecret ¶

func (a *AppConfig) GetClientSecret()string

GetClientSecret returns the ClientSecret field if it's non-nil, zero value otherwise.

func (*AppConfig)GetCreatedAt ¶

func (a *AppConfig) GetCreatedAt()Timestamp

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*AppConfig)GetDescription ¶

func (a *AppConfig) GetDescription()string

GetDescription returns the Description field if it's non-nil, zero value otherwise.

func (*AppConfig)GetExternalURL ¶

func (a *AppConfig) GetExternalURL()string

GetExternalURL returns the ExternalURL field if it's non-nil, zero value otherwise.

func (*AppConfig)GetHTMLURL ¶

func (a *AppConfig) GetHTMLURL()string

GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.

func (*AppConfig)GetID ¶

func (a *AppConfig) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*AppConfig)GetName ¶

func (a *AppConfig) GetName()string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (*AppConfig)GetNodeID ¶

func (a *AppConfig) GetNodeID()string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*AppConfig)GetOwner ¶

func (a *AppConfig) GetOwner() *User

GetOwner returns the Owner field.

func (*AppConfig)GetPEM ¶

func (a *AppConfig) GetPEM()string

GetPEM returns the PEM field if it's non-nil, zero value otherwise.

func (*AppConfig)GetUpdatedAt ¶

func (a *AppConfig) GetUpdatedAt()Timestamp

GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.

func (*AppConfig)GetWebhookSecret ¶

func (a *AppConfig) GetWebhookSecret()string

GetWebhookSecret returns the WebhookSecret field if it's non-nil, zero value otherwise.

typeAppsService ¶

type AppsService service

AppsService provides access to the installation related functionsin the GitHub API.

GitHub API docs:https://developer.github.com/v3/apps/

func (*AppsService)AddRepository ¶

func (s *AppsService) AddRepository(ctxcontext.Context, instID, repoIDint64) (*Repository, *Response,error)

AddRepository adds a single repository to an installation.

GitHub API docs:https://developer.github.com/v3/apps/installations/#add-repository-to-installation

func (*AppsService)CompleteAppManifest ¶

func (s *AppsService) CompleteAppManifest(ctxcontext.Context, codestring) (*AppConfig, *Response,error)

CompleteAppManifest completes the App manifest handshake flow for the givencode.

GitHub API docs:https://developer.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration

func (*AppsService)CreateAttachment ¶

func (s *AppsService) CreateAttachment(ctxcontext.Context, contentReferenceIDint64, title, bodystring) (*Attachment, *Response,error)

CreateAttachment creates a new attachment on user comment containing a url.

GitHub API docs:https://developer.github.com/v3/apps/#create-a-content-attachment

func (*AppsService)CreateInstallationToken ¶

func (s *AppsService) CreateInstallationToken(ctxcontext.Context, idint64, opts *InstallationTokenOptions) (*InstallationToken, *Response,error)

CreateInstallationToken creates a new installation token.

GitHub API docs:https://developer.github.com/v3/apps/#create-a-new-installation-token

func (*AppsService)FindOrganizationInstallation ¶

func (s *AppsService) FindOrganizationInstallation(ctxcontext.Context, orgstring) (*Installation, *Response,error)

FindOrganizationInstallation finds the organization's installation information.

GitHub API docs:https://developer.github.com/v3/apps/#get-an-organization-installation

func (*AppsService)FindRepositoryInstallation ¶

func (s *AppsService) FindRepositoryInstallation(ctxcontext.Context, owner, repostring) (*Installation, *Response,error)

FindRepositoryInstallation finds the repository's installation information.

GitHub API docs:https://developer.github.com/v3/apps/#get-a-repository-installation

func (*AppsService)FindRepositoryInstallationByID ¶

func (s *AppsService) FindRepositoryInstallationByID(ctxcontext.Context, idint64) (*Installation, *Response,error)

FindRepositoryInstallationByID finds the repository's installation information.

Note: FindRepositoryInstallationByID uses the undocumented GitHub API endpoint /repositories/:id/installation.

func (*AppsService)FindUserInstallation ¶

func (s *AppsService) FindUserInstallation(ctxcontext.Context, userstring) (*Installation, *Response,error)

FindUserInstallation finds the user's installation information.

GitHub API docs:https://developer.github.com/v3/apps/#get-a-user-installation

func (*AppsService)Get ¶

func (s *AppsService) Get(ctxcontext.Context, appSlugstring) (*App, *Response,error)

Get a single GitHub App. Passing the empty string will getthe authenticated GitHub App.

Note: appSlug 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).

GitHub API docs:https://developer.github.com/v3/apps/#get-a-single-github-app

func (*AppsService)GetInstallation ¶

func (s *AppsService) GetInstallation(ctxcontext.Context, idint64) (*Installation, *Response,error)

GetInstallation returns the specified installation.

GitHub API docs:https://developer.github.com/v3/apps/#get-a-single-installation

func (*AppsService)ListInstallations ¶

func (s *AppsService) ListInstallations(ctxcontext.Context, opts *ListOptions) ([]*Installation, *Response,error)

ListInstallations lists the installations that the current GitHub App has.

GitHub API docs:https://developer.github.com/v3/apps/#list-installations

func (*AppsService)ListRepos ¶

func (s *AppsService) ListRepos(ctxcontext.Context, opts *ListOptions) ([]*Repository, *Response,error)

ListRepos lists the repositories that are accessible to the authenticated installation.

GitHub API docs:https://developer.github.com/v3/apps/installations/#list-repositories

func (*AppsService)ListUserInstallations ¶

func (s *AppsService) ListUserInstallations(ctxcontext.Context, opts *ListOptions) ([]*Installation, *Response,error)

ListUserInstallations lists installations that are accessible to the authenticated user.

GitHub API docs:https://developer.github.com/v3/apps/#list-installations-for-user

func (*AppsService)ListUserRepos ¶

func (s *AppsService) ListUserRepos(ctxcontext.Context, idint64, opts *ListOptions) ([]*Repository, *Response,error)

ListUserRepos lists repositories that are accessibleto the authenticated user for an installation.

GitHub API docs:https://developer.github.com/v3/apps/installations/#list-repositories-accessible-to-the-user-for-an-installation

func (*AppsService)RemoveRepository ¶

func (s *AppsService) RemoveRepository(ctxcontext.Context, instID, repoIDint64) (*Response,error)

RemoveRepository removes a single repository from an installation.

GitHub docs:https://developer.github.com/v3/apps/installations/#remove-repository-from-installation

func (*AppsService)RevokeInstallationToken ¶added inv29.0.3

func (s *AppsService) RevokeInstallationToken(ctxcontext.Context) (*Response,error)

RevokeInstallationToken revokes an installation token.

GitHub docs:https://developer.github.com/v3/apps/installations/#revoke-an-installation-token

typeAttachment ¶

type Attachment struct {ID    *int64  `json:"id,omitempty"`Title *string `json:"title,omitempty"`Body  *string `json:"body,omitempty"`}

Attachment represents a GitHub Apps attachment.

func (*Attachment)GetBody ¶

func (a *Attachment) GetBody()string

GetBody returns the Body field if it's non-nil, zero value otherwise.

func (*Attachment)GetID ¶

func (a *Attachment) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*Attachment)GetTitle ¶

func (a *Attachment) GetTitle()string

GetTitle returns the Title field if it's non-nil, zero value otherwise.

typeAuthorization ¶

type Authorization struct {ID             *int64            `json:"id,omitempty"`URL            *string           `json:"url,omitempty"`Scopes         []Scope           `json:"scopes,omitempty"`Token          *string           `json:"token,omitempty"`TokenLastEight *string           `json:"token_last_eight,omitempty"`HashedToken    *string           `json:"hashed_token,omitempty"`App            *AuthorizationApp `json:"app,omitempty"`Note           *string           `json:"note,omitempty"`NoteURL        *string           `json:"note_url,omitempty"`UpdatedAt      *Timestamp        `json:"updated_at,omitempty"`CreatedAt      *Timestamp        `json:"created_at,omitempty"`Fingerprint    *string           `json:"fingerprint,omitempty"`// User is only populated by the Check and Reset methods.User *User `json:"user,omitempty"`}

Authorization represents an individual GitHub authorization.

func (*Authorization)GetApp ¶

func (a *Authorization) GetApp() *AuthorizationApp

GetApp returns the App field.

func (*Authorization)GetCreatedAt ¶

func (a *Authorization) GetCreatedAt()Timestamp

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*Authorization)GetFingerprint ¶

func (a *Authorization) GetFingerprint()string

GetFingerprint returns the Fingerprint field if it's non-nil, zero value otherwise.

func (*Authorization)GetHashedToken ¶

func (a *Authorization) GetHashedToken()string

GetHashedToken returns the HashedToken field if it's non-nil, zero value otherwise.

func (*Authorization)GetID ¶

func (a *Authorization) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*Authorization)GetNote ¶

func (a *Authorization) GetNote()string

GetNote returns the Note field if it's non-nil, zero value otherwise.

func (*Authorization)GetNoteURL ¶

func (a *Authorization) GetNoteURL()string

GetNoteURL returns the NoteURL field if it's non-nil, zero value otherwise.

func (*Authorization)GetToken ¶

func (a *Authorization) GetToken()string

GetToken returns the Token field if it's non-nil, zero value otherwise.

func (*Authorization)GetTokenLastEight ¶

func (a *Authorization) GetTokenLastEight()string

GetTokenLastEight returns the TokenLastEight field if it's non-nil, zero value otherwise.

func (*Authorization)GetURL ¶

func (a *Authorization) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (*Authorization)GetUpdatedAt ¶

func (a *Authorization) GetUpdatedAt()Timestamp

GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.

func (*Authorization)GetUser ¶

func (a *Authorization) GetUser() *User

GetUser returns the User field.

func (Authorization)String ¶

func (aAuthorization) String()string

typeAuthorizationApp ¶

type AuthorizationApp struct {URL      *string `json:"url,omitempty"`Name     *string `json:"name,omitempty"`ClientID *string `json:"client_id,omitempty"`}

AuthorizationApp represents an individual GitHub app (in the context of authorization).

func (*AuthorizationApp)GetClientID ¶

func (a *AuthorizationApp) GetClientID()string

GetClientID returns the ClientID field if it's non-nil, zero value otherwise.

func (*AuthorizationApp)GetName ¶

func (a *AuthorizationApp) GetName()string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (*AuthorizationApp)GetURL ¶

func (a *AuthorizationApp) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (AuthorizationApp)String ¶

func (aAuthorizationApp) String()string

typeAuthorizationRequest ¶

type AuthorizationRequest struct {Scopes       []Scope `json:"scopes,omitempty"`Note         *string `json:"note,omitempty"`NoteURL      *string `json:"note_url,omitempty"`ClientID     *string `json:"client_id,omitempty"`ClientSecret *string `json:"client_secret,omitempty"`Fingerprint  *string `json:"fingerprint,omitempty"`}

AuthorizationRequest represents a request to create an authorization.

func (*AuthorizationRequest)GetClientID ¶

func (a *AuthorizationRequest) GetClientID()string

GetClientID returns the ClientID field if it's non-nil, zero value otherwise.

func (*AuthorizationRequest)GetClientSecret ¶

func (a *AuthorizationRequest) GetClientSecret()string

GetClientSecret returns the ClientSecret field if it's non-nil, zero value otherwise.

func (*AuthorizationRequest)GetFingerprint ¶

func (a *AuthorizationRequest) GetFingerprint()string

GetFingerprint returns the Fingerprint field if it's non-nil, zero value otherwise.

func (*AuthorizationRequest)GetNote ¶

func (a *AuthorizationRequest) GetNote()string

GetNote returns the Note field if it's non-nil, zero value otherwise.

func (*AuthorizationRequest)GetNoteURL ¶

func (a *AuthorizationRequest) GetNoteURL()string

GetNoteURL returns the NoteURL field if it's non-nil, zero value otherwise.

func (AuthorizationRequest)String ¶

func (aAuthorizationRequest) String()string

typeAuthorizationUpdateRequest ¶

type AuthorizationUpdateRequest struct {Scopes       []string `json:"scopes,omitempty"`AddScopes    []string `json:"add_scopes,omitempty"`RemoveScopes []string `json:"remove_scopes,omitempty"`Note         *string  `json:"note,omitempty"`NoteURL      *string  `json:"note_url,omitempty"`Fingerprint  *string  `json:"fingerprint,omitempty"`}

AuthorizationUpdateRequest represents a request to update an authorization.

Note that for any one update, you must only provide one of the "scopes"fields. That is, you may provide only one of "Scopes", or "AddScopes", or"RemoveScopes".

GitHub API docs:https://developer.github.com/v3/oauth_authorizations/#update-an-existing-authorization

func (*AuthorizationUpdateRequest)GetFingerprint ¶

func (a *AuthorizationUpdateRequest) GetFingerprint()string

GetFingerprint returns the Fingerprint field if it's non-nil, zero value otherwise.

func (*AuthorizationUpdateRequest)GetNote ¶

func (a *AuthorizationUpdateRequest) GetNote()string

GetNote returns the Note field if it's non-nil, zero value otherwise.

func (*AuthorizationUpdateRequest)GetNoteURL ¶

func (a *AuthorizationUpdateRequest) GetNoteURL()string

GetNoteURL returns the NoteURL field if it's non-nil, zero value otherwise.

func (AuthorizationUpdateRequest)String ¶

func (aAuthorizationUpdateRequest) String()string

typeAuthorizationsService ¶

type AuthorizationsService service

AuthorizationsService handles communication with the authorization relatedmethods of the GitHub API.

This service requires HTTP Basic Authentication; it cannot be accessed usingan OAuth token.

GitHub API docs:https://developer.github.com/v3/oauth_authorizations/

func (*AuthorizationsService)Check ¶

func (s *AuthorizationsService) Check(ctxcontext.Context, clientIDstring, tokenstring) (*Authorization, *Response,error)

Check if an OAuth token is valid for a specific app.

Note that this operation requires the use of BasicAuth, but where theusername is the OAuth application clientID, and the password is itsclientSecret. Invalid tokens will return a 404 Not Found.

The returned Authorization.User field will be populated.

GitHub API docs:https://developer.github.com/v3/oauth_authorizations/#check-an-authorization

func (*AuthorizationsService)Create ¶

func (s *AuthorizationsService) Create(ctxcontext.Context, auth *AuthorizationRequest) (*Authorization, *Response,error)

Create a new authorization for the specified OAuth application.

GitHub API docs:https://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization

func (*AuthorizationsService)CreateImpersonation ¶

func (s *AuthorizationsService) CreateImpersonation(ctxcontext.Context, usernamestring, authReq *AuthorizationRequest) (*Authorization, *Response,error)

CreateImpersonation creates an impersonation OAuth token.

This requires admin permissions. With the returned Authorization.Tokenyou can e.g. create or delete a user's public SSH key. NOTE: creating anew token automatically revokes an existing one.

GitHub API docs:https://developer.github.com/enterprise/v3/enterprise-admin/users/#create-an-impersonation-oauth-token

func (*AuthorizationsService)Delete ¶

func (s *AuthorizationsService) Delete(ctxcontext.Context, idint64) (*Response,error)

Delete a single authorization.

GitHub API docs:https://developer.github.com/v3/oauth_authorizations/#delete-an-authorization

func (*AuthorizationsService)DeleteGrant ¶

func (s *AuthorizationsService) DeleteGrant(ctxcontext.Context, idint64) (*Response,error)

DeleteGrant deletes an OAuth application grant. Deleting an application'sgrant will also delete all OAuth tokens associated with the application forthe user.

GitHub API docs:https://developer.github.com/v3/oauth_authorizations/#delete-a-grant

func (*AuthorizationsService)DeleteImpersonation ¶

func (s *AuthorizationsService) DeleteImpersonation(ctxcontext.Context, usernamestring) (*Response,error)

DeleteImpersonation deletes an impersonation OAuth token.

NOTE: there can be only one at a time.

GitHub API docs:https://developer.github.com/enterprise/v3/enterprise-admin/users/#delete-an-impersonation-oauth-token

func (*AuthorizationsService)Edit ¶

func (s *AuthorizationsService) Edit(ctxcontext.Context, idint64, auth *AuthorizationUpdateRequest) (*Authorization, *Response,error)

Edit a single authorization.

GitHub API docs:https://developer.github.com/v3/oauth_authorizations/#update-an-existing-authorization

func (*AuthorizationsService)Get ¶

func (s *AuthorizationsService) Get(ctxcontext.Context, idint64) (*Authorization, *Response,error)

Get a single authorization.

GitHub API docs:https://developer.github.com/v3/oauth_authorizations/#get-a-single-authorization

func (*AuthorizationsService)GetGrant ¶

func (s *AuthorizationsService) GetGrant(ctxcontext.Context, idint64) (*Grant, *Response,error)

GetGrant gets a single OAuth application grant.

GitHub API docs:https://developer.github.com/v3/oauth_authorizations/#get-a-single-grant

func (*AuthorizationsService)GetOrCreateForApp ¶

func (s *AuthorizationsService) GetOrCreateForApp(ctxcontext.Context, clientIDstring, auth *AuthorizationRequest) (*Authorization, *Response,error)

GetOrCreateForApp creates a new authorization for the specified OAuthapplication, only if an authorization for that application doesn’t alreadyexist for the user.

If a new token is created, the HTTP status code will be "201 Created", andthe returned Authorization.Token field will be populated. If an existingtoken is returned, the status code will be "200 OK" and theAuthorization.Token field will be empty.

clientID is the OAuth Client ID with which to create the token.

GitHub API docs:https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint

func (*AuthorizationsService)List ¶

func (s *AuthorizationsService) List(ctxcontext.Context, opts *ListOptions) ([]*Authorization, *Response,error)

List the authorizations for the authenticated user.

GitHub API docs:https://developer.github.com/v3/oauth_authorizations/#list-your-authorizations

func (*AuthorizationsService)ListGrants ¶

func (s *AuthorizationsService) ListGrants(ctxcontext.Context, opts *ListOptions) ([]*Grant, *Response,error)

ListGrants lists the set of OAuth applications that have been grantedaccess to a user's account. This will return one entry for each applicationthat has been granted access to the account, regardless of the number oftokens an application has generated for the user.

GitHub API docs:https://developer.github.com/v3/oauth_authorizations/#list-your-grants

func (*AuthorizationsService)Reset ¶

func (s *AuthorizationsService) Reset(ctxcontext.Context, clientIDstring, tokenstring) (*Authorization, *Response,error)

Reset is used to reset a valid OAuth token without end user involvement.Applications must save the "token" property in the response, because changestake effect immediately.

Note that this operation requires the use of BasicAuth, but where theusername is the OAuth application clientID, and the password is itsclientSecret. Invalid tokens will return a 404 Not Found.

The returned Authorization.User field will be populated.

GitHub API docs:https://developer.github.com/v3/oauth_authorizations/#reset-an-authorization

func (*AuthorizationsService)Revoke ¶

func (s *AuthorizationsService) Revoke(ctxcontext.Context, clientIDstring, tokenstring) (*Response,error)

Revoke an authorization for an application.

Note that this operation requires the use of BasicAuth, but where theusername is the OAuth application clientID, and the password is itsclientSecret. Invalid tokens will return a 404 Not Found.

GitHub API docs:https://developer.github.com/v3/oauth_authorizations/#revoke-an-authorization-for-an-application

typeAutoTriggerCheck ¶

type AutoTriggerCheck struct {AppID   *int64 `json:"app_id,omitempty"`// The id of the GitHub App. (Required.)Setting *bool  `json:"setting,omitempty"`// Set to "true" to enable automatic creation of CheckSuite events upon pushes to the repository, or "false" to disable them. Default: "true" (Required.)}

AutoTriggerCheck enables or disables automatic creation of CheckSuite events upon pushes to the repository.

func (*AutoTriggerCheck)GetAppID ¶

func (a *AutoTriggerCheck) GetAppID()int64

GetAppID returns the AppID field if it's non-nil, zero value otherwise.

func (*AutoTriggerCheck)GetSetting ¶

func (a *AutoTriggerCheck) GetSetting()bool

GetSetting returns the Setting field if it's non-nil, zero value otherwise.

typeBasicAuthTransport ¶

type BasicAuthTransport struct {Usernamestring// GitHub usernamePasswordstring// GitHub passwordOTPstring// one-time password for users with two-factor auth enabled// Transport is the underlying HTTP transport to use when making requests.// It will default to http.DefaultTransport if nil.Transporthttp.RoundTripper}

BasicAuthTransport is an http.RoundTripper that authenticates all requestsusing HTTP Basic Authentication with the provided username and password. Itadditionally supports users who have two-factor authentication enabled ontheir GitHub account.

func (*BasicAuthTransport)Client ¶

func (t *BasicAuthTransport) Client() *http.Client

Client returns an *http.Client that makes requests that are authenticatedusing HTTP Basic Authentication.

func (*BasicAuthTransport)RoundTrip ¶

func (t *BasicAuthTransport) RoundTrip(req *http.Request) (*http.Response,error)

RoundTrip implements the RoundTripper interface.

typeBlob ¶

type Blob struct {Content  *string `json:"content,omitempty"`Encoding *string `json:"encoding,omitempty"`SHA      *string `json:"sha,omitempty"`Size     *int    `json:"size,omitempty"`URL      *string `json:"url,omitempty"`NodeID   *string `json:"node_id,omitempty"`}

Blob represents a blob object.

func (*Blob)GetContent ¶

func (b *Blob) GetContent()string

GetContent returns the Content field if it's non-nil, zero value otherwise.

func (*Blob)GetEncoding ¶

func (b *Blob) GetEncoding()string

GetEncoding returns the Encoding field if it's non-nil, zero value otherwise.

func (*Blob)GetNodeID ¶

func (b *Blob) GetNodeID()string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*Blob)GetSHA ¶

func (b *Blob) GetSHA()string

GetSHA returns the SHA field if it's non-nil, zero value otherwise.

func (*Blob)GetSize ¶

func (b *Blob) GetSize()int

GetSize returns the Size field if it's non-nil, zero value otherwise.

func (*Blob)GetURL ¶

func (b *Blob) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

typeBranch ¶

type Branch struct {Name      *string           `json:"name,omitempty"`Commit    *RepositoryCommit `json:"commit,omitempty"`Protected *bool             `json:"protected,omitempty"`}

Branch represents a repository branch

func (*Branch)GetCommit ¶

func (b *Branch) GetCommit() *RepositoryCommit

GetCommit returns the Commit field.

func (*Branch)GetName ¶

func (b *Branch) GetName()string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (*Branch)GetProtected ¶

func (b *Branch) GetProtected()bool

GetProtected returns the Protected field if it's non-nil, zero value otherwise.

typeBranchCommit ¶

type BranchCommit struct {Name      *string `json:"name,omitempty"`Commit    *Commit `json:"commit,omitempty"`Protected *bool   `json:"protected,omitempty"`}

BranchCommit is the result of listing branches with commit SHA.

func (*BranchCommit)GetCommit ¶

func (b *BranchCommit) GetCommit() *Commit

GetCommit returns the Commit field.

func (*BranchCommit)GetName ¶

func (b *BranchCommit) GetName()string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (*BranchCommit)GetProtected ¶

func (b *BranchCommit) GetProtected()bool

GetProtected returns the Protected field if it's non-nil, zero value otherwise.

typeBranchListOptions ¶

type BranchListOptions struct {// Setting to true returns only protected branches.// When set to false, only unprotected branches are returned.// Omitting this parameter returns all branches.// Default: nilProtected *bool `url:"protected,omitempty"`ListOptions}

BranchListOptions specifies the optional parameters to theRepositoriesService.ListBranches method.

func (*BranchListOptions)GetProtected ¶

func (b *BranchListOptions) GetProtected()bool

GetProtected returns the Protected field if it's non-nil, zero value otherwise.

typeBranchRestrictions ¶

type BranchRestrictions struct {// The list of user logins with push access.Users []*User `json:"users"`// The list of team slugs with push access.Teams []*Team `json:"teams"`// The list of app slugs with push access.Apps []*App `json:"apps"`}

BranchRestrictions represents the restriction that only certain users orteams may push to a branch.

typeBranchRestrictionsRequest ¶

type BranchRestrictionsRequest struct {// The list of user logins with push access. (Required; use []string{} instead of nil for empty list.)Users []string `json:"users"`// The list of team slugs with push access. (Required; use []string{} instead of nil for empty list.)Teams []string `json:"teams"`// The list of app slugs with push access.Apps []string `json:"apps,omitempty"`}

BranchRestrictionsRequest represents the request to create/edit therestriction that only certain users or teams may push to a branch. It isseparate from BranchRestrictions above because the request structure isdifferent from the response structure.

typeCheckRun ¶

type CheckRun struct {ID           *int64          `json:"id,omitempty"`NodeID       *string         `json:"node_id,omitempty"`HeadSHA      *string         `json:"head_sha,omitempty"`ExternalID   *string         `json:"external_id,omitempty"`URL          *string         `json:"url,omitempty"`HTMLURL      *string         `json:"html_url,omitempty"`DetailsURL   *string         `json:"details_url,omitempty"`Status       *string         `json:"status,omitempty"`Conclusion   *string         `json:"conclusion,omitempty"`StartedAt    *Timestamp      `json:"started_at,omitempty"`CompletedAt  *Timestamp      `json:"completed_at,omitempty"`Output       *CheckRunOutput `json:"output,omitempty"`Name         *string         `json:"name,omitempty"`CheckSuite   *CheckSuite     `json:"check_suite,omitempty"`App          *App            `json:"app,omitempty"`PullRequests []*PullRequest  `json:"pull_requests,omitempty"`}

CheckRun represents a GitHub check run on a repository associated with a GitHub app.

func (*CheckRun)GetApp ¶

func (c *CheckRun) GetApp() *App

GetApp returns the App field.

func (*CheckRun)GetCheckSuite ¶

func (c *CheckRun) GetCheckSuite() *CheckSuite

GetCheckSuite returns the CheckSuite field.

func (*CheckRun)GetCompletedAt ¶

func (c *CheckRun) GetCompletedAt()Timestamp

GetCompletedAt returns the CompletedAt field if it's non-nil, zero value otherwise.

func (*CheckRun)GetConclusion ¶

func (c *CheckRun) GetConclusion()string

GetConclusion returns the Conclusion field if it's non-nil, zero value otherwise.

func (*CheckRun)GetDetailsURL ¶

func (c *CheckRun) GetDetailsURL()string

GetDetailsURL returns the DetailsURL field if it's non-nil, zero value otherwise.

func (*CheckRun)GetExternalID ¶

func (c *CheckRun) GetExternalID()string

GetExternalID returns the ExternalID field if it's non-nil, zero value otherwise.

func (*CheckRun)GetHTMLURL ¶

func (c *CheckRun) GetHTMLURL()string

GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.

func (*CheckRun)GetHeadSHA ¶

func (c *CheckRun) GetHeadSHA()string

GetHeadSHA returns the HeadSHA field if it's non-nil, zero value otherwise.

func (*CheckRun)GetID ¶

func (c *CheckRun) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*CheckRun)GetName ¶

func (c *CheckRun) GetName()string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (*CheckRun)GetNodeID ¶

func (c *CheckRun) GetNodeID()string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*CheckRun)GetOutput ¶

func (c *CheckRun) GetOutput() *CheckRunOutput

GetOutput returns the Output field.

func (*CheckRun)GetStartedAt ¶

func (c *CheckRun) GetStartedAt()Timestamp

GetStartedAt returns the StartedAt field if it's non-nil, zero value otherwise.

func (*CheckRun)GetStatus ¶

func (c *CheckRun) GetStatus()string

GetStatus returns the Status field if it's non-nil, zero value otherwise.

func (*CheckRun)GetURL ¶

func (c *CheckRun) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (CheckRun)String ¶

func (cCheckRun) String()string

typeCheckRunAction ¶

type CheckRunAction struct {Labelstring `json:"label"`// The text to be displayed on a button in the web UI. The maximum size is 20 characters. (Required.)Descriptionstring `json:"description"`// A short explanation of what this action would do. The maximum size is 40 characters. (Required.)Identifierstring `json:"identifier"`// A reference for the action on the integrator's system. The maximum size is 20 characters. (Required.)}

CheckRunAction exposes further actions the integrator can perform, which a user may trigger.

typeCheckRunAnnotation ¶

type CheckRunAnnotation struct {Path            *string `json:"path,omitempty"`StartLine       *int    `json:"start_line,omitempty"`EndLine         *int    `json:"end_line,omitempty"`StartColumn     *int    `json:"start_column,omitempty"`EndColumn       *int    `json:"end_column,omitempty"`AnnotationLevel *string `json:"annotation_level,omitempty"`Message         *string `json:"message,omitempty"`Title           *string `json:"title,omitempty"`RawDetails      *string `json:"raw_details,omitempty"`}

CheckRunAnnotation represents an annotation object for a CheckRun output.

func (*CheckRunAnnotation)GetAnnotationLevel ¶

func (c *CheckRunAnnotation) GetAnnotationLevel()string

GetAnnotationLevel returns the AnnotationLevel field if it's non-nil, zero value otherwise.

func (*CheckRunAnnotation)GetEndColumn ¶

func (c *CheckRunAnnotation) GetEndColumn()int

GetEndColumn returns the EndColumn field if it's non-nil, zero value otherwise.

func (*CheckRunAnnotation)GetEndLine ¶

func (c *CheckRunAnnotation) GetEndLine()int

GetEndLine returns the EndLine field if it's non-nil, zero value otherwise.

func (*CheckRunAnnotation)GetMessage ¶

func (c *CheckRunAnnotation) GetMessage()string

GetMessage returns the Message field if it's non-nil, zero value otherwise.

func (*CheckRunAnnotation)GetPath ¶

func (c *CheckRunAnnotation) GetPath()string

GetPath returns the Path field if it's non-nil, zero value otherwise.

func (*CheckRunAnnotation)GetRawDetails ¶

func (c *CheckRunAnnotation) GetRawDetails()string

GetRawDetails returns the RawDetails field if it's non-nil, zero value otherwise.

func (*CheckRunAnnotation)GetStartColumn ¶

func (c *CheckRunAnnotation) GetStartColumn()int

GetStartColumn returns the StartColumn field if it's non-nil, zero value otherwise.

func (*CheckRunAnnotation)GetStartLine ¶

func (c *CheckRunAnnotation) GetStartLine()int

GetStartLine returns the StartLine field if it's non-nil, zero value otherwise.

func (*CheckRunAnnotation)GetTitle ¶

func (c *CheckRunAnnotation) GetTitle()string

GetTitle returns the Title field if it's non-nil, zero value otherwise.

typeCheckRunEvent ¶

type CheckRunEvent struct {CheckRun *CheckRun `json:"check_run,omitempty"`// The action performed. Possible values are: "created", "updated", "rerequested" or "requested_action".Action *string `json:"action,omitempty"`// The following fields are only populated by Webhook events.Repo         *Repository   `json:"repository,omitempty"`Org          *Organization `json:"organization,omitempty"`Sender       *User         `json:"sender,omitempty"`Installation *Installation `json:"installation,omitempty"`// The action requested by the user. Populated when the Action is "requested_action".RequestedAction *RequestedAction `json:"requested_action,omitempty"`//}

CheckRunEvent is triggered when a check run is "created", "updated", or "rerequested".The Webhook event name is "check_run".

GitHub API docs:https://developer.github.com/v3/activity/events/types/#checkrunevent

func (*CheckRunEvent)GetAction ¶

func (c *CheckRunEvent) GetAction()string

GetAction returns the Action field if it's non-nil, zero value otherwise.

func (*CheckRunEvent)GetCheckRun ¶

func (c *CheckRunEvent) GetCheckRun() *CheckRun

GetCheckRun returns the CheckRun field.

func (*CheckRunEvent)GetInstallation ¶

func (c *CheckRunEvent) GetInstallation() *Installation

GetInstallation returns the Installation field.

func (*CheckRunEvent)GetOrg ¶

func (c *CheckRunEvent) GetOrg() *Organization

GetOrg returns the Org field.

func (*CheckRunEvent)GetRepo ¶

func (c *CheckRunEvent) GetRepo() *Repository

GetRepo returns the Repo field.

func (*CheckRunEvent)GetRequestedAction ¶

func (c *CheckRunEvent) GetRequestedAction() *RequestedAction

GetRequestedAction returns the RequestedAction field.

func (*CheckRunEvent)GetSender ¶

func (c *CheckRunEvent) GetSender() *User

GetSender returns the Sender field.

typeCheckRunImage ¶

type CheckRunImage struct {Alt      *string `json:"alt,omitempty"`ImageURL *string `json:"image_url,omitempty"`Caption  *string `json:"caption,omitempty"`}

CheckRunImage represents an image object for a CheckRun output.

func (*CheckRunImage)GetAlt ¶

func (c *CheckRunImage) GetAlt()string

GetAlt returns the Alt field if it's non-nil, zero value otherwise.

func (*CheckRunImage)GetCaption ¶

func (c *CheckRunImage) GetCaption()string

GetCaption returns the Caption field if it's non-nil, zero value otherwise.

func (*CheckRunImage)GetImageURL ¶

func (c *CheckRunImage) GetImageURL()string

GetImageURL returns the ImageURL field if it's non-nil, zero value otherwise.

typeCheckRunOutput ¶

type CheckRunOutput struct {Title            *string               `json:"title,omitempty"`Summary          *string               `json:"summary,omitempty"`Text             *string               `json:"text,omitempty"`AnnotationsCount *int                  `json:"annotations_count,omitempty"`AnnotationsURL   *string               `json:"annotations_url,omitempty"`Annotations      []*CheckRunAnnotation `json:"annotations,omitempty"`Images           []*CheckRunImage      `json:"images,omitempty"`}

CheckRunOutput represents the output of a CheckRun.

func (*CheckRunOutput)GetAnnotationsCount ¶

func (c *CheckRunOutput) GetAnnotationsCount()int

GetAnnotationsCount returns the AnnotationsCount field if it's non-nil, zero value otherwise.

func (*CheckRunOutput)GetAnnotationsURL ¶

func (c *CheckRunOutput) GetAnnotationsURL()string

GetAnnotationsURL returns the AnnotationsURL field if it's non-nil, zero value otherwise.

func (*CheckRunOutput)GetSummary ¶

func (c *CheckRunOutput) GetSummary()string

GetSummary returns the Summary field if it's non-nil, zero value otherwise.

func (*CheckRunOutput)GetText ¶

func (c *CheckRunOutput) GetText()string

GetText returns the Text field if it's non-nil, zero value otherwise.

func (*CheckRunOutput)GetTitle ¶

func (c *CheckRunOutput) GetTitle()string

GetTitle returns the Title field if it's non-nil, zero value otherwise.

typeCheckSuite ¶

type CheckSuite struct {ID           *int64         `json:"id,omitempty"`NodeID       *string        `json:"node_id,omitempty"`HeadBranch   *string        `json:"head_branch,omitempty"`HeadSHA      *string        `json:"head_sha,omitempty"`URL          *string        `json:"url,omitempty"`BeforeSHA    *string        `json:"before,omitempty"`AfterSHA     *string        `json:"after,omitempty"`Status       *string        `json:"status,omitempty"`Conclusion   *string        `json:"conclusion,omitempty"`App          *App           `json:"app,omitempty"`Repository   *Repository    `json:"repository,omitempty"`PullRequests []*PullRequest `json:"pull_requests,omitempty"`// The following fields are only populated by Webhook events.HeadCommit *Commit `json:"head_commit,omitempty"`}

CheckSuite represents a suite of check runs.

func (*CheckSuite)GetAfterSHA ¶

func (c *CheckSuite) GetAfterSHA()string

GetAfterSHA returns the AfterSHA field if it's non-nil, zero value otherwise.

func (*CheckSuite)GetApp ¶

func (c *CheckSuite) GetApp() *App

GetApp returns the App field.

func (*CheckSuite)GetBeforeSHA ¶

func (c *CheckSuite) GetBeforeSHA()string

GetBeforeSHA returns the BeforeSHA field if it's non-nil, zero value otherwise.

func (*CheckSuite)GetConclusion ¶

func (c *CheckSuite) GetConclusion()string

GetConclusion returns the Conclusion field if it's non-nil, zero value otherwise.

func (*CheckSuite)GetHeadBranch ¶

func (c *CheckSuite) GetHeadBranch()string

GetHeadBranch returns the HeadBranch field if it's non-nil, zero value otherwise.

func (*CheckSuite)GetHeadCommit ¶

func (c *CheckSuite) GetHeadCommit() *Commit

GetHeadCommit returns the HeadCommit field.

func (*CheckSuite)GetHeadSHA ¶

func (c *CheckSuite) GetHeadSHA()string

GetHeadSHA returns the HeadSHA field if it's non-nil, zero value otherwise.

func (*CheckSuite)GetID ¶

func (c *CheckSuite) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*CheckSuite)GetNodeID ¶

func (c *CheckSuite) GetNodeID()string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*CheckSuite)GetRepository ¶

func (c *CheckSuite) GetRepository() *Repository

GetRepository returns the Repository field.

func (*CheckSuite)GetStatus ¶

func (c *CheckSuite) GetStatus()string

GetStatus returns the Status field if it's non-nil, zero value otherwise.

func (*CheckSuite)GetURL ¶

func (c *CheckSuite) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (CheckSuite)String ¶

func (cCheckSuite) String()string

typeCheckSuiteEvent ¶

type CheckSuiteEvent struct {CheckSuite *CheckSuite `json:"check_suite,omitempty"`// The action performed. Possible values are: "completed", "requested" or "rerequested".Action *string `json:"action,omitempty"`// The following fields are only populated by Webhook events.Repo         *Repository   `json:"repository,omitempty"`Org          *Organization `json:"organization,omitempty"`Sender       *User         `json:"sender,omitempty"`Installation *Installation `json:"installation,omitempty"`}

CheckSuiteEvent is triggered when a check suite is "completed", "requested", or "rerequested".The Webhook event name is "check_suite".

GitHub API docs:https://developer.github.com/v3/activity/events/types/#checksuiteevent

func (*CheckSuiteEvent)GetAction ¶

func (c *CheckSuiteEvent) GetAction()string

GetAction returns the Action field if it's non-nil, zero value otherwise.

func (*CheckSuiteEvent)GetCheckSuite ¶

func (c *CheckSuiteEvent) GetCheckSuite() *CheckSuite

GetCheckSuite returns the CheckSuite field.

func (*CheckSuiteEvent)GetInstallation ¶

func (c *CheckSuiteEvent) GetInstallation() *Installation

GetInstallation returns the Installation field.

func (*CheckSuiteEvent)GetOrg ¶

func (c *CheckSuiteEvent) GetOrg() *Organization

GetOrg returns the Org field.

func (*CheckSuiteEvent)GetRepo ¶

func (c *CheckSuiteEvent) GetRepo() *Repository

GetRepo returns the Repo field.

func (*CheckSuiteEvent)GetSender ¶

func (c *CheckSuiteEvent) GetSender() *User

GetSender returns the Sender field.

typeCheckSuitePreferenceOptions ¶

type CheckSuitePreferenceOptions struct {AutoTriggerChecks []*AutoTriggerCheck `json:"auto_trigger_checks,omitempty"`// A slice of auto trigger checks that can be set for a check suite in a repository.}

CheckSuitePreferenceOptions set options for check suite preferences for a repository.

typeCheckSuitePreferenceResults ¶

type CheckSuitePreferenceResults struct {Preferences *PreferenceList `json:"preferences,omitempty"`Repository  *Repository     `json:"repository,omitempty"`}

CheckSuitePreferenceResults represents the results of the preference set operation.

func (*CheckSuitePreferenceResults)GetPreferences ¶

func (c *CheckSuitePreferenceResults) GetPreferences() *PreferenceList

GetPreferences returns the Preferences field.

func (*CheckSuitePreferenceResults)GetRepository ¶

func (c *CheckSuitePreferenceResults) GetRepository() *Repository

GetRepository returns the Repository field.

typeChecksService ¶

type ChecksService service

ChecksService provides access to the Checks API in theGitHub API.

GitHub API docs:https://developer.github.com/v3/checks/

func (*ChecksService)CreateCheckRun ¶

func (s *ChecksService) CreateCheckRun(ctxcontext.Context, owner, repostring, optsCreateCheckRunOptions) (*CheckRun, *Response,error)

CreateCheckRun creates a check run for repository.

GitHub API docs:https://developer.github.com/v3/checks/runs/#create-a-check-run

func (*ChecksService)CreateCheckSuite ¶

func (s *ChecksService) CreateCheckSuite(ctxcontext.Context, owner, repostring, optsCreateCheckSuiteOptions) (*CheckSuite, *Response,error)

CreateCheckSuite manually creates a check suite for a repository.

GitHub API docs:https://developer.github.com/v3/checks/suites/#create-a-check-suite

func (*ChecksService)GetCheckRun ¶

func (s *ChecksService) GetCheckRun(ctxcontext.Context, owner, repostring, checkRunIDint64) (*CheckRun, *Response,error)

GetCheckRun gets a check-run for a repository.

GitHub API docs:https://developer.github.com/v3/checks/runs/#get-a-single-check-run

func (*ChecksService)GetCheckSuite ¶

func (s *ChecksService) GetCheckSuite(ctxcontext.Context, owner, repostring, checkSuiteIDint64) (*CheckSuite, *Response,error)

GetCheckSuite gets a single check suite.

GitHub API docs:https://developer.github.com/v3/checks/suites/#get-a-single-check-suite

func (*ChecksService)ListCheckRunAnnotations ¶

func (s *ChecksService) ListCheckRunAnnotations(ctxcontext.Context, owner, repostring, checkRunIDint64, opts *ListOptions) ([]*CheckRunAnnotation, *Response,error)

ListCheckRunAnnotations lists the annotations for a check run.

GitHub API docs:https://developer.github.com/v3/checks/runs/#list-annotations-for-a-check-run

func (*ChecksService)ListCheckRunsCheckSuite ¶

func (s *ChecksService) ListCheckRunsCheckSuite(ctxcontext.Context, owner, repostring, checkSuiteIDint64, opts *ListCheckRunsOptions) (*ListCheckRunsResults, *Response,error)

ListCheckRunsCheckSuite lists check runs for a check suite.

GitHub API docs:https://developer.github.com/v3/checks/runs/#list-check-runs-in-a-check-suite

func (*ChecksService)ListCheckRunsForRef ¶

func (s *ChecksService) ListCheckRunsForRef(ctxcontext.Context, owner, repo, refstring, opts *ListCheckRunsOptions) (*ListCheckRunsResults, *Response,error)

ListCheckRunsForRef lists check runs for a specific ref.

GitHub API docs:https://developer.github.com/v3/checks/runs/#list-check-runs-for-a-specific-ref

func (*ChecksService)ListCheckSuitesForRef ¶

func (s *ChecksService) ListCheckSuitesForRef(ctxcontext.Context, owner, repo, refstring, opts *ListCheckSuiteOptions) (*ListCheckSuiteResults, *Response,error)

ListCheckSuitesForRef lists check suite for a specific ref.

GitHub API docs:https://developer.github.com/v3/checks/suites/#list-check-suites-for-a-specific-ref

func (*ChecksService)ReRequestCheckSuite ¶

func (s *ChecksService) ReRequestCheckSuite(ctxcontext.Context, owner, repostring, checkSuiteIDint64) (*Response,error)

ReRequestCheckSuite triggers GitHub to rerequest an existing check suite, without pushing new code to a repository.

GitHub API docs:https://developer.github.com/v3/checks/suites/#rerequest-check-suite

func (*ChecksService)SetCheckSuitePreferences ¶

func (s *ChecksService) SetCheckSuitePreferences(ctxcontext.Context, owner, repostring, optsCheckSuitePreferenceOptions) (*CheckSuitePreferenceResults, *Response,error)

SetCheckSuitePreferences changes the default automatic flow when creating check suites.

GitHub API docs:https://developer.github.com/v3/checks/suites/#set-preferences-for-check-suites-on-a-repository

func (*ChecksService)UpdateCheckRun ¶

func (s *ChecksService) UpdateCheckRun(ctxcontext.Context, owner, repostring, checkRunIDint64, optsUpdateCheckRunOptions) (*CheckRun, *Response,error)

UpdateCheckRun updates a check run for a specific commit in a repository.

GitHub API docs:https://developer.github.com/v3/checks/runs/#update-a-check-run

typeClient ¶

type Client struct {// Base URL for API requests. Defaults to the public GitHub API, but can be// set to a domain endpoint to use with GitHub Enterprise. BaseURL should// always be specified with a trailing slash.BaseURL *url.URL// Base URL for uploading files.UploadURL *url.URL// User agent used when communicating with the GitHub API.UserAgentstring// Services used for talking to different parts of the GitHub API.Actions        *ActionsServiceActivity       *ActivityServiceAdmin          *AdminServiceApps           *AppsServiceAuthorizations *AuthorizationsServiceChecks         *ChecksServiceGists          *GistsServiceGit            *GitServiceGitignores     *GitignoresServiceInteractions   *InteractionsServiceIssues         *IssuesServiceLicenses       *LicensesServiceMarketplace    *MarketplaceServiceMigrations     *MigrationServiceOrganizations  *OrganizationsServiceProjects       *ProjectsServicePullRequests   *PullRequestsServiceReactions      *ReactionsServiceRepositories   *RepositoriesServiceSearch         *SearchServiceTeams          *TeamsServiceUsers          *UsersService// contains filtered or unexported fields}

A Client manages communication with the GitHub API.

funcNewClient ¶

func NewClient(httpClient *http.Client) *Client

NewClient returns a new GitHub API client. If a nil httpClient isprovided, a new http.Client will be used. To use API methods which requireauthentication, provide an http.Client that will perform the authenticationfor you (such as that provided by the golang.org/x/oauth2 library).

funcNewEnterpriseClient ¶

func NewEnterpriseClient(baseURL, uploadURLstring, httpClient *http.Client) (*Client,error)

NewEnterpriseClient returns a new GitHub API client with providedbase URL and upload URL (often the same URL and is your GitHub Enterprise hostname).If either URL does not have the suffix "/api/v3/", it will be added automatically.If a nil httpClient is provided, http.DefaultClient will be used.

Note that NewEnterpriseClient is a convenience helper only;its behavior is equivalent to using NewClient, followed by settingthe BaseURL and UploadURL fields.

Another important thing is that by default, the GitHub Enterprise URL formatshould be http(s)://[hostname]/api/v3 or you will always receive the 406 status code.

func (*Client)APIMeta ¶

func (c *Client) APIMeta(ctxcontext.Context) (*APIMeta, *Response,error)

APIMeta returns information about GitHub.com, the service. Or, if you accessthis endpoint on your organization’s GitHub Enterprise installation, thisendpoint provides information about that installation.

GitHub API docs:https://developer.github.com/v3/meta/

func (*Client)Do ¶

func (c *Client) Do(ctxcontext.Context, req *http.Request, v interface{}) (*Response,error)

Do sends an API request and returns the API response. The API response isJSON decoded and stored in the value pointed to by v, or returned as anerror if an API error has occurred. If v implements the io.Writerinterface, the raw response body will be written to v, without attempting tofirst decode it. If rate limit is exceeded and reset time is in the future,Do returns *RateLimitError immediately without making a network API call.

The provided ctx must be non-nil, if it is nil an error is returned. If it is canceled or times out,ctx.Err() will be returned.

func (*Client)GetCodeOfConduct ¶

func (c *Client) GetCodeOfConduct(ctxcontext.Context, keystring) (*CodeOfConduct, *Response,error)

GetCodeOfConduct returns an individual code of conduct.

https://developer.github.com/v3/codes_of_conduct/#get-an-individual-code-of-conduct

func (*Client)ListCodesOfConduct ¶

func (c *Client) ListCodesOfConduct(ctxcontext.Context) ([]*CodeOfConduct, *Response,error)

ListCodesOfConduct returns all codes of conduct.

GitHub API docs:https://developer.github.com/v3/codes_of_conduct/#list-all-codes-of-conduct

func (*Client)ListEmojis ¶

func (c *Client) ListEmojis(ctxcontext.Context) (map[string]string, *Response,error)

ListEmojis returns the emojis available to use on GitHub.

GitHub API docs:https://developer.github.com/v3/emojis/

func (*Client)ListServiceHooks ¶

func (c *Client) ListServiceHooks(ctxcontext.Context) ([]*ServiceHook, *Response,error)

ListServiceHooks lists all of the available service hooks.

GitHub API docs:https://developer.github.com/webhooks/#services

func (*Client)Markdown ¶

func (c *Client) Markdown(ctxcontext.Context, textstring, opts *MarkdownOptions) (string, *Response,error)

Markdown renders an arbitrary Markdown document.

GitHub API docs:https://developer.github.com/v3/markdown/

Example¶

package mainimport ("context""fmt""github.com/google/go-github/v29/github")func main() {client := github.NewClient(nil)input := "# heading #\n\nLink to issue #1"opt := &github.MarkdownOptions{Mode: "gfm", Context: "google/go-github"}output, _, err := client.Markdown(context.Background(), input, opt)if err != nil {fmt.Println(err)}fmt.Println(output)}

func (*Client)NewRequest ¶

func (c *Client) NewRequest(method, urlStrstring, body interface{}) (*http.Request,error)

NewRequest creates an API request. A relative URL can be provided in urlStr,in which case it is resolved relative to the BaseURL of the Client.Relative URLs should always be specified without a preceding slash. Ifspecified, the value pointed to by body is JSON encoded and included as therequest body.

func (*Client)NewUploadRequest ¶

func (c *Client) NewUploadRequest(urlStrstring, readerio.Reader, sizeint64, mediaTypestring) (*http.Request,error)

NewUploadRequest creates an upload request. A relative URL can be provided inurlStr, in which case it is resolved relative to the UploadURL of the Client.Relative URLs should always be specified without a preceding slash.

func (*Client)Octocat ¶

func (c *Client) Octocat(ctxcontext.Context, messagestring) (string, *Response,error)

Octocat returns an ASCII art octocat with the specified message in a speechbubble. If message is empty, a random zen phrase is used.

func (*Client)RateLimits ¶

func (c *Client) RateLimits(ctxcontext.Context) (*RateLimits, *Response,error)

RateLimits returns the rate limits for the current client.

func (*Client)Zen ¶

func (c *Client) Zen(ctxcontext.Context) (string, *Response,error)

Zen returns a random line from The Zen of GitHub.

typeCodeOfConduct ¶

type CodeOfConduct struct {Name *string `json:"name,omitempty"`Key  *string `json:"key,omitempty"`URL  *string `json:"url,omitempty"`Body *string `json:"body,omitempty"`}

CodeOfConduct represents a code of conduct.

func (*CodeOfConduct)GetBody ¶

func (c *CodeOfConduct) GetBody()string

GetBody returns the Body field if it's non-nil, zero value otherwise.

func (*CodeOfConduct)GetKey ¶

func (c *CodeOfConduct) GetKey()string

GetKey returns the Key field if it's non-nil, zero value otherwise.

func (*CodeOfConduct)GetName ¶

func (c *CodeOfConduct) GetName()string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (*CodeOfConduct)GetURL ¶

func (c *CodeOfConduct) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (*CodeOfConduct)String ¶

func (c *CodeOfConduct) String()string

typeCodeResult ¶

type CodeResult struct {Name        *string     `json:"name,omitempty"`Path        *string     `json:"path,omitempty"`SHA         *string     `json:"sha,omitempty"`HTMLURL     *string     `json:"html_url,omitempty"`Repository  *Repository `json:"repository,omitempty"`TextMatches []TextMatch `json:"text_matches,omitempty"`}

CodeResult represents a single search result.

func (*CodeResult)GetHTMLURL ¶

func (c *CodeResult) GetHTMLURL()string

GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.

func (*CodeResult)GetName ¶

func (c *CodeResult) GetName()string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (*CodeResult)GetPath ¶

func (c *CodeResult) GetPath()string

GetPath returns the Path field if it's non-nil, zero value otherwise.

func (*CodeResult)GetRepository ¶

func (c *CodeResult) GetRepository() *Repository

GetRepository returns the Repository field.

func (*CodeResult)GetSHA ¶

func (c *CodeResult) GetSHA()string

GetSHA returns the SHA field if it's non-nil, zero value otherwise.

func (CodeResult)String ¶

func (cCodeResult) String()string

typeCodeSearchResult ¶

type CodeSearchResult struct {Total             *int         `json:"total_count,omitempty"`IncompleteResults *bool        `json:"incomplete_results,omitempty"`CodeResults       []CodeResult `json:"items,omitempty"`}

CodeSearchResult represents the result of a code search.

func (*CodeSearchResult)GetIncompleteResults ¶

func (c *CodeSearchResult) GetIncompleteResults()bool

GetIncompleteResults returns the IncompleteResults field if it's non-nil, zero value otherwise.

func (*CodeSearchResult)GetTotal ¶

func (c *CodeSearchResult) GetTotal()int

GetTotal returns the Total field if it's non-nil, zero value otherwise.

typeCollaboratorInvitation ¶

type CollaboratorInvitation struct {ID          *int64      `json:"id,omitempty"`Repo        *Repository `json:"repository,omitempty"`Invitee     *User       `json:"invitee,omitempty"`Inviter     *User       `json:"inviter,omitempty"`Permissions *string     `json:"permissions,omitempty"`CreatedAt   *Timestamp  `json:"created_at,omitempty"`URL         *string     `json:"url,omitempty"`HTMLURL     *string     `json:"html_url,omitempty"`}

CollaboratorInvitation represents an invitation created when adding a collaborator.GitHub API docs:https://developer.github.com/v3/repos/collaborators/#response-when-a-new-invitation-is-created

func (*CollaboratorInvitation)GetCreatedAt ¶

func (c *CollaboratorInvitation) GetCreatedAt()Timestamp

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*CollaboratorInvitation)GetHTMLURL ¶

func (c *CollaboratorInvitation) GetHTMLURL()string

GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.

func (*CollaboratorInvitation)GetID ¶

func (c *CollaboratorInvitation) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*CollaboratorInvitation)GetInvitee ¶

func (c *CollaboratorInvitation) GetInvitee() *User

GetInvitee returns the Invitee field.

func (*CollaboratorInvitation)GetInviter ¶

func (c *CollaboratorInvitation) GetInviter() *User

GetInviter returns the Inviter field.

func (*CollaboratorInvitation)GetPermissions ¶

func (c *CollaboratorInvitation) GetPermissions()string

GetPermissions returns the Permissions field if it's non-nil, zero value otherwise.

func (*CollaboratorInvitation)GetRepo ¶

func (c *CollaboratorInvitation) GetRepo() *Repository

GetRepo returns the Repo field.

func (*CollaboratorInvitation)GetURL ¶

func (c *CollaboratorInvitation) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

typeCombinedStatus ¶

type CombinedStatus struct {// State is the combined state of the repository. Possible values are:// failure, pending, or success.State *string `json:"state,omitempty"`Name       *string      `json:"name,omitempty"`SHA        *string      `json:"sha,omitempty"`TotalCount *int         `json:"total_count,omitempty"`Statuses   []RepoStatus `json:"statuses,omitempty"`CommitURL     *string `json:"commit_url,omitempty"`RepositoryURL *string `json:"repository_url,omitempty"`}

CombinedStatus represents the combined status of a repository at a particular reference.

func (*CombinedStatus)GetCommitURL ¶

func (c *CombinedStatus) GetCommitURL()string

GetCommitURL returns the CommitURL field if it's non-nil, zero value otherwise.

func (*CombinedStatus)GetName ¶

func (c *CombinedStatus) GetName()string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (*CombinedStatus)GetRepositoryURL ¶

func (c *CombinedStatus) GetRepositoryURL()string

GetRepositoryURL returns the RepositoryURL field if it's non-nil, zero value otherwise.

func (*CombinedStatus)GetSHA ¶

func (c *CombinedStatus) GetSHA()string

GetSHA returns the SHA field if it's non-nil, zero value otherwise.

func (*CombinedStatus)GetState ¶

func (c *CombinedStatus) GetState()string

GetState returns the State field if it's non-nil, zero value otherwise.

func (*CombinedStatus)GetTotalCount ¶

func (c *CombinedStatus) GetTotalCount()int

GetTotalCount returns the TotalCount field if it's non-nil, zero value otherwise.

func (CombinedStatus)String ¶

func (sCombinedStatus) String()string

typeCommentStats ¶

type CommentStats struct {TotalCommitComments      *int `json:"total_commit_comments,omitempty"`TotalGistComments        *int `json:"total_gist_comments,omitempty"`TotalIssueComments       *int `json:"total_issue_comments,omitempty"`TotalPullRequestComments *int `json:"total_pull_request_comments,omitempty"`}

CommentStats represents the number of total comments on commits, gists, issuesand pull requests.

func (*CommentStats)GetTotalCommitComments ¶

func (c *CommentStats) GetTotalCommitComments()int

GetTotalCommitComments returns the TotalCommitComments field if it's non-nil, zero value otherwise.

func (*CommentStats)GetTotalGistComments ¶

func (c *CommentStats) GetTotalGistComments()int

GetTotalGistComments returns the TotalGistComments field if it's non-nil, zero value otherwise.

func (*CommentStats)GetTotalIssueComments ¶

func (c *CommentStats) GetTotalIssueComments()int

GetTotalIssueComments returns the TotalIssueComments field if it's non-nil, zero value otherwise.

func (*CommentStats)GetTotalPullRequestComments ¶

func (c *CommentStats) GetTotalPullRequestComments()int

GetTotalPullRequestComments returns the TotalPullRequestComments field if it's non-nil, zero value otherwise.

func (CommentStats)String ¶

func (sCommentStats) String()string

typeCommit ¶

type Commit struct {SHA          *string                `json:"sha,omitempty"`Author       *CommitAuthor          `json:"author,omitempty"`Committer    *CommitAuthor          `json:"committer,omitempty"`Message      *string                `json:"message,omitempty"`Tree         *Tree                  `json:"tree,omitempty"`Parents      []Commit               `json:"parents,omitempty"`Stats        *CommitStats           `json:"stats,omitempty"`HTMLURL      *string                `json:"html_url,omitempty"`URL          *string                `json:"url,omitempty"`Verification *SignatureVerification `json:"verification,omitempty"`NodeID       *string                `json:"node_id,omitempty"`// CommentCount is the number of GitHub comments on the commit. This// is only populated for requests that fetch GitHub data like// Pulls.ListCommits, Repositories.ListCommits, etc.CommentCount *int `json:"comment_count,omitempty"`// SigningKey denotes a key to sign the commit with. If not nil this key will// be used to sign the commit. The private key must be present and already// decrypted. Ignored if Verification.Signature is defined.SigningKey *openpgp.Entity `json:"-"`}

Commit represents a GitHub commit.

func (*Commit)GetAuthor ¶

func (c *Commit) GetAuthor() *CommitAuthor

GetAuthor returns the Author field.

func (*Commit)GetCommentCount ¶

func (c *Commit) GetCommentCount()int

GetCommentCount returns the CommentCount field if it's non-nil, zero value otherwise.

func (*Commit)GetCommitter ¶

func (c *Commit) GetCommitter() *CommitAuthor

GetCommitter returns the Committer field.

func (*Commit)GetHTMLURL ¶

func (c *Commit) GetHTMLURL()string

GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.

func (*Commit)GetMessage ¶

func (c *Commit) GetMessage()string

GetMessage returns the Message field if it's non-nil, zero value otherwise.

func (*Commit)GetNodeID ¶

func (c *Commit) GetNodeID()string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*Commit)GetSHA ¶

func (c *Commit) GetSHA()string

GetSHA returns the SHA field if it's non-nil, zero value otherwise.

func (*Commit)GetStats ¶

func (c *Commit) GetStats() *CommitStats

GetStats returns the Stats field.

func (*Commit)GetTree ¶

func (c *Commit) GetTree() *Tree

GetTree returns the Tree field.

func (*Commit)GetURL ¶

func (c *Commit) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (*Commit)GetVerification ¶

func (c *Commit) GetVerification() *SignatureVerification

GetVerification returns the Verification field.

func (Commit)String ¶

func (cCommit) String()string

typeCommitAuthor ¶

type CommitAuthor struct {Date  *time.Time `json:"date,omitempty"`Name  *string    `json:"name,omitempty"`Email *string    `json:"email,omitempty"`// The following fields are only populated by Webhook events.Login *string `json:"username,omitempty"`// Renamed for go-github consistency.}

CommitAuthor represents the author or committer of a commit. The commitauthor may not correspond to a GitHub User.

func (*CommitAuthor)GetDate ¶

func (c *CommitAuthor) GetDate()time.Time

GetDate returns the Date field if it's non-nil, zero value otherwise.

func (*CommitAuthor)GetEmail ¶

func (c *CommitAuthor) GetEmail()string

GetEmail returns the Email field if it's non-nil, zero value otherwise.

func (*CommitAuthor)GetLogin ¶

func (c *CommitAuthor) GetLogin()string

GetLogin returns the Login field if it's non-nil, zero value otherwise.

func (*CommitAuthor)GetName ¶

func (c *CommitAuthor) GetName()string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (CommitAuthor)String ¶

func (cCommitAuthor) String()string

typeCommitCommentEvent ¶

type CommitCommentEvent struct {Comment *RepositoryComment `json:"comment,omitempty"`// The following fields are only populated by Webhook events.Action       *string       `json:"action,omitempty"`Repo         *Repository   `json:"repository,omitempty"`Sender       *User         `json:"sender,omitempty"`Installation *Installation `json:"installation,omitempty"`}

CommitCommentEvent is triggered when a commit comment is created.The Webhook event name is "commit_comment".

GitHub API docs:https://developer.github.com/v3/activity/events/types/#commitcommentevent

func (*CommitCommentEvent)GetAction ¶

func (c *CommitCommentEvent) GetAction()string

GetAction returns the Action field if it's non-nil, zero value otherwise.

func (*CommitCommentEvent)GetComment ¶

func (c *CommitCommentEvent) GetComment() *RepositoryComment

GetComment returns the Comment field.

func (*CommitCommentEvent)GetInstallation ¶

func (c *CommitCommentEvent) GetInstallation() *Installation

GetInstallation returns the Installation field.

func (*CommitCommentEvent)GetRepo ¶

func (c *CommitCommentEvent) GetRepo() *Repository

GetRepo returns the Repo field.

func (*CommitCommentEvent)GetSender ¶

func (c *CommitCommentEvent) GetSender() *User

GetSender returns the Sender field.

typeCommitFile ¶

type CommitFile struct {SHA              *string `json:"sha,omitempty"`Filename         *string `json:"filename,omitempty"`Additions        *int    `json:"additions,omitempty"`Deletions        *int    `json:"deletions,omitempty"`Changes          *int    `json:"changes,omitempty"`Status           *string `json:"status,omitempty"`Patch            *string `json:"patch,omitempty"`BlobURL          *string `json:"blob_url,omitempty"`RawURL           *string `json:"raw_url,omitempty"`ContentsURL      *string `json:"contents_url,omitempty"`PreviousFilename *string `json:"previous_filename,omitempty"`}

CommitFile represents a file modified in a commit.

func (*CommitFile)GetAdditions ¶

func (c *CommitFile) GetAdditions()int

GetAdditions returns the Additions field if it's non-nil, zero value otherwise.

func (*CommitFile)GetBlobURL ¶

func (c *CommitFile) GetBlobURL()string

GetBlobURL returns the BlobURL field if it's non-nil, zero value otherwise.

func (*CommitFile)GetChanges ¶

func (c *CommitFile) GetChanges()int

GetChanges returns the Changes field if it's non-nil, zero value otherwise.

func (*CommitFile)GetContentsURL ¶

func (c *CommitFile) GetContentsURL()string

GetContentsURL returns the ContentsURL field if it's non-nil, zero value otherwise.

func (*CommitFile)GetDeletions ¶

func (c *CommitFile) GetDeletions()int

GetDeletions returns the Deletions field if it's non-nil, zero value otherwise.

func (*CommitFile)GetFilename ¶

func (c *CommitFile) GetFilename()string

GetFilename returns the Filename field if it's non-nil, zero value otherwise.

func (*CommitFile)GetPatch ¶

func (c *CommitFile) GetPatch()string

GetPatch returns the Patch field if it's non-nil, zero value otherwise.

func (*CommitFile)GetPreviousFilename ¶

func (c *CommitFile) GetPreviousFilename()string

GetPreviousFilename returns the PreviousFilename field if it's non-nil, zero value otherwise.

func (*CommitFile)GetRawURL ¶

func (c *CommitFile) GetRawURL()string

GetRawURL returns the RawURL field if it's non-nil, zero value otherwise.

func (*CommitFile)GetSHA ¶

func (c *CommitFile) GetSHA()string

GetSHA returns the SHA field if it's non-nil, zero value otherwise.

func (*CommitFile)GetStatus ¶

func (c *CommitFile) GetStatus()string

GetStatus returns the Status field if it's non-nil, zero value otherwise.

func (CommitFile)String ¶

func (cCommitFile) String()string

typeCommitResult ¶

type CommitResult struct {SHA         *string   `json:"sha,omitempty"`Commit      *Commit   `json:"commit,omitempty"`Author      *User     `json:"author,omitempty"`Committer   *User     `json:"committer,omitempty"`Parents     []*Commit `json:"parents,omitempty"`HTMLURL     *string   `json:"html_url,omitempty"`URL         *string   `json:"url,omitempty"`CommentsURL *string   `json:"comments_url,omitempty"`Repository *Repository `json:"repository,omitempty"`Score      *float64    `json:"score,omitempty"`}

CommitResult represents a commit object as returned in commit search endpoint response.

func (*CommitResult)GetAuthor ¶

func (c *CommitResult) GetAuthor() *User

GetAuthor returns the Author field.

func (*CommitResult)GetCommentsURL ¶

func (c *CommitResult) GetCommentsURL()string

GetCommentsURL returns the CommentsURL field if it's non-nil, zero value otherwise.

func (*CommitResult)GetCommit ¶

func (c *CommitResult) GetCommit() *Commit

GetCommit returns the Commit field.

func (*CommitResult)GetCommitter ¶

func (c *CommitResult) GetCommitter() *User

GetCommitter returns the Committer field.

func (*CommitResult)GetHTMLURL ¶

func (c *CommitResult) GetHTMLURL()string

GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.

func (*CommitResult)GetRepository ¶

func (c *CommitResult) GetRepository() *Repository

GetRepository returns the Repository field.

func (*CommitResult)GetSHA ¶

func (c *CommitResult) GetSHA()string

GetSHA returns the SHA field if it's non-nil, zero value otherwise.

func (*CommitResult)GetScore ¶

func (c *CommitResult) GetScore() *float64

GetScore returns the Score field.

func (*CommitResult)GetURL ¶

func (c *CommitResult) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

typeCommitStats ¶

type CommitStats struct {Additions *int `json:"additions,omitempty"`Deletions *int `json:"deletions,omitempty"`Total     *int `json:"total,omitempty"`}

CommitStats represents the number of additions / deletions from a file in a given RepositoryCommit or GistCommit.

func (*CommitStats)GetAdditions ¶

func (c *CommitStats) GetAdditions()int

GetAdditions returns the Additions field if it's non-nil, zero value otherwise.

func (*CommitStats)GetDeletions ¶

func (c *CommitStats) GetDeletions()int

GetDeletions returns the Deletions field if it's non-nil, zero value otherwise.

func (*CommitStats)GetTotal ¶

func (c *CommitStats) GetTotal()int

GetTotal returns the Total field if it's non-nil, zero value otherwise.

func (CommitStats)String ¶

func (cCommitStats) String()string

typeCommitsComparison ¶

type CommitsComparison struct {BaseCommit      *RepositoryCommit `json:"base_commit,omitempty"`MergeBaseCommit *RepositoryCommit `json:"merge_base_commit,omitempty"`// Head can be 'behind' or 'ahead'Status       *string `json:"status,omitempty"`AheadBy      *int    `json:"ahead_by,omitempty"`BehindBy     *int    `json:"behind_by,omitempty"`TotalCommits *int    `json:"total_commits,omitempty"`Commits []RepositoryCommit `json:"commits,omitempty"`Files []CommitFile `json:"files,omitempty"`HTMLURL      *string `json:"html_url,omitempty"`PermalinkURL *string `json:"permalink_url,omitempty"`DiffURL      *string `json:"diff_url,omitempty"`PatchURL     *string `json:"patch_url,omitempty"`URL          *string `json:"url,omitempty"`// API URL.}

CommitsComparison is the result of comparing two commits.See CompareCommits() for details.

func (*CommitsComparison)GetAheadBy ¶

func (c *CommitsComparison) GetAheadBy()int

GetAheadBy returns the AheadBy field if it's non-nil, zero value otherwise.

func (*CommitsComparison)GetBaseCommit ¶

func (c *CommitsComparison) GetBaseCommit() *RepositoryCommit

GetBaseCommit returns the BaseCommit field.

func (*CommitsComparison)GetBehindBy ¶

func (c *CommitsComparison) GetBehindBy()int

GetBehindBy returns the BehindBy field if it's non-nil, zero value otherwise.

func (*CommitsComparison)GetDiffURL ¶

func (c *CommitsComparison) GetDiffURL()string

GetDiffURL returns the DiffURL field if it's non-nil, zero value otherwise.

func (*CommitsComparison)GetHTMLURL ¶

func (c *CommitsComparison) GetHTMLURL()string

GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.

func (*CommitsComparison)GetMergeBaseCommit ¶

func (c *CommitsComparison) GetMergeBaseCommit() *RepositoryCommit

GetMergeBaseCommit returns the MergeBaseCommit field.

func (*CommitsComparison)GetPatchURL ¶

func (c *CommitsComparison) GetPatchURL()string

GetPatchURL returns the PatchURL field if it's non-nil, zero value otherwise.

func (*CommitsComparison)GetPermalinkURL ¶

func (c *CommitsComparison) GetPermalinkURL()string

GetPermalinkURL returns the PermalinkURL field if it's non-nil, zero value otherwise.

func (*CommitsComparison)GetStatus ¶

func (c *CommitsComparison) GetStatus()string

GetStatus returns the Status field if it's non-nil, zero value otherwise.

func (*CommitsComparison)GetTotalCommits ¶

func (c *CommitsComparison) GetTotalCommits()int

GetTotalCommits returns the TotalCommits field if it's non-nil, zero value otherwise.

func (*CommitsComparison)GetURL ¶

func (c *CommitsComparison) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (CommitsComparison)String ¶

func (cCommitsComparison) String()string

typeCommitsListOptions ¶

type CommitsListOptions struct {// SHA or branch to start listing Commits from.SHAstring `url:"sha,omitempty"`// Path that should be touched by the returned Commits.Pathstring `url:"path,omitempty"`// Author of by which to filter Commits.Authorstring `url:"author,omitempty"`// Since when should Commits be included in the response.Sincetime.Time `url:"since,omitempty"`// Until when should Commits be included in the response.Untiltime.Time `url:"until,omitempty"`ListOptions}

CommitsListOptions specifies the optional parameters to theRepositoriesService.ListCommits method.

typeCommitsSearchResult ¶

type CommitsSearchResult struct {Total             *int            `json:"total_count,omitempty"`IncompleteResults *bool           `json:"incomplete_results,omitempty"`Commits           []*CommitResult `json:"items,omitempty"`}

CommitsSearchResult represents the result of a commits search.

func (*CommitsSearchResult)GetIncompleteResults ¶

func (c *CommitsSearchResult) GetIncompleteResults()bool

GetIncompleteResults returns the IncompleteResults field if it's non-nil, zero value otherwise.

func (*CommitsSearchResult)GetTotal ¶

func (c *CommitsSearchResult) GetTotal()int

GetTotal returns the Total field if it's non-nil, zero value otherwise.

typeCommunityHealthFiles ¶

type CommunityHealthFiles struct {CodeOfConduct       *Metric `json:"code_of_conduct"`Contributing        *Metric `json:"contributing"`IssueTemplate       *Metric `json:"issue_template"`PullRequestTemplate *Metric `json:"pull_request_template"`License             *Metric `json:"license"`Readme              *Metric `json:"readme"`}

CommunityHealthFiles represents the different files in the community health metrics response.

func (*CommunityHealthFiles)GetCodeOfConduct ¶

func (c *CommunityHealthFiles) GetCodeOfConduct() *Metric

GetCodeOfConduct returns the CodeOfConduct field.

func (*CommunityHealthFiles)GetContributing ¶

func (c *CommunityHealthFiles) GetContributing() *Metric

GetContributing returns the Contributing field.

func (*CommunityHealthFiles)GetIssueTemplate ¶

func (c *CommunityHealthFiles) GetIssueTemplate() *Metric

GetIssueTemplate returns the IssueTemplate field.

func (*CommunityHealthFiles)GetLicense ¶

func (c *CommunityHealthFiles) GetLicense() *Metric

GetLicense returns the License field.

func (*CommunityHealthFiles)GetPullRequestTemplate ¶

func (c *CommunityHealthFiles) GetPullRequestTemplate() *Metric

GetPullRequestTemplate returns the PullRequestTemplate field.

func (*CommunityHealthFiles)GetReadme ¶

func (c *CommunityHealthFiles) GetReadme() *Metric

GetReadme returns the Readme field.

typeCommunityHealthMetrics ¶

type CommunityHealthMetrics struct {HealthPercentage *int                  `json:"health_percentage"`Files            *CommunityHealthFiles `json:"files"`UpdatedAt        *time.Time            `json:"updated_at"`}

CommunityHealthMetrics represents a response containing the community metrics of a repository.

func (*CommunityHealthMetrics)GetFiles ¶

func (c *CommunityHealthMetrics) GetFiles() *CommunityHealthFiles

GetFiles returns the Files field.

func (*CommunityHealthMetrics)GetHealthPercentage ¶

func (c *CommunityHealthMetrics) GetHealthPercentage()int

GetHealthPercentage returns the HealthPercentage field if it's non-nil, zero value otherwise.

func (*CommunityHealthMetrics)GetUpdatedAt ¶

func (c *CommunityHealthMetrics) GetUpdatedAt()time.Time

GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.

typeContributor ¶

type Contributor struct {Login             *string `json:"login,omitempty"`ID                *int64  `json:"id,omitempty"`NodeID            *string `json:"node_id,omitempty"`AvatarURL         *string `json:"avatar_url,omitempty"`GravatarID        *string `json:"gravatar_id,omitempty"`URL               *string `json:"url,omitempty"`HTMLURL           *string `json:"html_url,omitempty"`FollowersURL      *string `json:"followers_url,omitempty"`FollowingURL      *string `json:"following_url,omitempty"`GistsURL          *string `json:"gists_url,omitempty"`StarredURL        *string `json:"starred_url,omitempty"`SubscriptionsURL  *string `json:"subscriptions_url,omitempty"`OrganizationsURL  *string `json:"organizations_url,omitempty"`ReposURL          *string `json:"repos_url,omitempty"`EventsURL         *string `json:"events_url,omitempty"`ReceivedEventsURL *string `json:"received_events_url,omitempty"`Type              *string `json:"type,omitempty"`SiteAdmin         *bool   `json:"site_admin,omitempty"`Contributions     *int    `json:"contributions,omitempty"`}

Contributor represents a repository contributor

func (*Contributor)GetAvatarURL ¶

func (c *Contributor) GetAvatarURL()string

GetAvatarURL returns the AvatarURL field if it's non-nil, zero value otherwise.

func (*Contributor)GetContributions ¶

func (c *Contributor) GetContributions()int

GetContributions returns the Contributions field if it's non-nil, zero value otherwise.

func (*Contributor)GetEventsURL ¶

func (c *Contributor) GetEventsURL()string

GetEventsURL returns the EventsURL field if it's non-nil, zero value otherwise.

func (*Contributor)GetFollowersURL ¶

func (c *Contributor) GetFollowersURL()string

GetFollowersURL returns the FollowersURL field if it's non-nil, zero value otherwise.

func (*Contributor)GetFollowingURL ¶

func (c *Contributor) GetFollowingURL()string

GetFollowingURL returns the FollowingURL field if it's non-nil, zero value otherwise.

func (*Contributor)GetGistsURL ¶

func (c *Contributor) GetGistsURL()string

GetGistsURL returns the GistsURL field if it's non-nil, zero value otherwise.

func (*Contributor)GetGravatarID ¶

func (c *Contributor) GetGravatarID()string

GetGravatarID returns the GravatarID field if it's non-nil, zero value otherwise.

func (*Contributor)GetHTMLURL ¶

func (c *Contributor) GetHTMLURL()string

GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.

func (*Contributor)GetID ¶

func (c *Contributor) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*Contributor)GetLogin ¶

func (c *Contributor) GetLogin()string

GetLogin returns the Login field if it's non-nil, zero value otherwise.

func (*Contributor)GetNodeID ¶added inv29.0.3

func (c *Contributor) GetNodeID()string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*Contributor)GetOrganizationsURL ¶

func (c *Contributor) GetOrganizationsURL()string

GetOrganizationsURL returns the OrganizationsURL field if it's non-nil, zero value otherwise.

func (*Contributor)GetReceivedEventsURL ¶

func (c *Contributor) GetReceivedEventsURL()string

GetReceivedEventsURL returns the ReceivedEventsURL field if it's non-nil, zero value otherwise.

func (*Contributor)GetReposURL ¶

func (c *Contributor) GetReposURL()string

GetReposURL returns the ReposURL field if it's non-nil, zero value otherwise.

func (*Contributor)GetSiteAdmin ¶

func (c *Contributor) GetSiteAdmin()bool

GetSiteAdmin returns the SiteAdmin field if it's non-nil, zero value otherwise.

func (*Contributor)GetStarredURL ¶

func (c *Contributor) GetStarredURL()string

GetStarredURL returns the StarredURL field if it's non-nil, zero value otherwise.

func (*Contributor)GetSubscriptionsURL ¶

func (c *Contributor) GetSubscriptionsURL()string

GetSubscriptionsURL returns the SubscriptionsURL field if it's non-nil, zero value otherwise.

func (*Contributor)GetType ¶

func (c *Contributor) GetType()string

GetType returns the Type field if it's non-nil, zero value otherwise.

func (*Contributor)GetURL ¶

func (c *Contributor) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

typeContributorStats ¶

type ContributorStats struct {Author *Contributor  `json:"author,omitempty"`Total  *int          `json:"total,omitempty"`Weeks  []WeeklyStats `json:"weeks,omitempty"`}

ContributorStats represents a contributor to a repository and theirweekly contributions to a given repo.

func (*ContributorStats)GetAuthor ¶

func (c *ContributorStats) GetAuthor() *Contributor

GetAuthor returns the Author field.

func (*ContributorStats)GetTotal ¶

func (c *ContributorStats) GetTotal()int

GetTotal returns the Total field if it's non-nil, zero value otherwise.

func (ContributorStats)String ¶

func (cContributorStats) String()string

typeCreateCheckRunOptions ¶

type CreateCheckRunOptions struct {Namestring            `json:"name"`// The name of the check (e.g., "code-coverage"). (Required.)HeadSHAstring            `json:"head_sha"`// The SHA of the commit. (Required.)DetailsURL  *string           `json:"details_url,omitempty"`// The URL of the integrator's site that has the full details of the check. (Optional.)ExternalID  *string           `json:"external_id,omitempty"`// A reference for the run on the integrator's system. (Optional.)Status      *string           `json:"status,omitempty"`// The current status. Can be one of "queued", "in_progress", or "completed". Default: "queued". (Optional.)Conclusion  *string           `json:"conclusion,omitempty"`// Can be one of "success", "failure", "neutral", "cancelled", "timed_out", or "action_required". (Optional. Required if you provide a status of "completed".)StartedAt   *Timestamp        `json:"started_at,omitempty"`// The time that the check run began. (Optional.)CompletedAt *Timestamp        `json:"completed_at,omitempty"`// The time the check completed. (Optional. Required if you provide conclusion.)Output      *CheckRunOutput   `json:"output,omitempty"`// Provide descriptive details about the run. (Optional)Actions     []*CheckRunAction `json:"actions,omitempty"`// Possible further actions the integrator can perform, which a user may trigger. (Optional.)}

CreateCheckRunOptions sets up parameters needed to create a CheckRun.

func (*CreateCheckRunOptions)GetCompletedAt ¶

func (c *CreateCheckRunOptions) GetCompletedAt()Timestamp

GetCompletedAt returns the CompletedAt field if it's non-nil, zero value otherwise.

func (*CreateCheckRunOptions)GetConclusion ¶

func (c *CreateCheckRunOptions) GetConclusion()string

GetConclusion returns the Conclusion field if it's non-nil, zero value otherwise.

func (*CreateCheckRunOptions)GetDetailsURL ¶

func (c *CreateCheckRunOptions) GetDetailsURL()string

GetDetailsURL returns the DetailsURL field if it's non-nil, zero value otherwise.

func (*CreateCheckRunOptions)GetExternalID ¶

func (c *CreateCheckRunOptions) GetExternalID()string

GetExternalID returns the ExternalID field if it's non-nil, zero value otherwise.

func (*CreateCheckRunOptions)GetOutput ¶

func (c *CreateCheckRunOptions) GetOutput() *CheckRunOutput

GetOutput returns the Output field.

func (*CreateCheckRunOptions)GetStartedAt ¶

func (c *CreateCheckRunOptions) GetStartedAt()Timestamp

GetStartedAt returns the StartedAt field if it's non-nil, zero value otherwise.

func (*CreateCheckRunOptions)GetStatus ¶

func (c *CreateCheckRunOptions) GetStatus()string

GetStatus returns the Status field if it's non-nil, zero value otherwise.

typeCreateCheckSuiteOptions ¶

type CreateCheckSuiteOptions struct {HeadSHAstring  `json:"head_sha"`// The sha of the head commit. (Required.)HeadBranch *string `json:"head_branch,omitempty"`// The name of the head branch where the code changes are implemented.}

CreateCheckSuiteOptions sets up parameters to manually create a check suites

func (*CreateCheckSuiteOptions)GetHeadBranch ¶

func (c *CreateCheckSuiteOptions) GetHeadBranch()string

GetHeadBranch returns the HeadBranch field if it's non-nil, zero value otherwise.

typeCreateEvent ¶

type CreateEvent struct {Ref *string `json:"ref,omitempty"`// RefType is the object that was created. Possible values are: "repository", "branch", "tag".RefType      *string `json:"ref_type,omitempty"`MasterBranch *string `json:"master_branch,omitempty"`Description  *string `json:"description,omitempty"`// The following fields are only populated by Webhook events.PusherType   *string       `json:"pusher_type,omitempty"`Repo         *Repository   `json:"repository,omitempty"`Sender       *User         `json:"sender,omitempty"`Installation *Installation `json:"installation,omitempty"`}

CreateEvent represents a created repository, branch, or tag.The Webhook event name is "create".

Note: webhooks will not receive this event for created repositories.Additionally, webhooks will not receive this event for tags if morethan three tags are pushed at once.

GitHub API docs:https://developer.github.com/v3/activity/events/types/#createevent

func (*CreateEvent)GetDescription ¶

func (c *CreateEvent) GetDescription()string

GetDescription returns the Description field if it's non-nil, zero value otherwise.

func (*CreateEvent)GetInstallation ¶

func (c *CreateEvent) GetInstallation() *Installation

GetInstallation returns the Installation field.

func (*CreateEvent)GetMasterBranch ¶

func (c *CreateEvent) GetMasterBranch()string

GetMasterBranch returns the MasterBranch field if it's non-nil, zero value otherwise.

func (*CreateEvent)GetPusherType ¶

func (c *CreateEvent) GetPusherType()string

GetPusherType returns the PusherType field if it's non-nil, zero value otherwise.

func (*CreateEvent)GetRef ¶

func (c *CreateEvent) GetRef()string

GetRef returns the Ref field if it's non-nil, zero value otherwise.

func (*CreateEvent)GetRefType ¶

func (c *CreateEvent) GetRefType()string

GetRefType returns the RefType field if it's non-nil, zero value otherwise.

func (*CreateEvent)GetRepo ¶

func (c *CreateEvent) GetRepo() *Repository

GetRepo returns the Repo field.

func (*CreateEvent)GetSender ¶

func (c *CreateEvent) GetSender() *User

GetSender returns the Sender field.

typeCreateOrgInvitationOptions ¶

type CreateOrgInvitationOptions struct {// GitHub user ID for the person you are inviting. Not required if you provide Email.InviteeID *int64 `json:"invitee_id,omitempty"`// Email address of the person you are inviting, which can be an existing GitHub user.// Not required if you provide InviteeIDEmail *string `json:"email,omitempty"`// 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.// Default is "direct_member".Role   *string `json:"role"`TeamID []int64 `json:"team_ids"`}

CreateOrgInvitationOptions specifies the parameters to the OrganizationService.Invitemethod.

func (*CreateOrgInvitationOptions)GetEmail ¶

func (c *CreateOrgInvitationOptions) GetEmail()string

GetEmail returns the Email field if it's non-nil, zero value otherwise.

func (*CreateOrgInvitationOptions)GetInviteeID ¶

func (c *CreateOrgInvitationOptions) GetInviteeID()int64

GetInviteeID returns the InviteeID field if it's non-nil, zero value otherwise.

func (*CreateOrgInvitationOptions)GetRole ¶

func (c *CreateOrgInvitationOptions) GetRole()string

GetRole returns the Role field if it's non-nil, zero value otherwise.

typeCreateUserProjectOptions ¶

type CreateUserProjectOptions struct {// The name of the project. (Required.)Namestring `json:"name"`// The description of the project. (Optional.)Body *string `json:"body,omitempty"`}

CreateUserProjectOptions specifies the parameters to the UsersService.CreateProject method.

func (*CreateUserProjectOptions)GetBody ¶

func (c *CreateUserProjectOptions) GetBody()string

GetBody returns the Body field if it's non-nil, zero value otherwise.

typeDeleteEvent ¶

type DeleteEvent struct {Ref *string `json:"ref,omitempty"`// RefType is the object that was deleted. Possible values are: "branch", "tag".RefType *string `json:"ref_type,omitempty"`// The following fields are only populated by Webhook events.PusherType   *string       `json:"pusher_type,omitempty"`Repo         *Repository   `json:"repository,omitempty"`Sender       *User         `json:"sender,omitempty"`Installation *Installation `json:"installation,omitempty"`}

DeleteEvent represents a deleted branch or tag.The Webhook event name is "delete".

Note: webhooks will not receive this event for tags if more than three tagsare deleted at once.

GitHub API docs:https://developer.github.com/v3/activity/events/types/#deleteevent

func (*DeleteEvent)GetInstallation ¶

func (d *DeleteEvent) GetInstallation() *Installation

GetInstallation returns the Installation field.

func (*DeleteEvent)GetPusherType ¶

func (d *DeleteEvent) GetPusherType()string

GetPusherType returns the PusherType field if it's non-nil, zero value otherwise.

func (*DeleteEvent)GetRef ¶

func (d *DeleteEvent) GetRef()string

GetRef returns the Ref field if it's non-nil, zero value otherwise.

func (*DeleteEvent)GetRefType ¶

func (d *DeleteEvent) GetRefType()string

GetRefType returns the RefType field if it's non-nil, zero value otherwise.

func (*DeleteEvent)GetRepo ¶

func (d *DeleteEvent) GetRepo() *Repository

GetRepo returns the Repo field.

func (*DeleteEvent)GetSender ¶

func (d *DeleteEvent) GetSender() *User

GetSender returns the Sender field.

typeDeployKeyEvent ¶

type DeployKeyEvent struct {// Action is the action that was performed. Possible values are:// "created" or "deleted".Action *string `json:"action,omitempty"`// The deploy key resource.Key *Key `json:"key,omitempty"`}

DeployKeyEvent is triggered when a deploy key is added or removed from a repository.The Webhook event name is "deploy_key".

GitHub API docs:https://developer.github.com/v3/activity/events/types/#deploykeyevent

func (*DeployKeyEvent)GetAction ¶

func (d *DeployKeyEvent) GetAction()string

GetAction returns the Action field if it's non-nil, zero value otherwise.

func (*DeployKeyEvent)GetKey ¶

func (d *DeployKeyEvent) GetKey() *Key

GetKey returns the Key field.

typeDeployment ¶

type Deployment struct {URL           *string         `json:"url,omitempty"`ID            *int64          `json:"id,omitempty"`SHA           *string         `json:"sha,omitempty"`Ref           *string         `json:"ref,omitempty"`Task          *string         `json:"task,omitempty"`Payloadjson.RawMessage `json:"payload,omitempty"`Environment   *string         `json:"environment,omitempty"`Description   *string         `json:"description,omitempty"`Creator       *User           `json:"creator,omitempty"`CreatedAt     *Timestamp      `json:"created_at,omitempty"`UpdatedAt     *Timestamp      `json:"updated_at,omitempty"`StatusesURL   *string         `json:"statuses_url,omitempty"`RepositoryURL *string         `json:"repository_url,omitempty"`NodeID        *string         `json:"node_id,omitempty"`}

Deployment represents a deployment in a repo

func (*Deployment)GetCreatedAt ¶

func (d *Deployment) GetCreatedAt()Timestamp

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*Deployment)GetCreator ¶

func (d *Deployment) GetCreator() *User

GetCreator returns the Creator field.

func (*Deployment)GetDescription ¶

func (d *Deployment) GetDescription()string

GetDescription returns the Description field if it's non-nil, zero value otherwise.

func (*Deployment)GetEnvironment ¶

func (d *Deployment) GetEnvironment()string

GetEnvironment returns the Environment field if it's non-nil, zero value otherwise.

func (*Deployment)GetID ¶

func (d *Deployment) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*Deployment)GetNodeID ¶

func (d *Deployment) GetNodeID()string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*Deployment)GetRef ¶

func (d *Deployment) GetRef()string

GetRef returns the Ref field if it's non-nil, zero value otherwise.

func (*Deployment)GetRepositoryURL ¶

func (d *Deployment) GetRepositoryURL()string

GetRepositoryURL returns the RepositoryURL field if it's non-nil, zero value otherwise.

func (*Deployment)GetSHA ¶

func (d *Deployment) GetSHA()string

GetSHA returns the SHA field if it's non-nil, zero value otherwise.

func (*Deployment)GetStatusesURL ¶

func (d *Deployment) GetStatusesURL()string

GetStatusesURL returns the StatusesURL field if it's non-nil, zero value otherwise.

func (*Deployment)GetTask ¶

func (d *Deployment) GetTask()string

GetTask returns the Task field if it's non-nil, zero value otherwise.

func (*Deployment)GetURL ¶

func (d *Deployment) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (*Deployment)GetUpdatedAt ¶

func (d *Deployment) GetUpdatedAt()Timestamp

GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.

typeDeploymentEvent ¶

type DeploymentEvent struct {Deployment *Deployment `json:"deployment,omitempty"`Repo       *Repository `json:"repository,omitempty"`// The following fields are only populated by Webhook events.Sender       *User         `json:"sender,omitempty"`Installation *Installation `json:"installation,omitempty"`}

DeploymentEvent represents a deployment.The Webhook event name is "deployment".

Events of this type are not visible in timelines, they are only used to trigger hooks.

GitHub API docs:https://developer.github.com/v3/activity/events/types/#deploymentevent

func (*DeploymentEvent)GetDeployment ¶

func (d *DeploymentEvent) GetDeployment() *Deployment

GetDeployment returns the Deployment field.

func (*DeploymentEvent)GetInstallation ¶

func (d *DeploymentEvent) GetInstallation() *Installation

GetInstallation returns the Installation field.

func (*DeploymentEvent)GetRepo ¶

func (d *DeploymentEvent) GetRepo() *Repository

GetRepo returns the Repo field.

func (*DeploymentEvent)GetSender ¶

func (d *DeploymentEvent) GetSender() *User

GetSender returns the Sender field.

typeDeploymentRequest ¶

type DeploymentRequest struct {Ref                   *string     `json:"ref,omitempty"`Task                  *string     `json:"task,omitempty"`AutoMerge             *bool       `json:"auto_merge,omitempty"`RequiredContexts      *[]string   `json:"required_contexts,omitempty"`Payload               interface{} `json:"payload,omitempty"`Environment           *string     `json:"environment,omitempty"`Description           *string     `json:"description,omitempty"`TransientEnvironment  *bool       `json:"transient_environment,omitempty"`ProductionEnvironment *bool       `json:"production_environment,omitempty"`}

DeploymentRequest represents a deployment request

func (*DeploymentRequest)GetAutoMerge ¶

func (d *DeploymentRequest) GetAutoMerge()bool

GetAutoMerge returns the AutoMerge field if it's non-nil, zero value otherwise.

func (*DeploymentRequest)GetDescription ¶

func (d *DeploymentRequest) GetDescription()string

GetDescription returns the Description field if it's non-nil, zero value otherwise.

func (*DeploymentRequest)GetEnvironment ¶

func (d *DeploymentRequest) GetEnvironment()string

GetEnvironment returns the Environment field if it's non-nil, zero value otherwise.

func (*DeploymentRequest)GetProductionEnvironment ¶

func (d *DeploymentRequest) GetProductionEnvironment()bool

GetProductionEnvironment returns the ProductionEnvironment field if it's non-nil, zero value otherwise.

func (*DeploymentRequest)GetRef ¶

func (d *DeploymentRequest) GetRef()string

GetRef returns the Ref field if it's non-nil, zero value otherwise.

func (*DeploymentRequest)GetRequiredContexts ¶

func (d *DeploymentRequest) GetRequiredContexts() []string

GetRequiredContexts returns the RequiredContexts field if it's non-nil, zero value otherwise.

func (*DeploymentRequest)GetTask ¶

func (d *DeploymentRequest) GetTask()string

GetTask returns the Task field if it's non-nil, zero value otherwise.

func (*DeploymentRequest)GetTransientEnvironment ¶

func (d *DeploymentRequest) GetTransientEnvironment()bool

GetTransientEnvironment returns the TransientEnvironment field if it's non-nil, zero value otherwise.

typeDeploymentStatus ¶

type DeploymentStatus struct {ID *int64 `json:"id,omitempty"`// State is the deployment state.// Possible values are: "pending", "success", "failure", "error", "inactive".State         *string    `json:"state,omitempty"`Creator       *User      `json:"creator,omitempty"`Description   *string    `json:"description,omitempty"`TargetURL     *string    `json:"target_url,omitempty"`CreatedAt     *Timestamp `json:"created_at,omitempty"`UpdatedAt     *Timestamp `json:"updated_at,omitempty"`DeploymentURL *string    `json:"deployment_url,omitempty"`RepositoryURL *string    `json:"repository_url,omitempty"`NodeID        *string    `json:"node_id,omitempty"`}

DeploymentStatus represents the status of aparticular deployment.

func (*DeploymentStatus)GetCreatedAt ¶

func (d *DeploymentStatus) GetCreatedAt()Timestamp

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*DeploymentStatus)GetCreator ¶

func (d *DeploymentStatus) GetCreator() *User

GetCreator returns the Creator field.

func (*DeploymentStatus)GetDeploymentURL ¶

func (d *DeploymentStatus) GetDeploymentURL()string

GetDeploymentURL returns the DeploymentURL field if it's non-nil, zero value otherwise.

func (*DeploymentStatus)GetDescription ¶

func (d *DeploymentStatus) GetDescription()string

GetDescription returns the Description field if it's non-nil, zero value otherwise.

func (*DeploymentStatus)GetID ¶

func (d *DeploymentStatus) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*DeploymentStatus)GetNodeID ¶

func (d *DeploymentStatus) GetNodeID()string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*DeploymentStatus)GetRepositoryURL ¶

func (d *DeploymentStatus) GetRepositoryURL()string

GetRepositoryURL returns the RepositoryURL field if it's non-nil, zero value otherwise.

func (*DeploymentStatus)GetState ¶

func (d *DeploymentStatus) GetState()string

GetState returns the State field if it's non-nil, zero value otherwise.

func (*DeploymentStatus)GetTargetURL ¶

func (d *DeploymentStatus) GetTargetURL()string

GetTargetURL returns the TargetURL field if it's non-nil, zero value otherwise.

func (*DeploymentStatus)GetUpdatedAt ¶

func (d *DeploymentStatus) GetUpdatedAt()Timestamp

GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.

typeDeploymentStatusEvent ¶

type DeploymentStatusEvent struct {Deployment       *Deployment       `json:"deployment,omitempty"`DeploymentStatus *DeploymentStatus `json:"deployment_status,omitempty"`Repo             *Repository       `json:"repository,omitempty"`// The following fields are only populated by Webhook events.Sender       *User         `json:"sender,omitempty"`Installation *Installation `json:"installation,omitempty"`}

DeploymentStatusEvent represents a deployment status.The Webhook event name is "deployment_status".

Events of this type are not visible in timelines, they are only used to trigger hooks.

GitHub API docs:https://developer.github.com/v3/activity/events/types/#deploymentstatusevent

func (*DeploymentStatusEvent)GetDeployment ¶

func (d *DeploymentStatusEvent) GetDeployment() *Deployment

GetDeployment returns the Deployment field.

func (*DeploymentStatusEvent)GetDeploymentStatus ¶

func (d *DeploymentStatusEvent) GetDeploymentStatus() *DeploymentStatus

GetDeploymentStatus returns the DeploymentStatus field.

func (*DeploymentStatusEvent)GetInstallation ¶

func (d *DeploymentStatusEvent) GetInstallation() *Installation

GetInstallation returns the Installation field.

func (*DeploymentStatusEvent)GetRepo ¶

func (d *DeploymentStatusEvent) GetRepo() *Repository

GetRepo returns the Repo field.

func (*DeploymentStatusEvent)GetSender ¶

func (d *DeploymentStatusEvent) GetSender() *User

GetSender returns the Sender field.

typeDeploymentStatusRequest ¶

type DeploymentStatusRequest struct {State          *string `json:"state,omitempty"`LogURL         *string `json:"log_url,omitempty"`Description    *string `json:"description,omitempty"`Environment    *string `json:"environment,omitempty"`EnvironmentURL *string `json:"environment_url,omitempty"`AutoInactive   *bool   `json:"auto_inactive,omitempty"`}

DeploymentStatusRequest represents a deployment request

func (*DeploymentStatusRequest)GetAutoInactive ¶

func (d *DeploymentStatusRequest) GetAutoInactive()bool

GetAutoInactive returns the AutoInactive field if it's non-nil, zero value otherwise.

func (*DeploymentStatusRequest)GetDescription ¶

func (d *DeploymentStatusRequest) GetDescription()string

GetDescription returns the Description field if it's non-nil, zero value otherwise.

func (*DeploymentStatusRequest)GetEnvironment ¶

func (d *DeploymentStatusRequest) GetEnvironment()string

GetEnvironment returns the Environment field if it's non-nil, zero value otherwise.

func (*DeploymentStatusRequest)GetEnvironmentURL ¶

func (d *DeploymentStatusRequest) GetEnvironmentURL()string

GetEnvironmentURL returns the EnvironmentURL field if it's non-nil, zero value otherwise.

func (*DeploymentStatusRequest)GetLogURL ¶

func (d *DeploymentStatusRequest) GetLogURL()string

GetLogURL returns the LogURL field if it's non-nil, zero value otherwise.

func (*DeploymentStatusRequest)GetState ¶

func (d *DeploymentStatusRequest) GetState()string

GetState returns the State field if it's non-nil, zero value otherwise.

typeDeploymentsListOptions ¶

type DeploymentsListOptions struct {// SHA of the Deployment.SHAstring `url:"sha,omitempty"`// List deployments for a given ref.Refstring `url:"ref,omitempty"`// List deployments for a given task.Taskstring `url:"task,omitempty"`// List deployments for a given environment.Environmentstring `url:"environment,omitempty"`ListOptions}

DeploymentsListOptions specifies the optional parameters to theRepositoriesService.ListDeployments method.

typeDiscussionComment ¶

type DiscussionComment struct {Author        *User      `json:"author,omitempty"`Body          *string    `json:"body,omitempty"`BodyHTML      *string    `json:"body_html,omitempty"`BodyVersion   *string    `json:"body_version,omitempty"`CreatedAt     *Timestamp `json:"created_at,omitempty"`LastEditedAt  *Timestamp `json:"last_edited_at,omitempty"`DiscussionURL *string    `json:"discussion_url,omitempty"`HTMLURL       *string    `json:"html_url,omitempty"`NodeID        *string    `json:"node_id,omitempty"`Number        *int       `json:"number,omitempty"`UpdatedAt     *Timestamp `json:"updated_at,omitempty"`URL           *string    `json:"url,omitempty"`Reactions     *Reactions `json:"reactions,omitempty"`}

DiscussionComment represents a GitHub dicussion in a team.

func (*DiscussionComment)GetAuthor ¶

func (d *DiscussionComment) GetAuthor() *User

GetAuthor returns the Author field.

func (*DiscussionComment)GetBody ¶

func (d *DiscussionComment) GetBody()string

GetBody returns the Body field if it's non-nil, zero value otherwise.

func (*DiscussionComment)GetBodyHTML ¶

func (d *DiscussionComment) GetBodyHTML()string

GetBodyHTML returns the BodyHTML field if it's non-nil, zero value otherwise.

func (*DiscussionComment)GetBodyVersion ¶

func (d *DiscussionComment) GetBodyVersion()string

GetBodyVersion returns the BodyVersion field if it's non-nil, zero value otherwise.

func (*DiscussionComment)GetCreatedAt ¶

func (d *DiscussionComment) GetCreatedAt()Timestamp

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*DiscussionComment)GetDiscussionURL ¶

func (d *DiscussionComment) GetDiscussionURL()string

GetDiscussionURL returns the DiscussionURL field if it's non-nil, zero value otherwise.

func (*DiscussionComment)GetHTMLURL ¶

func (d *DiscussionComment) GetHTMLURL()string

GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.

func (*DiscussionComment)GetLastEditedAt ¶

func (d *DiscussionComment) GetLastEditedAt()Timestamp

GetLastEditedAt returns the LastEditedAt field if it's non-nil, zero value otherwise.

func (*DiscussionComment)GetNodeID ¶

func (d *DiscussionComment) GetNodeID()string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*DiscussionComment)GetNumber ¶

func (d *DiscussionComment) GetNumber()int

GetNumber returns the Number field if it's non-nil, zero value otherwise.

func (*DiscussionComment)GetReactions ¶

func (d *DiscussionComment) GetReactions() *Reactions

GetReactions returns the Reactions field.

func (*DiscussionComment)GetURL ¶

func (d *DiscussionComment) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (*DiscussionComment)GetUpdatedAt ¶

func (d *DiscussionComment) GetUpdatedAt()Timestamp

GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.

func (DiscussionComment)String ¶

func (cDiscussionComment) String()string

typeDiscussionCommentListOptions ¶

type DiscussionCommentListOptions struct {// Sorts the discussion comments by the date they were created.// Accepted values are asc and desc. Default is desc.Directionstring `url:"direction,omitempty"`}

DiscussionCommentListOptions specifies optional parameters to theTeamServices.ListComments method.

typeDiscussionListOptions ¶

type DiscussionListOptions struct {// Sorts the discussion by the date they were created.// Accepted values are asc and desc. Default is desc.Directionstring `url:"direction,omitempty"`}

DiscussionListOptions specifies optional parameters to theTeamServices.ListDiscussions method.

typeDismissalRestrictions ¶

type DismissalRestrictions struct {// The list of users who can dimiss pull request reviews.Users []*User `json:"users"`// The list of teams which can dismiss pull request reviews.Teams []*Team `json:"teams"`}

DismissalRestrictions specifies which users and teams can dismiss pull request reviews.

typeDismissalRestrictionsRequest ¶

type DismissalRestrictionsRequest struct {// The list of user logins who can dismiss pull request reviews. (Required; use nil to disable dismissal_restrictions or &[]string{} otherwise.)Users *[]string `json:"users,omitempty"`// The list of team slugs which can dismiss pull request reviews. (Required; use nil to disable dismissal_restrictions or &[]string{} otherwise.)Teams *[]string `json:"teams,omitempty"`}

DismissalRestrictionsRequest represents the request to create/edit therestriction to allows only specific users or teams to dimiss pull request reviews. It isseparate from DismissalRestrictions above because the request structure isdifferent from the response structure.Note: Both Users and Teams must be nil, or both must be non-nil.

func (*DismissalRestrictionsRequest)GetTeams ¶

func (d *DismissalRestrictionsRequest) GetTeams() []string

GetTeams returns the Teams field if it's non-nil, zero value otherwise.

func (*DismissalRestrictionsRequest)GetUsers ¶

func (d *DismissalRestrictionsRequest) GetUsers() []string

GetUsers returns the Users field if it's non-nil, zero value otherwise.

typeDismissedReview ¶

type DismissedReview struct {// State represents the state of the dismissed review.// Possible values are: "commented", "approved", and "changes_requested".State             *string `json:"state,omitempty"`ReviewID          *int64  `json:"review_id,omitempty"`DismissalMessage  *string `json:"dismissal_message,omitempty"`DismissalCommitID *string `json:"dismissal_commit_id,omitempty"`}

DismissedReview represents details for 'dismissed_review' events.

func (*DismissedReview)GetDismissalCommitID ¶

func (d *DismissedReview) GetDismissalCommitID()string

GetDismissalCommitID returns the DismissalCommitID field if it's non-nil, zero value otherwise.

func (*DismissedReview)GetDismissalMessage ¶

func (d *DismissedReview) GetDismissalMessage()string

GetDismissalMessage returns the DismissalMessage field if it's non-nil, zero value otherwise.

func (*DismissedReview)GetReviewID ¶

func (d *DismissedReview) GetReviewID()int64

GetReviewID returns the ReviewID field if it's non-nil, zero value otherwise.

func (*DismissedReview)GetState ¶

func (d *DismissedReview) GetState()string

GetState returns the State field if it's non-nil, zero value otherwise.

typeDispatchRequestOptions ¶

type DispatchRequestOptions struct {// EventType is a custom webhook event name. (Required.)EventTypestring `json:"event_type"`// ClientPayload is a custom JSON payload with extra information about the webhook event.// Defaults to an empty JSON object.ClientPayload *json.RawMessage `json:"client_payload,omitempty"`}

DispatchRequestOptions represents a request to trigger a repository_dispatch event.

func (*DispatchRequestOptions)GetClientPayload ¶

func (d *DispatchRequestOptions) GetClientPayload()json.RawMessage

GetClientPayload returns the ClientPayload field if it's non-nil, zero value otherwise.

typeDraftReviewComment ¶

type DraftReviewComment struct {Path     *string `json:"path,omitempty"`Position *int    `json:"position,omitempty"`Body     *string `json:"body,omitempty"`}

DraftReviewComment represents a comment part of the review.

func (*DraftReviewComment)GetBody ¶

func (d *DraftReviewComment) GetBody()string

GetBody returns the Body field if it's non-nil, zero value otherwise.

func (*DraftReviewComment)GetPath ¶

func (d *DraftReviewComment) GetPath()string

GetPath returns the Path field if it's non-nil, zero value otherwise.

func (*DraftReviewComment)GetPosition ¶

func (d *DraftReviewComment) GetPosition()int

GetPosition returns the Position field if it's non-nil, zero value otherwise.

func (DraftReviewComment)String ¶

func (cDraftReviewComment) String()string

typeEditChange ¶

type EditChange struct {Title *struct {From *string `json:"from,omitempty"`} `json:"title,omitempty"`Body *struct {From *string `json:"from,omitempty"`} `json:"body,omitempty"`}

EditChange represents the changes when an issue, pull request, or comment hasbeen edited.

typeEncryptedSecret ¶added inv29.0.3

type EncryptedSecret struct {Namestring `json:"-"`KeyIDstring `json:"key_id"`EncryptedValuestring `json:"encrypted_value"`}

EncryptedSecret represents a secret that is encrypted using a public key.

The value of EncryptedValue must be your secret, encrypted withLibSodium (see documentation here:https://libsodium.gitbook.io/doc/bindings_for_other_languages)using the public key retrieved using the GetPublicKey method.

typeEnterprise ¶

type Enterprise struct {ID          *int       `json:"id,omitempty"`Slug        *string    `json:"slug,omitempty"`Name        *string    `json:"name,omitempty"`NodeID      *string    `json:"node_id,omitempty"`AvatarURL   *string    `json:"avatar_url,omitempty"`Description *string    `json:"description,omitempty"`WebsiteURL  *string    `json:"website_url,omitempty"`HTMLURL     *string    `json:"html_url,omitempty"`CreatedAt   *Timestamp `json:"created_at,omitempty"`UpdatedAt   *Timestamp `json:"updated_at,omitempty"`}

Enterprise represents the GitHub enterprise profile.

func (*Enterprise)GetAvatarURL ¶

func (e *Enterprise) GetAvatarURL()string

GetAvatarURL returns the AvatarURL field if it's non-nil, zero value otherwise.

func (*Enterprise)GetCreatedAt ¶

func (e *Enterprise) GetCreatedAt()Timestamp

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*Enterprise)GetDescription ¶

func (e *Enterprise) GetDescription()string

GetDescription returns the Description field if it's non-nil, zero value otherwise.

func (*Enterprise)GetHTMLURL ¶

func (e *Enterprise) GetHTMLURL()string

GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.

func (*Enterprise)GetID ¶

func (e *Enterprise) GetID()int

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*Enterprise)GetName ¶

func (e *Enterprise) GetName()string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (*Enterprise)GetNodeID ¶

func (e *Enterprise) GetNodeID()string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*Enterprise)GetSlug ¶

func (e *Enterprise) GetSlug()string

GetSlug returns the Slug field if it's non-nil, zero value otherwise.

func (*Enterprise)GetUpdatedAt ¶

func (e *Enterprise) GetUpdatedAt()Timestamp

GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.

func (*Enterprise)GetWebsiteURL ¶

func (e *Enterprise) GetWebsiteURL()string

GetWebsiteURL returns the WebsiteURL field if it's non-nil, zero value otherwise.

func (Enterprise)String ¶

func (mEnterprise) String()string

typeError ¶

type Error struct {Resourcestring `json:"resource"`// resource on which the error occurredFieldstring `json:"field"`// field on which the error occurredCodestring `json:"code"`// validation error codeMessagestring `json:"message"`// Message describing the error. Errors with Code == "custom" will always have this set.}

An Error reports more details on an individual error in an ErrorResponse.These are the possible validation error codes:

missing:    resource does not existmissing_field:    a required field on a resource has not been setinvalid:    the formatting of a field is invalidalready_exists:    another resource has the same valid as this fieldcustom:    some resources return this (e.g. github.User.CreateKey()), additional    information is set in the Message field of the Error

GitHub error responses structure are often undocumented and inconsistent.Sometimes error is just a simple string (Issue #540).In such cases, Message represents an error message as a workaround.

GitHub API docs:https://developer.github.com/v3/#client-errors

func (*Error)Error ¶

func (e *Error) Error()string

func (*Error)UnmarshalJSON ¶

func (e *Error) UnmarshalJSON(data []byte)error

typeErrorResponse ¶

type ErrorResponse struct {Response *http.Response// HTTP response that caused this errorMessagestring         `json:"message"`// error messageErrors   []Error        `json:"errors"`// more detail on individual errors// Block is only populated on certain types of errors such as code 451.// Seehttps://developer.github.com/changes/2016-03-17-the-451-status-code-is-now-supported/// for more information.Block *struct {Reasonstring     `json:"reason,omitempty"`CreatedAt *Timestamp `json:"created_at,omitempty"`} `json:"block,omitempty"`// Most errors will also include a documentation_url field pointing// to some content that might help you resolve the error, see//https://developer.github.com/v3/#client-errorsDocumentationURLstring `json:"documentation_url,omitempty"`}

An ErrorResponse reports one or more errors caused by an API request.

GitHub API docs:https://developer.github.com/v3/#client-errors

func (*ErrorResponse)Error ¶

func (r *ErrorResponse) Error()string

typeEvent ¶

type Event struct {Type       *string          `json:"type,omitempty"`Public     *bool            `json:"public,omitempty"`RawPayload *json.RawMessage `json:"payload,omitempty"`Repo       *Repository      `json:"repo,omitempty"`Actor      *User            `json:"actor,omitempty"`Org        *Organization    `json:"org,omitempty"`CreatedAt  *time.Time       `json:"created_at,omitempty"`ID         *string          `json:"id,omitempty"`}

Event represents a GitHub event.

func (*Event)GetActor ¶

func (e *Event) GetActor() *User

GetActor returns the Actor field.

func (*Event)GetCreatedAt ¶

func (e *Event) GetCreatedAt()time.Time

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*Event)GetID ¶

func (e *Event) GetID()string

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*Event)GetOrg ¶

func (e *Event) GetOrg() *Organization

GetOrg returns the Org field.

func (*Event)GetPublic ¶

func (e *Event) GetPublic()bool

GetPublic returns the Public field if it's non-nil, zero value otherwise.

func (*Event)GetRawPayload ¶

func (e *Event) GetRawPayload()json.RawMessage

GetRawPayload returns the RawPayload field if it's non-nil, zero value otherwise.

func (*Event)GetRepo ¶

func (e *Event) GetRepo() *Repository

GetRepo returns the Repo field.

func (*Event)GetType ¶

func (e *Event) GetType()string

GetType returns the Type field if it's non-nil, zero value otherwise.

func (*Event)ParsePayload ¶

func (e *Event) ParsePayload() (payload interface{}, errerror)

ParsePayload parses the event payload. For recognized event types,a value of the corresponding struct type will be returned.

func (*Event)Payloaddeprecated

func (e *Event) Payload() (payload interface{})

Payload returns the parsed event payload. For recognized event types,a value of the corresponding struct type will be returned.

Deprecated: Use ParsePayload instead, which returns an errorrather than panics if JSON unmarshaling raw payload fails.

func (Event)String ¶

func (eEvent) String()string

typeFeedLink ¶

type FeedLink struct {HRef *string `json:"href,omitempty"`Type *string `json:"type,omitempty"`}

FeedLink represents a link to a related resource.

func (*FeedLink)GetHRef ¶

func (f *FeedLink) GetHRef()string

GetHRef returns the HRef field if it's non-nil, zero value otherwise.

func (*FeedLink)GetType ¶

func (f *FeedLink) GetType()string

GetType returns the Type field if it's non-nil, zero value otherwise.

typeFeeds ¶

type Feeds struct {TimelineURL                 *string  `json:"timeline_url,omitempty"`UserURL                     *string  `json:"user_url,omitempty"`CurrentUserPublicURL        *string  `json:"current_user_public_url,omitempty"`CurrentUserURL              *string  `json:"current_user_url,omitempty"`CurrentUserActorURL         *string  `json:"current_user_actor_url,omitempty"`CurrentUserOrganizationURL  *string  `json:"current_user_organization_url,omitempty"`CurrentUserOrganizationURLs []string `json:"current_user_organization_urls,omitempty"`Links                       *struct {Timeline                 *FeedLink  `json:"timeline,omitempty"`User                     *FeedLink  `json:"user,omitempty"`CurrentUserPublic        *FeedLink  `json:"current_user_public,omitempty"`CurrentUser              *FeedLink  `json:"current_user,omitempty"`CurrentUserActor         *FeedLink  `json:"current_user_actor,omitempty"`CurrentUserOrganization  *FeedLink  `json:"current_user_organization,omitempty"`CurrentUserOrganizations []FeedLink `json:"current_user_organizations,omitempty"`} `json:"_links,omitempty"`}

Feeds represents timeline resources in Atom format.

func (*Feeds)GetCurrentUserActorURL ¶

func (f *Feeds) GetCurrentUserActorURL()string

GetCurrentUserActorURL returns the CurrentUserActorURL field if it's non-nil, zero value otherwise.

func (*Feeds)GetCurrentUserOrganizationURL ¶

func (f *Feeds) GetCurrentUserOrganizationURL()string

GetCurrentUserOrganizationURL returns the CurrentUserOrganizationURL field if it's non-nil, zero value otherwise.

func (*Feeds)GetCurrentUserPublicURL ¶

func (f *Feeds) GetCurrentUserPublicURL()string

GetCurrentUserPublicURL returns the CurrentUserPublicURL field if it's non-nil, zero value otherwise.

func (*Feeds)GetCurrentUserURL ¶

func (f *Feeds) GetCurrentUserURL()string

GetCurrentUserURL returns the CurrentUserURL field if it's non-nil, zero value otherwise.

func (*Feeds)GetTimelineURL ¶

func (f *Feeds) GetTimelineURL()string

GetTimelineURL returns the TimelineURL field if it's non-nil, zero value otherwise.

func (*Feeds)GetUserURL ¶

func (f *Feeds) GetUserURL()string

GetUserURL returns the UserURL field if it's non-nil, zero value otherwise.

typeForkEvent ¶

type ForkEvent struct {// Forkee is the created repository.Forkee *Repository `json:"forkee,omitempty"`// The following fields are only populated by Webhook events.Repo         *Repository   `json:"repository,omitempty"`Sender       *User         `json:"sender,omitempty"`Installation *Installation `json:"installation,omitempty"`}

ForkEvent is triggered when a user forks a repository.The Webhook event name is "fork".

GitHub API docs:https://developer.github.com/v3/activity/events/types/#forkevent

func (*ForkEvent)GetForkee ¶

func (f *ForkEvent) GetForkee() *Repository

GetForkee returns the Forkee field.

func (*ForkEvent)GetInstallation ¶

func (f *ForkEvent) GetInstallation() *Installation

GetInstallation returns the Installation field.

func (*ForkEvent)GetRepo ¶

func (f *ForkEvent) GetRepo() *Repository

GetRepo returns the Repo field.

func (*ForkEvent)GetSender ¶

func (f *ForkEvent) GetSender() *User

GetSender returns the Sender field.

typeGPGEmail ¶

type GPGEmail struct {Email    *string `json:"email,omitempty"`Verified *bool   `json:"verified,omitempty"`}

GPGEmail represents an email address associated to a GPG key.

func (*GPGEmail)GetEmail ¶

func (g *GPGEmail) GetEmail()string

GetEmail returns the Email field if it's non-nil, zero value otherwise.

func (*GPGEmail)GetVerified ¶

func (g *GPGEmail) GetVerified()bool

GetVerified returns the Verified field if it's non-nil, zero value otherwise.

typeGPGKey ¶

type GPGKey struct {ID                *int64     `json:"id,omitempty"`PrimaryKeyID      *int64     `json:"primary_key_id,omitempty"`KeyID             *string    `json:"key_id,omitempty"`PublicKey         *string    `json:"public_key,omitempty"`Emails            []GPGEmail `json:"emails,omitempty"`Subkeys           []GPGKey   `json:"subkeys,omitempty"`CanSign           *bool      `json:"can_sign,omitempty"`CanEncryptComms   *bool      `json:"can_encrypt_comms,omitempty"`CanEncryptStorage *bool      `json:"can_encrypt_storage,omitempty"`CanCertify        *bool      `json:"can_certify,omitempty"`CreatedAt         *time.Time `json:"created_at,omitempty"`ExpiresAt         *time.Time `json:"expires_at,omitempty"`}

GPGKey represents a GitHub user's public GPG key used to verify GPG signed commits and tags.

https://developer.github.com/changes/2016-04-04-git-signing-api-preview/

func (*GPGKey)GetCanCertify ¶

func (g *GPGKey) GetCanCertify()bool

GetCanCertify returns the CanCertify field if it's non-nil, zero value otherwise.

func (*GPGKey)GetCanEncryptComms ¶

func (g *GPGKey) GetCanEncryptComms()bool

GetCanEncryptComms returns the CanEncryptComms field if it's non-nil, zero value otherwise.

func (*GPGKey)GetCanEncryptStorage ¶

func (g *GPGKey) GetCanEncryptStorage()bool

GetCanEncryptStorage returns the CanEncryptStorage field if it's non-nil, zero value otherwise.

func (*GPGKey)GetCanSign ¶

func (g *GPGKey) GetCanSign()bool

GetCanSign returns the CanSign field if it's non-nil, zero value otherwise.

func (*GPGKey)GetCreatedAt ¶

func (g *GPGKey) GetCreatedAt()time.Time

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*GPGKey)GetExpiresAt ¶

func (g *GPGKey) GetExpiresAt()time.Time

GetExpiresAt returns the ExpiresAt field if it's non-nil, zero value otherwise.

func (*GPGKey)GetID ¶

func (g *GPGKey) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*GPGKey)GetKeyID ¶

func (g *GPGKey) GetKeyID()string

GetKeyID returns the KeyID field if it's non-nil, zero value otherwise.

func (*GPGKey)GetPrimaryKeyID ¶

func (g *GPGKey) GetPrimaryKeyID()int64

GetPrimaryKeyID returns the PrimaryKeyID field if it's non-nil, zero value otherwise.

func (*GPGKey)GetPublicKey ¶

func (g *GPGKey) GetPublicKey()string

GetPublicKey returns the PublicKey field if it's non-nil, zero value otherwise.

func (GPGKey)String ¶

func (kGPGKey) String()string

String stringifies a GPGKey.

typeGist ¶

type Gist struct {ID          *string                   `json:"id,omitempty"`Description *string                   `json:"description,omitempty"`Public      *bool                     `json:"public,omitempty"`Owner       *User                     `json:"owner,omitempty"`Files       map[GistFilename]GistFile `json:"files,omitempty"`Comments    *int                      `json:"comments,omitempty"`HTMLURL     *string                   `json:"html_url,omitempty"`GitPullURL  *string                   `json:"git_pull_url,omitempty"`GitPushURL  *string                   `json:"git_push_url,omitempty"`CreatedAt   *time.Time                `json:"created_at,omitempty"`UpdatedAt   *time.Time                `json:"updated_at,omitempty"`NodeID      *string                   `json:"node_id,omitempty"`}

Gist represents a GitHub's gist.

func (*Gist)GetComments ¶

func (g *Gist) GetComments()int

GetComments returns the Comments field if it's non-nil, zero value otherwise.

func (*Gist)GetCreatedAt ¶

func (g *Gist) GetCreatedAt()time.Time

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*Gist)GetDescription ¶

func (g *Gist) GetDescription()string

GetDescription returns the Description field if it's non-nil, zero value otherwise.

func (*Gist)GetGitPullURL ¶

func (g *Gist) GetGitPullURL()string

GetGitPullURL returns the GitPullURL field if it's non-nil, zero value otherwise.

func (*Gist)GetGitPushURL ¶

func (g *Gist) GetGitPushURL()string

GetGitPushURL returns the GitPushURL field if it's non-nil, zero value otherwise.

func (*Gist)GetHTMLURL ¶

func (g *Gist) GetHTMLURL()string

GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.

func (*Gist)GetID ¶

func (g *Gist) GetID()string

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*Gist)GetNodeID ¶

func (g *Gist) GetNodeID()string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*Gist)GetOwner ¶

func (g *Gist) GetOwner() *User

GetOwner returns the Owner field.

func (*Gist)GetPublic ¶

func (g *Gist) GetPublic()bool

GetPublic returns the Public field if it's non-nil, zero value otherwise.

func (*Gist)GetUpdatedAt ¶

func (g *Gist) GetUpdatedAt()time.Time

GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.

func (Gist)String ¶

func (gGist) String()string

typeGistComment ¶

type GistComment struct {ID        *int64     `json:"id,omitempty"`URL       *string    `json:"url,omitempty"`Body      *string    `json:"body,omitempty"`User      *User      `json:"user,omitempty"`CreatedAt *time.Time `json:"created_at,omitempty"`}

GistComment represents a Gist comment.

func (*GistComment)GetBody ¶

func (g *GistComment) GetBody()string

GetBody returns the Body field if it's non-nil, zero value otherwise.

func (*GistComment)GetCreatedAt ¶

func (g *GistComment) GetCreatedAt()time.Time

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*GistComment)GetID ¶

func (g *GistComment) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*GistComment)GetURL ¶

func (g *GistComment) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (*GistComment)GetUser ¶

func (g *GistComment) GetUser() *User

GetUser returns the User field.

func (GistComment)String ¶

func (gGistComment) String()string

typeGistCommit ¶

type GistCommit struct {URL          *string      `json:"url,omitempty"`Version      *string      `json:"version,omitempty"`User         *User        `json:"user,omitempty"`ChangeStatus *CommitStats `json:"change_status,omitempty"`CommittedAt  *Timestamp   `json:"committed_at,omitempty"`NodeID       *string      `json:"node_id,omitempty"`}

GistCommit represents a commit on a gist.

func (*GistCommit)GetChangeStatus ¶

func (g *GistCommit) GetChangeStatus() *CommitStats

GetChangeStatus returns the ChangeStatus field.

func (*GistCommit)GetCommittedAt ¶

func (g *GistCommit) GetCommittedAt()Timestamp

GetCommittedAt returns the CommittedAt field if it's non-nil, zero value otherwise.

func (*GistCommit)GetNodeID ¶

func (g *GistCommit) GetNodeID()string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*GistCommit)GetURL ¶

func (g *GistCommit) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (*GistCommit)GetUser ¶

func (g *GistCommit) GetUser() *User

GetUser returns the User field.

func (*GistCommit)GetVersion ¶

func (g *GistCommit) GetVersion()string

GetVersion returns the Version field if it's non-nil, zero value otherwise.

func (GistCommit)String ¶

func (gcGistCommit) String()string

typeGistFile ¶

type GistFile struct {Size     *int    `json:"size,omitempty"`Filename *string `json:"filename,omitempty"`Language *string `json:"language,omitempty"`Type     *string `json:"type,omitempty"`RawURL   *string `json:"raw_url,omitempty"`Content  *string `json:"content,omitempty"`}

GistFile represents a file on a gist.

func (*GistFile)GetContent ¶

func (g *GistFile) GetContent()string

GetContent returns the Content field if it's non-nil, zero value otherwise.

func (*GistFile)GetFilename ¶

func (g *GistFile) GetFilename()string

GetFilename returns the Filename field if it's non-nil, zero value otherwise.

func (*GistFile)GetLanguage ¶

func (g *GistFile) GetLanguage()string

GetLanguage returns the Language field if it's non-nil, zero value otherwise.

func (*GistFile)GetRawURL ¶

func (g *GistFile) GetRawURL()string

GetRawURL returns the RawURL field if it's non-nil, zero value otherwise.

func (*GistFile)GetSize ¶

func (g *GistFile) GetSize()int

GetSize returns the Size field if it's non-nil, zero value otherwise.

func (*GistFile)GetType ¶

func (g *GistFile) GetType()string

GetType returns the Type field if it's non-nil, zero value otherwise.

func (GistFile)String ¶

func (gGistFile) String()string

typeGistFilename ¶

type GistFilenamestring

GistFilename represents filename on a gist.

typeGistFork ¶

type GistFork struct {URL       *string    `json:"url,omitempty"`User      *User      `json:"user,omitempty"`ID        *string    `json:"id,omitempty"`CreatedAt *Timestamp `json:"created_at,omitempty"`UpdatedAt *Timestamp `json:"updated_at,omitempty"`NodeID    *string    `json:"node_id,omitempty"`}

GistFork represents a fork of a gist.

func (*GistFork)GetCreatedAt ¶

func (g *GistFork) GetCreatedAt()Timestamp

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*GistFork)GetID ¶

func (g *GistFork) GetID()string

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*GistFork)GetNodeID ¶

func (g *GistFork) GetNodeID()string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*GistFork)GetURL ¶

func (g *GistFork) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (*GistFork)GetUpdatedAt ¶

func (g *GistFork) GetUpdatedAt()Timestamp

GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.

func (*GistFork)GetUser ¶

func (g *GistFork) GetUser() *User

GetUser returns the User field.

func (GistFork)String ¶

func (gfGistFork) String()string

typeGistListOptions ¶

type GistListOptions struct {// Since filters Gists by time.Sincetime.Time `url:"since,omitempty"`ListOptions}

GistListOptions specifies the optional parameters to theGistsService.List, GistsService.ListAll, and GistsService.ListStarred methods.

typeGistStats ¶

type GistStats struct {TotalGists   *int `json:"total_gists,omitempty"`PrivateGists *int `json:"private_gists,omitempty"`PublicGists  *int `json:"public_gists,omitempty"`}

GistStats represents the number of total, private and public gists.

func (*GistStats)GetPrivateGists ¶

func (g *GistStats) GetPrivateGists()int

GetPrivateGists returns the PrivateGists field if it's non-nil, zero value otherwise.

func (*GistStats)GetPublicGists ¶

func (g *GistStats) GetPublicGists()int

GetPublicGists returns the PublicGists field if it's non-nil, zero value otherwise.

func (*GistStats)GetTotalGists ¶

func (g *GistStats) GetTotalGists()int

GetTotalGists returns the TotalGists field if it's non-nil, zero value otherwise.

func (GistStats)String ¶

func (sGistStats) String()string

typeGistsService ¶

type GistsService service

GistsService handles communication with the Gist relatedmethods of the GitHub API.

GitHub API docs:https://developer.github.com/v3/gists/

func (*GistsService)Create ¶

func (s *GistsService) Create(ctxcontext.Context, gist *Gist) (*Gist, *Response,error)

Create a gist for authenticated user.

GitHub API docs:https://developer.github.com/v3/gists/#create-a-gist

func (*GistsService)CreateComment ¶

func (s *GistsService) CreateComment(ctxcontext.Context, gistIDstring, comment *GistComment) (*GistComment, *Response,error)

CreateComment creates a comment for a gist.

GitHub API docs:https://developer.github.com/v3/gists/comments/#create-a-comment

func (*GistsService)Delete ¶

func (s *GistsService) Delete(ctxcontext.Context, idstring) (*Response,error)

Delete a gist.

GitHub API docs:https://developer.github.com/v3/gists/#delete-a-gist

func (*GistsService)DeleteComment ¶

func (s *GistsService) DeleteComment(ctxcontext.Context, gistIDstring, commentIDint64) (*Response,error)

DeleteComment deletes a gist comment.

GitHub API docs:https://developer.github.com/v3/gists/comments/#delete-a-comment

func (*GistsService)Edit ¶

func (s *GistsService) Edit(ctxcontext.Context, idstring, gist *Gist) (*Gist, *Response,error)

Edit a gist.

GitHub API docs:https://developer.github.com/v3/gists/#edit-a-gist

func (*GistsService)EditComment ¶

func (s *GistsService) EditComment(ctxcontext.Context, gistIDstring, commentIDint64, comment *GistComment) (*GistComment, *Response,error)

EditComment edits an existing gist comment.

GitHub API docs:https://developer.github.com/v3/gists/comments/#edit-a-comment

func (*GistsService)Fork ¶

func (s *GistsService) Fork(ctxcontext.Context, idstring) (*Gist, *Response,error)

Fork a gist.

GitHub API docs:https://developer.github.com/v3/gists/#fork-a-gist

func (*GistsService)Get ¶

func (s *GistsService) Get(ctxcontext.Context, idstring) (*Gist, *Response,error)

Get a single gist.

GitHub API docs:https://developer.github.com/v3/gists/#get-a-single-gist

func (*GistsService)GetComment ¶

func (s *GistsService) GetComment(ctxcontext.Context, gistIDstring, commentIDint64) (*GistComment, *Response,error)

GetComment retrieves a single comment from a gist.

GitHub API docs:https://developer.github.com/v3/gists/comments/#get-a-single-comment

func (*GistsService)GetRevision ¶

func (s *GistsService) GetRevision(ctxcontext.Context, id, shastring) (*Gist, *Response,error)

GetRevision gets a specific revision of a gist.

GitHub API docs:https://developer.github.com/v3/gists/#get-a-specific-revision-of-a-gist

func (*GistsService)IsStarred ¶

func (s *GistsService) IsStarred(ctxcontext.Context, idstring) (bool, *Response,error)

IsStarred checks if a gist is starred by authenticated user.

GitHub API docs:https://developer.github.com/v3/gists/#check-if-a-gist-is-starred

func (*GistsService)List ¶

func (s *GistsService) List(ctxcontext.Context, userstring, opts *GistListOptions) ([]*Gist, *Response,error)

List gists for a user. Passing the empty string will listall public gists if called anonymously. However, if the callis authenticated, it will returns all gists for the authenticateduser.

GitHub API docs:https://developer.github.com/v3/gists/#list-gists

func (*GistsService)ListAll ¶

func (s *GistsService) ListAll(ctxcontext.Context, opts *GistListOptions) ([]*Gist, *Response,error)

ListAll lists all public gists.

GitHub API docs:https://developer.github.com/v3/gists/#list-gists

func (*GistsService)ListComments ¶

func (s *GistsService) ListComments(ctxcontext.Context, gistIDstring, opts *ListOptions) ([]*GistComment, *Response,error)

ListComments lists all comments for a gist.

GitHub API docs:https://developer.github.com/v3/gists/comments/#list-comments-on-a-gist

func (*GistsService)ListCommits ¶

func (s *GistsService) ListCommits(ctxcontext.Context, idstring, opts *ListOptions) ([]*GistCommit, *Response,error)

ListCommits lists commits of a gist.

GitHub API docs:https://developer.github.com/v3/gists/#list-gist-commits

func (*GistsService)ListForks ¶

func (s *GistsService) ListForks(ctxcontext.Context, idstring, opts *ListOptions) ([]*GistFork, *Response,error)

ListForks lists forks of a gist.

GitHub API docs:https://developer.github.com/v3/gists/#list-gist-forks

func (*GistsService)ListStarred ¶

func (s *GistsService) ListStarred(ctxcontext.Context, opts *GistListOptions) ([]*Gist, *Response,error)

ListStarred lists starred gists of authenticated user.

GitHub API docs:https://developer.github.com/v3/gists/#list-gists

func (*GistsService)Star ¶

func (s *GistsService) Star(ctxcontext.Context, idstring) (*Response,error)

Star a gist on behalf of authenticated user.

GitHub API docs:https://developer.github.com/v3/gists/#star-a-gist

func (*GistsService)Unstar ¶

func (s *GistsService) Unstar(ctxcontext.Context, idstring) (*Response,error)

Unstar a gist on a behalf of authenticated user.

GitHub API docs:https://developer.github.com/v3/gists/#unstar-a-gist

typeGitHubAppAuthorizationEvent ¶

type GitHubAppAuthorizationEvent struct {// The action performed. Possible value is: "revoked".Action *string `json:"action,omitempty"`// The following fields are only populated by Webhook events.Sender *User `json:"sender,omitempty"`}

GitHubAppAuthorizationEvent is triggered when a user's authorization for aGitHub Application is revoked.

GitHub API docs:https://developer.github.com/v3/activity/events/types/#githubappauthorizationevent

func (*GitHubAppAuthorizationEvent)GetAction ¶

func (g *GitHubAppAuthorizationEvent) GetAction()string

GetAction returns the Action field if it's non-nil, zero value otherwise.

func (*GitHubAppAuthorizationEvent)GetSender ¶

func (g *GitHubAppAuthorizationEvent) GetSender() *User

GetSender returns the Sender field.

typeGitObject ¶

type GitObject struct {Type *string `json:"type"`SHA  *string `json:"sha"`URL  *string `json:"url"`}

GitObject represents a Git object.

func (*GitObject)GetSHA ¶

func (g *GitObject) GetSHA()string

GetSHA returns the SHA field if it's non-nil, zero value otherwise.

func (*GitObject)GetType ¶

func (g *GitObject) GetType()string

GetType returns the Type field if it's non-nil, zero value otherwise.

func (*GitObject)GetURL ¶

func (g *GitObject) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (GitObject)String ¶

func (oGitObject) String()string

typeGitService ¶

type GitService service

GitService handles communication with the git data relatedmethods of the GitHub API.

GitHub API docs:https://developer.github.com/v3/git/

func (*GitService)CreateBlob ¶

func (s *GitService) CreateBlob(ctxcontext.Context, ownerstring, repostring, blob *Blob) (*Blob, *Response,error)

CreateBlob creates a blob object.

GitHub API docs:https://developer.github.com/v3/git/blobs/#create-a-blob

func (*GitService)CreateCommit ¶

func (s *GitService) CreateCommit(ctxcontext.Context, ownerstring, repostring, commit *Commit) (*Commit, *Response,error)

CreateCommit creates a new commit in a repository.commit must not be nil.

The commit.Committer is optional and will be filled with the commit.Authordata if omitted. If the commit.Author is omitted, it will be filled in withthe authenticated user’s information and the current date.

GitHub API docs:https://developer.github.com/v3/git/commits/#create-a-commit

func (*GitService)CreateRef ¶

func (s *GitService) CreateRef(ctxcontext.Context, ownerstring, repostring, ref *Reference) (*Reference, *Response,error)

CreateRef creates a new ref in a repository.

GitHub API docs:https://developer.github.com/v3/git/refs/#create-a-reference

func (*GitService)CreateTag ¶

func (s *GitService) CreateTag(ctxcontext.Context, ownerstring, repostring, tag *Tag) (*Tag, *Response,error)

CreateTag creates a tag object.

GitHub API docs:https://developer.github.com/v3/git/tags/#create-a-tag-object

func (*GitService)CreateTree ¶

func (s *GitService) CreateTree(ctxcontext.Context, ownerstring, repostring, baseTreestring, entries []TreeEntry) (*Tree, *Response,error)

CreateTree creates a new tree in a repository. If both a tree and a nestedpath modifying that tree are specified, it will overwrite the contents ofthat tree with the new path contents and write a new tree out.

GitHub API docs:https://developer.github.com/v3/git/trees/#create-a-tree

func (*GitService)DeleteRef ¶

func (s *GitService) DeleteRef(ctxcontext.Context, ownerstring, repostring, refstring) (*Response,error)

DeleteRef deletes a ref from a repository.

GitHub API docs:https://developer.github.com/v3/git/refs/#delete-a-reference

func (*GitService)GetBlob ¶

func (s *GitService) GetBlob(ctxcontext.Context, ownerstring, repostring, shastring) (*Blob, *Response,error)

GetBlob fetches a blob from a repo given a SHA.

GitHub API docs:https://developer.github.com/v3/git/blobs/#get-a-blob

func (*GitService)GetBlobRaw ¶

func (s *GitService) GetBlobRaw(ctxcontext.Context, owner, repo, shastring) ([]byte, *Response,error)

GetBlobRaw fetches a blob's contents from a repo.Unlike GetBlob, it returns the raw bytes rather than the base64-encoded data.

GitHub API docs:https://developer.github.com/v3/git/blobs/#get-a-blob

func (*GitService)GetCommit ¶

func (s *GitService) GetCommit(ctxcontext.Context, ownerstring, repostring, shastring) (*Commit, *Response,error)

GetCommit fetches the Commit object for a given SHA.

GitHub API docs:https://developer.github.com/v3/git/commits/#get-a-commit

func (*GitService)GetRef ¶

func (s *GitService) GetRef(ctxcontext.Context, ownerstring, repostring, refstring) (*Reference, *Response,error)

GetRef fetches a single Reference object for a given Git ref.If there is no exact match, GetRef will return an error.

Note: The GitHub API can return multiple matches.If you wish to use this functionality please use the GetRefs() method.

GitHub API docs:https://developer.github.com/v3/git/refs/#get-a-reference

func (*GitService)GetRefs ¶

func (s *GitService) GetRefs(ctxcontext.Context, ownerstring, repostring, refstring) ([]*Reference, *Response,error)

GetRefs fetches a slice of Reference objects for a given Git ref.If there is an exact match, only that ref is returned.If there is no exact match, GitHub returns all refs that start with ref.If returned error is nil, there will be at least 1 ref returned.For example:

"heads/featureA" -> ["refs/heads/featureA"]                         // Exact match, single ref is returned."heads/feature"  -> ["refs/heads/featureA", "refs/heads/featureB"]  // All refs that start with ref."heads/notexist" -> []                                              // Returns an error.

GitHub API docs:https://developer.github.com/v3/git/refs/#get-a-reference

func (*GitService)GetTag ¶

func (s *GitService) GetTag(ctxcontext.Context, ownerstring, repostring, shastring) (*Tag, *Response,error)

GetTag fetches a tag from a repo given a SHA.

GitHub API docs:https://developer.github.com/v3/git/tags/#get-a-tag

func (*GitService)GetTree ¶

func (s *GitService) GetTree(ctxcontext.Context, ownerstring, repostring, shastring, recursivebool) (*Tree, *Response,error)

GetTree fetches the Tree object for a given sha hash from a repository.

GitHub API docs:https://developer.github.com/v3/git/trees/#get-a-tree

func (*GitService)ListRefs ¶

func (s *GitService) ListRefs(ctxcontext.Context, owner, repostring, opts *ReferenceListOptions) ([]*Reference, *Response,error)

ListRefs lists all refs in a repository.

GitHub API docs:https://developer.github.com/v3/git/refs/#get-all-references

func (*GitService)UpdateRef ¶

func (s *GitService) UpdateRef(ctxcontext.Context, ownerstring, repostring, ref *Reference, forcebool) (*Reference, *Response,error)

UpdateRef updates an existing ref in a repository.

GitHub API docs:https://developer.github.com/v3/git/refs/#update-a-reference

typeGitignore ¶

type Gitignore struct {Name   *string `json:"name,omitempty"`Source *string `json:"source,omitempty"`}

Gitignore represents a .gitignore file as returned by the GitHub API.

func (*Gitignore)GetName ¶

func (g *Gitignore) GetName()string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (*Gitignore)GetSource ¶

func (g *Gitignore) GetSource()string

GetSource returns the Source field if it's non-nil, zero value otherwise.

func (Gitignore)String ¶

func (gGitignore) String()string

typeGitignoresService ¶

type GitignoresService service

GitignoresService provides access to the gitignore related functions in theGitHub API.

GitHub API docs:https://developer.github.com/v3/gitignore/

func (GitignoresService)Get ¶

func (sGitignoresService) Get(ctxcontext.Context, namestring) (*Gitignore, *Response,error)

Get a Gitignore by name.

GitHub API docs:https://developer.github.com/v3/gitignore/#get-a-single-template

func (GitignoresService)List ¶

func (sGitignoresService) List(ctxcontext.Context) ([]string, *Response,error)

List all available Gitignore templates.

GitHub API docs:https://developer.github.com/v3/gitignore/#listing-available-templates

typeGollumEvent ¶

type GollumEvent struct {Pages []*Page `json:"pages,omitempty"`// The following fields are only populated by Webhook events.Repo         *Repository   `json:"repository,omitempty"`Sender       *User         `json:"sender,omitempty"`Installation *Installation `json:"installation,omitempty"`}

GollumEvent is triggered when a Wiki page is created or updated.The Webhook event name is "gollum".

GitHub API docs:https://developer.github.com/v3/activity/events/types/#gollumevent

func (*GollumEvent)GetInstallation ¶

func (g *GollumEvent) GetInstallation() *Installation

GetInstallation returns the Installation field.

func (*GollumEvent)GetRepo ¶

func (g *GollumEvent) GetRepo() *Repository

GetRepo returns the Repo field.

func (*GollumEvent)GetSender ¶

func (g *GollumEvent) GetSender() *User

GetSender returns the Sender field.

typeGrant ¶

type Grant struct {ID        *int64            `json:"id,omitempty"`URL       *string           `json:"url,omitempty"`App       *AuthorizationApp `json:"app,omitempty"`CreatedAt *Timestamp        `json:"created_at,omitempty"`UpdatedAt *Timestamp        `json:"updated_at,omitempty"`Scopes    []string          `json:"scopes,omitempty"`}

Grant represents an OAuth application that has been granted access to an account.

func (*Grant)GetApp ¶

func (g *Grant) GetApp() *AuthorizationApp

GetApp returns the App field.

func (*Grant)GetCreatedAt ¶

func (g *Grant) GetCreatedAt()Timestamp

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*Grant)GetID ¶

func (g *Grant) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*Grant)GetURL ¶

func (g *Grant) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (*Grant)GetUpdatedAt ¶

func (g *Grant) GetUpdatedAt()Timestamp

GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.

func (Grant)String ¶

func (gGrant) String()string

typeHook ¶

type Hook struct {CreatedAt *time.Time `json:"created_at,omitempty"`UpdatedAt *time.Time `json:"updated_at,omitempty"`URL       *string    `json:"url,omitempty"`ID        *int64     `json:"id,omitempty"`// Only the following fields are used when creating a hook.// Config is required.Config map[string]interface{} `json:"config,omitempty"`Events []string               `json:"events,omitempty"`Active *bool                  `json:"active,omitempty"`}

Hook represents a GitHub (web and service) hook for a repository.

func (*Hook)GetActive ¶

func (h *Hook) GetActive()bool

GetActive returns the Active field if it's non-nil, zero value otherwise.

func (*Hook)GetCreatedAt ¶

func (h *Hook) GetCreatedAt()time.Time

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*Hook)GetID ¶

func (h *Hook) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*Hook)GetURL ¶

func (h *Hook) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (*Hook)GetUpdatedAt ¶

func (h *Hook) GetUpdatedAt()time.Time

GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.

func (Hook)String ¶

func (hHook) String()string

typeHookStats ¶

type HookStats struct {TotalHooks    *int `json:"total_hooks,omitempty"`ActiveHooks   *int `json:"active_hooks,omitempty"`InactiveHooks *int `json:"inactive_hooks,omitempty"`}

HookStats represents the number of total, active and inactive hooks.

func (*HookStats)GetActiveHooks ¶

func (h *HookStats) GetActiveHooks()int

GetActiveHooks returns the ActiveHooks field if it's non-nil, zero value otherwise.

func (*HookStats)GetInactiveHooks ¶

func (h *HookStats) GetInactiveHooks()int

GetInactiveHooks returns the InactiveHooks field if it's non-nil, zero value otherwise.

func (*HookStats)GetTotalHooks ¶

func (h *HookStats) GetTotalHooks()int

GetTotalHooks returns the TotalHooks field if it's non-nil, zero value otherwise.

func (HookStats)String ¶

func (sHookStats) String()string

typeHovercard ¶

type Hovercard struct {Contexts []*UserContext `json:"contexts,omitempty"`}

Hovercard represents hovercard information about a user.

typeHovercardOptions ¶

type HovercardOptions struct {// SubjectType specifies the additional information to be received about the hovercard.// Possible values are: organization, repository, issue, pull_request. (Required when using subject_id.)SubjectTypestring `url:"subject_type"`// SubjectID specifies the ID for the SubjectType. (Required when using subject_type.)SubjectIDstring `url:"subject_id"`}

HovercardOptions specifies optional parameters to the UsersService.GetHovercardmethod.

typeIDPGroup ¶

type IDPGroup struct {GroupID          *string `json:"group_id,omitempty"`GroupName        *string `json:"group_name,omitempty"`GroupDescription *string `json:"group_description,omitempty"`}

IDPGroup represents an external identity provider (IDP) group.

func (*IDPGroup)GetGroupDescription ¶

func (i *IDPGroup) GetGroupDescription()string

GetGroupDescription returns the GroupDescription field if it's non-nil, zero value otherwise.

func (*IDPGroup)GetGroupID ¶

func (i *IDPGroup) GetGroupID()string

GetGroupID returns the GroupID field if it's non-nil, zero value otherwise.

func (*IDPGroup)GetGroupName ¶

func (i *IDPGroup) GetGroupName()string

GetGroupName returns the GroupName field if it's non-nil, zero value otherwise.

typeIDPGroupList ¶

type IDPGroupList struct {Groups []*IDPGroup `json:"groups"`}

IDPGroupList represents a list of external identity provider (IDP) groups.

typeImpersonateUserOptions ¶

type ImpersonateUserOptions struct {Scopes []string `json:"scopes,omitempty"`}

ImpersonateUserOptions represents the scoping for the OAuth token.

typeImport ¶

type Import struct {// The URL of the originating repository.VCSURL *string `json:"vcs_url,omitempty"`// The originating VCS type. Can be one of 'subversion', 'git',// 'mercurial', or 'tfvc'. 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.VCS *string `json:"vcs,omitempty"`// VCSUsername and VCSPassword are only used for StartImport calls that// are importing a password-protected repository.VCSUsername *string `json:"vcs_username,omitempty"`VCSPassword *string `json:"vcs_password,omitempty"`// For a tfvc import, the name of the project that is being imported.TFVCProject *string `json:"tfvc_project,omitempty"`// 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.UseLFS *string `json:"use_lfs,omitempty"`// Describes whether files larger than 100MB were found during the// importing step.HasLargeFiles *bool `json:"has_large_files,omitempty"`// The total size in gigabytes of files larger than 100MB found in the// originating repository.LargeFilesSize *int `json:"large_files_size,omitempty"`// The total number of files larger than 100MB found in the originating// repository. To see a list of these files, call LargeFiles.LargeFilesCount *int `json:"large_files_count,omitempty"`// Identifies the current status of an import. 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 CommitCount (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 PushPercent, 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. Make an UpdateImport//         request, and include VCSUsername and VCSPassword.//     error - the import encountered an error. The import progress//         response will include the FailedStep and an error message.//         Contact GitHub support for more information.//     detection_needs_auth - the importer requires authentication for//         the originating repository to continue detection. Make an//         UpdatImport request, and include VCSUsername and//         VCSPassword.//     detection_found_nothing - the importer didn't recognize any//         source control at the 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//         ProjectChoices field with the possible project choices as//         values. Make an UpdateImport request, and include VCS and//         (if applicable) TFVCProject.Status        *string `json:"status,omitempty"`CommitCount   *int    `json:"commit_count,omitempty"`StatusText    *string `json:"status_text,omitempty"`AuthorsCount  *int    `json:"authors_count,omitempty"`Percent       *int    `json:"percent,omitempty"`PushPercent   *int    `json:"push_percent,omitempty"`URL           *string `json:"url,omitempty"`HTMLURL       *string `json:"html_url,omitempty"`AuthorsURL    *string `json:"authors_url,omitempty"`RepositoryURL *string `json:"repository_url,omitempty"`Message       *string `json:"message,omitempty"`FailedStep    *string `json:"failed_step,omitempty"`// Human readable display name, provided when the Import appears as// part of ProjectChoices.HumanName *string `json:"human_name,omitempty"`// When the importer finds several projects or repositories at the// provided URLs, this will identify the available choices. Call// UpdateImport with the selected Import value.ProjectChoices []Import `json:"project_choices,omitempty"`}

Import represents a repository import request.

func (*Import)GetAuthorsCount ¶

func (i *Import) GetAuthorsCount()int

GetAuthorsCount returns the AuthorsCount field if it's non-nil, zero value otherwise.

func (*Import)GetAuthorsURL ¶

func (i *Import) GetAuthorsURL()string

GetAuthorsURL returns the AuthorsURL field if it's non-nil, zero value otherwise.

func (*Import)GetCommitCount ¶

func (i *Import) GetCommitCount()int

GetCommitCount returns the CommitCount field if it's non-nil, zero value otherwise.

func (*Import)GetFailedStep ¶

func (i *Import) GetFailedStep()string

GetFailedStep returns the FailedStep field if it's non-nil, zero value otherwise.

func (*Import)GetHTMLURL ¶

func (i *Import) GetHTMLURL()string

GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.

func (*Import)GetHasLargeFiles ¶

func (i *Import) GetHasLargeFiles()bool

GetHasLargeFiles returns the HasLargeFiles field if it's non-nil, zero value otherwise.

func (*Import)GetHumanName ¶

func (i *Import) GetHumanName()string

GetHumanName returns the HumanName field if it's non-nil, zero value otherwise.

func (*Import)GetLargeFilesCount ¶

func (i *Import) GetLargeFilesCount()int

GetLargeFilesCount returns the LargeFilesCount field if it's non-nil, zero value otherwise.

func (*Import)GetLargeFilesSize ¶

func (i *Import) GetLargeFilesSize()int

GetLargeFilesSize returns the LargeFilesSize field if it's non-nil, zero value otherwise.

func (*Import)GetMessage ¶

func (i *Import) GetMessage()string

GetMessage returns the Message field if it's non-nil, zero value otherwise.

func (*Import)GetPercent ¶

func (i *Import) GetPercent()int

GetPercent returns the Percent field if it's non-nil, zero value otherwise.

func (*Import)GetPushPercent ¶

func (i *Import) GetPushPercent()int

GetPushPercent returns the PushPercent field if it's non-nil, zero value otherwise.

func (*Import)GetRepositoryURL ¶

func (i *Import) GetRepositoryURL()string

GetRepositoryURL returns the RepositoryURL field if it's non-nil, zero value otherwise.

func (*Import)GetStatus ¶

func (i *Import) GetStatus()string

GetStatus returns the Status field if it's non-nil, zero value otherwise.

func (*Import)GetStatusText ¶

func (i *Import) GetStatusText()string

GetStatusText returns the StatusText field if it's non-nil, zero value otherwise.

func (*Import)GetTFVCProject ¶

func (i *Import) GetTFVCProject()string

GetTFVCProject returns the TFVCProject field if it's non-nil, zero value otherwise.

func (*Import)GetURL ¶

func (i *Import) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (*Import)GetUseLFS ¶

func (i *Import) GetUseLFS()string

GetUseLFS returns the UseLFS field if it's non-nil, zero value otherwise.

func (*Import)GetVCS ¶

func (i *Import) GetVCS()string

GetVCS returns the VCS field if it's non-nil, zero value otherwise.

func (*Import)GetVCSPassword ¶

func (i *Import) GetVCSPassword()string

GetVCSPassword returns the VCSPassword field if it's non-nil, zero value otherwise.

func (*Import)GetVCSURL ¶

func (i *Import) GetVCSURL()string

GetVCSURL returns the VCSURL field if it's non-nil, zero value otherwise.

func (*Import)GetVCSUsername ¶

func (i *Import) GetVCSUsername()string

GetVCSUsername returns the VCSUsername field if it's non-nil, zero value otherwise.

func (Import)String ¶

func (iImport) String()string

typeInstallation ¶

type Installation struct {ID                  *int64                   `json:"id,omitempty"`AppID               *int64                   `json:"app_id,omitempty"`TargetID            *int64                   `json:"target_id,omitempty"`Account             *User                    `json:"account,omitempty"`AccessTokensURL     *string                  `json:"access_tokens_url,omitempty"`RepositoriesURL     *string                  `json:"repositories_url,omitempty"`HTMLURL             *string                  `json:"html_url,omitempty"`TargetType          *string                  `json:"target_type,omitempty"`SingleFileName      *string                  `json:"single_file_name,omitempty"`RepositorySelection *string                  `json:"repository_selection,omitempty"`Events              []string                 `json:"events,omitempty"`Permissions         *InstallationPermissions `json:"permissions,omitempty"`CreatedAt           *Timestamp               `json:"created_at,omitempty"`UpdatedAt           *Timestamp               `json:"updated_at,omitempty"`}

Installation represents a GitHub Apps installation.

func (*Installation)GetAccessTokensURL ¶

func (i *Installation) GetAccessTokensURL()string

GetAccessTokensURL returns the AccessTokensURL field if it's non-nil, zero value otherwise.

func (*Installation)GetAccount ¶

func (i *Installation) GetAccount() *User

GetAccount returns the Account field.

func (*Installation)GetAppID ¶

func (i *Installation) GetAppID()int64

GetAppID returns the AppID field if it's non-nil, zero value otherwise.

func (*Installation)GetCreatedAt ¶

func (i *Installation) GetCreatedAt()Timestamp

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*Installation)GetHTMLURL ¶

func (i *Installation) GetHTMLURL()string

GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.

func (*Installation)GetID ¶

func (i *Installation) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*Installation)GetPermissions ¶

func (i *Installation) GetPermissions() *InstallationPermissions

GetPermissions returns the Permissions field.

func (*Installation)GetRepositoriesURL ¶

func (i *Installation) GetRepositoriesURL()string

GetRepositoriesURL returns the RepositoriesURL field if it's non-nil, zero value otherwise.

func (*Installation)GetRepositorySelection ¶

func (i *Installation) GetRepositorySelection()string

GetRepositorySelection returns the RepositorySelection field if it's non-nil, zero value otherwise.

func (*Installation)GetSingleFileName ¶

func (i *Installation) GetSingleFileName()string

GetSingleFileName returns the SingleFileName field if it's non-nil, zero value otherwise.

func (*Installation)GetTargetID ¶

func (i *Installation) GetTargetID()int64

GetTargetID returns the TargetID field if it's non-nil, zero value otherwise.

func (*Installation)GetTargetType ¶

func (i *Installation) GetTargetType()string

GetTargetType returns the TargetType field if it's non-nil, zero value otherwise.

func (*Installation)GetUpdatedAt ¶

func (i *Installation) GetUpdatedAt()Timestamp

GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.

func (Installation)String ¶

func (iInstallation) String()string

typeInstallationEvent ¶

type InstallationEvent struct {// The action that was performed. Can be either "created" or "deleted".Action       *string       `json:"action,omitempty"`Repositories []*Repository `json:"repositories,omitempty"`Sender       *User         `json:"sender,omitempty"`Installation *Installation `json:"installation,omitempty"`}

InstallationEvent is triggered when a GitHub App has been installed or uninstalled.The Webhook event name is "installation".

GitHub API docs:https://developer.github.com/v3/activity/events/types/#installationevent

func (*InstallationEvent)GetAction ¶

func (i *InstallationEvent) GetAction()string

GetAction returns the Action field if it's non-nil, zero value otherwise.

func (*InstallationEvent)GetInstallation ¶

func (i *InstallationEvent) GetInstallation() *Installation

GetInstallation returns the Installation field.

func (*InstallationEvent)GetSender ¶

func (i *InstallationEvent) GetSender() *User

GetSender returns the Sender field.

typeInstallationPermissions ¶

type InstallationPermissions struct {Administration              *string `json:"administration,omitempty"`Blocking                    *string `json:"blocking,omitempty"`Checks                      *string `json:"checks,omitempty"`Contents                    *string `json:"contents,omitempty"`ContentReferences           *string `json:"content_references,omitempty"`Deployments                 *string `json:"deployments,omitempty"`Emails                      *string `json:"emails,omitempty"`Followers                   *string `json:"followers,omitempty"`Issues                      *string `json:"issues,omitempty"`Metadata                    *string `json:"metadata,omitempty"`Members                     *string `json:"members,omitempty"`OrganizationAdministration  *string `json:"organization_administration,omitempty"`OrganizationHooks           *string `json:"organization_hooks,omitempty"`OrganizationPlan            *string `json:"organization_plan,omitempty"`OrganizationPreReceiveHooks *string `json:"organization_pre_receive_hooks,omitempty"`OrganizationProjects        *string `json:"organization_projects,omitempty"`OrganizationUserBlocking    *string `json:"organization_user_blocking,omitempty"`Packages                    *string `json:"packages,omitempty"`Pages                       *string `json:"pages,omitempty"`PullRequests                *string `json:"pull_requests,omitempty"`RepositoryHooks             *string `json:"repository_hooks,omitempty"`RepositoryProjects          *string `json:"repository_projects,omitempty"`RepositoryPreReceiveHooks   *string `json:"repository_pre_receive_hooks,omitempty"`SingleFile                  *string `json:"single_file,omitempty"`Statuses                    *string `json:"statuses,omitempty"`TeamDiscussions             *string `json:"team_discussions,omitempty"`VulnerabilityAlerts         *string `json:"vulnerability_alerts,omitempty"`}

InstallationPermissions lists the repository and organization permissions for an installation.

Permission names taken from:

https://developer.github.com/v3/apps/permissions/https://developer.github.com/enterprise/v3/apps/permissions/

func (*InstallationPermissions)GetAdministration ¶

func (i *InstallationPermissions) GetAdministration()string

GetAdministration returns the Administration field if it's non-nil, zero value otherwise.

func (*InstallationPermissions)GetBlocking ¶

func (i *InstallationPermissions) GetBlocking()string

GetBlocking returns the Blocking field if it's non-nil, zero value otherwise.

func (*InstallationPermissions)GetChecks ¶

func (i *InstallationPermissions) GetChecks()string

GetChecks returns the Checks field if it's non-nil, zero value otherwise.

func (*InstallationPermissions)GetContentReferences ¶

func (i *InstallationPermissions) GetContentReferences()string

GetContentReferences returns the ContentReferences field if it's non-nil, zero value otherwise.

func (*InstallationPermissions)GetContents ¶

func (i *InstallationPermissions) GetContents()string

GetContents returns the Contents field if it's non-nil, zero value otherwise.

func (*InstallationPermissions)GetDeployments ¶

func (i *InstallationPermissions) GetDeployments()string

GetDeployments returns the Deployments field if it's non-nil, zero value otherwise.

func (*InstallationPermissions)GetEmails ¶

func (i *InstallationPermissions) GetEmails()string

GetEmails returns the Emails field if it's non-nil, zero value otherwise.

func (*InstallationPermissions)GetFollowers ¶

func (i *InstallationPermissions) GetFollowers()string

GetFollowers returns the Followers field if it's non-nil, zero value otherwise.

func (*InstallationPermissions)GetIssues ¶

func (i *InstallationPermissions) GetIssues()string

GetIssues returns the Issues field if it's non-nil, zero value otherwise.

func (*InstallationPermissions)GetMembers ¶

func (i *InstallationPermissions) GetMembers()string

GetMembers returns the Members field if it's non-nil, zero value otherwise.

func (*InstallationPermissions)GetMetadata ¶

func (i *InstallationPermissions) GetMetadata()string

GetMetadata returns the Metadata field if it's non-nil, zero value otherwise.

func (*InstallationPermissions)GetOrganizationAdministration ¶

func (i *InstallationPermissions) GetOrganizationAdministration()string

GetOrganizationAdministration returns the OrganizationAdministration field if it's non-nil, zero value otherwise.

func (*InstallationPermissions)GetOrganizationHooks ¶

func (i *InstallationPermissions) GetOrganizationHooks()string

GetOrganizationHooks returns the OrganizationHooks field if it's non-nil, zero value otherwise.

func (*InstallationPermissions)GetOrganizationPlan ¶

func (i *InstallationPermissions) GetOrganizationPlan()string

GetOrganizationPlan returns the OrganizationPlan field if it's non-nil, zero value otherwise.

func (*InstallationPermissions)GetOrganizationPreReceiveHooks ¶

func (i *InstallationPermissions) GetOrganizationPreReceiveHooks()string

GetOrganizationPreReceiveHooks returns the OrganizationPreReceiveHooks field if it's non-nil, zero value otherwise.

func (*InstallationPermissions)GetOrganizationProjects ¶

func (i *InstallationPermissions) GetOrganizationProjects()string

GetOrganizationProjects returns the OrganizationProjects field if it's non-nil, zero value otherwise.

func (*InstallationPermissions)GetOrganizationUserBlocking ¶

func (i *InstallationPermissions) GetOrganizationUserBlocking()string

GetOrganizationUserBlocking returns the OrganizationUserBlocking field if it's non-nil, zero value otherwise.

func (*InstallationPermissions)GetPackages ¶

func (i *InstallationPermissions) GetPackages()string

GetPackages returns the Packages field if it's non-nil, zero value otherwise.

func (*InstallationPermissions)GetPages ¶

func (i *InstallationPermissions) GetPages()string

GetPages returns the Pages field if it's non-nil, zero value otherwise.

func (*InstallationPermissions)GetPullRequests ¶

func (i *InstallationPermissions) GetPullRequests()string

GetPullRequests returns the PullRequests field if it's non-nil, zero value otherwise.

func (*InstallationPermissions)GetRepositoryHooks ¶

func (i *InstallationPermissions) GetRepositoryHooks()string

GetRepositoryHooks returns the RepositoryHooks field if it's non-nil, zero value otherwise.

func (*InstallationPermissions)GetRepositoryPreReceiveHooks ¶

func (i *InstallationPermissions) GetRepositoryPreReceiveHooks()string

GetRepositoryPreReceiveHooks returns the RepositoryPreReceiveHooks field if it's non-nil, zero value otherwise.

func (*InstallationPermissions)GetRepositoryProjects ¶

func (i *InstallationPermissions) GetRepositoryProjects()string

GetRepositoryProjects returns the RepositoryProjects field if it's non-nil, zero value otherwise.

func (*InstallationPermissions)GetSingleFile ¶

func (i *InstallationPermissions) GetSingleFile()string

GetSingleFile returns the SingleFile field if it's non-nil, zero value otherwise.

func (*InstallationPermissions)GetStatuses ¶

func (i *InstallationPermissions) GetStatuses()string

GetStatuses returns the Statuses field if it's non-nil, zero value otherwise.

func (*InstallationPermissions)GetTeamDiscussions ¶

func (i *InstallationPermissions) GetTeamDiscussions()string

GetTeamDiscussions returns the TeamDiscussions field if it's non-nil, zero value otherwise.

func (*InstallationPermissions)GetVulnerabilityAlerts ¶

func (i *InstallationPermissions) GetVulnerabilityAlerts()string

GetVulnerabilityAlerts returns the VulnerabilityAlerts field if it's non-nil, zero value otherwise.

typeInstallationRepositoriesEvent ¶

type InstallationRepositoriesEvent struct {// The action that was performed. Can be either "added" or "removed".Action              *string       `json:"action,omitempty"`RepositoriesAdded   []*Repository `json:"repositories_added,omitempty"`RepositoriesRemoved []*Repository `json:"repositories_removed,omitempty"`RepositorySelection *string       `json:"repository_selection,omitempty"`Sender              *User         `json:"sender,omitempty"`Installation        *Installation `json:"installation,omitempty"`}

InstallationRepositoriesEvent is triggered when a repository is added orremoved from an installation. The Webhook event name is "installation_repositories".

GitHub API docs:https://developer.github.com/v3/activity/events/types/#installationrepositoriesevent

func (*InstallationRepositoriesEvent)GetAction ¶

func (i *InstallationRepositoriesEvent) GetAction()string

GetAction returns the Action field if it's non-nil, zero value otherwise.

func (*InstallationRepositoriesEvent)GetInstallation ¶

func (i *InstallationRepositoriesEvent) GetInstallation() *Installation

GetInstallation returns the Installation field.

func (*InstallationRepositoriesEvent)GetRepositorySelection ¶

func (i *InstallationRepositoriesEvent) GetRepositorySelection()string

GetRepositorySelection returns the RepositorySelection field if it's non-nil, zero value otherwise.

func (*InstallationRepositoriesEvent)GetSender ¶

func (i *InstallationRepositoriesEvent) GetSender() *User

GetSender returns the Sender field.

typeInstallationToken ¶

type InstallationToken struct {Token        *string                  `json:"token,omitempty"`ExpiresAt    *time.Time               `json:"expires_at,omitempty"`Permissions  *InstallationPermissions `json:"permissions,omitempty"`Repositories []*Repository            `json:"repositories,omitempty"`}

InstallationToken represents an installation token.

func (*InstallationToken)GetExpiresAt ¶

func (i *InstallationToken) GetExpiresAt()time.Time

GetExpiresAt returns the ExpiresAt field if it's non-nil, zero value otherwise.

func (*InstallationToken)GetPermissions ¶

func (i *InstallationToken) GetPermissions() *InstallationPermissions

GetPermissions returns the Permissions field.

func (*InstallationToken)GetToken ¶

func (i *InstallationToken) GetToken()string

GetToken returns the Token field if it's non-nil, zero value otherwise.

typeInstallationTokenOptions ¶

type InstallationTokenOptions struct {// The IDs of the repositories that the installation token can access.// Providing repository IDs restricts the access of an installation token to specific repositories.RepositoryIDs []int64 `json:"repository_ids,omitempty"`// The permissions granted to the access token.// The permissions object includes the permission names and their access type.Permissions *InstallationPermissions `json:"permissions,omitempty"`}

InstallationTokenOptions allow restricting a token's access to specific repositories.

func (*InstallationTokenOptions)GetPermissions ¶

func (i *InstallationTokenOptions) GetPermissions() *InstallationPermissions

GetPermissions returns the Permissions field.

typeInteractionRestriction ¶

type InteractionRestriction struct {// Specifies the group of GitHub users who can// comment, open issues, or create pull requests for the given repository.// Possible values are: "existing_users", "contributors_only" and "collaborators_only".Limit *string `json:"limit,omitempty"`// Origin specifies the type of the resource to interact with.// Possible values are: "repository" and "organization".Origin *string `json:"origin,omitempty"`// ExpiresAt specifies the time after which the interaction restrictions expire.// The default expiry time is 24 hours from the time restriction is created.ExpiresAt *Timestamp `json:"expires_at,omitempty"`}

InteractionRestriction represents the interaction restrictions for repository and organization.

func (*InteractionRestriction)GetExpiresAt ¶

func (i *InteractionRestriction) GetExpiresAt()Timestamp

GetExpiresAt returns the ExpiresAt field if it's non-nil, zero value otherwise.

func (*InteractionRestriction)GetLimit ¶

func (i *InteractionRestriction) GetLimit()string

GetLimit returns the Limit field if it's non-nil, zero value otherwise.

func (*InteractionRestriction)GetOrigin ¶

func (i *InteractionRestriction) GetOrigin()string

GetOrigin returns the Origin field if it's non-nil, zero value otherwise.

typeInteractionsService ¶

type InteractionsService service

InteractionsService handles communication with the repository and organization relatedmethods of the GitHub API.

GitHub API docs:https://developer.github.com/v3/interactions/

func (*InteractionsService)GetRestrictionsForOrg ¶

func (s *InteractionsService) GetRestrictionsForOrg(ctxcontext.Context, organizationstring) (*InteractionRestriction, *Response,error)

GetRestrictionsForOrg fetches the interaction restrictions for an organization.

GitHub API docs:https://developer.github.com/v3/interactions/orgs/#get-interaction-restrictions-for-an-organization

func (*InteractionsService)GetRestrictionsForRepo ¶

func (s *InteractionsService) GetRestrictionsForRepo(ctxcontext.Context, owner, repostring) (*InteractionRestriction, *Response,error)

GetRestrictionsForRepo fetches the interaction restrictions for a repository.

GitHub API docs:https://developer.github.com/v3/interactions/repos/#get-interaction-restrictions-for-a-repository

func (*InteractionsService)RemoveRestrictionsFromOrg ¶

func (s *InteractionsService) RemoveRestrictionsFromOrg(ctxcontext.Context, organizationstring) (*Response,error)

RemoveRestrictionsFromOrg removes the interaction restrictions for an organization.

GitHub API docs:https://developer.github.com/v3/interactions/orgs/#remove-interaction-restrictions-for-an-organization

func (*InteractionsService)RemoveRestrictionsFromRepo ¶

func (s *InteractionsService) RemoveRestrictionsFromRepo(ctxcontext.Context, owner, repostring) (*Response,error)

RemoveRestrictionsFromRepo removes the interaction restrictions for a repository.

GitHub API docs:https://developer.github.com/v3/interactions/repos/#remove-interaction-restrictions-for-a-repository

func (*InteractionsService)UpdateRestrictionsForOrg ¶

func (s *InteractionsService) UpdateRestrictionsForOrg(ctxcontext.Context, organization, limitstring) (*InteractionRestriction, *Response,error)

UpdateRestrictionsForOrg adds or updates the interaction restrictions for an organization.

limit specifies the group of GitHub users who can comment, open issues, or create pull requestsin public repositories for the given organization.Possible values are: "existing_users", "contributors_only", "collaborators_only".

GitHub API docs:https://developer.github.com/v3/interactions/orgs/#add-or-update-interaction-restrictions-for-an-organization

func (*InteractionsService)UpdateRestrictionsForRepo ¶

func (s *InteractionsService) UpdateRestrictionsForRepo(ctxcontext.Context, owner, repo, limitstring) (*InteractionRestriction, *Response,error)

UpdateRestrictionsForRepo adds or updates the interaction restrictions for a repository.

limit specifies the group of GitHub users who can comment, open issues, or create pull requestsfor the given repository.Possible values are: "existing_users", "contributors_only", "collaborators_only".

GitHub API docs:https://developer.github.com/v3/interactions/repos/#add-or-update-interaction-restrictions-for-a-repository

typeInvitation ¶

type Invitation struct {ID     *int64  `json:"id,omitempty"`NodeID *string `json:"node_id,omitempty"`Login  *string `json:"login,omitempty"`Email  *string `json:"email,omitempty"`// Role can be one of the values - 'direct_member', 'admin', 'billing_manager', 'hiring_manager', or 'reinstate'.Role              *string    `json:"role,omitempty"`CreatedAt         *time.Time `json:"created_at,omitempty"`Inviter           *User      `json:"inviter,omitempty"`TeamCount         *int       `json:"team_count,omitempty"`InvitationTeamURL *string    `json:"invitation_team_url,omitempty"`}

Invitation represents a team member's invitation status.

func (*Invitation)GetCreatedAt ¶

func (i *Invitation) GetCreatedAt()time.Time

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*Invitation)GetEmail ¶

func (i *Invitation) GetEmail()string

GetEmail returns the Email field if it's non-nil, zero value otherwise.

func (*Invitation)GetID ¶

func (i *Invitation) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*Invitation)GetInvitationTeamURL ¶

func (i *Invitation) GetInvitationTeamURL()string

GetInvitationTeamURL returns the InvitationTeamURL field if it's non-nil, zero value otherwise.

func (*Invitation)GetInviter ¶

func (i *Invitation) GetInviter() *User

GetInviter returns the Inviter field.

func (*Invitation)GetLogin ¶

func (i *Invitation) GetLogin()string

GetLogin returns the Login field if it's non-nil, zero value otherwise.

func (*Invitation)GetNodeID ¶

func (i *Invitation) GetNodeID()string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*Invitation)GetRole ¶

func (i *Invitation) GetRole()string

GetRole returns the Role field if it's non-nil, zero value otherwise.

func (*Invitation)GetTeamCount ¶

func (i *Invitation) GetTeamCount()int

GetTeamCount returns the TeamCount field if it's non-nil, zero value otherwise.

func (Invitation)String ¶

func (iInvitation) String()string

typeIssue ¶

type Issue struct {ID               *int64            `json:"id,omitempty"`Number           *int              `json:"number,omitempty"`State            *string           `json:"state,omitempty"`Locked           *bool             `json:"locked,omitempty"`Title            *string           `json:"title,omitempty"`Body             *string           `json:"body,omitempty"`User             *User             `json:"user,omitempty"`Labels           []Label           `json:"labels,omitempty"`Assignee         *User             `json:"assignee,omitempty"`Comments         *int              `json:"comments,omitempty"`ClosedAt         *time.Time        `json:"closed_at,omitempty"`CreatedAt        *time.Time        `json:"created_at,omitempty"`UpdatedAt        *time.Time        `json:"updated_at,omitempty"`ClosedBy         *User             `json:"closed_by,omitempty"`URL              *string           `json:"url,omitempty"`HTMLURL          *string           `json:"html_url,omitempty"`CommentsURL      *string           `json:"comments_url,omitempty"`EventsURL        *string           `json:"events_url,omitempty"`LabelsURL        *string           `json:"labels_url,omitempty"`RepositoryURL    *string           `json:"repository_url,omitempty"`Milestone        *Milestone        `json:"milestone,omitempty"`PullRequestLinks *PullRequestLinks `json:"pull_request,omitempty"`Repository       *Repository       `json:"repository,omitempty"`Reactions        *Reactions        `json:"reactions,omitempty"`Assignees        []*User           `json:"assignees,omitempty"`NodeID           *string           `json:"node_id,omitempty"`// TextMatches is only populated from search results that request text matches// See: search.go andhttps://developer.github.com/v3/search/#text-match-metadataTextMatches []TextMatch `json:"text_matches,omitempty"`// ActiveLockReason is populated only when LockReason is provided while locking the issue.// Possible values are: "off-topic", "too heated", "resolved", and "spam".ActiveLockReason *string `json:"active_lock_reason,omitempty"`}

Issue represents a GitHub issue on a repository.

Note: As far as the GitHub API is concerned, every pull request is an issue,but not every issue is a pull request. Some endpoints, events, and webhooksmay also return pull requests via this struct. If PullRequestLinks is nil,this is an issue, and if PullRequestLinks is not nil, this is a pull request.The IsPullRequest helper method can be used to check that.

func (*Issue)GetActiveLockReason ¶

func (i *Issue) GetActiveLockReason()string

GetActiveLockReason returns the ActiveLockReason field if it's non-nil, zero value otherwise.

func (*Issue)GetAssignee ¶

func (i *Issue) GetAssignee() *User

GetAssignee returns the Assignee field.

func (*Issue)GetBody ¶

func (i *Issue) GetBody()string

GetBody returns the Body field if it's non-nil, zero value otherwise.

func (*Issue)GetClosedAt ¶

func (i *Issue) GetClosedAt()time.Time

GetClosedAt returns the ClosedAt field if it's non-nil, zero value otherwise.

func (*Issue)GetClosedBy ¶

func (i *Issue) GetClosedBy() *User

GetClosedBy returns the ClosedBy field.

func (*Issue)GetComments ¶

func (i *Issue) GetComments()int

GetComments returns the Comments field if it's non-nil, zero value otherwise.

func (*Issue)GetCommentsURL ¶

func (i *Issue) GetCommentsURL()string

GetCommentsURL returns the CommentsURL field if it's non-nil, zero value otherwise.

func (*Issue)GetCreatedAt ¶

func (i *Issue) GetCreatedAt()time.Time

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*Issue)GetEventsURL ¶

func (i *Issue) GetEventsURL()string

GetEventsURL returns the EventsURL field if it's non-nil, zero value otherwise.

func (*Issue)GetHTMLURL ¶

func (i *Issue) GetHTMLURL()string

GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.

func (*Issue)GetID ¶

func (i *Issue) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*Issue)GetLabelsURL ¶

func (i *Issue) GetLabelsURL()string

GetLabelsURL returns the LabelsURL field if it's non-nil, zero value otherwise.

func (*Issue)GetLocked ¶

func (i *Issue) GetLocked()bool

GetLocked returns the Locked field if it's non-nil, zero value otherwise.

func (*Issue)GetMilestone ¶

func (i *Issue) GetMilestone() *Milestone

GetMilestone returns the Milestone field.

func (*Issue)GetNodeID ¶

func (i *Issue) GetNodeID()string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*Issue)GetNumber ¶

func (i *Issue) GetNumber()int

GetNumber returns the Number field if it's non-nil, zero value otherwise.

func (*Issue)GetPullRequestLinks ¶

func (i *Issue) GetPullRequestLinks() *PullRequestLinks

GetPullRequestLinks returns the PullRequestLinks field.

func (*Issue)GetReactions ¶

func (i *Issue) GetReactions() *Reactions

GetReactions returns the Reactions field.

func (*Issue)GetRepository ¶

func (i *Issue) GetRepository() *Repository

GetRepository returns the Repository field.

func (*Issue)GetRepositoryURL ¶

func (i *Issue) GetRepositoryURL()string

GetRepositoryURL returns the RepositoryURL field if it's non-nil, zero value otherwise.

func (*Issue)GetState ¶

func (i *Issue) GetState()string

GetState returns the State field if it's non-nil, zero value otherwise.

func (*Issue)GetTitle ¶

func (i *Issue) GetTitle()string

GetTitle returns the Title field if it's non-nil, zero value otherwise.

func (*Issue)GetURL ¶

func (i *Issue) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (*Issue)GetUpdatedAt ¶

func (i *Issue) GetUpdatedAt()time.Time

GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.

func (*Issue)GetUser ¶

func (i *Issue) GetUser() *User

GetUser returns the User field.

func (Issue)IsPullRequest ¶

func (iIssue) IsPullRequest()bool

IsPullRequest reports whether the issue is also a pull request. It uses themethod recommended by GitHub's API documentation, which is to check whetherPullRequestLinks is non-nil.

func (Issue)String ¶

func (iIssue) String()string

typeIssueComment ¶

type IssueComment struct {ID        *int64     `json:"id,omitempty"`NodeID    *string    `json:"node_id,omitempty"`Body      *string    `json:"body,omitempty"`User      *User      `json:"user,omitempty"`Reactions *Reactions `json:"reactions,omitempty"`CreatedAt *time.Time `json:"created_at,omitempty"`UpdatedAt *time.Time `json:"updated_at,omitempty"`// AuthorAssociation is the comment author's relationship to the issue's repository.// Possible values are "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MEMBER", "OWNER", or "NONE".AuthorAssociation *string `json:"author_association,omitempty"`URL               *string `json:"url,omitempty"`HTMLURL           *string `json:"html_url,omitempty"`IssueURL          *string `json:"issue_url,omitempty"`}

IssueComment represents a comment left on an issue.

func (*IssueComment)GetAuthorAssociation ¶

func (i *IssueComment) GetAuthorAssociation()string

GetAuthorAssociation returns the AuthorAssociation field if it's non-nil, zero value otherwise.

func (*IssueComment)GetBody ¶

func (i *IssueComment) GetBody()string

GetBody returns the Body field if it's non-nil, zero value otherwise.

func (*IssueComment)GetCreatedAt ¶

func (i *IssueComment) GetCreatedAt()time.Time

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*IssueComment)GetHTMLURL ¶

func (i *IssueComment) GetHTMLURL()string

GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.

func (*IssueComment)GetID ¶

func (i *IssueComment) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*IssueComment)GetIssueURL ¶

func (i *IssueComment) GetIssueURL()string

GetIssueURL returns the IssueURL field if it's non-nil, zero value otherwise.

func (*IssueComment)GetNodeID ¶

func (i *IssueComment) GetNodeID()string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*IssueComment)GetReactions ¶

func (i *IssueComment) GetReactions() *Reactions

GetReactions returns the Reactions field.

func (*IssueComment)GetURL ¶

func (i *IssueComment) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (*IssueComment)GetUpdatedAt ¶

func (i *IssueComment) GetUpdatedAt()time.Time

GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.

func (*IssueComment)GetUser ¶

func (i *IssueComment) GetUser() *User

GetUser returns the User field.

func (IssueComment)String ¶

func (iIssueComment) String()string

typeIssueCommentEvent ¶

type IssueCommentEvent struct {// Action is the action that was performed on the comment.// Possible values are: "created", "edited", "deleted".Action  *string       `json:"action,omitempty"`Issue   *Issue        `json:"issue,omitempty"`Comment *IssueComment `json:"comment,omitempty"`// The following fields are only populated by Webhook events.Changes      *EditChange   `json:"changes,omitempty"`Repo         *Repository   `json:"repository,omitempty"`Sender       *User         `json:"sender,omitempty"`Installation *Installation `json:"installation,omitempty"`}

IssueCommentEvent is triggered when an issue comment is created on an issueor pull request.The Webhook event name is "issue_comment".

GitHub API docs:https://developer.github.com/v3/activity/events/types/#issuecommentevent

func (*IssueCommentEvent)GetAction ¶

func (i *IssueCommentEvent) GetAction()string

GetAction returns the Action field if it's non-nil, zero value otherwise.

func (*IssueCommentEvent)GetChanges ¶

func (i *IssueCommentEvent) GetChanges() *EditChange

GetChanges returns the Changes field.

func (*IssueCommentEvent)GetComment ¶

func (i *IssueCommentEvent) GetComment() *IssueComment

GetComment returns the Comment field.

func (*IssueCommentEvent)GetInstallation ¶

func (i *IssueCommentEvent) GetInstallation() *Installation

GetInstallation returns the Installation field.

func (*IssueCommentEvent)GetIssue ¶

func (i *IssueCommentEvent) GetIssue() *Issue

GetIssue returns the Issue field.

func (*IssueCommentEvent)GetRepo ¶

func (i *IssueCommentEvent) GetRepo() *Repository

GetRepo returns the Repo field.

func (*IssueCommentEvent)GetSender ¶

func (i *IssueCommentEvent) GetSender() *User

GetSender returns the Sender field.

typeIssueEvent ¶

type IssueEvent struct {ID  *int64  `json:"id,omitempty"`URL *string `json:"url,omitempty"`// The User that generated this event.Actor *User `json:"actor,omitempty"`// Event identifies the actual type of Event that occurred. Possible// values are:////     closed//       The Actor closed the issue.//       If the issue was closed by commit message, CommitID holds the SHA1 hash of the commit.////     merged//       The Actor merged into master a branch containing a commit mentioning the issue.//       CommitID holds the SHA1 of the merge commit.////     referenced//       The Actor committed to master a commit mentioning the issue in its commit message.//       CommitID holds the SHA1 of the commit.////     reopened, unlocked//       The Actor did that to the issue.////     locked//       The Actor locked the issue.//       LockReason holds the reason of locking the issue (if provided while locking).////     renamed//       The Actor changed the issue title from Rename.From to Rename.To.////     mentioned//       Someone unspecified @mentioned the Actor [sic] in an issue comment body.////     assigned, unassigned//       The Assigner assigned the issue to or removed the assignment from the Assignee.////     labeled, unlabeled//       The Actor added or removed the Label from the issue.////     milestoned, demilestoned//       The Actor added or removed the issue from the Milestone.////     subscribed, unsubscribed//       The Actor subscribed to or unsubscribed from notifications for an issue.////     head_ref_deleted, head_ref_restored//       The pull request’s branch was deleted or restored.////    review_dismissed//       The review was dismissed and `DismissedReview` will be populated below.//Event *string `json:"event,omitempty"`CreatedAt *time.Time `json:"created_at,omitempty"`Issue     *Issue     `json:"issue,omitempty"`// Only present on certain events; see above.Assignee        *User            `json:"assignee,omitempty"`Assigner        *User            `json:"assigner,omitempty"`CommitID        *string          `json:"commit_id,omitempty"`Milestone       *Milestone       `json:"milestone,omitempty"`Label           *Label           `json:"label,omitempty"`Rename          *Rename          `json:"rename,omitempty"`LockReason      *string          `json:"lock_reason,omitempty"`ProjectCard     *ProjectCard     `json:"project_card,omitempty"`DismissedReview *DismissedReview `json:"dismissed_review,omitempty"`}

IssueEvent represents an event that occurred around an Issue or Pull Request.

func (*IssueEvent)GetActor ¶

func (i *IssueEvent) GetActor() *User

GetActor returns the Actor field.

func (*IssueEvent)GetAssignee ¶

func (i *IssueEvent) GetAssignee() *User

GetAssignee returns the Assignee field.

func (*IssueEvent)GetAssigner ¶

func (i *IssueEvent) GetAssigner() *User

GetAssigner returns the Assigner field.

func (*IssueEvent)GetCommitID ¶

func (i *IssueEvent) GetCommitID()string

GetCommitID returns the CommitID field if it's non-nil, zero value otherwise.

func (*IssueEvent)GetCreatedAt ¶

func (i *IssueEvent) GetCreatedAt()time.Time

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*IssueEvent)GetDismissedReview ¶

func (i *IssueEvent) GetDismissedReview() *DismissedReview

GetDismissedReview returns the DismissedReview field.

func (*IssueEvent)GetEvent ¶

func (i *IssueEvent) GetEvent()string

GetEvent returns the Event field if it's non-nil, zero value otherwise.

func (*IssueEvent)GetID ¶

func (i *IssueEvent) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*IssueEvent)GetIssue ¶

func (i *IssueEvent) GetIssue() *Issue

GetIssue returns the Issue field.

func (*IssueEvent)GetLabel ¶

func (i *IssueEvent) GetLabel() *Label

GetLabel returns the Label field.

func (*IssueEvent)GetLockReason ¶

func (i *IssueEvent) GetLockReason()string

GetLockReason returns the LockReason field if it's non-nil, zero value otherwise.

func (*IssueEvent)GetMilestone ¶

func (i *IssueEvent) GetMilestone() *Milestone

GetMilestone returns the Milestone field.

func (*IssueEvent)GetProjectCard ¶

func (i *IssueEvent) GetProjectCard() *ProjectCard

GetProjectCard returns the ProjectCard field.

func (*IssueEvent)GetRename ¶

func (i *IssueEvent) GetRename() *Rename

GetRename returns the Rename field.

func (*IssueEvent)GetURL ¶

func (i *IssueEvent) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

typeIssueListByRepoOptions ¶

type IssueListByRepoOptions struct {// Milestone limits issues for the specified milestone. Possible values are// a milestone number, "none" for issues with no milestone, "*" for issues// with any milestone.Milestonestring `url:"milestone,omitempty"`// State filters issues based on their state. Possible values are: open,// closed, all. Default is "open".Statestring `url:"state,omitempty"`// Assignee filters issues based on their assignee. Possible values are a// user name, "none" for issues that are not assigned, "*" for issues with// any assigned user.Assigneestring `url:"assignee,omitempty"`// Creator filters issues based on their creator.Creatorstring `url:"creator,omitempty"`// Mentioned filters issues to those mentioned a specific user.Mentionedstring `url:"mentioned,omitempty"`// Labels filters issues based on their label.Labels []string `url:"labels,omitempty,comma"`// Sort specifies how to sort issues. Possible values are: created, updated,// and comments. Default value is "created".Sortstring `url:"sort,omitempty"`// Direction in which to sort issues. Possible values are: asc, desc.// Default is "desc".Directionstring `url:"direction,omitempty"`// Since filters issues by time.Sincetime.Time `url:"since,omitempty"`ListOptions}

IssueListByRepoOptions specifies the optional parameters to theIssuesService.ListByRepo method.

typeIssueListCommentsOptions ¶

type IssueListCommentsOptions struct {// Sort specifies how to sort comments. Possible values are: created, updated.Sort *string `url:"sort,omitempty"`// Direction in which to sort comments. Possible values are: asc, desc.Direction *string `url:"direction,omitempty"`// Since filters comments by time.Since *time.Time `url:"since,omitempty"`ListOptions}

IssueListCommentsOptions specifies the optional parameters to theIssuesService.ListComments method.

func (*IssueListCommentsOptions)GetDirection ¶

func (i *IssueListCommentsOptions) GetDirection()string

GetDirection returns the Direction field if it's non-nil, zero value otherwise.

func (*IssueListCommentsOptions)GetSince ¶

func (i *IssueListCommentsOptions) GetSince()time.Time

GetSince returns the Since field if it's non-nil, zero value otherwise.

func (*IssueListCommentsOptions)GetSort ¶

func (i *IssueListCommentsOptions) GetSort()string

GetSort returns the Sort field if it's non-nil, zero value otherwise.

typeIssueListOptions ¶

type IssueListOptions struct {// Filter specifies which issues to list. Possible values are: assigned,// created, mentioned, subscribed, all. Default is "assigned".Filterstring `url:"filter,omitempty"`// State filters issues based on their state. Possible values are: open,// closed, all. Default is "open".Statestring `url:"state,omitempty"`// Labels filters issues based on their label.Labels []string `url:"labels,comma,omitempty"`// Sort specifies how to sort issues. Possible values are: created, updated,// and comments. Default value is "created".Sortstring `url:"sort,omitempty"`// Direction in which to sort issues. Possible values are: asc, desc.// Default is "desc".Directionstring `url:"direction,omitempty"`// Since filters issues by time.Sincetime.Time `url:"since,omitempty"`ListOptions}

IssueListOptions specifies the optional parameters to the IssuesService.Listand IssuesService.ListByOrg methods.

typeIssueRequest ¶

type IssueRequest struct {Title     *string   `json:"title,omitempty"`Body      *string   `json:"body,omitempty"`Labels    *[]string `json:"labels,omitempty"`Assignee  *string   `json:"assignee,omitempty"`State     *string   `json:"state,omitempty"`Milestone *int      `json:"milestone,omitempty"`Assignees *[]string `json:"assignees,omitempty"`}

IssueRequest represents a request to create/edit an issue.It is separate from Issue above because otherwise Labelsand Assignee fail to serialize to the correct JSON.

func (*IssueRequest)GetAssignee ¶

func (i *IssueRequest) GetAssignee()string

GetAssignee returns the Assignee field if it's non-nil, zero value otherwise.

func (*IssueRequest)GetAssignees ¶

func (i *IssueRequest) GetAssignees() []string

GetAssignees returns the Assignees field if it's non-nil, zero value otherwise.

func (*IssueRequest)GetBody ¶

func (i *IssueRequest) GetBody()string

GetBody returns the Body field if it's non-nil, zero value otherwise.

func (*IssueRequest)GetLabels ¶

func (i *IssueRequest) GetLabels() []string

GetLabels returns the Labels field if it's non-nil, zero value otherwise.

func (*IssueRequest)GetMilestone ¶

func (i *IssueRequest) GetMilestone()int

GetMilestone returns the Milestone field if it's non-nil, zero value otherwise.

func (*IssueRequest)GetState ¶

func (i *IssueRequest) GetState()string

GetState returns the State field if it's non-nil, zero value otherwise.

func (*IssueRequest)GetTitle ¶

func (i *IssueRequest) GetTitle()string

GetTitle returns the Title field if it's non-nil, zero value otherwise.

typeIssueStats ¶

type IssueStats struct {TotalIssues  *int `json:"total_issues,omitempty"`OpenIssues   *int `json:"open_issues,omitempty"`ClosedIssues *int `json:"closed_issues,omitempty"`}

IssueStats represents the number of total, open and closed issues.

func (*IssueStats)GetClosedIssues ¶

func (i *IssueStats) GetClosedIssues()int

GetClosedIssues returns the ClosedIssues field if it's non-nil, zero value otherwise.

func (*IssueStats)GetOpenIssues ¶

func (i *IssueStats) GetOpenIssues()int

GetOpenIssues returns the OpenIssues field if it's non-nil, zero value otherwise.

func (*IssueStats)GetTotalIssues ¶

func (i *IssueStats) GetTotalIssues()int

GetTotalIssues returns the TotalIssues field if it's non-nil, zero value otherwise.

func (IssueStats)String ¶

func (sIssueStats) String()string

typeIssuesEvent ¶

type IssuesEvent struct {// Action is the action that was performed. Possible values are: "opened",// "edited", "deleted", "transferred", "pinned", "unpinned", "closed", "reopened",// "assigned", "unassigned", "labeled", "unlabeled", "locked", "unlocked",// "milestoned", or "demilestoned".Action   *string `json:"action,omitempty"`Issue    *Issue  `json:"issue,omitempty"`Assignee *User   `json:"assignee,omitempty"`Label    *Label  `json:"label,omitempty"`// The following fields are only populated by Webhook events.Changes      *EditChange   `json:"changes,omitempty"`Repo         *Repository   `json:"repository,omitempty"`Sender       *User         `json:"sender,omitempty"`Installation *Installation `json:"installation,omitempty"`}

IssuesEvent is triggered when an issue is opened, edited, deleted, transferred,pinned, unpinned, closed, reopened, assigned, unassigned, labeled, unlabeled,locked, unlocked, milestoned, or demilestoned.The Webhook event name is "issues".

GitHub API docs:https://developer.github.com/v3/activity/events/types/#issuesevent

func (*IssuesEvent)GetAction ¶

func (i *IssuesEvent) GetAction()string

GetAction returns the Action field if it's non-nil, zero value otherwise.

func (*IssuesEvent)GetAssignee ¶

func (i *IssuesEvent) GetAssignee() *User

GetAssignee returns the Assignee field.

func (*IssuesEvent)GetChanges ¶

func (i *IssuesEvent) GetChanges() *EditChange

GetChanges returns the Changes field.

func (*IssuesEvent)GetInstallation ¶

func (i *IssuesEvent) GetInstallation() *Installation

GetInstallation returns the Installation field.

func (*IssuesEvent)GetIssue ¶

func (i *IssuesEvent) GetIssue() *Issue

GetIssue returns the Issue field.

func (*IssuesEvent)GetLabel ¶

func (i *IssuesEvent) GetLabel() *Label

GetLabel returns the Label field.

func (*IssuesEvent)GetRepo ¶

func (i *IssuesEvent) GetRepo() *Repository

GetRepo returns the Repo field.

func (*IssuesEvent)GetSender ¶

func (i *IssuesEvent) GetSender() *User

GetSender returns the Sender field.

typeIssuesSearchResult ¶

type IssuesSearchResult struct {Total             *int    `json:"total_count,omitempty"`IncompleteResults *bool   `json:"incomplete_results,omitempty"`Issues            []Issue `json:"items,omitempty"`}

IssuesSearchResult represents the result of an issues search.

func (*IssuesSearchResult)GetIncompleteResults ¶

func (i *IssuesSearchResult) GetIncompleteResults()bool

GetIncompleteResults returns the IncompleteResults field if it's non-nil, zero value otherwise.

func (*IssuesSearchResult)GetTotal ¶

func (i *IssuesSearchResult) GetTotal()int

GetTotal returns the Total field if it's non-nil, zero value otherwise.

typeIssuesService ¶

type IssuesService service

IssuesService handles communication with the issue relatedmethods of the GitHub API.

GitHub API docs:https://developer.github.com/v3/issues/

func (*IssuesService)AddAssignees ¶

func (s *IssuesService) AddAssignees(ctxcontext.Context, owner, repostring, numberint, assignees []string) (*Issue, *Response,error)

AddAssignees adds the provided GitHub users as assignees to the issue.

GitHub API docs:https://developer.github.com/v3/issues/assignees/#add-assignees-to-an-issue

func (*IssuesService)AddLabelsToIssue ¶

func (s *IssuesService) AddLabelsToIssue(ctxcontext.Context, ownerstring, repostring, numberint, labels []string) ([]*Label, *Response,error)

AddLabelsToIssue adds labels to an issue.

GitHub API docs:https://developer.github.com/v3/issues/labels/#add-labels-to-an-issue

func (*IssuesService)Create ¶

func (s *IssuesService) Create(ctxcontext.Context, ownerstring, repostring, issue *IssueRequest) (*Issue, *Response,error)

Create a new issue on the specified repository.

GitHub API docs:https://developer.github.com/v3/issues/#create-an-issue

func (*IssuesService)CreateComment ¶

func (s *IssuesService) CreateComment(ctxcontext.Context, ownerstring, repostring, numberint, comment *IssueComment) (*IssueComment, *Response,error)

CreateComment creates a new comment on the specified issue.

GitHub API docs:https://developer.github.com/v3/issues/comments/#create-a-comment

func (*IssuesService)CreateLabel ¶

func (s *IssuesService) CreateLabel(ctxcontext.Context, ownerstring, repostring, label *Label) (*Label, *Response,error)

CreateLabel creates a new label on the specified repository.

GitHub API docs:https://developer.github.com/v3/issues/labels/#create-a-label

func (*IssuesService)CreateMilestone ¶

func (s *IssuesService) CreateMilestone(ctxcontext.Context, ownerstring, repostring, milestone *Milestone) (*Milestone, *Response,error)

CreateMilestone creates a new milestone on the specified repository.

GitHub API docs:https://developer.github.com/v3/issues/milestones/#create-a-milestone

func (*IssuesService)DeleteComment ¶

func (s *IssuesService) DeleteComment(ctxcontext.Context, ownerstring, repostring, commentIDint64) (*Response,error)

DeleteComment deletes an issue comment.

GitHub API docs:https://developer.github.com/v3/issues/comments/#delete-a-comment

func (*IssuesService)DeleteLabel ¶

func (s *IssuesService) DeleteLabel(ctxcontext.Context, ownerstring, repostring, namestring) (*Response,error)

DeleteLabel deletes a label.

GitHub API docs:https://developer.github.com/v3/issues/labels/#delete-a-label

func (*IssuesService)DeleteMilestone ¶

func (s *IssuesService) DeleteMilestone(ctxcontext.Context, ownerstring, repostring, numberint) (*Response,error)

DeleteMilestone deletes a milestone.

GitHub API docs:https://developer.github.com/v3/issues/milestones/#delete-a-milestone

func (*IssuesService)Edit ¶

func (s *IssuesService) Edit(ctxcontext.Context, ownerstring, repostring, numberint, issue *IssueRequest) (*Issue, *Response,error)

Edit an issue.

GitHub API docs:https://developer.github.com/v3/issues/#edit-an-issue

func (*IssuesService)EditComment ¶

func (s *IssuesService) EditComment(ctxcontext.Context, ownerstring, repostring, commentIDint64, comment *IssueComment) (*IssueComment, *Response,error)

EditComment updates an issue comment.A non-nil comment.Body must be provided. Other comment fields should be left nil.

GitHub API docs:https://developer.github.com/v3/issues/comments/#edit-a-comment

func (*IssuesService)EditLabel ¶

func (s *IssuesService) EditLabel(ctxcontext.Context, ownerstring, repostring, namestring, label *Label) (*Label, *Response,error)

EditLabel edits a label.

GitHub API docs:https://developer.github.com/v3/issues/labels/#update-a-label

func (*IssuesService)EditMilestone ¶

func (s *IssuesService) EditMilestone(ctxcontext.Context, ownerstring, repostring, numberint, milestone *Milestone) (*Milestone, *Response,error)

EditMilestone edits a milestone.

GitHub API docs:https://developer.github.com/v3/issues/milestones/#update-a-milestone

func (*IssuesService)Get ¶

func (s *IssuesService) Get(ctxcontext.Context, ownerstring, repostring, numberint) (*Issue, *Response,error)

Get a single issue.

GitHub API docs:https://developer.github.com/v3/issues/#get-a-single-issue

func (*IssuesService)GetComment ¶

func (s *IssuesService) GetComment(ctxcontext.Context, ownerstring, repostring, commentIDint64) (*IssueComment, *Response,error)

GetComment fetches the specified issue comment.

GitHub API docs:https://developer.github.com/v3/issues/comments/#get-a-single-comment

func (*IssuesService)GetEvent ¶

func (s *IssuesService) GetEvent(ctxcontext.Context, owner, repostring, idint64) (*IssueEvent, *Response,error)

GetEvent returns the specified issue event.

GitHub API docs:https://developer.github.com/v3/issues/events/#get-a-single-event

func (*IssuesService)GetLabel ¶

func (s *IssuesService) GetLabel(ctxcontext.Context, ownerstring, repostring, namestring) (*Label, *Response,error)

GetLabel gets a single label.

GitHub API docs:https://developer.github.com/v3/issues/labels/#get-a-single-label

func (*IssuesService)GetMilestone ¶

func (s *IssuesService) GetMilestone(ctxcontext.Context, ownerstring, repostring, numberint) (*Milestone, *Response,error)

GetMilestone gets a single milestone.

GitHub API docs:https://developer.github.com/v3/issues/milestones/#get-a-single-milestone

func (*IssuesService)IsAssignee ¶

func (s *IssuesService) IsAssignee(ctxcontext.Context, owner, repo, userstring) (bool, *Response,error)

IsAssignee checks if a user is an assignee for the specified repository.

GitHub API docs:https://developer.github.com/v3/issues/assignees/#check-assignee

func (*IssuesService)List ¶

func (s *IssuesService) List(ctxcontext.Context, allbool, opts *IssueListOptions) ([]*Issue, *Response,error)

List the issues for the authenticated user. If all is true, list issuesacross all the user's visible repositories including owned, member, andorganization repositories; if false, list only owned and memberrepositories.

GitHub API docs:https://developer.github.com/v3/issues/#list-issues

func (*IssuesService)ListAssignees ¶

func (s *IssuesService) ListAssignees(ctxcontext.Context, owner, repostring, opts *ListOptions) ([]*User, *Response,error)

ListAssignees fetches all available assignees (owners and collaborators) towhich issues may be assigned.

GitHub API docs:https://developer.github.com/v3/issues/assignees/#list-assignees

func (*IssuesService)ListByOrg ¶

func (s *IssuesService) ListByOrg(ctxcontext.Context, orgstring, opts *IssueListOptions) ([]*Issue, *Response,error)

ListByOrg fetches the issues in the specified organization for theauthenticated user.

GitHub API docs:https://developer.github.com/v3/issues/#list-issues

func (*IssuesService)ListByRepo ¶

func (s *IssuesService) ListByRepo(ctxcontext.Context, ownerstring, repostring, opts *IssueListByRepoOptions) ([]*Issue, *Response,error)

ListByRepo lists the issues for the specified repository.

GitHub API docs:https://developer.github.com/v3/issues/#list-issues-for-a-repository

func (*IssuesService)ListComments ¶

func (s *IssuesService) ListComments(ctxcontext.Context, ownerstring, repostring, numberint, opts *IssueListCommentsOptions) ([]*IssueComment, *Response,error)

ListComments lists all comments on the specified issue. Specifying an issuenumber of 0 will return all comments on all issues for the repository.

GitHub API docs:https://developer.github.com/v3/issues/comments/#list-comments-on-an-issue

func (*IssuesService)ListIssueEvents ¶

func (s *IssuesService) ListIssueEvents(ctxcontext.Context, owner, repostring, numberint, opts *ListOptions) ([]*IssueEvent, *Response,error)

ListIssueEvents lists events for the specified issue.

GitHub API docs:https://developer.github.com/v3/issues/events/#list-events-for-an-issue

func (*IssuesService)ListIssueTimeline ¶

func (s *IssuesService) ListIssueTimeline(ctxcontext.Context, owner, repostring, numberint, opts *ListOptions) ([]*Timeline, *Response,error)

ListIssueTimeline lists events for the specified issue.

GitHub API docs:https://developer.github.com/v3/issues/timeline/#list-events-for-an-issue

func (*IssuesService)ListLabels ¶

func (s *IssuesService) ListLabels(ctxcontext.Context, ownerstring, repostring, opts *ListOptions) ([]*Label, *Response,error)

ListLabels lists all labels for a repository.

GitHub API docs:https://developer.github.com/v3/issues/labels/#list-all-labels-for-this-repository

func (*IssuesService)ListLabelsByIssue ¶

func (s *IssuesService) ListLabelsByIssue(ctxcontext.Context, ownerstring, repostring, numberint, opts *ListOptions) ([]*Label, *Response,error)

ListLabelsByIssue lists all labels for an issue.

GitHub API docs:https://developer.github.com/v3/issues/labels/#list-labels-on-an-issue

func (*IssuesService)ListLabelsForMilestone ¶

func (s *IssuesService) ListLabelsForMilestone(ctxcontext.Context, ownerstring, repostring, numberint, opts *ListOptions) ([]*Label, *Response,error)

ListLabelsForMilestone lists labels for every issue in a milestone.

GitHub API docs:https://developer.github.com/v3/issues/labels/#get-labels-for-every-issue-in-a-milestone

func (*IssuesService)ListMilestones ¶

func (s *IssuesService) ListMilestones(ctxcontext.Context, ownerstring, repostring, opts *MilestoneListOptions) ([]*Milestone, *Response,error)

ListMilestones lists all milestones for a repository.

GitHub API docs:https://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository

func (*IssuesService)ListRepositoryEvents ¶

func (s *IssuesService) ListRepositoryEvents(ctxcontext.Context, owner, repostring, opts *ListOptions) ([]*IssueEvent, *Response,error)

ListRepositoryEvents lists events for the specified repository.

GitHub API docs:https://developer.github.com/v3/issues/events/#list-events-for-a-repository

func (*IssuesService)Lock ¶

func (s *IssuesService) Lock(ctxcontext.Context, ownerstring, repostring, numberint, opts *LockIssueOptions) (*Response,error)

Lock an issue's conversation.

GitHub API docs:https://developer.github.com/v3/issues/#lock-an-issue

func (*IssuesService)RemoveAssignees ¶

func (s *IssuesService) RemoveAssignees(ctxcontext.Context, owner, repostring, numberint, assignees []string) (*Issue, *Response,error)

RemoveAssignees removes the provided GitHub users as assignees from the issue.

GitHub API docs:https://developer.github.com/v3/issues/assignees/#remove-assignees-from-an-issue

func (*IssuesService)RemoveLabelForIssue ¶

func (s *IssuesService) RemoveLabelForIssue(ctxcontext.Context, ownerstring, repostring, numberint, labelstring) (*Response,error)

RemoveLabelForIssue removes a label for an issue.

GitHub API docs:https://developer.github.com/v3/issues/labels/#remove-a-label-from-an-issue

func (*IssuesService)RemoveLabelsForIssue ¶

func (s *IssuesService) RemoveLabelsForIssue(ctxcontext.Context, ownerstring, repostring, numberint) (*Response,error)

RemoveLabelsForIssue removes all labels for an issue.

GitHub API docs:https://developer.github.com/v3/issues/labels/#remove-all-labels-from-an-issue

func (*IssuesService)ReplaceLabelsForIssue ¶

func (s *IssuesService) ReplaceLabelsForIssue(ctxcontext.Context, ownerstring, repostring, numberint, labels []string) ([]*Label, *Response,error)

ReplaceLabelsForIssue replaces all labels for an issue.

GitHub API docs:https://developer.github.com/v3/issues/labels/#replace-all-labels-for-an-issue

func (*IssuesService)Unlock ¶

func (s *IssuesService) Unlock(ctxcontext.Context, ownerstring, repostring, numberint) (*Response,error)

Unlock an issue's conversation.

GitHub API docs:https://developer.github.com/v3/issues/#unlock-an-issue

typeKey ¶

type Key struct {ID        *int64     `json:"id,omitempty"`Key       *string    `json:"key,omitempty"`URL       *string    `json:"url,omitempty"`Title     *string    `json:"title,omitempty"`ReadOnly  *bool      `json:"read_only,omitempty"`CreatedAt *Timestamp `json:"created_at,omitempty"`}

Key represents a public SSH key used to authenticate a user or deploy script.

func (*Key)GetCreatedAt ¶

func (k *Key) GetCreatedAt()Timestamp

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*Key)GetID ¶

func (k *Key) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*Key)GetKey ¶

func (k *Key) GetKey()string

GetKey returns the Key field if it's non-nil, zero value otherwise.

func (*Key)GetReadOnly ¶

func (k *Key) GetReadOnly()bool

GetReadOnly returns the ReadOnly field if it's non-nil, zero value otherwise.

func (*Key)GetTitle ¶

func (k *Key) GetTitle()string

GetTitle returns the Title field if it's non-nil, zero value otherwise.

func (*Key)GetURL ¶

func (k *Key) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (Key)String ¶

func (kKey) String()string

typeLabel ¶

type Label struct {ID          *int64  `json:"id,omitempty"`URL         *string `json:"url,omitempty"`Name        *string `json:"name,omitempty"`Color       *string `json:"color,omitempty"`Description *string `json:"description,omitempty"`Default     *bool   `json:"default,omitempty"`NodeID      *string `json:"node_id,omitempty"`}

Label represents a GitHub label on an Issue

func (*Label)GetColor ¶

func (l *Label) GetColor()string

GetColor returns the Color field if it's non-nil, zero value otherwise.

func (*Label)GetDefault ¶

func (l *Label) GetDefault()bool

GetDefault returns the Default field if it's non-nil, zero value otherwise.

func (*Label)GetDescription ¶

func (l *Label) GetDescription()string

GetDescription returns the Description field if it's non-nil, zero value otherwise.

func (*Label)GetID ¶

func (l *Label) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*Label)GetName ¶

func (l *Label) GetName()string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (*Label)GetNodeID ¶

func (l *Label) GetNodeID()string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*Label)GetURL ¶

func (l *Label) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (Label)String ¶

func (lLabel) String()string

typeLabelEvent ¶

type LabelEvent struct {// Action is the action that was performed. Possible values are:// "created", "edited", "deleted"Action *string `json:"action,omitempty"`Label  *Label  `json:"label,omitempty"`// The following fields are only populated by Webhook events.Changes      *EditChange   `json:"changes,omitempty"`Repo         *Repository   `json:"repository,omitempty"`Org          *Organization `json:"organization,omitempty"`Installation *Installation `json:"installation,omitempty"`}

LabelEvent is triggered when a repository's label is created, edited, or deleted.The Webhook event name is "label"

GitHub API docs:https://developer.github.com/v3/activity/events/types/#labelevent

func (*LabelEvent)GetAction ¶

func (l *LabelEvent) GetAction()string

GetAction returns the Action field if it's non-nil, zero value otherwise.

func (*LabelEvent)GetChanges ¶

func (l *LabelEvent) GetChanges() *EditChange

GetChanges returns the Changes field.

func (*LabelEvent)GetInstallation ¶

func (l *LabelEvent) GetInstallation() *Installation

GetInstallation returns the Installation field.

func (*LabelEvent)GetLabel ¶

func (l *LabelEvent) GetLabel() *Label

GetLabel returns the Label field.

func (*LabelEvent)GetOrg ¶

func (l *LabelEvent) GetOrg() *Organization

GetOrg returns the Org field.

func (*LabelEvent)GetRepo ¶

func (l *LabelEvent) GetRepo() *Repository

GetRepo returns the Repo field.

typeLabelResult ¶

type LabelResult struct {ID          *int64   `json:"id,omitempty"`URL         *string  `json:"url,omitempty"`Name        *string  `json:"name,omitempty"`Color       *string  `json:"color,omitempty"`Default     *bool    `json:"default,omitempty"`Description *string  `json:"description,omitempty"`Score       *float64 `json:"score,omitempty"`}

LabelResult represents a single search result.

func (*LabelResult)GetColor ¶

func (l *LabelResult) GetColor()string

GetColor returns the Color field if it's non-nil, zero value otherwise.

func (*LabelResult)GetDefault ¶

func (l *LabelResult) GetDefault()bool

GetDefault returns the Default field if it's non-nil, zero value otherwise.

func (*LabelResult)GetDescription ¶

func (l *LabelResult) GetDescription()string

GetDescription returns the Description field if it's non-nil, zero value otherwise.

func (*LabelResult)GetID ¶

func (l *LabelResult) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*LabelResult)GetName ¶

func (l *LabelResult) GetName()string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (*LabelResult)GetScore ¶

func (l *LabelResult) GetScore() *float64

GetScore returns the Score field.

func (*LabelResult)GetURL ¶

func (l *LabelResult) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (LabelResult)String ¶

func (lLabelResult) String()string

typeLabelsSearchResult ¶

type LabelsSearchResult struct {Total             *int           `json:"total_count,omitempty"`IncompleteResults *bool          `json:"incomplete_results,omitempty"`Labels            []*LabelResult `json:"items,omitempty"`}

LabelsSearchResult represents the result of a code search.

func (*LabelsSearchResult)GetIncompleteResults ¶

func (l *LabelsSearchResult) GetIncompleteResults()bool

GetIncompleteResults returns the IncompleteResults field if it's non-nil, zero value otherwise.

func (*LabelsSearchResult)GetTotal ¶

func (l *LabelsSearchResult) GetTotal()int

GetTotal returns the Total field if it's non-nil, zero value otherwise.

typeLargeFile ¶

type LargeFile struct {RefName *string `json:"ref_name,omitempty"`Path    *string `json:"path,omitempty"`OID     *string `json:"oid,omitempty"`Size    *int    `json:"size,omitempty"`}

LargeFile identifies a file larger than 100MB found during a repository import.

GitHub API docs:https://developer.github.com/v3/migration/source_imports/#get-large-files

func (*LargeFile)GetOID ¶

func (l *LargeFile) GetOID()string

GetOID returns the OID field if it's non-nil, zero value otherwise.

func (*LargeFile)GetPath ¶

func (l *LargeFile) GetPath()string

GetPath returns the Path field if it's non-nil, zero value otherwise.

func (*LargeFile)GetRefName ¶

func (l *LargeFile) GetRefName()string

GetRefName returns the RefName field if it's non-nil, zero value otherwise.

func (*LargeFile)GetSize ¶

func (l *LargeFile) GetSize()int

GetSize returns the Size field if it's non-nil, zero value otherwise.

func (LargeFile)String ¶

func (fLargeFile) String()string

typeLicense ¶

type License struct {Key  *string `json:"key,omitempty"`Name *string `json:"name,omitempty"`URL  *string `json:"url,omitempty"`SPDXID         *string   `json:"spdx_id,omitempty"`HTMLURL        *string   `json:"html_url,omitempty"`Featured       *bool     `json:"featured,omitempty"`Description    *string   `json:"description,omitempty"`Implementation *string   `json:"implementation,omitempty"`Permissions    *[]string `json:"permissions,omitempty"`Conditions     *[]string `json:"conditions,omitempty"`Limitations    *[]string `json:"limitations,omitempty"`Body           *string   `json:"body,omitempty"`}

License represents an open source license.

func (*License)GetBody ¶

func (l *License) GetBody()string

GetBody returns the Body field if it's non-nil, zero value otherwise.

func (*License)GetConditions ¶

func (l *License) GetConditions() []string

GetConditions returns the Conditions field if it's non-nil, zero value otherwise.

func (*License)GetDescription ¶

func (l *License) GetDescription()string

GetDescription returns the Description field if it's non-nil, zero value otherwise.

func (*License)GetFeatured ¶

func (l *License) GetFeatured()bool

GetFeatured returns the Featured field if it's non-nil, zero value otherwise.

func (*License)GetHTMLURL ¶

func (l *License) GetHTMLURL()string

GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.

func (*License)GetImplementation ¶

func (l *License) GetImplementation()string

GetImplementation returns the Implementation field if it's non-nil, zero value otherwise.

func (*License)GetKey ¶

func (l *License) GetKey()string

GetKey returns the Key field if it's non-nil, zero value otherwise.

func (*License)GetLimitations ¶

func (l *License) GetLimitations() []string

GetLimitations returns the Limitations field if it's non-nil, zero value otherwise.

func (*License)GetName ¶

func (l *License) GetName()string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (*License)GetPermissions ¶

func (l *License) GetPermissions() []string

GetPermissions returns the Permissions field if it's non-nil, zero value otherwise.

func (*License)GetSPDXID ¶

func (l *License) GetSPDXID()string

GetSPDXID returns the SPDXID field if it's non-nil, zero value otherwise.

func (*License)GetURL ¶

func (l *License) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (License)String ¶

func (lLicense) String()string

typeLicensesService ¶

type LicensesService service

LicensesService handles communication with the license relatedmethods of the GitHub API.

GitHub API docs:https://developer.github.com/v3/licenses/

func (*LicensesService)Get ¶

func (s *LicensesService) Get(ctxcontext.Context, licenseNamestring) (*License, *Response,error)

Get extended metadata for one license.

GitHub API docs:https://developer.github.com/v3/licenses/#get-an-individual-license

func (*LicensesService)List ¶

func (s *LicensesService) List(ctxcontext.Context) ([]*License, *Response,error)

List popular open source licenses.

GitHub API docs:https://developer.github.com/v3/licenses/#list-all-licenses

typeListCheckRunsOptions ¶

type ListCheckRunsOptions struct {CheckName *string `url:"check_name,omitempty"`// Returns check runs with the specified name.Status    *string `url:"status,omitempty"`// Returns check runs with the specified status. Can be one of "queued", "in_progress", or "completed".Filter    *string `url:"filter,omitempty"`// Filters check runs by their completed_at timestamp. Can be one of "latest" (returning the most recent check runs) or "all". Default: "latest"ListOptions}

ListCheckRunsOptions represents parameters to list check runs.

func (*ListCheckRunsOptions)GetCheckName ¶

func (l *ListCheckRunsOptions) GetCheckName()string

GetCheckName returns the CheckName field if it's non-nil, zero value otherwise.

func (*ListCheckRunsOptions)GetFilter ¶

func (l *ListCheckRunsOptions) GetFilter()string

GetFilter returns the Filter field if it's non-nil, zero value otherwise.

func (*ListCheckRunsOptions)GetStatus ¶

func (l *ListCheckRunsOptions) GetStatus()string

GetStatus returns the Status field if it's non-nil, zero value otherwise.

typeListCheckRunsResults ¶

type ListCheckRunsResults struct {Total     *int        `json:"total_count,omitempty"`CheckRuns []*CheckRun `json:"check_runs,omitempty"`}

ListCheckRunsResults represents the result of a check run list.

func (*ListCheckRunsResults)GetTotal ¶

func (l *ListCheckRunsResults) GetTotal()int

GetTotal returns the Total field if it's non-nil, zero value otherwise.

typeListCheckSuiteOptions ¶

type ListCheckSuiteOptions struct {CheckName *string `url:"check_name,omitempty"`// Filters checks suites by the name of the check run.AppID     *int    `url:"app_id,omitempty"`// Filters check suites by GitHub App id.ListOptions}

ListCheckSuiteOptions represents parameters to list check suites.

func (*ListCheckSuiteOptions)GetAppID ¶

func (l *ListCheckSuiteOptions) GetAppID()int

GetAppID returns the AppID field if it's non-nil, zero value otherwise.

func (*ListCheckSuiteOptions)GetCheckName ¶

func (l *ListCheckSuiteOptions) GetCheckName()string

GetCheckName returns the CheckName field if it's non-nil, zero value otherwise.

typeListCheckSuiteResults ¶

type ListCheckSuiteResults struct {Total       *int          `json:"total_count,omitempty"`CheckSuites []*CheckSuite `json:"check_suites,omitempty"`}

ListCheckSuiteResults represents the result of a check run list.

func (*ListCheckSuiteResults)GetTotal ¶

func (l *ListCheckSuiteResults) GetTotal()int

GetTotal returns the Total field if it's non-nil, zero value otherwise.

typeListCollaboratorOptions ¶

type ListCollaboratorOptions struct {// Affiliation specifies how collaborators should be filtered by their affiliation.// Possible values are://     "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//// Default value is "all".Affiliation *string `url:"affiliation,omitempty"`ListOptions}

ListCollaboratorOptions specifies the optional parameters to theProjectsService.ListProjectCollaborators method.

func (*ListCollaboratorOptions)GetAffiliation ¶

func (l *ListCollaboratorOptions) GetAffiliation()string

GetAffiliation returns the Affiliation field if it's non-nil, zero value otherwise.

typeListCollaboratorsOptions ¶

type ListCollaboratorsOptions struct {// Affiliation specifies how collaborators should be filtered by their affiliation.// Possible values are://     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//// Default value is "all".Affiliationstring `url:"affiliation,omitempty"`ListOptions}

ListCollaboratorsOptions specifies the optional parameters to theRepositoriesService.ListCollaborators method.

typeListCommentReactionOptions ¶

type ListCommentReactionOptions struct {// Content restricts the returned comment reactions to only those with the given type.// Omit this parameter to list all reactions to a commit comment.// Possible values are: "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", or "eyes".Contentstring `url:"content,omitempty"`ListOptions}

ListCommentReactionOptions specifies the optional parameters to theReactionsService.ListCommentReactions method.

typeListContributorsOptions ¶

type ListContributorsOptions struct {// Include anonymous contributors in results or notAnonstring `url:"anon,omitempty"`ListOptions}

ListContributorsOptions specifies the optional parameters to theRepositoriesService.ListContributors method.

typeListCursorOptions ¶added inv29.0.3

type ListCursorOptions struct {// For paginated result sets, page of results to retrieve.Pagestring `url:"page,omitempty"`// For paginated result sets, the number of results to include per page.PerPageint `url:"per_page,omitempty"`}

ListCursorOptions specifies the optional parameters to various List methods thatsupport cursor pagination.

typeListMembersOptions ¶

type ListMembersOptions struct {// If true (or if the authenticated user is not an owner of the// organization), list only publicly visible members.PublicOnlybool `url:"-"`// Filter members returned in the list. Possible values are:// 2fa_disabled, all. Default is "all".Filterstring `url:"filter,omitempty"`// Role filters members returned by their role in the organization.// Possible values are://     all - all members of the organization, regardless of role//     admin - organization owners//     member - non-owner organization members//// Default is "all".Rolestring `url:"role,omitempty"`ListOptions}

ListMembersOptions specifies optional parameters to theOrganizationsService.ListMembers method.

typeListOptions ¶

type ListOptions struct {// For paginated result sets, page of results to retrieve.Pageint `url:"page,omitempty"`// For paginated result sets, the number of results to include per page.PerPageint `url:"per_page,omitempty"`}

ListOptions specifies the optional parameters to various List methods thatsupport offset pagination.

typeListOrgMembershipsOptions ¶

type ListOrgMembershipsOptions struct {// Filter memberships to include only those with the specified state.// Possible values are: "active", "pending".Statestring `url:"state,omitempty"`ListOptions}

ListOrgMembershipsOptions specifies optional parameters to theOrganizationsService.ListOrgMemberships method.

typeListOutsideCollaboratorsOptions ¶

type ListOutsideCollaboratorsOptions struct {// Filter outside collaborators returned in the list. Possible values are:// 2fa_disabled, all.  Default is "all".Filterstring `url:"filter,omitempty"`ListOptions}

ListOutsideCollaboratorsOptions specifies optional parameters to theOrganizationsService.ListOutsideCollaborators method.

typeLockIssueOptions ¶

type LockIssueOptions struct {// LockReason specifies the reason to lock this issue.// Providing a lock reason can help make it clearer to contributors why an issue// was locked. Possible values are: "off-topic", "too heated", "resolved", and "spam".LockReasonstring `json:"lock_reason,omitempty"`}

LockIssueOptions specifies the optional parameters to theIssuesService.Lock method.

typeMarkdownOptions ¶

type MarkdownOptions struct {// Mode identifies the rendering mode. Possible values are://   markdown - render a document as plain Markdown, just like//   README files are rendered.////   gfm - to render a document as user-content, e.g. like user//   comments or issues are rendered. In GFM mode, hard line breaks are//   always taken into account, and issue and user mentions are linked//   accordingly.//// Default is "markdown".Modestring// Context identifies the repository context. Only taken into account// when rendering as "gfm".Contextstring}

MarkdownOptions specifies optional parameters to the Markdown method.

typeMarketplacePendingChange ¶

type MarketplacePendingChange struct {EffectiveDate *Timestamp       `json:"effective_date,omitempty"`UnitCount     *int             `json:"unit_count,omitempty"`ID            *int64           `json:"id,omitempty"`Plan          *MarketplacePlan `json:"plan,omitempty"`}

MarketplacePendingChange represents a pending change to a GitHub Apps Marketplace Plan.

func (*MarketplacePendingChange)GetEffectiveDate ¶

func (m *MarketplacePendingChange) GetEffectiveDate()Timestamp

GetEffectiveDate returns the EffectiveDate field if it's non-nil, zero value otherwise.

func (*MarketplacePendingChange)GetID ¶

func (m *MarketplacePendingChange) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*MarketplacePendingChange)GetPlan ¶

func (m *MarketplacePendingChange) GetPlan() *MarketplacePlan

GetPlan returns the Plan field.

func (*MarketplacePendingChange)GetUnitCount ¶

func (m *MarketplacePendingChange) GetUnitCount()int

GetUnitCount returns the UnitCount field if it's non-nil, zero value otherwise.

typeMarketplacePlan ¶

type MarketplacePlan struct {URL                 *string `json:"url,omitempty"`AccountsURL         *string `json:"accounts_url,omitempty"`ID                  *int64  `json:"id,omitempty"`Name                *string `json:"name,omitempty"`Description         *string `json:"description,omitempty"`MonthlyPriceInCents *int    `json:"monthly_price_in_cents,omitempty"`YearlyPriceInCents  *int    `json:"yearly_price_in_cents,omitempty"`// The pricing model for this listing.  Can be one of "flat-rate", "per-unit", or "free".PriceModel *string   `json:"price_model,omitempty"`UnitName   *string   `json:"unit_name,omitempty"`Bullets    *[]string `json:"bullets,omitempty"`// State can be one of the values "draft" or "published".State        *string `json:"state,omitempty"`HasFreeTrial *bool   `json:"has_free_trial,omitempty"`}

MarketplacePlan represents a GitHub Apps Marketplace Listing Plan.

func (*MarketplacePlan)GetAccountsURL ¶

func (m *MarketplacePlan) GetAccountsURL()string

GetAccountsURL returns the AccountsURL field if it's non-nil, zero value otherwise.

func (*MarketplacePlan)GetBullets ¶

func (m *MarketplacePlan) GetBullets() []string

GetBullets returns the Bullets field if it's non-nil, zero value otherwise.

func (*MarketplacePlan)GetDescription ¶

func (m *MarketplacePlan) GetDescription()string

GetDescription returns the Description field if it's non-nil, zero value otherwise.

func (*MarketplacePlan)GetHasFreeTrial ¶

func (m *MarketplacePlan) GetHasFreeTrial()bool

GetHasFreeTrial returns the HasFreeTrial field if it's non-nil, zero value otherwise.

func (*MarketplacePlan)GetID ¶

func (m *MarketplacePlan) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*MarketplacePlan)GetMonthlyPriceInCents ¶

func (m *MarketplacePlan) GetMonthlyPriceInCents()int

GetMonthlyPriceInCents returns the MonthlyPriceInCents field if it's non-nil, zero value otherwise.

func (*MarketplacePlan)GetName ¶

func (m *MarketplacePlan) GetName()string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (*MarketplacePlan)GetPriceModel ¶

func (m *MarketplacePlan) GetPriceModel()string

GetPriceModel returns the PriceModel field if it's non-nil, zero value otherwise.

func (*MarketplacePlan)GetState ¶

func (m *MarketplacePlan) GetState()string

GetState returns the State field if it's non-nil, zero value otherwise.

func (*MarketplacePlan)GetURL ¶

func (m *MarketplacePlan) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (*MarketplacePlan)GetUnitName ¶

func (m *MarketplacePlan) GetUnitName()string

GetUnitName returns the UnitName field if it's non-nil, zero value otherwise.

func (*MarketplacePlan)GetYearlyPriceInCents ¶

func (m *MarketplacePlan) GetYearlyPriceInCents()int

GetYearlyPriceInCents returns the YearlyPriceInCents field if it's non-nil, zero value otherwise.

typeMarketplacePlanAccount ¶

type MarketplacePlanAccount struct {URL                      *string                   `json:"url,omitempty"`Type                     *string                   `json:"type,omitempty"`ID                       *int64                    `json:"id,omitempty"`NodeID                   *string                   `json:"node_id,omitempty"`Login                    *string                   `json:"login,omitempty"`Email                    *string                   `json:"email,omitempty"`OrganizationBillingEmail *string                   `json:"organization_billing_email,omitempty"`MarketplacePurchase      *MarketplacePurchase      `json:"marketplace_purchase,omitempty"`MarketplacePendingChange *MarketplacePendingChange `json:"marketplace_pending_change,omitempty"`}

MarketplacePlanAccount represents a GitHub Account (user or organization) on a specific plan.

func (*MarketplacePlanAccount)GetEmail ¶

func (m *MarketplacePlanAccount) GetEmail()string

GetEmail returns the Email field if it's non-nil, zero value otherwise.

func (*MarketplacePlanAccount)GetID ¶

func (m *MarketplacePlanAccount) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*MarketplacePlanAccount)GetLogin ¶

func (m *MarketplacePlanAccount) GetLogin()string

GetLogin returns the Login field if it's non-nil, zero value otherwise.

func (*MarketplacePlanAccount)GetMarketplacePendingChange ¶

func (m *MarketplacePlanAccount) GetMarketplacePendingChange() *MarketplacePendingChange

GetMarketplacePendingChange returns the MarketplacePendingChange field.

func (*MarketplacePlanAccount)GetMarketplacePurchase ¶

func (m *MarketplacePlanAccount) GetMarketplacePurchase() *MarketplacePurchase

GetMarketplacePurchase returns the MarketplacePurchase field.

func (*MarketplacePlanAccount)GetNodeID ¶

func (m *MarketplacePlanAccount) GetNodeID()string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*MarketplacePlanAccount)GetOrganizationBillingEmail ¶

func (m *MarketplacePlanAccount) GetOrganizationBillingEmail()string

GetOrganizationBillingEmail returns the OrganizationBillingEmail field if it's non-nil, zero value otherwise.

func (*MarketplacePlanAccount)GetType ¶

func (m *MarketplacePlanAccount) GetType()string

GetType returns the Type field if it's non-nil, zero value otherwise.

func (*MarketplacePlanAccount)GetURL ¶

func (m *MarketplacePlanAccount) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

typeMarketplacePurchase ¶

type MarketplacePurchase struct {// BillingCycle can be one of the values "yearly", "monthly" or nil.BillingCycle    *string                 `json:"billing_cycle,omitempty"`NextBillingDate *Timestamp              `json:"next_billing_date,omitempty"`UnitCount       *int                    `json:"unit_count,omitempty"`Plan            *MarketplacePlan        `json:"plan,omitempty"`Account         *MarketplacePlanAccount `json:"account,omitempty"`OnFreeTrial     *bool                   `json:"on_free_trial,omitempty"`FreeTrialEndsOn *Timestamp              `json:"free_trial_ends_on,omitempty"`}

MarketplacePurchase represents a GitHub Apps Marketplace Purchase.

func (*MarketplacePurchase)GetAccount ¶

func (m *MarketplacePurchase) GetAccount() *MarketplacePlanAccount

GetAccount returns the Account field.

func (*MarketplacePurchase)GetBillingCycle ¶

func (m *MarketplacePurchase) GetBillingCycle()string

GetBillingCycle returns the BillingCycle field if it's non-nil, zero value otherwise.

func (*MarketplacePurchase)GetFreeTrialEndsOn ¶

func (m *MarketplacePurchase) GetFreeTrialEndsOn()Timestamp

GetFreeTrialEndsOn returns the FreeTrialEndsOn field if it's non-nil, zero value otherwise.

func (*MarketplacePurchase)GetNextBillingDate ¶

func (m *MarketplacePurchase) GetNextBillingDate()Timestamp

GetNextBillingDate returns the NextBillingDate field if it's non-nil, zero value otherwise.

func (*MarketplacePurchase)GetOnFreeTrial ¶

func (m *MarketplacePurchase) GetOnFreeTrial()bool

GetOnFreeTrial returns the OnFreeTrial field if it's non-nil, zero value otherwise.

func (*MarketplacePurchase)GetPlan ¶

func (m *MarketplacePurchase) GetPlan() *MarketplacePlan

GetPlan returns the Plan field.

func (*MarketplacePurchase)GetUnitCount ¶

func (m *MarketplacePurchase) GetUnitCount()int

GetUnitCount returns the UnitCount field if it's non-nil, zero value otherwise.

typeMarketplacePurchaseEvent ¶

type MarketplacePurchaseEvent struct {// Action is the action that was performed. Possible values are:// "purchased", "cancelled", "pending_change", "pending_change_cancelled", "changed".Action *string `json:"action,omitempty"`// The following fields are only populated by Webhook events.EffectiveDate               *Timestamp           `json:"effective_date,omitempty"`MarketplacePurchase         *MarketplacePurchase `json:"marketplace_purchase,omitempty"`PreviousMarketplacePurchase *MarketplacePurchase `json:"previous_marketplace_purchase,omitempty"`Sender                      *User                `json:"sender,omitempty"`Installation                *Installation        `json:"installation,omitempty"`}

MarketplacePurchaseEvent is triggered when a user purchases, cancels, or changestheir GitHub Marketplace plan.Webhook event name "marketplace_purchase".

Github API docs:https://developer.github.com/v3/activity/events/types/#marketplacepurchaseevent

func (*MarketplacePurchaseEvent)GetAction ¶

func (m *MarketplacePurchaseEvent) GetAction()string

GetAction returns the Action field if it's non-nil, zero value otherwise.

func (*MarketplacePurchaseEvent)GetEffectiveDate ¶

func (m *MarketplacePurchaseEvent) GetEffectiveDate()Timestamp

GetEffectiveDate returns the EffectiveDate field if it's non-nil, zero value otherwise.

func (*MarketplacePurchaseEvent)GetInstallation ¶

func (m *MarketplacePurchaseEvent) GetInstallation() *Installation

GetInstallation returns the Installation field.

func (*MarketplacePurchaseEvent)GetMarketplacePurchase ¶

func (m *MarketplacePurchaseEvent) GetMarketplacePurchase() *MarketplacePurchase

GetMarketplacePurchase returns the MarketplacePurchase field.

func (*MarketplacePurchaseEvent)GetPreviousMarketplacePurchase ¶

func (m *MarketplacePurchaseEvent) GetPreviousMarketplacePurchase() *MarketplacePurchase

GetPreviousMarketplacePurchase returns the PreviousMarketplacePurchase field.

func (*MarketplacePurchaseEvent)GetSender ¶

func (m *MarketplacePurchaseEvent) GetSender() *User

GetSender returns the Sender field.

typeMarketplaceService ¶

type MarketplaceService struct {// Stubbed controls whether endpoints that return stubbed data are used// instead of production endpoints. Stubbed data is fake data that's useful// for testing your GitHub Apps. Stubbed data is hard-coded and will not// change based on actual subscriptions.//// GitHub API docs:https://developer.github.com/v3/apps/marketplace/Stubbedbool// contains filtered or unexported fields}

MarketplaceService handles communication with the marketplace relatedmethods of the GitHub API.

GitHub API docs:https://developer.github.com/v3/apps/marketplace/

func (*MarketplaceService)ListMarketplacePurchasesForUser ¶

func (s *MarketplaceService) ListMarketplacePurchasesForUser(ctxcontext.Context, opts *ListOptions) ([]*MarketplacePurchase, *Response,error)

ListMarketplacePurchasesForUser lists all GitHub marketplace purchases made by a user.

GitHub API docs:https://developer.github.com/v3/apps/marketplace/#get-a-users-marketplace-purchases

func (*MarketplaceService)ListPlanAccountsForAccount ¶

func (s *MarketplaceService) ListPlanAccountsForAccount(ctxcontext.Context, accountIDint64, opts *ListOptions) ([]*MarketplacePlanAccount, *Response,error)

ListPlanAccountsForAccount lists all GitHub accounts (user or organization) associated with an account.

GitHub API docs:https://developer.github.com/v3/apps/marketplace/#check-if-a-github-account-is-associated-with-any-marketplace-listing

func (*MarketplaceService)ListPlanAccountsForPlan ¶

func (s *MarketplaceService) ListPlanAccountsForPlan(ctxcontext.Context, planIDint64, opts *ListOptions) ([]*MarketplacePlanAccount, *Response,error)

ListPlanAccountsForPlan lists all GitHub accounts (user or organization) on a specific plan.

GitHub API docs:https://developer.github.com/v3/apps/marketplace/#list-all-github-accounts-user-or-organization-on-a-specific-plan

func (*MarketplaceService)ListPlans ¶

func (s *MarketplaceService) ListPlans(ctxcontext.Context, opts *ListOptions) ([]*MarketplacePlan, *Response,error)

ListPlans lists all plans for your Marketplace listing.

GitHub API docs:https://developer.github.com/v3/apps/marketplace/#list-all-plans-for-your-marketplace-listing

typeMatch ¶

type Match struct {Text    *string `json:"text,omitempty"`Indices []int   `json:"indices,omitempty"`}

Match represents a single text match.

func (*Match)GetText ¶

func (m *Match) GetText()string

GetText returns the Text field if it's non-nil, zero value otherwise.

typeMemberEvent ¶

type MemberEvent struct {// Action is the action that was performed. Possible value is: "added".Action *string `json:"action,omitempty"`Member *User   `json:"member,omitempty"`// The following fields are only populated by Webhook events.Repo         *Repository   `json:"repository,omitempty"`Sender       *User         `json:"sender,omitempty"`Installation *Installation `json:"installation,omitempty"`}

MemberEvent is triggered when a user is added as a collaborator to a repository.The Webhook event name is "member".

GitHub API docs:https://developer.github.com/v3/activity/events/types/#memberevent

func (*MemberEvent)GetAction ¶

func (m *MemberEvent) GetAction()string

GetAction returns the Action field if it's non-nil, zero value otherwise.

func (*MemberEvent)GetInstallation ¶

func (m *MemberEvent) GetInstallation() *Installation

GetInstallation returns the Installation field.

func (*MemberEvent)GetMember ¶

func (m *MemberEvent) GetMember() *User

GetMember returns the Member field.

func (*MemberEvent)GetRepo ¶

func (m *MemberEvent) GetRepo() *Repository

GetRepo returns the Repo field.

func (*MemberEvent)GetSender ¶

func (m *MemberEvent) GetSender() *User

GetSender returns the Sender field.

typeMembership ¶

type Membership struct {URL *string `json:"url,omitempty"`// State is the user's status within the organization or team.// Possible values are: "active", "pending"State *string `json:"state,omitempty"`// Role identifies the user's role within the organization or team.// Possible values for organization membership://     member - non-owner organization member//     admin - organization owner//// Possible values for team membership are://     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 descriptionRole *string `json:"role,omitempty"`// For organization membership, the API URL of the organization.OrganizationURL *string `json:"organization_url,omitempty"`// For organization membership, the organization the membership is for.Organization *Organization `json:"organization,omitempty"`// For organization membership, the user the membership is for.User *User `json:"user,omitempty"`}

Membership represents the status of a user's membership in an organization or team.

func (*Membership)GetOrganization ¶

func (m *Membership) GetOrganization() *Organization

GetOrganization returns the Organization field.

func (*Membership)GetOrganizationURL ¶

func (m *Membership) GetOrganizationURL()string

GetOrganizationURL returns the OrganizationURL field if it's non-nil, zero value otherwise.

func (*Membership)GetRole ¶

func (m *Membership) GetRole()string

GetRole returns the Role field if it's non-nil, zero value otherwise.

func (*Membership)GetState ¶

func (m *Membership) GetState()string

GetState returns the State field if it's non-nil, zero value otherwise.

func (*Membership)GetURL ¶

func (m *Membership) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (*Membership)GetUser ¶

func (m *Membership) GetUser() *User

GetUser returns the User field.

func (Membership)String ¶

func (mMembership) String()string

typeMembershipEvent ¶

type MembershipEvent struct {// Action is the action that was performed. Possible values are: "added", "removed".Action *string `json:"action,omitempty"`// Scope is the scope of the membership. Possible value is: "team".Scope  *string `json:"scope,omitempty"`Member *User   `json:"member,omitempty"`Team   *Team   `json:"team,omitempty"`// The following fields are only populated by Webhook events.Org          *Organization `json:"organization,omitempty"`Sender       *User         `json:"sender,omitempty"`Installation *Installation `json:"installation,omitempty"`}

MembershipEvent is triggered when a user is added or removed from a team.The Webhook event name is "membership".

Events of this type are not visible in timelines, they are only used totrigger organization webhooks.

GitHub API docs:https://developer.github.com/v3/activity/events/types/#membershipevent

func (*MembershipEvent)GetAction ¶

func (m *MembershipEvent) GetAction()string

GetAction returns the Action field if it's non-nil, zero value otherwise.

func (*MembershipEvent)GetInstallation ¶

func (m *MembershipEvent) GetInstallation() *Installation

GetInstallation returns the Installation field.

func (*MembershipEvent)GetMember ¶

func (m *MembershipEvent) GetMember() *User

GetMember returns the Member field.

func (*MembershipEvent)GetOrg ¶

func (m *MembershipEvent) GetOrg() *Organization

GetOrg returns the Org field.

func (*MembershipEvent)GetScope ¶

func (m *MembershipEvent) GetScope()string

GetScope returns the Scope field if it's non-nil, zero value otherwise.

func (*MembershipEvent)GetSender ¶

func (m *MembershipEvent) GetSender() *User

GetSender returns the Sender field.

func (*MembershipEvent)GetTeam ¶

func (m *MembershipEvent) GetTeam() *Team

GetTeam returns the Team field.

typeMetaEvent ¶

type MetaEvent struct {// Action is the action that was performed. Possible value is: "deleted".Action *string `json:"action,omitempty"`// The ID of the modified webhook.HookID *int64 `json:"hook_id,omitempty"`// The modified webhook.// This will contain different keys based on the type of webhook it is: repository,// organization, business, app, or GitHub Marketplace.Hook *Hook `json:"hook,omitempty"`}

MetaEvent is triggered when the webhook that this event is configured on is deleted.This event will only listen for changes to the particular hook the event is installed on.Therefore, it must be selected for each hook that you'd like to receive meta events for.The Webhook event name is "meta".

GitHub API docs:https://developer.github.com/v3/activity/events/types/#metaevent

func (*MetaEvent)GetAction ¶

func (m *MetaEvent) GetAction()string

GetAction returns the Action field if it's non-nil, zero value otherwise.

func (*MetaEvent)GetHook ¶

func (m *MetaEvent) GetHook() *Hook

GetHook returns the Hook field.

func (*MetaEvent)GetHookID ¶

func (m *MetaEvent) GetHookID()int64

GetHookID returns the HookID field if it's non-nil, zero value otherwise.

typeMetric ¶

type Metric struct {Name    *string `json:"name"`Key     *string `json:"key"`URL     *string `json:"url"`HTMLURL *string `json:"html_url"`}

Metric represents the different fields for one file in community health files.

func (*Metric)GetHTMLURL ¶

func (m *Metric) GetHTMLURL()string

GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.

func (*Metric)GetKey ¶

func (m *Metric) GetKey()string

GetKey returns the Key field if it's non-nil, zero value otherwise.

func (*Metric)GetName ¶

func (m *Metric) GetName()string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (*Metric)GetURL ¶

func (m *Metric) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

typeMigration ¶

type Migration struct {ID   *int64  `json:"id,omitempty"`GUID *string `json:"guid,omitempty"`// State is the current state of a migration.// Possible values are://     "pending" which means the migration hasn't started yet,//     "exporting" which means the migration is in progress,//     "exported" which means the migration finished successfully, or//     "failed" which means the migration failed.State *string `json:"state,omitempty"`// LockRepositories indicates whether repositories are locked (to prevent// manipulation) while migrating data.LockRepositories *bool `json:"lock_repositories,omitempty"`// ExcludeAttachments indicates whether attachments should be excluded from// the migration (to reduce migration archive file size).ExcludeAttachments *bool         `json:"exclude_attachments,omitempty"`URL                *string       `json:"url,omitempty"`CreatedAt          *string       `json:"created_at,omitempty"`UpdatedAt          *string       `json:"updated_at,omitempty"`Repositories       []*Repository `json:"repositories,omitempty"`}

Migration represents a GitHub migration (archival).

func (*Migration)GetCreatedAt ¶

func (m *Migration) GetCreatedAt()string

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*Migration)GetExcludeAttachments ¶

func (m *Migration) GetExcludeAttachments()bool

GetExcludeAttachments returns the ExcludeAttachments field if it's non-nil, zero value otherwise.

func (*Migration)GetGUID ¶

func (m *Migration) GetGUID()string

GetGUID returns the GUID field if it's non-nil, zero value otherwise.

func (*Migration)GetID ¶

func (m *Migration) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*Migration)GetLockRepositories ¶

func (m *Migration) GetLockRepositories()bool

GetLockRepositories returns the LockRepositories field if it's non-nil, zero value otherwise.

func (*Migration)GetState ¶

func (m *Migration) GetState()string

GetState returns the State field if it's non-nil, zero value otherwise.

func (*Migration)GetURL ¶

func (m *Migration) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (*Migration)GetUpdatedAt ¶

func (m *Migration) GetUpdatedAt()string

GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.

func (Migration)String ¶

func (mMigration) String()string

typeMigrationOptions ¶

type MigrationOptions struct {// LockRepositories indicates whether repositories should be locked (to prevent// manipulation) while migrating data.LockRepositoriesbool// ExcludeAttachments indicates whether attachments should be excluded from// the migration (to reduce migration archive file size).ExcludeAttachmentsbool}

MigrationOptions specifies the optional parameters to Migration methods.

typeMigrationService ¶

type MigrationService service

MigrationService provides access to the migration related functionsin the GitHub API.

GitHub API docs:https://developer.github.com/v3/migration/

func (*MigrationService)CancelImport ¶

func (s *MigrationService) CancelImport(ctxcontext.Context, owner, repostring) (*Response,error)

CancelImport stops an import for a repository.

GitHub API docs:https://developer.github.com/v3/migration/source_imports/#cancel-an-import

func (*MigrationService)CommitAuthors ¶

func (s *MigrationService) CommitAuthors(ctxcontext.Context, owner, repostring) ([]*SourceImportAuthor, *Response,error)

CommitAuthors gets the authors mapped from the original repository.

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 willmake the author information valid, but the author might not be correct. Forexample, it will change the bare Subversion username "hubot" into somethinglike "hubot <hubot@12341234-abab-fefe-8787-fedcba987654>".

This method and MapCommitAuthor allow you to provide correct Git authorinformation.

GitHub API docs:https://developer.github.com/v3/migration/source_imports/#get-commit-authors

func (*MigrationService)DeleteMigration ¶

func (s *MigrationService) DeleteMigration(ctxcontext.Context, orgstring, idint64) (*Response,error)

DeleteMigration deletes a previous migration archive.id is the migration ID.

GitHub API docs:https://developer.github.com/v3/migration/migrations/#delete-a-migration-archive

func (*MigrationService)DeleteUserMigration ¶

func (s *MigrationService) DeleteUserMigration(ctxcontext.Context, idint64) (*Response,error)

DeleteUserMigration will delete a previous migration archive.id is the migration ID.

GitHub API docs:https://developer.github.com/v3/migrations/users/#delete-a-user-migration-archive

func (*MigrationService)ImportProgress ¶

func (s *MigrationService) ImportProgress(ctxcontext.Context, owner, repostring) (*Import, *Response,error)

ImportProgress queries for the status and progress of an ongoing repository import.

GitHub API docs:https://developer.github.com/v3/migration/source_imports/#get-import-progress

func (*MigrationService)LargeFiles ¶

func (s *MigrationService) LargeFiles(ctxcontext.Context, owner, repostring) ([]*LargeFile, *Response,error)

LargeFiles lists files larger than 100MB found during the import.

GitHub API docs:https://developer.github.com/v3/migration/source_imports/#get-large-files

func (*MigrationService)ListMigrations ¶

func (s *MigrationService) ListMigrations(ctxcontext.Context, orgstring, opts *ListOptions) ([]*Migration, *Response,error)

ListMigrations lists the most recent migrations.

GitHub API docs:https://developer.github.com/v3/migrations/orgs/#get-a-list-of-organization-migrations

func (*MigrationService)ListUserMigrations ¶

func (s *MigrationService) ListUserMigrations(ctxcontext.Context) ([]*UserMigration, *Response,error)

ListUserMigrations lists the most recent migrations.

GitHub API docs:https://developer.github.com/v3/migrations/users/#get-a-list-of-user-migrations

func (*MigrationService)MapCommitAuthor ¶

func (s *MigrationService) MapCommitAuthor(ctxcontext.Context, owner, repostring, idint64, author *SourceImportAuthor) (*SourceImportAuthor, *Response,error)

MapCommitAuthor updates an author's identity for the import. Yourapplication can continue updating authors any time before you push newcommits to the repository.

GitHub API docs:https://developer.github.com/v3/migration/source_imports/#map-a-commit-author

func (*MigrationService)MigrationArchiveURL ¶

func (s *MigrationService) MigrationArchiveURL(ctxcontext.Context, orgstring, idint64) (urlstring, errerror)

MigrationArchiveURL fetches a migration archive URL.id is the migration ID.

GitHub API docs:https://developer.github.com/v3/migration/migrations/#download-a-migration-archive

func (*MigrationService)MigrationStatus ¶

func (s *MigrationService) MigrationStatus(ctxcontext.Context, orgstring, idint64) (*Migration, *Response,error)

MigrationStatus gets the status of a specific migration archive.id is the migration ID.

GitHub API docs:https://developer.github.com/v3/migration/migrations/#get-the-status-of-a-migration

func (*MigrationService)SetLFSPreference ¶

func (s *MigrationService) SetLFSPreference(ctxcontext.Context, owner, repostring, in *Import) (*Import, *Response,error)

SetLFSPreference sets whether imported repositories should use Git LFS forfiles larger than 100MB. Only the UseLFS field on the provided Import isused.

GitHub API docs:https://developer.github.com/v3/migration/source_imports/#set-git-lfs-preference

func (*MigrationService)StartImport ¶

func (s *MigrationService) StartImport(ctxcontext.Context, owner, repostring, in *Import) (*Import, *Response,error)

StartImport initiates a repository import.

GitHub API docs:https://developer.github.com/v3/migration/source_imports/#start-an-import

func (*MigrationService)StartMigration ¶

func (s *MigrationService) StartMigration(ctxcontext.Context, orgstring, repos []string, opts *MigrationOptions) (*Migration, *Response,error)

StartMigration starts the generation of a migration archive.repos is a slice of repository names to migrate.

GitHub API docs:https://developer.github.com/v3/migration/migrations/#start-a-migration

func (*MigrationService)StartUserMigration ¶

func (s *MigrationService) StartUserMigration(ctxcontext.Context, repos []string, opts *UserMigrationOptions) (*UserMigration, *Response,error)

StartUserMigration starts the generation of a migration archive.repos is a slice of repository names to migrate.

GitHub API docs:https://developer.github.com/v3/migrations/users/#start-a-user-migration

func (*MigrationService)UnlockRepo ¶

func (s *MigrationService) UnlockRepo(ctxcontext.Context, orgstring, idint64, repostring) (*Response,error)

UnlockRepo unlocks a repository that was locked for migration.id is the migration ID.You should unlock each migrated repository and delete them when the migrationis complete and you no longer need the source data.

GitHub API docs:https://developer.github.com/v3/migration/migrations/#unlock-a-repository

func (*MigrationService)UnlockUserRepo ¶

func (s *MigrationService) UnlockUserRepo(ctxcontext.Context, idint64, repostring) (*Response,error)

UnlockUserRepo will unlock a repo that was locked for migration.id is migration ID.You should unlock each migrated repository and delete them when the migrationis complete and you no longer need the source data.

GitHub API docs:https://developer.github.com/v3/migrations/users/#unlock-a-user-repository

func (*MigrationService)UpdateImport ¶

func (s *MigrationService) UpdateImport(ctxcontext.Context, owner, repostring, in *Import) (*Import, *Response,error)

UpdateImport initiates a repository import.

GitHub API docs:https://developer.github.com/v3/migration/source_imports/#update-existing-import

func (*MigrationService)UserMigrationArchiveURL ¶

func (s *MigrationService) UserMigrationArchiveURL(ctxcontext.Context, idint64) (string,error)

UserMigrationArchiveURL gets the URL for a specific migration archive.id is the migration ID.

GitHub API docs:https://developer.github.com/v3/migrations/users/#download-a-user-migration-archive

func (*MigrationService)UserMigrationStatus ¶

func (s *MigrationService) UserMigrationStatus(ctxcontext.Context, idint64) (*UserMigration, *Response,error)

UserMigrationStatus gets the status of a specific migration archive.id is the migration ID.

GitHub API docs:https://developer.github.com/v3/migrations/users/#get-the-status-of-a-user-migration

typeMilestone ¶

type Milestone struct {URL          *string    `json:"url,omitempty"`HTMLURL      *string    `json:"html_url,omitempty"`LabelsURL    *string    `json:"labels_url,omitempty"`ID           *int64     `json:"id,omitempty"`Number       *int       `json:"number,omitempty"`State        *string    `json:"state,omitempty"`Title        *string    `json:"title,omitempty"`Description  *string    `json:"description,omitempty"`Creator      *User      `json:"creator,omitempty"`OpenIssues   *int       `json:"open_issues,omitempty"`ClosedIssues *int       `json:"closed_issues,omitempty"`CreatedAt    *time.Time `json:"created_at,omitempty"`UpdatedAt    *time.Time `json:"updated_at,omitempty"`ClosedAt     *time.Time `json:"closed_at,omitempty"`DueOn        *time.Time `json:"due_on,omitempty"`NodeID       *string    `json:"node_id,omitempty"`}

Milestone represents a GitHub repository milestone.

func (*Milestone)GetClosedAt ¶

func (m *Milestone) GetClosedAt()time.Time

GetClosedAt returns the ClosedAt field if it's non-nil, zero value otherwise.

func (*Milestone)GetClosedIssues ¶

func (m *Milestone) GetClosedIssues()int

GetClosedIssues returns the ClosedIssues field if it's non-nil, zero value otherwise.

func (*Milestone)GetCreatedAt ¶

func (m *Milestone) GetCreatedAt()time.Time

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*Milestone)GetCreator ¶

func (m *Milestone) GetCreator() *User

GetCreator returns the Creator field.

func (*Milestone)GetDescription ¶

func (m *Milestone) GetDescription()string

GetDescription returns the Description field if it's non-nil, zero value otherwise.

func (*Milestone)GetDueOn ¶

func (m *Milestone) GetDueOn()time.Time

GetDueOn returns the DueOn field if it's non-nil, zero value otherwise.

func (*Milestone)GetHTMLURL ¶

func (m *Milestone) GetHTMLURL()string

GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.

func (*Milestone)GetID ¶

func (m *Milestone) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*Milestone)GetLabelsURL ¶

func (m *Milestone) GetLabelsURL()string

GetLabelsURL returns the LabelsURL field if it's non-nil, zero value otherwise.

func (*Milestone)GetNodeID ¶

func (m *Milestone) GetNodeID()string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*Milestone)GetNumber ¶

func (m *Milestone) GetNumber()int

GetNumber returns the Number field if it's non-nil, zero value otherwise.

func (*Milestone)GetOpenIssues ¶

func (m *Milestone) GetOpenIssues()int

GetOpenIssues returns the OpenIssues field if it's non-nil, zero value otherwise.

func (*Milestone)GetState ¶

func (m *Milestone) GetState()string

GetState returns the State field if it's non-nil, zero value otherwise.

func (*Milestone)GetTitle ¶

func (m *Milestone) GetTitle()string

GetTitle returns the Title field if it's non-nil, zero value otherwise.

func (*Milestone)GetURL ¶

func (m *Milestone) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (*Milestone)GetUpdatedAt ¶

func (m *Milestone) GetUpdatedAt()time.Time

GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.

func (Milestone)String ¶

func (mMilestone) String()string

typeMilestoneEvent ¶

type MilestoneEvent struct {// Action is the action that was performed. Possible values are:// "created", "closed", "opened", "edited", "deleted"Action    *string    `json:"action,omitempty"`Milestone *Milestone `json:"milestone,omitempty"`// The following fields are only populated by Webhook events.Changes      *EditChange   `json:"changes,omitempty"`Repo         *Repository   `json:"repository,omitempty"`Sender       *User         `json:"sender,omitempty"`Org          *Organization `json:"organization,omitempty"`Installation *Installation `json:"installation,omitempty"`}

MilestoneEvent is triggered when a milestone is created, closed, opened, edited, or deleted.The Webhook event name is "milestone".

GitHub API docs:https://developer.github.com/v3/activity/events/types/#milestoneevent

func (*MilestoneEvent)GetAction ¶

func (m *MilestoneEvent) GetAction()string

GetAction returns the Action field if it's non-nil, zero value otherwise.

func (*MilestoneEvent)GetChanges ¶

func (m *MilestoneEvent) GetChanges() *EditChange

GetChanges returns the Changes field.

func (*MilestoneEvent)GetInstallation ¶

func (m *MilestoneEvent) GetInstallation() *Installation

GetInstallation returns the Installation field.

func (*MilestoneEvent)GetMilestone ¶

func (m *MilestoneEvent) GetMilestone() *Milestone

GetMilestone returns the Milestone field.

func (*MilestoneEvent)GetOrg ¶

func (m *MilestoneEvent) GetOrg() *Organization

GetOrg returns the Org field.

func (*MilestoneEvent)GetRepo ¶

func (m *MilestoneEvent) GetRepo() *Repository

GetRepo returns the Repo field.

func (*MilestoneEvent)GetSender ¶

func (m *MilestoneEvent) GetSender() *User

GetSender returns the Sender field.

typeMilestoneListOptions ¶

type MilestoneListOptions struct {// State filters milestones based on their state. Possible values are:// open, closed, all. Default is "open".Statestring `url:"state,omitempty"`// Sort specifies how to sort milestones. Possible values are: due_on, completeness.// Default value is "due_on".Sortstring `url:"sort,omitempty"`// Direction in which to sort milestones. Possible values are: asc, desc.// Default is "asc".Directionstring `url:"direction,omitempty"`ListOptions}

MilestoneListOptions specifies the optional parameters to theIssuesService.ListMilestones method.

typeMilestoneStats ¶

type MilestoneStats struct {TotalMilestones  *int `json:"total_milestones,omitempty"`OpenMilestones   *int `json:"open_milestones,omitempty"`ClosedMilestones *int `json:"closed_milestones,omitempty"`}

MilestoneStats represents the number of total, open and close milestones.

func (*MilestoneStats)GetClosedMilestones ¶

func (m *MilestoneStats) GetClosedMilestones()int

GetClosedMilestones returns the ClosedMilestones field if it's non-nil, zero value otherwise.

func (*MilestoneStats)GetOpenMilestones ¶

func (m *MilestoneStats) GetOpenMilestones()int

GetOpenMilestones returns the OpenMilestones field if it's non-nil, zero value otherwise.

func (*MilestoneStats)GetTotalMilestones ¶

func (m *MilestoneStats) GetTotalMilestones()int

GetTotalMilestones returns the TotalMilestones field if it's non-nil, zero value otherwise.

func (MilestoneStats)String ¶

func (sMilestoneStats) String()string

typeNewPullRequest ¶

type NewPullRequest struct {Title               *string `json:"title,omitempty"`Head                *string `json:"head,omitempty"`Base                *string `json:"base,omitempty"`Body                *string `json:"body,omitempty"`Issue               *int    `json:"issue,omitempty"`MaintainerCanModify *bool   `json:"maintainer_can_modify,omitempty"`Draft               *bool   `json:"draft,omitempty"`}

NewPullRequest represents a new pull request to be created.

func (*NewPullRequest)GetBase ¶

func (n *NewPullRequest) GetBase()string

GetBase returns the Base field if it's non-nil, zero value otherwise.

func (*NewPullRequest)GetBody ¶

func (n *NewPullRequest) GetBody()string

GetBody returns the Body field if it's non-nil, zero value otherwise.

func (*NewPullRequest)GetDraft ¶

func (n *NewPullRequest) GetDraft()bool

GetDraft returns the Draft field if it's non-nil, zero value otherwise.

func (*NewPullRequest)GetHead ¶

func (n *NewPullRequest) GetHead()string

GetHead returns the Head field if it's non-nil, zero value otherwise.

func (*NewPullRequest)GetIssue ¶

func (n *NewPullRequest) GetIssue()int

GetIssue returns the Issue field if it's non-nil, zero value otherwise.

func (*NewPullRequest)GetMaintainerCanModify ¶

func (n *NewPullRequest) GetMaintainerCanModify()bool

GetMaintainerCanModify returns the MaintainerCanModify field if it's non-nil, zero value otherwise.

func (*NewPullRequest)GetTitle ¶

func (n *NewPullRequest) GetTitle()string

GetTitle returns the Title field if it's non-nil, zero value otherwise.

typeNewTeam ¶

type NewTeam struct {Namestring   `json:"name"`// Name of the team. (Required.)Description  *string  `json:"description,omitempty"`Maintainers  []string `json:"maintainers,omitempty"`RepoNames    []string `json:"repo_names,omitempty"`ParentTeamID *int64   `json:"parent_team_id,omitempty"`// Deprecated: Permission is deprecated when creating or editing a team in an org// using the new GitHub permission model. It no longer identifies the// permission a team has on its repos, but only specifies the default// permission a repo is initially added with. Avoid confusion by// specifying a permission value when calling AddTeamRepo.Permission *string `json:"permission,omitempty"`// Privacy identifies the level of privacy this team should have.// Possible values are://     secret - only visible to organization owners and members of this team//     closed - visible to all members of this organization// Default is "secret".Privacy *string `json:"privacy,omitempty"`// LDAPDN may be used in GitHub Enterprise when the team membership// is synchronized with LDAP.LDAPDN *string `json:"ldap_dn,omitempty"`}

NewTeam represents a team to be created or modified.

func (*NewTeam)GetDescription ¶

func (n *NewTeam) GetDescription()string

GetDescription returns the Description field if it's non-nil, zero value otherwise.

func (*NewTeam)GetLDAPDN ¶

func (n *NewTeam) GetLDAPDN()string

GetLDAPDN returns the LDAPDN field if it's non-nil, zero value otherwise.

func (*NewTeam)GetParentTeamID ¶

func (n *NewTeam) GetParentTeamID()int64

GetParentTeamID returns the ParentTeamID field if it's non-nil, zero value otherwise.

func (*NewTeam)GetPermission ¶

func (n *NewTeam) GetPermission()string

GetPermission returns the Permission field if it's non-nil, zero value otherwise.

func (*NewTeam)GetPrivacy ¶

func (n *NewTeam) GetPrivacy()string

GetPrivacy returns the Privacy field if it's non-nil, zero value otherwise.

func (NewTeam)String ¶

func (sNewTeam) String()string

typeNotification ¶

type Notification struct {ID         *string              `json:"id,omitempty"`Repository *Repository          `json:"repository,omitempty"`Subject    *NotificationSubject `json:"subject,omitempty"`// Reason identifies the event that triggered the notification.//// GitHub API docs:https://developer.github.com/v3/activity/notifications/#notification-reasonsReason *string `json:"reason,omitempty"`Unread     *bool      `json:"unread,omitempty"`UpdatedAt  *time.Time `json:"updated_at,omitempty"`LastReadAt *time.Time `json:"last_read_at,omitempty"`URL        *string    `json:"url,omitempty"`}

Notification identifies a GitHub notification for a user.

func (*Notification)GetID ¶

func (n *Notification) GetID()string

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*Notification)GetLastReadAt ¶

func (n *Notification) GetLastReadAt()time.Time

GetLastReadAt returns the LastReadAt field if it's non-nil, zero value otherwise.

func (*Notification)GetReason ¶

func (n *Notification) GetReason()string

GetReason returns the Reason field if it's non-nil, zero value otherwise.

func (*Notification)GetRepository ¶

func (n *Notification) GetRepository() *Repository

GetRepository returns the Repository field.

func (*Notification)GetSubject ¶

func (n *Notification) GetSubject() *NotificationSubject

GetSubject returns the Subject field.

func (*Notification)GetURL ¶

func (n *Notification) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (*Notification)GetUnread ¶

func (n *Notification) GetUnread()bool

GetUnread returns the Unread field if it's non-nil, zero value otherwise.

func (*Notification)GetUpdatedAt ¶

func (n *Notification) GetUpdatedAt()time.Time

GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.

typeNotificationListOptions ¶

type NotificationListOptions struct {Allbool      `url:"all,omitempty"`Participatingbool      `url:"participating,omitempty"`Sincetime.Time `url:"since,omitempty"`Beforetime.Time `url:"before,omitempty"`ListOptions}

NotificationListOptions specifies the optional parameters to theActivityService.ListNotifications method.

typeNotificationSubject ¶

type NotificationSubject struct {Title            *string `json:"title,omitempty"`URL              *string `json:"url,omitempty"`LatestCommentURL *string `json:"latest_comment_url,omitempty"`Type             *string `json:"type,omitempty"`}

NotificationSubject identifies the subject of a notification.

func (*NotificationSubject)GetLatestCommentURL ¶

func (n *NotificationSubject) GetLatestCommentURL()string

GetLatestCommentURL returns the LatestCommentURL field if it's non-nil, zero value otherwise.

func (*NotificationSubject)GetTitle ¶

func (n *NotificationSubject) GetTitle()string

GetTitle returns the Title field if it's non-nil, zero value otherwise.

func (*NotificationSubject)GetType ¶

func (n *NotificationSubject) GetType()string

GetType returns the Type field if it's non-nil, zero value otherwise.

func (*NotificationSubject)GetURL ¶

func (n *NotificationSubject) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

typeOAuthAPP ¶

type OAuthAPP struct {URL      *string `json:"url,omitempty"`Name     *string `json:"name,omitempty"`ClientID *string `json:"client_id,omitempty"`}

OAuthAPP represents the GitHub Site Administrator OAuth app.

func (*OAuthAPP)GetClientID ¶

func (o *OAuthAPP) GetClientID()string

GetClientID returns the ClientID field if it's non-nil, zero value otherwise.

func (*OAuthAPP)GetName ¶

func (o *OAuthAPP) GetName()string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (*OAuthAPP)GetURL ¶

func (o *OAuthAPP) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (OAuthAPP)String ¶

func (sOAuthAPP) String()string

typeOrgBlockEvent ¶

type OrgBlockEvent struct {// Action is the action that was performed.// Can be "blocked" or "unblocked".Action       *string       `json:"action,omitempty"`BlockedUser  *User         `json:"blocked_user,omitempty"`Organization *Organization `json:"organization,omitempty"`Sender       *User         `json:"sender,omitempty"`// The following fields are only populated by Webhook events.Installation *Installation `json:"installation,omitempty"`}

OrgBlockEvent is triggered when an organization blocks or unblocks a user.The Webhook event name is "org_block".

GitHub API docs:https://developer.github.com/v3/activity/events/types/#orgblockevent

func (*OrgBlockEvent)GetAction ¶

func (o *OrgBlockEvent) GetAction()string

GetAction returns the Action field if it's non-nil, zero value otherwise.

func (*OrgBlockEvent)GetBlockedUser ¶

func (o *OrgBlockEvent) GetBlockedUser() *User

GetBlockedUser returns the BlockedUser field.

func (*OrgBlockEvent)GetInstallation ¶

func (o *OrgBlockEvent) GetInstallation() *Installation

GetInstallation returns the Installation field.

func (*OrgBlockEvent)GetOrganization ¶

func (o *OrgBlockEvent) GetOrganization() *Organization

GetOrganization returns the Organization field.

func (*OrgBlockEvent)GetSender ¶

func (o *OrgBlockEvent) GetSender() *User

GetSender returns the Sender field.

typeOrgStats ¶

type OrgStats struct {TotalOrgs        *int `json:"total_orgs,omitempty"`DisabledOrgs     *int `json:"disabled_orgs,omitempty"`TotalTeams       *int `json:"total_teams,omitempty"`TotalTeamMembers *int `json:"total_team_members,omitempty"`}

OrgStats represents the number of total, disabled organizations and the teamand team member count.

func (*OrgStats)GetDisabledOrgs ¶

func (o *OrgStats) GetDisabledOrgs()int

GetDisabledOrgs returns the DisabledOrgs field if it's non-nil, zero value otherwise.

func (*OrgStats)GetTotalOrgs ¶

func (o *OrgStats) GetTotalOrgs()int

GetTotalOrgs returns the TotalOrgs field if it's non-nil, zero value otherwise.

func (*OrgStats)GetTotalTeamMembers ¶

func (o *OrgStats) GetTotalTeamMembers()int

GetTotalTeamMembers returns the TotalTeamMembers field if it's non-nil, zero value otherwise.

func (*OrgStats)GetTotalTeams ¶

func (o *OrgStats) GetTotalTeams()int

GetTotalTeams returns the TotalTeams field if it's non-nil, zero value otherwise.

func (OrgStats)String ¶

func (sOrgStats) String()string

typeOrganization ¶

type Organization struct {Login                       *string    `json:"login,omitempty"`ID                          *int64     `json:"id,omitempty"`NodeID                      *string    `json:"node_id,omitempty"`AvatarURL                   *string    `json:"avatar_url,omitempty"`HTMLURL                     *string    `json:"html_url,omitempty"`Name                        *string    `json:"name,omitempty"`Company                     *string    `json:"company,omitempty"`Blog                        *string    `json:"blog,omitempty"`Location                    *string    `json:"location,omitempty"`Email                       *string    `json:"email,omitempty"`Description                 *string    `json:"description,omitempty"`PublicRepos                 *int       `json:"public_repos,omitempty"`PublicGists                 *int       `json:"public_gists,omitempty"`Followers                   *int       `json:"followers,omitempty"`Following                   *int       `json:"following,omitempty"`CreatedAt                   *time.Time `json:"created_at,omitempty"`UpdatedAt                   *time.Time `json:"updated_at,omitempty"`TotalPrivateRepos           *int       `json:"total_private_repos,omitempty"`OwnedPrivateRepos           *int       `json:"owned_private_repos,omitempty"`PrivateGists                *int       `json:"private_gists,omitempty"`DiskUsage                   *int       `json:"disk_usage,omitempty"`Collaborators               *int       `json:"collaborators,omitempty"`BillingEmail                *string    `json:"billing_email,omitempty"`Type                        *string    `json:"type,omitempty"`Plan                        *Plan      `json:"plan,omitempty"`TwoFactorRequirementEnabled *bool      `json:"two_factor_requirement_enabled,omitempty"`// DefaultRepoPermission can be one of: "read", "write", "admin", or "none". (Default: "read").// It is only used in OrganizationsService.Edit.DefaultRepoPermission *string `json:"default_repository_permission,omitempty"`// DefaultRepoSettings can be one of: "read", "write", "admin", or "none". (Default: "read").// It is only used in OrganizationsService.Get.DefaultRepoSettings *string `json:"default_repository_settings,omitempty"`// MembersCanCreateRepos default value is true and is only used in Organizations.Edit.MembersCanCreateRepos *bool `json:"members_can_create_repositories,omitempty"`//https://developer.github.com/changes/2019-12-03-internal-visibility-changes/#rest-v3-apiMembersCanCreatePublicRepos   *bool `json:"members_can_create_public_repositories,omitempty"`MembersCanCreatePrivateRepos  *bool `json:"members_can_create_private_repositories,omitempty"`MembersCanCreateInternalRepos *bool `json:"members_can_create_internal_repositories,omitempty"`// MembersAllowedRepositoryCreationType denotes if organization members can create repositories// and the type of repositories they can create. Possible values are: "all", "private", or "none".//// Deprecated: Use MembersCanCreatePublicRepos, MembersCanCreatePrivateRepos, MembersCanCreateInternalRepos// instead. The new fields overrides the existing MembersAllowedRepositoryCreationType during 'edit'// operation and does not consider 'internal' repositories during 'get' operationMembersAllowedRepositoryCreationType *string `json:"members_allowed_repository_creation_type,omitempty"`// API URLsURL              *string `json:"url,omitempty"`EventsURL        *string `json:"events_url,omitempty"`HooksURL         *string `json:"hooks_url,omitempty"`IssuesURL        *string `json:"issues_url,omitempty"`MembersURL       *string `json:"members_url,omitempty"`PublicMembersURL *string `json:"public_members_url,omitempty"`ReposURL         *string `json:"repos_url,omitempty"`}

Organization represents a GitHub organization account.

func (*Organization)GetAvatarURL ¶

func (o *Organization) GetAvatarURL()string

GetAvatarURL returns the AvatarURL field if it's non-nil, zero value otherwise.

func (*Organization)GetBillingEmail ¶

func (o *Organization) GetBillingEmail()string

GetBillingEmail returns the BillingEmail field if it's non-nil, zero value otherwise.

func (*Organization)GetBlog ¶

func (o *Organization) GetBlog()string

GetBlog returns the Blog field if it's non-nil, zero value otherwise.

func (*Organization)GetCollaborators ¶

func (o *Organization) GetCollaborators()int

GetCollaborators returns the Collaborators field if it's non-nil, zero value otherwise.

func (*Organization)GetCompany ¶

func (o *Organization) GetCompany()string

GetCompany returns the Company field if it's non-nil, zero value otherwise.

func (*Organization)GetCreatedAt ¶

func (o *Organization) GetCreatedAt()time.Time

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*Organization)GetDefaultRepoPermission ¶

func (o *Organization) GetDefaultRepoPermission()string

GetDefaultRepoPermission returns the DefaultRepoPermission field if it's non-nil, zero value otherwise.

func (*Organization)GetDefaultRepoSettings ¶

func (o *Organization) GetDefaultRepoSettings()string

GetDefaultRepoSettings returns the DefaultRepoSettings field if it's non-nil, zero value otherwise.

func (*Organization)GetDescription ¶

func (o *Organization) GetDescription()string

GetDescription returns the Description field if it's non-nil, zero value otherwise.

func (*Organization)GetDiskUsage ¶

func (o *Organization) GetDiskUsage()int

GetDiskUsage returns the DiskUsage field if it's non-nil, zero value otherwise.

func (*Organization)GetEmail ¶

func (o *Organization) GetEmail()string

GetEmail returns the Email field if it's non-nil, zero value otherwise.

func (*Organization)GetEventsURL ¶

func (o *Organization) GetEventsURL()string

GetEventsURL returns the EventsURL field if it's non-nil, zero value otherwise.

func (*Organization)GetFollowers ¶

func (o *Organization) GetFollowers()int

GetFollowers returns the Followers field if it's non-nil, zero value otherwise.

func (*Organization)GetFollowing ¶

func (o *Organization) GetFollowing()int

GetFollowing returns the Following field if it's non-nil, zero value otherwise.

func (*Organization)GetHTMLURL ¶

func (o *Organization) GetHTMLURL()string

GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.

func (*Organization)GetHooksURL ¶

func (o *Organization) GetHooksURL()string

GetHooksURL returns the HooksURL field if it's non-nil, zero value otherwise.

func (*Organization)GetID ¶

func (o *Organization) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*Organization)GetIssuesURL ¶

func (o *Organization) GetIssuesURL()string

GetIssuesURL returns the IssuesURL field if it's non-nil, zero value otherwise.

func (*Organization)GetLocation ¶

func (o *Organization) GetLocation()string

GetLocation returns the Location field if it's non-nil, zero value otherwise.

func (*Organization)GetLogin ¶

func (o *Organization) GetLogin()string

GetLogin returns the Login field if it's non-nil, zero value otherwise.

func (*Organization)GetMembersAllowedRepositoryCreationType ¶

func (o *Organization) GetMembersAllowedRepositoryCreationType()string

GetMembersAllowedRepositoryCreationType returns the MembersAllowedRepositoryCreationType field if it's non-nil, zero value otherwise.

func (*Organization)GetMembersCanCreateInternalRepos ¶

func (o *Organization) GetMembersCanCreateInternalRepos()bool

GetMembersCanCreateInternalRepos returns the MembersCanCreateInternalRepos field if it's non-nil, zero value otherwise.

func (*Organization)GetMembersCanCreatePrivateRepos ¶

func (o *Organization) GetMembersCanCreatePrivateRepos()bool

GetMembersCanCreatePrivateRepos returns the MembersCanCreatePrivateRepos field if it's non-nil, zero value otherwise.

func (*Organization)GetMembersCanCreatePublicRepos ¶

func (o *Organization) GetMembersCanCreatePublicRepos()bool

GetMembersCanCreatePublicRepos returns the MembersCanCreatePublicRepos field if it's non-nil, zero value otherwise.

func (*Organization)GetMembersCanCreateRepos ¶

func (o *Organization) GetMembersCanCreateRepos()bool

GetMembersCanCreateRepos returns the MembersCanCreateRepos field if it's non-nil, zero value otherwise.

func (*Organization)GetMembersURL ¶

func (o *Organization) GetMembersURL()string

GetMembersURL returns the MembersURL field if it's non-nil, zero value otherwise.

func (*Organization)GetName ¶

func (o *Organization) GetName()string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (*Organization)GetNodeID ¶

func (o *Organization) GetNodeID()string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*Organization)GetOwnedPrivateRepos ¶

func (o *Organization) GetOwnedPrivateRepos()int

GetOwnedPrivateRepos returns the OwnedPrivateRepos field if it's non-nil, zero value otherwise.

func (*Organization)GetPlan ¶

func (o *Organization) GetPlan() *Plan

GetPlan returns the Plan field.

func (*Organization)GetPrivateGists ¶

func (o *Organization) GetPrivateGists()int

GetPrivateGists returns the PrivateGists field if it's non-nil, zero value otherwise.

func (*Organization)GetPublicGists ¶

func (o *Organization) GetPublicGists()int

GetPublicGists returns the PublicGists field if it's non-nil, zero value otherwise.

func (*Organization)GetPublicMembersURL ¶

func (o *Organization) GetPublicMembersURL()string

GetPublicMembersURL returns the PublicMembersURL field if it's non-nil, zero value otherwise.

func (*Organization)GetPublicRepos ¶

func (o *Organization) GetPublicRepos()int

GetPublicRepos returns the PublicRepos field if it's non-nil, zero value otherwise.

func (*Organization)GetReposURL ¶

func (o *Organization) GetReposURL()string

GetReposURL returns the ReposURL field if it's non-nil, zero value otherwise.

func (*Organization)GetTotalPrivateRepos ¶

func (o *Organization) GetTotalPrivateRepos()int

GetTotalPrivateRepos returns the TotalPrivateRepos field if it's non-nil, zero value otherwise.

func (*Organization)GetTwoFactorRequirementEnabled ¶

func (o *Organization) GetTwoFactorRequirementEnabled()bool

GetTwoFactorRequirementEnabled returns the TwoFactorRequirementEnabled field if it's non-nil, zero value otherwise.

func (*Organization)GetType ¶

func (o *Organization) GetType()string

GetType returns the Type field if it's non-nil, zero value otherwise.

func (*Organization)GetURL ¶

func (o *Organization) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (*Organization)GetUpdatedAt ¶

func (o *Organization) GetUpdatedAt()time.Time

GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.

func (Organization)String ¶

func (oOrganization) String()string

typeOrganizationEvent ¶

type OrganizationEvent struct {// Action is the action that was performed.// Possible values are: "deleted", "renamed", "member_added", "member_removed", or "member_invited".Action *string `json:"action,omitempty"`// Invitation is the invitation for the user or email if the action is "member_invited".Invitation *Invitation `json:"invitation,omitempty"`// Membership is the membership between the user and the organization.// Not present when the action is "member_invited".Membership *Membership `json:"membership,omitempty"`Organization *Organization `json:"organization,omitempty"`Sender       *User         `json:"sender,omitempty"`Installation *Installation `json:"installation,omitempty"`}

OrganizationEvent is triggered when an organization is deleted and renamed, and when a user is added,removed, or invited to an organization.Events of this type are not visible in timelines. These events are only used to trigger organization hooks.Webhook event name is "organization".

GitHub API docs:https://developer.github.com/v3/activity/events/types/#organizationevent

func (*OrganizationEvent)GetAction ¶

func (o *OrganizationEvent) GetAction()string

GetAction returns the Action field if it's non-nil, zero value otherwise.

func (*OrganizationEvent)GetInstallation ¶

func (o *OrganizationEvent) GetInstallation() *Installation

GetInstallation returns the Installation field.

func (*OrganizationEvent)GetInvitation ¶

func (o *OrganizationEvent) GetInvitation() *Invitation

GetInvitation returns the Invitation field.

func (*OrganizationEvent)GetMembership ¶

func (o *OrganizationEvent) GetMembership() *Membership

GetMembership returns the Membership field.

func (*OrganizationEvent)GetOrganization ¶

func (o *OrganizationEvent) GetOrganization() *Organization

GetOrganization returns the Organization field.

func (*OrganizationEvent)GetSender ¶

func (o *OrganizationEvent) GetSender() *User

GetSender returns the Sender field.

typeOrganizationInstallations ¶

type OrganizationInstallations struct {TotalCount    *int            `json:"total_count,omitempty"`Installations []*Installation `json:"installations,omitempty"`}

OrganizationInstallations represents GitHub app installations for an organization.

func (*OrganizationInstallations)GetTotalCount ¶

func (o *OrganizationInstallations) GetTotalCount()int

GetTotalCount returns the TotalCount field if it's non-nil, zero value otherwise.

typeOrganizationsListOptions ¶

type OrganizationsListOptions struct {// Since filters Organizations by ID.Sinceint64 `url:"since,omitempty"`// Note: Pagination is powered exclusively by the Since parameter,// ListOptions.Page has no effect.// ListOptions.PerPage controls an undocumented GitHub API parameter.ListOptions}

OrganizationsListOptions specifies the optional parameters to theOrganizationsService.ListAll method.

typeOrganizationsService ¶

type OrganizationsService service

OrganizationsService provides access to the organization related functionsin the GitHub API.

GitHub API docs:https://developer.github.com/v3/orgs/

func (*OrganizationsService)BlockUser ¶

func (s *OrganizationsService) BlockUser(ctxcontext.Context, orgstring, userstring) (*Response,error)

BlockUser blocks specified user from an organization.

GitHub API docs:https://developer.github.com/v3/orgs/blocking/#block-a-user

func (*OrganizationsService)ConcealMembership ¶

func (s *OrganizationsService) ConcealMembership(ctxcontext.Context, org, userstring) (*Response,error)

ConcealMembership conceals a user's membership in an organization.

GitHub API docs:https://developer.github.com/v3/orgs/members/#conceal-a-users-membership

func (*OrganizationsService)ConvertMemberToOutsideCollaborator ¶

func (s *OrganizationsService) ConvertMemberToOutsideCollaborator(ctxcontext.Context, orgstring, userstring) (*Response,error)

ConvertMemberToOutsideCollaborator reduces the permission level of a member of theorganization to that of an outside collaborator. Therefore, they will onlyhave access to the repositories that their current team membership allows.Responses for converting a non-member or the last owner to an outside collaboratorare listed in GitHub API docs.

GitHub API docs:https://developer.github.com/v3/orgs/outside_collaborators/#convert-member-to-outside-collaborator

func (*OrganizationsService)CreateHook ¶

func (s *OrganizationsService) CreateHook(ctxcontext.Context, orgstring, hook *Hook) (*Hook, *Response,error)

CreateHook creates a Hook for the specified org.Config is a required field.

Note that only a subset of the hook fields are used and hook mustnot be nil.

GitHub API docs:https://developer.github.com/v3/orgs/hooks/#create-a-hook

func (*OrganizationsService)CreateOrgInvitation ¶

func (s *OrganizationsService) CreateOrgInvitation(ctxcontext.Context, orgstring, opts *CreateOrgInvitationOptions) (*Invitation, *Response,error)

CreateOrgInvitation invites 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.

https://developer.github.com/v3/orgs/members/#create-organization-invitation

func (*OrganizationsService)CreateProject ¶

func (s *OrganizationsService) CreateProject(ctxcontext.Context, orgstring, opts *ProjectOptions) (*Project, *Response,error)

CreateProject creates a GitHub Project for the specified organization.

GitHub API docs:https://developer.github.com/v3/projects/#create-an-organization-project

func (*OrganizationsService)DeleteHook ¶

func (s *OrganizationsService) DeleteHook(ctxcontext.Context, orgstring, idint64) (*Response,error)

DeleteHook deletes a specified Hook.

GitHub API docs:https://developer.github.com/v3/orgs/hooks/#delete-a-hook

func (*OrganizationsService)Edit ¶

func (s *OrganizationsService) Edit(ctxcontext.Context, namestring, org *Organization) (*Organization, *Response,error)

Edit an organization.

GitHub API docs:https://developer.github.com/v3/orgs/#edit-an-organization

func (*OrganizationsService)EditHook ¶

func (s *OrganizationsService) EditHook(ctxcontext.Context, orgstring, idint64, hook *Hook) (*Hook, *Response,error)

EditHook updates a specified Hook.

GitHub API docs:https://developer.github.com/v3/orgs/hooks/#edit-a-hook

func (*OrganizationsService)EditOrgMembership ¶

func (s *OrganizationsService) EditOrgMembership(ctxcontext.Context, user, orgstring, membership *Membership) (*Membership, *Response,error)

EditOrgMembership edits the membership for user in specified organization.Passing an empty string for user will edit the membership for theauthenticated user.

GitHub API docs:https://developer.github.com/v3/orgs/members/#add-or-update-organization-membershipGitHub API docs:https://developer.github.com/v3/orgs/members/#edit-your-organization-membership

func (*OrganizationsService)Get ¶

func (s *OrganizationsService) Get(ctxcontext.Context, orgstring) (*Organization, *Response,error)

Get fetches an organization by name.

GitHub API docs:https://developer.github.com/v3/orgs/#get-an-organization

func (*OrganizationsService)GetByID ¶

func (s *OrganizationsService) GetByID(ctxcontext.Context, idint64) (*Organization, *Response,error)

GetByID fetches an organization.

Note: GetByID uses the undocumented GitHub API endpoint /organizations/:id.

func (*OrganizationsService)GetHook ¶

func (s *OrganizationsService) GetHook(ctxcontext.Context, orgstring, idint64) (*Hook, *Response,error)

GetHook returns a single specified Hook.

GitHub API docs:https://developer.github.com/v3/orgs/hooks/#get-single-hook

func (*OrganizationsService)GetOrgMembership ¶

func (s *OrganizationsService) GetOrgMembership(ctxcontext.Context, user, orgstring) (*Membership, *Response,error)

GetOrgMembership gets the membership for a user in a specified organization.Passing an empty string for user will get the membership for theauthenticated user.

GitHub API docs:https://developer.github.com/v3/orgs/members/#get-organization-membership https://developer.github.com/v3/orgs/members/#get-your-organization-membership

func (*OrganizationsService)IsBlocked ¶

func (s *OrganizationsService) IsBlocked(ctxcontext.Context, orgstring, userstring) (bool, *Response,error)

IsBlocked reports whether specified user is blocked from an organization.

GitHub API docs:https://developer.github.com/v3/orgs/blocking/#check-whether-a-user-is-blocked-from-an-organization

func (*OrganizationsService)IsMember ¶

func (s *OrganizationsService) IsMember(ctxcontext.Context, org, userstring) (bool, *Response,error)

IsMember checks if a user is a member of an organization.

GitHub API docs:https://developer.github.com/v3/orgs/members/#check-membership

func (*OrganizationsService)IsPublicMember ¶

func (s *OrganizationsService) IsPublicMember(ctxcontext.Context, org, userstring) (bool, *Response,error)

IsPublicMember checks if a user is a public member of an organization.

GitHub API docs:https://developer.github.com/v3/orgs/members/#check-public-membership

func (*OrganizationsService)List ¶

func (s *OrganizationsService) List(ctxcontext.Context, userstring, opts *ListOptions) ([]*Organization, *Response,error)

List the organizations for a user. Passing the empty string will listorganizations for the authenticated user.

GitHub API docs:https://developer.github.com/v3/orgs/#list-user-organizations

func (*OrganizationsService)ListAll ¶

func (s *OrganizationsService) ListAll(ctxcontext.Context, opts *OrganizationsListOptions) ([]*Organization, *Response,error)

ListAll lists all organizations, in the order that they were created on GitHub.

Note: Pagination is powered exclusively by the since parameter. To continuelisting the next set of organizations, use the ID of the last-returned organizationas the opts.Since parameter for the next call.

GitHub API docs:https://developer.github.com/v3/orgs/#list-all-organizations

func (*OrganizationsService)ListBlockedUsers ¶

func (s *OrganizationsService) ListBlockedUsers(ctxcontext.Context, orgstring, opts *ListOptions) ([]*User, *Response,error)

ListBlockedUsers lists all the users blocked by an organization.

GitHub API docs:https://developer.github.com/v3/orgs/blocking/#list-blocked-users

func (*OrganizationsService)ListHooks ¶

func (s *OrganizationsService) ListHooks(ctxcontext.Context, orgstring, opts *ListOptions) ([]*Hook, *Response,error)

ListHooks lists all Hooks for the specified organization.

GitHub API docs:https://developer.github.com/v3/orgs/hooks/#list-hooks

func (*OrganizationsService)ListInstallations ¶

func (s *OrganizationsService) ListInstallations(ctxcontext.Context, orgstring, opts *ListOptions) (*OrganizationInstallations, *Response,error)

ListInstallations lists installations for an organization.

GitHub API docs:https://developer.github.com/v3/orgs/#list-installations-for-an-organization

func (*OrganizationsService)ListMembers ¶

func (s *OrganizationsService) ListMembers(ctxcontext.Context, orgstring, opts *ListMembersOptions) ([]*User, *Response,error)

ListMembers lists the members for an organization. If the authenticateduser is an owner of the organization, this will return both concealed andpublic members, otherwise it will only return public members.

GitHub API docs:https://developer.github.com/v3/orgs/members/#members-list

func (*OrganizationsService)ListOrgInvitationTeams ¶

func (s *OrganizationsService) ListOrgInvitationTeams(ctxcontext.Context, org, invitationIDstring, opts *ListOptions) ([]*Team, *Response,error)

ListOrgInvitationTeams lists all teams associated with an invitation. In order to see invitations in an organization,the authenticated user must be an organization owner.

GitHub API docs:https://developer.github.com/v3/orgs/members/#list-organization-invitation-teams

func (*OrganizationsService)ListOrgMemberships ¶

func (s *OrganizationsService) ListOrgMemberships(ctxcontext.Context, opts *ListOrgMembershipsOptions) ([]*Membership, *Response,error)

ListOrgMemberships lists the organization memberships for the authenticated user.

GitHub API docs:https://developer.github.com/v3/orgs/members/#list-your-organization-memberships

func (*OrganizationsService)ListOutsideCollaborators ¶

func (s *OrganizationsService) ListOutsideCollaborators(ctxcontext.Context, orgstring, opts *ListOutsideCollaboratorsOptions) ([]*User, *Response,error)

ListOutsideCollaborators lists outside collaborators of organization's repositories.This will only work if the authenticateduser is an owner of the organization.

Warning: The API may change without advance notice during the preview period.Preview features are not supported for production use.

GitHub API docs:https://developer.github.com/v3/orgs/outside_collaborators/#list-outside-collaborators

func (*OrganizationsService)ListPendingOrgInvitations ¶

func (s *OrganizationsService) ListPendingOrgInvitations(ctxcontext.Context, orgstring, opts *ListOptions) ([]*Invitation, *Response,error)

ListPendingOrgInvitations returns a list of pending invitations.

GitHub API docs:https://developer.github.com/v3/orgs/members/#list-pending-organization-invitations

func (*OrganizationsService)ListProjects ¶

func (s *OrganizationsService) ListProjects(ctxcontext.Context, orgstring, opts *ProjectListOptions) ([]*Project, *Response,error)

ListProjects lists the projects for an organization.

GitHub API docs:https://developer.github.com/v3/projects/#list-organization-projects

func (*OrganizationsService)PingHook ¶

func (s *OrganizationsService) PingHook(ctxcontext.Context, orgstring, idint64) (*Response,error)

PingHook triggers a 'ping' event to be sent to the Hook.

GitHub API docs:https://developer.github.com/v3/orgs/hooks/#ping-a-hook

func (*OrganizationsService)PublicizeMembership ¶

func (s *OrganizationsService) PublicizeMembership(ctxcontext.Context, org, userstring) (*Response,error)

PublicizeMembership publicizes a user's membership in an organization. (Auser cannot publicize the membership for another user.)

GitHub API docs:https://developer.github.com/v3/orgs/members/#publicize-a-users-membership

func (*OrganizationsService)RemoveMember ¶

func (s *OrganizationsService) RemoveMember(ctxcontext.Context, org, userstring) (*Response,error)

RemoveMember removes a user from all teams of an organization.

GitHub API docs:https://developer.github.com/v3/orgs/members/#remove-a-member

func (*OrganizationsService)RemoveOrgMembership ¶

func (s *OrganizationsService) RemoveOrgMembership(ctxcontext.Context, user, orgstring) (*Response,error)

RemoveOrgMembership removes user from the specified organization. If theuser has been invited to the organization, this will cancel their invitation.

GitHub API docs:https://developer.github.com/v3/orgs/members/#remove-organization-membership

func (*OrganizationsService)RemoveOutsideCollaborator ¶

func (s *OrganizationsService) RemoveOutsideCollaborator(ctxcontext.Context, orgstring, userstring) (*Response,error)

RemoveOutsideCollaborator removes a user from the list of outside collaborators;consequently, removing them from all the organization's repositories.

GitHub API docs:https://developer.github.com/v3/orgs/outside_collaborators/#remove-outside-collaborator

func (*OrganizationsService)UnblockUser ¶

func (s *OrganizationsService) UnblockUser(ctxcontext.Context, orgstring, userstring) (*Response,error)

UnblockUser unblocks specified user from an organization.

GitHub API docs:https://developer.github.com/v3/orgs/blocking/#unblock-a-user

typePRLink ¶

type PRLink struct {HRef *string `json:"href,omitempty"`}

PRLink represents a single link object from Github pull request _links.

func (*PRLink)GetHRef ¶

func (p *PRLink) GetHRef()string

GetHRef returns the HRef field if it's non-nil, zero value otherwise.

typePRLinks ¶

type PRLinks struct {Self           *PRLink `json:"self,omitempty"`HTML           *PRLink `json:"html,omitempty"`Issue          *PRLink `json:"issue,omitempty"`Comments       *PRLink `json:"comments,omitempty"`ReviewComments *PRLink `json:"review_comments,omitempty"`ReviewComment  *PRLink `json:"review_comment,omitempty"`Commits        *PRLink `json:"commits,omitempty"`Statuses       *PRLink `json:"statuses,omitempty"`}

PRLinks represents the "_links" object in a Github pull request.

func (*PRLinks)GetComments ¶

func (p *PRLinks) GetComments() *PRLink

GetComments returns the Comments field.

func (*PRLinks)GetCommits ¶

func (p *PRLinks) GetCommits() *PRLink

GetCommits returns the Commits field.

func (*PRLinks)GetHTML ¶

func (p *PRLinks) GetHTML() *PRLink

GetHTML returns the HTML field.

func (*PRLinks)GetIssue ¶

func (p *PRLinks) GetIssue() *PRLink

GetIssue returns the Issue field.

func (*PRLinks)GetReviewComment ¶

func (p *PRLinks) GetReviewComment() *PRLink

GetReviewComment returns the ReviewComment field.

func (*PRLinks)GetReviewComments ¶

func (p *PRLinks) GetReviewComments() *PRLink

GetReviewComments returns the ReviewComments field.

func (*PRLinks)GetSelf ¶

func (p *PRLinks) GetSelf() *PRLink

GetSelf returns the Self field.

func (*PRLinks)GetStatuses ¶

func (p *PRLinks) GetStatuses() *PRLink

GetStatuses returns the Statuses field.

typePage ¶

type Page struct {PageName *string `json:"page_name,omitempty"`Title    *string `json:"title,omitempty"`Summary  *string `json:"summary,omitempty"`Action   *string `json:"action,omitempty"`SHA      *string `json:"sha,omitempty"`HTMLURL  *string `json:"html_url,omitempty"`}

Page represents a single Wiki page.

func (*Page)GetAction ¶

func (p *Page) GetAction()string

GetAction returns the Action field if it's non-nil, zero value otherwise.

func (*Page)GetHTMLURL ¶

func (p *Page) GetHTMLURL()string

GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.

func (*Page)GetPageName ¶

func (p *Page) GetPageName()string

GetPageName returns the PageName field if it's non-nil, zero value otherwise.

func (*Page)GetSHA ¶

func (p *Page) GetSHA()string

GetSHA returns the SHA field if it's non-nil, zero value otherwise.

func (*Page)GetSummary ¶

func (p *Page) GetSummary()string

GetSummary returns the Summary field if it's non-nil, zero value otherwise.

func (*Page)GetTitle ¶

func (p *Page) GetTitle()string

GetTitle returns the Title field if it's non-nil, zero value otherwise.

typePageBuildEvent ¶

type PageBuildEvent struct {Build *PagesBuild `json:"build,omitempty"`// The following fields are only populated by Webhook events.ID           *int64        `json:"id,omitempty"`Repo         *Repository   `json:"repository,omitempty"`Sender       *User         `json:"sender,omitempty"`Installation *Installation `json:"installation,omitempty"`}

PageBuildEvent represents an attempted build of a GitHub Pages site, whethersuccessful or not.The Webhook event name is "page_build".

This event is triggered on push to a GitHub Pages enabled branch (gh-pagesfor project pages, master for user and organization pages).

Events of this type are not visible in timelines, they are only used to trigger hooks.

GitHub API docs:https://developer.github.com/v3/activity/events/types/#pagebuildevent

func (*PageBuildEvent)GetBuild ¶

func (p *PageBuildEvent) GetBuild() *PagesBuild

GetBuild returns the Build field.

func (*PageBuildEvent)GetID ¶

func (p *PageBuildEvent) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*PageBuildEvent)GetInstallation ¶

func (p *PageBuildEvent) GetInstallation() *Installation

GetInstallation returns the Installation field.

func (*PageBuildEvent)GetRepo ¶

func (p *PageBuildEvent) GetRepo() *Repository

GetRepo returns the Repo field.

func (*PageBuildEvent)GetSender ¶

func (p *PageBuildEvent) GetSender() *User

GetSender returns the Sender field.

typePageStats ¶

type PageStats struct {TotalPages *int `json:"total_pages,omitempty"`}

PageStats represents the total number of github pages.

func (*PageStats)GetTotalPages ¶

func (p *PageStats) GetTotalPages()int

GetTotalPages returns the TotalPages field if it's non-nil, zero value otherwise.

func (PageStats)String ¶

func (sPageStats) String()string

typePages ¶

type Pages struct {URL       *string      `json:"url,omitempty"`Status    *string      `json:"status,omitempty"`CNAME     *string      `json:"cname,omitempty"`Custom404 *bool        `json:"custom_404,omitempty"`HTMLURL   *string      `json:"html_url,omitempty"`Source    *PagesSource `json:"source,omitempty"`}

Pages represents a GitHub Pages site configuration.

func (*Pages)GetCNAME ¶

func (p *Pages) GetCNAME()string

GetCNAME returns the CNAME field if it's non-nil, zero value otherwise.

func (*Pages)GetCustom404 ¶

func (p *Pages) GetCustom404()bool

GetCustom404 returns the Custom404 field if it's non-nil, zero value otherwise.

func (*Pages)GetHTMLURL ¶

func (p *Pages) GetHTMLURL()string

GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.

func (*Pages)GetSource ¶

func (p *Pages) GetSource() *PagesSource

GetSource returns the Source field.

func (*Pages)GetStatus ¶

func (p *Pages) GetStatus()string

GetStatus returns the Status field if it's non-nil, zero value otherwise.

func (*Pages)GetURL ¶

func (p *Pages) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

typePagesBuild ¶

type PagesBuild struct {URL       *string     `json:"url,omitempty"`Status    *string     `json:"status,omitempty"`Error     *PagesError `json:"error,omitempty"`Pusher    *User       `json:"pusher,omitempty"`Commit    *string     `json:"commit,omitempty"`Duration  *int        `json:"duration,omitempty"`CreatedAt *Timestamp  `json:"created_at,omitempty"`UpdatedAt *Timestamp  `json:"updated_at,omitempty"`}

PagesBuild represents the build information for a GitHub Pages site.

func (*PagesBuild)GetCommit ¶

func (p *PagesBuild) GetCommit()string

GetCommit returns the Commit field if it's non-nil, zero value otherwise.

func (*PagesBuild)GetCreatedAt ¶

func (p *PagesBuild) GetCreatedAt()Timestamp

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*PagesBuild)GetDuration ¶

func (p *PagesBuild) GetDuration()int

GetDuration returns the Duration field if it's non-nil, zero value otherwise.

func (*PagesBuild)GetError ¶

func (p *PagesBuild) GetError() *PagesError

GetError returns the Error field.

func (*PagesBuild)GetPusher ¶

func (p *PagesBuild) GetPusher() *User

GetPusher returns the Pusher field.

func (*PagesBuild)GetStatus ¶

func (p *PagesBuild) GetStatus()string

GetStatus returns the Status field if it's non-nil, zero value otherwise.

func (*PagesBuild)GetURL ¶

func (p *PagesBuild) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (*PagesBuild)GetUpdatedAt ¶

func (p *PagesBuild) GetUpdatedAt()Timestamp

GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.

typePagesError ¶

type PagesError struct {Message *string `json:"message,omitempty"`}

PagesError represents a build error for a GitHub Pages site.

func (*PagesError)GetMessage ¶

func (p *PagesError) GetMessage()string

GetMessage returns the Message field if it's non-nil, zero value otherwise.

typePagesSource ¶

type PagesSource struct {Branch *string `json:"branch,omitempty"`Path   *string `json:"path,omitempty"`}

PagesSource represents a GitHub page's source.

func (*PagesSource)GetBranch ¶

func (p *PagesSource) GetBranch()string

GetBranch returns the Branch field if it's non-nil, zero value otherwise.

func (*PagesSource)GetPath ¶

func (p *PagesSource) GetPath()string

GetPath returns the Path field if it's non-nil, zero value otherwise.

typePingEvent ¶

type PingEvent struct {// Random string of GitHub zen.Zen *string `json:"zen,omitempty"`// The ID of the webhook that triggered the ping.HookID *int64 `json:"hook_id,omitempty"`// The webhook configuration.Hook         *Hook         `json:"hook,omitempty"`Installation *Installation `json:"installation,omitempty"`}

PingEvent is triggered when a Webhook is added to GitHub.

GitHub API docs:https://developer.github.com/webhooks/#ping-event

func (*PingEvent)GetHook ¶

func (p *PingEvent) GetHook() *Hook

GetHook returns the Hook field.

func (*PingEvent)GetHookID ¶

func (p *PingEvent) GetHookID()int64

GetHookID returns the HookID field if it's non-nil, zero value otherwise.

func (*PingEvent)GetInstallation ¶

func (p *PingEvent) GetInstallation() *Installation

GetInstallation returns the Installation field.

func (*PingEvent)GetZen ¶

func (p *PingEvent) GetZen()string

GetZen returns the Zen field if it's non-nil, zero value otherwise.

typePlan ¶

type Plan struct {Name          *string `json:"name,omitempty"`Space         *int    `json:"space,omitempty"`Collaborators *int    `json:"collaborators,omitempty"`PrivateRepos  *int    `json:"private_repos,omitempty"`FilledSeats   *int    `json:"filled_seats,omitempty"`Seats         *int    `json:"seats,omitempty"`}

Plan represents the payment plan for an account. See plans athttps://github.com/plans.

func (*Plan)GetCollaborators ¶

func (p *Plan) GetCollaborators()int

GetCollaborators returns the Collaborators field if it's non-nil, zero value otherwise.

func (*Plan)GetFilledSeats ¶

func (p *Plan) GetFilledSeats()int

GetFilledSeats returns the FilledSeats field if it's non-nil, zero value otherwise.

func (*Plan)GetName ¶

func (p *Plan) GetName()string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (*Plan)GetPrivateRepos ¶

func (p *Plan) GetPrivateRepos()int

GetPrivateRepos returns the PrivateRepos field if it's non-nil, zero value otherwise.

func (*Plan)GetSeats ¶

func (p *Plan) GetSeats()int

GetSeats returns the Seats field if it's non-nil, zero value otherwise.

func (*Plan)GetSpace ¶

func (p *Plan) GetSpace()int

GetSpace returns the Space field if it's non-nil, zero value otherwise.

func (Plan)String ¶

func (pPlan) String()string

typePreReceiveHook ¶

type PreReceiveHook struct {ID          *int64  `json:"id,omitempty"`Name        *string `json:"name,omitempty"`Enforcement *string `json:"enforcement,omitempty"`ConfigURL   *string `json:"configuration_url,omitempty"`}

PreReceiveHook represents a GitHub pre-receive hook for a repository.

func (*PreReceiveHook)GetConfigURL ¶

func (p *PreReceiveHook) GetConfigURL()string

GetConfigURL returns the ConfigURL field if it's non-nil, zero value otherwise.

func (*PreReceiveHook)GetEnforcement ¶

func (p *PreReceiveHook) GetEnforcement()string

GetEnforcement returns the Enforcement field if it's non-nil, zero value otherwise.

func (*PreReceiveHook)GetID ¶

func (p *PreReceiveHook) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*PreReceiveHook)GetName ¶

func (p *PreReceiveHook) GetName()string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (PreReceiveHook)String ¶

func (pPreReceiveHook) String()string

typePreferenceList ¶

type PreferenceList struct {AutoTriggerChecks []*AutoTriggerCheck `json:"auto_trigger_checks,omitempty"`// A slice of auto trigger checks that can be set for a check suite in a repository.}

PreferenceList represents a list of auto trigger checks for repository

typeProject ¶

type Project struct {ID         *int64     `json:"id,omitempty"`URL        *string    `json:"url,omitempty"`HTMLURL    *string    `json:"html_url,omitempty"`ColumnsURL *string    `json:"columns_url,omitempty"`OwnerURL   *string    `json:"owner_url,omitempty"`Name       *string    `json:"name,omitempty"`Body       *string    `json:"body,omitempty"`Number     *int       `json:"number,omitempty"`State      *string    `json:"state,omitempty"`CreatedAt  *Timestamp `json:"created_at,omitempty"`UpdatedAt  *Timestamp `json:"updated_at,omitempty"`NodeID     *string    `json:"node_id,omitempty"`// The User object that generated the project.Creator *User `json:"creator,omitempty"`}

Project represents a GitHub Project.

func (*Project)GetBody ¶

func (p *Project) GetBody()string

GetBody returns the Body field if it's non-nil, zero value otherwise.

func (*Project)GetColumnsURL ¶

func (p *Project) GetColumnsURL()string

GetColumnsURL returns the ColumnsURL field if it's non-nil, zero value otherwise.

func (*Project)GetCreatedAt ¶

func (p *Project) GetCreatedAt()Timestamp

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*Project)GetCreator ¶

func (p *Project) GetCreator() *User

GetCreator returns the Creator field.

func (*Project)GetHTMLURL ¶

func (p *Project) GetHTMLURL()string

GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.

func (*Project)GetID ¶

func (p *Project) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*Project)GetName ¶

func (p *Project) GetName()string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (*Project)GetNodeID ¶

func (p *Project) GetNodeID()string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*Project)GetNumber ¶

func (p *Project) GetNumber()int

GetNumber returns the Number field if it's non-nil, zero value otherwise.

func (*Project)GetOwnerURL ¶

func (p *Project) GetOwnerURL()string

GetOwnerURL returns the OwnerURL field if it's non-nil, zero value otherwise.

func (*Project)GetState ¶

func (p *Project) GetState()string

GetState returns the State field if it's non-nil, zero value otherwise.

func (*Project)GetURL ¶

func (p *Project) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (*Project)GetUpdatedAt ¶

func (p *Project) GetUpdatedAt()Timestamp

GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.

func (Project)String ¶

func (pProject) String()string

typeProjectCard ¶

type ProjectCard struct {URL        *string    `json:"url,omitempty"`ColumnURL  *string    `json:"column_url,omitempty"`ContentURL *string    `json:"content_url,omitempty"`ID         *int64     `json:"id,omitempty"`Note       *string    `json:"note,omitempty"`Creator    *User      `json:"creator,omitempty"`CreatedAt  *Timestamp `json:"created_at,omitempty"`UpdatedAt  *Timestamp `json:"updated_at,omitempty"`NodeID     *string    `json:"node_id,omitempty"`Archived   *bool      `json:"archived,omitempty"`// The following fields are only populated by Webhook events.ColumnID *int64 `json:"column_id,omitempty"`// The following fields are only populated by Events API.ProjectID          *int64  `json:"project_id,omitempty"`ProjectURL         *string `json:"project_url,omitempty"`ColumnName         *string `json:"column_name,omitempty"`PreviousColumnName *string `json:"previous_column_name,omitempty"`// Populated in "moved_columns_in_project" event deliveries.}

ProjectCard represents a card in a column of a GitHub Project.

GitHub API docs:https://developer.github.com/v3/projects/cards/#get-a-project-card

func (*ProjectCard)GetArchived ¶

func (p *ProjectCard) GetArchived()bool

GetArchived returns the Archived field if it's non-nil, zero value otherwise.

func (*ProjectCard)GetColumnID ¶

func (p *ProjectCard) GetColumnID()int64

GetColumnID returns the ColumnID field if it's non-nil, zero value otherwise.

func (*ProjectCard)GetColumnName ¶

func (p *ProjectCard) GetColumnName()string

GetColumnName returns the ColumnName field if it's non-nil, zero value otherwise.

func (*ProjectCard)GetColumnURL ¶

func (p *ProjectCard) GetColumnURL()string

GetColumnURL returns the ColumnURL field if it's non-nil, zero value otherwise.

func (*ProjectCard)GetContentURL ¶

func (p *ProjectCard) GetContentURL()string

GetContentURL returns the ContentURL field if it's non-nil, zero value otherwise.

func (*ProjectCard)GetCreatedAt ¶

func (p *ProjectCard) GetCreatedAt()Timestamp

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*ProjectCard)GetCreator ¶

func (p *ProjectCard) GetCreator() *User

GetCreator returns the Creator field.

func (*ProjectCard)GetID ¶

func (p *ProjectCard) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*ProjectCard)GetNodeID ¶

func (p *ProjectCard) GetNodeID()string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*ProjectCard)GetNote ¶

func (p *ProjectCard) GetNote()string

GetNote returns the Note field if it's non-nil, zero value otherwise.

func (*ProjectCard)GetPreviousColumnName ¶

func (p *ProjectCard) GetPreviousColumnName()string

GetPreviousColumnName returns the PreviousColumnName field if it's non-nil, zero value otherwise.

func (*ProjectCard)GetProjectID ¶

func (p *ProjectCard) GetProjectID()int64

GetProjectID returns the ProjectID field if it's non-nil, zero value otherwise.

func (*ProjectCard)GetProjectURL ¶

func (p *ProjectCard) GetProjectURL()string

GetProjectURL returns the ProjectURL field if it's non-nil, zero value otherwise.

func (*ProjectCard)GetURL ¶

func (p *ProjectCard) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (*ProjectCard)GetUpdatedAt ¶

func (p *ProjectCard) GetUpdatedAt()Timestamp

GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.

typeProjectCardChange ¶

type ProjectCardChange struct {Note *struct {From *string `json:"from,omitempty"`} `json:"note,omitempty"`}

ProjectCardChange represents the changes when a project card has been edited.

typeProjectCardEvent ¶

type ProjectCardEvent struct {Action      *string            `json:"action,omitempty"`Changes     *ProjectCardChange `json:"changes,omitempty"`AfterID     *int64             `json:"after_id,omitempty"`ProjectCard *ProjectCard       `json:"project_card,omitempty"`// The following fields are only populated by Webhook events.Repo         *Repository   `json:"repository,omitempty"`Org          *Organization `json:"organization,omitempty"`Sender       *User         `json:"sender,omitempty"`Installation *Installation `json:"installation,omitempty"`}

ProjectCardEvent is triggered when a project card is created, updated, moved, converted to an issue, or deleted.The webhook event name is "project_card".

GitHub API docs:https://developer.github.com/v3/activity/events/types/#projectcardevent

func (*ProjectCardEvent)GetAction ¶

func (p *ProjectCardEvent) GetAction()string

GetAction returns the Action field if it's non-nil, zero value otherwise.

func (*ProjectCardEvent)GetAfterID ¶

func (p *ProjectCardEvent) GetAfterID()int64

GetAfterID returns the AfterID field if it's non-nil, zero value otherwise.

func (*ProjectCardEvent)GetChanges ¶

func (p *ProjectCardEvent) GetChanges() *ProjectCardChange

GetChanges returns the Changes field.

func (*ProjectCardEvent)GetInstallation ¶

func (p *ProjectCardEvent) GetInstallation() *Installation

GetInstallation returns the Installation field.

func (*ProjectCardEvent)GetOrg ¶

func (p *ProjectCardEvent) GetOrg() *Organization

GetOrg returns the Org field.

func (*ProjectCardEvent)GetProjectCard ¶

func (p *ProjectCardEvent) GetProjectCard() *ProjectCard

GetProjectCard returns the ProjectCard field.

func (*ProjectCardEvent)GetRepo ¶

func (p *ProjectCardEvent) GetRepo() *Repository

GetRepo returns the Repo field.

func (*ProjectCardEvent)GetSender ¶

func (p *ProjectCardEvent) GetSender() *User

GetSender returns the Sender field.

typeProjectCardListOptions ¶

type ProjectCardListOptions struct {// ArchivedState is used to list all, archived, or not_archived project cards.// Defaults to not_archived when you omit this parameter.ArchivedState *string `url:"archived_state,omitempty"`ListOptions}

ProjectCardListOptions specifies the optional parameters to theProjectsService.ListProjectCards method.

func (*ProjectCardListOptions)GetArchivedState ¶

func (p *ProjectCardListOptions) GetArchivedState()string

GetArchivedState returns the ArchivedState field if it's non-nil, zero value otherwise.

typeProjectCardMoveOptions ¶

type ProjectCardMoveOptions struct {// Position can be one of "top", "bottom", or "after:<card-id>", where// <card-id> is the ID of a card in the same project.Positionstring `json:"position"`// ColumnID is the ID of a column in the same project. Note that ColumnID// is required when using Position "after:<card-id>" when that card is in// another column; otherwise it is optional.ColumnIDint64 `json:"column_id,omitempty"`}

ProjectCardMoveOptions specifies the parameters to theProjectsService.MoveProjectCard method.

typeProjectCardOptions ¶

type ProjectCardOptions struct {// The note of the card. Note and ContentID are mutually exclusive.Notestring `json:"note,omitempty"`// The ID (not Number) of the Issue to associate with this card.// Note and ContentID are mutually exclusive.ContentIDint64 `json:"content_id,omitempty"`// The type of content to associate with this card. Possible values are: "Issue" and "PullRequest".ContentTypestring `json:"content_type,omitempty"`// Use true to archive a project card.// Specify false if you need to restore a previously archived project card.Archived *bool `json:"archived,omitempty"`}

ProjectCardOptions specifies the parameters to theProjectsService.CreateProjectCard andProjectsService.UpdateProjectCard methods.

func (*ProjectCardOptions)GetArchived ¶

func (p *ProjectCardOptions) GetArchived()bool

GetArchived returns the Archived field if it's non-nil, zero value otherwise.

typeProjectChange ¶

type ProjectChange struct {Name *struct {From *string `json:"from,omitempty"`} `json:"name,omitempty"`Body *struct {From *string `json:"from,omitempty"`} `json:"body,omitempty"`}

ProjectChange represents the changes when a project has been edited.

typeProjectCollaboratorOptions ¶

type ProjectCollaboratorOptions struct {// Permission specifies the permission to grant to the collaborator.// Possible values are://     "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.//// Default value is "write"Permission *string `json:"permission,omitempty"`}

ProjectCollaboratorOptions specifies the optional parameters to theProjectsService.AddProjectCollaborator method.

func (*ProjectCollaboratorOptions)GetPermission ¶

func (p *ProjectCollaboratorOptions) GetPermission()string

GetPermission returns the Permission field if it's non-nil, zero value otherwise.

typeProjectColumn ¶

type ProjectColumn struct {ID         *int64     `json:"id,omitempty"`Name       *string    `json:"name,omitempty"`URL        *string    `json:"url,omitempty"`ProjectURL *string    `json:"project_url,omitempty"`CardsURL   *string    `json:"cards_url,omitempty"`CreatedAt  *Timestamp `json:"created_at,omitempty"`UpdatedAt  *Timestamp `json:"updated_at,omitempty"`NodeID     *string    `json:"node_id,omitempty"`}

ProjectColumn represents a column of a GitHub Project.

GitHub API docs:https://developer.github.com/v3/repos/projects/

func (*ProjectColumn)GetCardsURL ¶

func (p *ProjectColumn) GetCardsURL()string

GetCardsURL returns the CardsURL field if it's non-nil, zero value otherwise.

func (*ProjectColumn)GetCreatedAt ¶

func (p *ProjectColumn) GetCreatedAt()Timestamp

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*ProjectColumn)GetID ¶

func (p *ProjectColumn) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*ProjectColumn)GetName ¶

func (p *ProjectColumn) GetName()string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (*ProjectColumn)GetNodeID ¶

func (p *ProjectColumn) GetNodeID()string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*ProjectColumn)GetProjectURL ¶

func (p *ProjectColumn) GetProjectURL()string

GetProjectURL returns the ProjectURL field if it's non-nil, zero value otherwise.

func (*ProjectColumn)GetURL ¶

func (p *ProjectColumn) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (*ProjectColumn)GetUpdatedAt ¶

func (p *ProjectColumn) GetUpdatedAt()Timestamp

GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.

typeProjectColumnChange ¶

type ProjectColumnChange struct {Name *struct {From *string `json:"from,omitempty"`} `json:"name,omitempty"`}

ProjectColumnChange represents the changes when a project column has been edited.

typeProjectColumnEvent ¶

type ProjectColumnEvent struct {Action        *string              `json:"action,omitempty"`Changes       *ProjectColumnChange `json:"changes,omitempty"`AfterID       *int64               `json:"after_id,omitempty"`ProjectColumn *ProjectColumn       `json:"project_column,omitempty"`// The following fields are only populated by Webhook events.Repo         *Repository   `json:"repository,omitempty"`Org          *Organization `json:"organization,omitempty"`Sender       *User         `json:"sender,omitempty"`Installation *Installation `json:"installation,omitempty"`}

ProjectColumnEvent is triggered when a project column is created, updated, moved, or deleted.The webhook event name is "project_column".

GitHub API docs:https://developer.github.com/v3/activity/events/types/#projectcolumnevent

func (*ProjectColumnEvent)GetAction ¶

func (p *ProjectColumnEvent) GetAction()string

GetAction returns the Action field if it's non-nil, zero value otherwise.

func (*ProjectColumnEvent)GetAfterID ¶

func (p *ProjectColumnEvent) GetAfterID()int64

GetAfterID returns the AfterID field if it's non-nil, zero value otherwise.

func (*ProjectColumnEvent)GetChanges ¶

func (p *ProjectColumnEvent) GetChanges() *ProjectColumnChange

GetChanges returns the Changes field.

func (*ProjectColumnEvent)GetInstallation ¶

func (p *ProjectColumnEvent) GetInstallation() *Installation

GetInstallation returns the Installation field.

func (*ProjectColumnEvent)GetOrg ¶

func (p *ProjectColumnEvent) GetOrg() *Organization

GetOrg returns the Org field.

func (*ProjectColumnEvent)GetProjectColumn ¶

func (p *ProjectColumnEvent) GetProjectColumn() *ProjectColumn

GetProjectColumn returns the ProjectColumn field.

func (*ProjectColumnEvent)GetRepo ¶

func (p *ProjectColumnEvent) GetRepo() *Repository

GetRepo returns the Repo field.

func (*ProjectColumnEvent)GetSender ¶

func (p *ProjectColumnEvent) GetSender() *User

GetSender returns the Sender field.

typeProjectColumnMoveOptions ¶

type ProjectColumnMoveOptions struct {// Position can be one of "first", "last", or "after:<column-id>", where// <column-id> is the ID of a column in the same project. (Required.)Positionstring `json:"position"`}

ProjectColumnMoveOptions specifies the parameters to theProjectsService.MoveProjectColumn method.

typeProjectColumnOptions ¶

type ProjectColumnOptions struct {// The name of the project column. (Required for creation and update.)Namestring `json:"name"`}

ProjectColumnOptions specifies the parameters to theProjectsService.CreateProjectColumn andProjectsService.UpdateProjectColumn methods.

typeProjectEvent ¶

type ProjectEvent struct {Action  *string        `json:"action,omitempty"`Changes *ProjectChange `json:"changes,omitempty"`Project *Project       `json:"project,omitempty"`// The following fields are only populated by Webhook events.Repo         *Repository   `json:"repository,omitempty"`Org          *Organization `json:"organization,omitempty"`Sender       *User         `json:"sender,omitempty"`Installation *Installation `json:"installation,omitempty"`}

ProjectEvent is triggered when project is created, modified or deleted.The webhook event name is "project".

GitHub API docs:https://developer.github.com/v3/activity/events/types/#projectevent

func (*ProjectEvent)GetAction ¶

func (p *ProjectEvent) GetAction()string

GetAction returns the Action field if it's non-nil, zero value otherwise.

func (*ProjectEvent)GetChanges ¶

func (p *ProjectEvent) GetChanges() *ProjectChange

GetChanges returns the Changes field.

func (*ProjectEvent)GetInstallation ¶

func (p *ProjectEvent) GetInstallation() *Installation

GetInstallation returns the Installation field.

func (*ProjectEvent)GetOrg ¶

func (p *ProjectEvent) GetOrg() *Organization

GetOrg returns the Org field.

func (*ProjectEvent)GetProject ¶

func (p *ProjectEvent) GetProject() *Project

GetProject returns the Project field.

func (*ProjectEvent)GetRepo ¶

func (p *ProjectEvent) GetRepo() *Repository

GetRepo returns the Repo field.

func (*ProjectEvent)GetSender ¶

func (p *ProjectEvent) GetSender() *User

GetSender returns the Sender field.

typeProjectListOptions ¶

type ProjectListOptions struct {// Indicates the state of the projects to return. Can be either open, closed, or all. Default: openStatestring `url:"state,omitempty"`ListOptions}

ProjectListOptions specifies the optional parameters to theOrganizationsService.ListProjects and RepositoriesService.ListProjects methods.

typeProjectOptions ¶

type ProjectOptions struct {// The name of the project. (Required for creation; optional for update.)Name *string `json:"name,omitempty"`// The body of the project. (Optional.)Body *string `json:"body,omitempty"`// State of the project. Either "open" or "closed". (Optional.)State *string `json:"state,omitempty"`// The permission level that all members of the project's organization// will have on this project.// Setting the organization permission is only available// for organization projects. (Optional.)OrganizationPermission *string `json:"organization_permission,omitempty"`// Sets visibility of the project within the organization.// Setting visibility is only available// for organization projects.(Optional.)Public *bool `json:"public,omitempty"`}

ProjectOptions specifies the parameters to theRepositoriesService.CreateProject andProjectsService.UpdateProject methods.

func (*ProjectOptions)GetBody ¶

func (p *ProjectOptions) GetBody()string

GetBody returns the Body field if it's non-nil, zero value otherwise.

func (*ProjectOptions)GetName ¶

func (p *ProjectOptions) GetName()string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (*ProjectOptions)GetOrganizationPermission ¶

func (p *ProjectOptions) GetOrganizationPermission()string

GetOrganizationPermission returns the OrganizationPermission field if it's non-nil, zero value otherwise.

func (*ProjectOptions)GetPublic ¶

func (p *ProjectOptions) GetPublic()bool

GetPublic returns the Public field if it's non-nil, zero value otherwise.

func (*ProjectOptions)GetState ¶

func (p *ProjectOptions) GetState()string

GetState returns the State field if it's non-nil, zero value otherwise.

typeProjectPermissionLevel ¶

type ProjectPermissionLevel struct {// Possible values: "admin", "write", "read", "none"Permission *string `json:"permission,omitempty"`User *User `json:"user,omitempty"`}

ProjectPermissionLevel represents the permission level an organizationmember has for a given project.

func (*ProjectPermissionLevel)GetPermission ¶

func (p *ProjectPermissionLevel) GetPermission()string

GetPermission returns the Permission field if it's non-nil, zero value otherwise.

func (*ProjectPermissionLevel)GetUser ¶

func (p *ProjectPermissionLevel) GetUser() *User

GetUser returns the User field.

typeProjectsService ¶

type ProjectsService service

ProjectsService provides access to the projects functions in theGitHub API.

GitHub API docs:https://developer.github.com/v3/projects/

func (*ProjectsService)AddProjectCollaborator ¶

func (s *ProjectsService) AddProjectCollaborator(ctxcontext.Context, idint64, usernamestring, opts *ProjectCollaboratorOptions) (*Response,error)

AddProjectCollaborator adds a collaborator to an organization project and setstheir permission level. You must be an organization owner or a project admin to add a collaborator.

GitHub API docs:https://developer.github.com/v3/projects/collaborators/#add-user-as-a-collaborator

func (*ProjectsService)CreateProjectCard ¶

func (s *ProjectsService) CreateProjectCard(ctxcontext.Context, columnIDint64, opts *ProjectCardOptions) (*ProjectCard, *Response,error)

CreateProjectCard creates a card in the specified column of a GitHub Project.

GitHub API docs:https://developer.github.com/v3/projects/cards/#create-a-project-card

func (*ProjectsService)CreateProjectColumn ¶

func (s *ProjectsService) CreateProjectColumn(ctxcontext.Context, projectIDint64, opts *ProjectColumnOptions) (*ProjectColumn, *Response,error)

CreateProjectColumn creates a column for the specified (by number) project.

GitHub API docs:https://developer.github.com/v3/projects/columns/#create-a-project-column

func (*ProjectsService)DeleteProject ¶

func (s *ProjectsService) DeleteProject(ctxcontext.Context, idint64) (*Response,error)

DeleteProject deletes a GitHub Project from a repository.

GitHub API docs:https://developer.github.com/v3/projects/#delete-a-project

func (*ProjectsService)DeleteProjectCard ¶

func (s *ProjectsService) DeleteProjectCard(ctxcontext.Context, cardIDint64) (*Response,error)

DeleteProjectCard deletes a card from a GitHub Project.

GitHub API docs:https://developer.github.com/v3/projects/cards/#delete-a-project-card

func (*ProjectsService)DeleteProjectColumn ¶

func (s *ProjectsService) DeleteProjectColumn(ctxcontext.Context, columnIDint64) (*Response,error)

DeleteProjectColumn deletes a column from a GitHub Project.

GitHub API docs:https://developer.github.com/v3/projects/columns/#delete-a-project-column

func (*ProjectsService)GetProject ¶

func (s *ProjectsService) GetProject(ctxcontext.Context, idint64) (*Project, *Response,error)

GetProject gets a GitHub Project for a repo.

GitHub API docs:https://developer.github.com/v3/projects/#get-a-project

func (*ProjectsService)GetProjectCard ¶

func (s *ProjectsService) GetProjectCard(ctxcontext.Context, cardIDint64) (*ProjectCard, *Response,error)

GetProjectCard gets a card in a column of a GitHub Project.

GitHub API docs:https://developer.github.com/v3/projects/cards/#get-a-project-card

func (*ProjectsService)GetProjectColumn ¶

func (s *ProjectsService) GetProjectColumn(ctxcontext.Context, idint64) (*ProjectColumn, *Response,error)

GetProjectColumn gets a column of a GitHub Project for a repo.

GitHub API docs:https://developer.github.com/v3/projects/columns/#get-a-project-column

func (*ProjectsService)ListProjectCards ¶

func (s *ProjectsService) ListProjectCards(ctxcontext.Context, columnIDint64, opts *ProjectCardListOptions) ([]*ProjectCard, *Response,error)

ListProjectCards lists the cards in a column of a GitHub Project.

GitHub API docs:https://developer.github.com/v3/projects/cards/#list-project-cards

func (*ProjectsService)ListProjectCollaborators ¶

func (s *ProjectsService) ListProjectCollaborators(ctxcontext.Context, idint64, opts *ListCollaboratorOptions) ([]*User, *Response,error)

ListProjectCollaborators lists the collaborators for an organization project. For a project,the list of collaborators includes outside collaborators, organization members that are directcollaborators, organization members with access through team memberships, organization memberswith access through default organization permissions, and organization owners. You must be anorganization owner or a project admin to list collaborators.

GitHub API docs:https://developer.github.com/v3/projects/collaborators/#list-collaborators

func (*ProjectsService)ListProjectColumns ¶

func (s *ProjectsService) ListProjectColumns(ctxcontext.Context, projectIDint64, opts *ListOptions) ([]*ProjectColumn, *Response,error)

ListProjectColumns lists the columns of a GitHub Project for a repo.

GitHub API docs:https://developer.github.com/v3/projects/columns/#list-project-columns

func (*ProjectsService)MoveProjectCard ¶

func (s *ProjectsService) MoveProjectCard(ctxcontext.Context, cardIDint64, opts *ProjectCardMoveOptions) (*Response,error)

MoveProjectCard moves a card within a GitHub Project.

GitHub API docs:https://developer.github.com/v3/projects/cards/#move-a-project-card

func (*ProjectsService)MoveProjectColumn ¶

func (s *ProjectsService) MoveProjectColumn(ctxcontext.Context, columnIDint64, opts *ProjectColumnMoveOptions) (*Response,error)

MoveProjectColumn moves a column within a GitHub Project.

GitHub API docs:https://developer.github.com/v3/projects/columns/#move-a-project-column

func (*ProjectsService)RemoveProjectCollaborator ¶

func (s *ProjectsService) RemoveProjectCollaborator(ctxcontext.Context, idint64, usernamestring) (*Response,error)

RemoveProjectCollaborator removes a collaborator from an organization project.You must be an organization owner or a project admin to remove a collaborator.

GitHub API docs:https://developer.github.com/v3/projects/collaborators/#remove-user-as-a-collaborator

func (*ProjectsService)ReviewProjectCollaboratorPermission ¶

func (s *ProjectsService) ReviewProjectCollaboratorPermission(ctxcontext.Context, idint64, usernamestring) (*ProjectPermissionLevel, *Response,error)

ReviewProjectCollaboratorPermission returns the collaborator's permission level for an organizationproject. 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.

GitHub API docs:https://developer.github.com/v3/projects/collaborators/#review-a-users-permission-level

func (*ProjectsService)UpdateProject ¶

func (s *ProjectsService) UpdateProject(ctxcontext.Context, idint64, opts *ProjectOptions) (*Project, *Response,error)

UpdateProject updates a repository project.

GitHub API docs:https://developer.github.com/v3/projects/#update-a-project

func (*ProjectsService)UpdateProjectCard ¶

func (s *ProjectsService) UpdateProjectCard(ctxcontext.Context, cardIDint64, opts *ProjectCardOptions) (*ProjectCard, *Response,error)

UpdateProjectCard updates a card of a GitHub Project.

GitHub API docs:https://developer.github.com/v3/projects/cards/#update-a-project-card

func (*ProjectsService)UpdateProjectColumn ¶

func (s *ProjectsService) UpdateProjectColumn(ctxcontext.Context, columnIDint64, opts *ProjectColumnOptions) (*ProjectColumn, *Response,error)

UpdateProjectColumn updates a column of a GitHub Project.

GitHub API docs:https://developer.github.com/v3/projects/columns/#update-a-project-column

typeProtection ¶

type Protection struct {RequiredStatusChecks       *RequiredStatusChecks          `json:"required_status_checks"`RequiredPullRequestReviews *PullRequestReviewsEnforcement `json:"required_pull_request_reviews"`EnforceAdmins              *AdminEnforcement              `json:"enforce_admins"`Restrictions               *BranchRestrictions            `json:"restrictions"`RequireLinearHistory       *RequireLinearHistory          `json:"required_linear_history"`AllowForcePushes           *AllowForcePushes              `json:"allow_force_pushes"`AllowDeletions             *AllowDeletions                `json:"allow_deletions"`}

Protection represents a repository branch's protection.

func (*Protection)GetAllowDeletions ¶added inv29.0.3

func (p *Protection) GetAllowDeletions() *AllowDeletions

GetAllowDeletions returns the AllowDeletions field.

func (*Protection)GetAllowForcePushes ¶added inv29.0.3

func (p *Protection) GetAllowForcePushes() *AllowForcePushes

GetAllowForcePushes returns the AllowForcePushes field.

func (*Protection)GetEnforceAdmins ¶

func (p *Protection) GetEnforceAdmins() *AdminEnforcement

GetEnforceAdmins returns the EnforceAdmins field.

func (*Protection)GetRequireLinearHistory ¶added inv29.0.3

func (p *Protection) GetRequireLinearHistory() *RequireLinearHistory

GetRequireLinearHistory returns the RequireLinearHistory field.

func (*Protection)GetRequiredPullRequestReviews ¶

func (p *Protection) GetRequiredPullRequestReviews() *PullRequestReviewsEnforcement

GetRequiredPullRequestReviews returns the RequiredPullRequestReviews field.

func (*Protection)GetRequiredStatusChecks ¶

func (p *Protection) GetRequiredStatusChecks() *RequiredStatusChecks

GetRequiredStatusChecks returns the RequiredStatusChecks field.

func (*Protection)GetRestrictions ¶

func (p *Protection) GetRestrictions() *BranchRestrictions

GetRestrictions returns the Restrictions field.

typeProtectionRequest ¶

type ProtectionRequest struct {RequiredStatusChecks       *RequiredStatusChecks                 `json:"required_status_checks"`RequiredPullRequestReviews *PullRequestReviewsEnforcementRequest `json:"required_pull_request_reviews"`EnforceAdminsbool                                  `json:"enforce_admins"`Restrictions               *BranchRestrictionsRequest            `json:"restrictions"`// Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch.RequireLinearHistory *bool `json:"required_linear_history,omitempty"`// Permits force pushes to the protected branch by anyone with write access to the repository.AllowForcePushes *bool `json:"allow_force_pushes,omitempty"`// Allows deletion of the protected branch by anyone with write access to the repository.AllowDeletions *bool `json:"allow_deletions,omitempty"`}

ProtectionRequest represents a request to create/edit a branch's protection.

func (*ProtectionRequest)GetAllowDeletions ¶added inv29.0.3

func (p *ProtectionRequest) GetAllowDeletions()bool

GetAllowDeletions returns the AllowDeletions field if it's non-nil, zero value otherwise.

func (*ProtectionRequest)GetAllowForcePushes ¶added inv29.0.3

func (p *ProtectionRequest) GetAllowForcePushes()bool

GetAllowForcePushes returns the AllowForcePushes field if it's non-nil, zero value otherwise.

func (*ProtectionRequest)GetRequireLinearHistory ¶added inv29.0.3

func (p *ProtectionRequest) GetRequireLinearHistory()bool

GetRequireLinearHistory returns the RequireLinearHistory field if it's non-nil, zero value otherwise.

func (*ProtectionRequest)GetRequiredPullRequestReviews ¶

func (p *ProtectionRequest) GetRequiredPullRequestReviews() *PullRequestReviewsEnforcementRequest

GetRequiredPullRequestReviews returns the RequiredPullRequestReviews field.

func (*ProtectionRequest)GetRequiredStatusChecks ¶

func (p *ProtectionRequest) GetRequiredStatusChecks() *RequiredStatusChecks

GetRequiredStatusChecks returns the RequiredStatusChecks field.

func (*ProtectionRequest)GetRestrictions ¶

func (p *ProtectionRequest) GetRestrictions() *BranchRestrictionsRequest

GetRestrictions returns the Restrictions field.

typePublicEvent ¶

type PublicEvent struct {// The following fields are only populated by Webhook events.Repo         *Repository   `json:"repository,omitempty"`Sender       *User         `json:"sender,omitempty"`Installation *Installation `json:"installation,omitempty"`}

PublicEvent is triggered when a private repository is open sourced.According to GitHub: "Without a doubt: the best GitHub event."The Webhook event name is "public".

GitHub API docs:https://developer.github.com/v3/activity/events/types/#publicevent

func (*PublicEvent)GetInstallation ¶

func (p *PublicEvent) GetInstallation() *Installation

GetInstallation returns the Installation field.

func (*PublicEvent)GetRepo ¶

func (p *PublicEvent) GetRepo() *Repository

GetRepo returns the Repo field.

func (*PublicEvent)GetSender ¶

func (p *PublicEvent) GetSender() *User

GetSender returns the Sender field.

typePublicKey ¶added inv29.0.3

type PublicKey struct {KeyID *string `json:"key_id"`Key   *string `json:"key"`}

PublicKey represents the public key that should be used to encrypt secrets.

func (*PublicKey)GetKey ¶added inv29.0.3

func (p *PublicKey) GetKey()string

GetKey returns the Key field if it's non-nil, zero value otherwise.

func (*PublicKey)GetKeyID ¶added inv29.0.3

func (p *PublicKey) GetKeyID()string

GetKeyID returns the KeyID field if it's non-nil, zero value otherwise.

typePullRequest ¶

type PullRequest struct {ID                  *int64     `json:"id,omitempty"`Number              *int       `json:"number,omitempty"`State               *string    `json:"state,omitempty"`Locked              *bool      `json:"locked,omitempty"`Title               *string    `json:"title,omitempty"`Body                *string    `json:"body,omitempty"`CreatedAt           *time.Time `json:"created_at,omitempty"`UpdatedAt           *time.Time `json:"updated_at,omitempty"`ClosedAt            *time.Time `json:"closed_at,omitempty"`MergedAt            *time.Time `json:"merged_at,omitempty"`Labels              []*Label   `json:"labels,omitempty"`User                *User      `json:"user,omitempty"`Draft               *bool      `json:"draft,omitempty"`Merged              *bool      `json:"merged,omitempty"`Mergeable           *bool      `json:"mergeable,omitempty"`MergeableState      *string    `json:"mergeable_state,omitempty"`MergedBy            *User      `json:"merged_by,omitempty"`MergeCommitSHA      *string    `json:"merge_commit_sha,omitempty"`Rebaseable          *bool      `json:"rebaseable,omitempty"`Comments            *int       `json:"comments,omitempty"`Commits             *int       `json:"commits,omitempty"`Additions           *int       `json:"additions,omitempty"`Deletions           *int       `json:"deletions,omitempty"`ChangedFiles        *int       `json:"changed_files,omitempty"`URL                 *string    `json:"url,omitempty"`HTMLURL             *string    `json:"html_url,omitempty"`IssueURL            *string    `json:"issue_url,omitempty"`StatusesURL         *string    `json:"statuses_url,omitempty"`DiffURL             *string    `json:"diff_url,omitempty"`PatchURL            *string    `json:"patch_url,omitempty"`CommitsURL          *string    `json:"commits_url,omitempty"`CommentsURL         *string    `json:"comments_url,omitempty"`ReviewCommentsURL   *string    `json:"review_comments_url,omitempty"`ReviewCommentURL    *string    `json:"review_comment_url,omitempty"`ReviewComments      *int       `json:"review_comments,omitempty"`Assignee            *User      `json:"assignee,omitempty"`Assignees           []*User    `json:"assignees,omitempty"`Milestone           *Milestone `json:"milestone,omitempty"`MaintainerCanModify *bool      `json:"maintainer_can_modify,omitempty"`AuthorAssociation   *string    `json:"author_association,omitempty"`NodeID              *string    `json:"node_id,omitempty"`RequestedReviewers  []*User    `json:"requested_reviewers,omitempty"`// RequestedTeams is populated as part of the PullRequestEvent.// See,https://developer.github.com/v3/activity/events/types/#pullrequestevent for an example.RequestedTeams []*Team `json:"requested_teams,omitempty"`Links *PRLinks           `json:"_links,omitempty"`Head  *PullRequestBranch `json:"head,omitempty"`Base  *PullRequestBranch `json:"base,omitempty"`// ActiveLockReason is populated only when LockReason is provided while locking the pull request.// Possible values are: "off-topic", "too heated", "resolved", and "spam".ActiveLockReason *string `json:"active_lock_reason,omitempty"`}

PullRequest represents a GitHub pull request on a repository.

func (*PullRequest)GetActiveLockReason ¶

func (p *PullRequest) GetActiveLockReason()string

GetActiveLockReason returns the ActiveLockReason field if it's non-nil, zero value otherwise.

func (*PullRequest)GetAdditions ¶

func (p *PullRequest) GetAdditions()int

GetAdditions returns the Additions field if it's non-nil, zero value otherwise.

func (*PullRequest)GetAssignee ¶

func (p *PullRequest) GetAssignee() *User

GetAssignee returns the Assignee field.

func (*PullRequest)GetAuthorAssociation ¶

func (p *PullRequest) GetAuthorAssociation()string

GetAuthorAssociation returns the AuthorAssociation field if it's non-nil, zero value otherwise.

func (*PullRequest)GetBase ¶

func (p *PullRequest) GetBase() *PullRequestBranch

GetBase returns the Base field.

func (*PullRequest)GetBody ¶

func (p *PullRequest) GetBody()string

GetBody returns the Body field if it's non-nil, zero value otherwise.

func (*PullRequest)GetChangedFiles ¶

func (p *PullRequest) GetChangedFiles()int

GetChangedFiles returns the ChangedFiles field if it's non-nil, zero value otherwise.

func (*PullRequest)GetClosedAt ¶

func (p *PullRequest) GetClosedAt()time.Time

GetClosedAt returns the ClosedAt field if it's non-nil, zero value otherwise.

func (*PullRequest)GetComments ¶

func (p *PullRequest) GetComments()int

GetComments returns the Comments field if it's non-nil, zero value otherwise.

func (*PullRequest)GetCommentsURL ¶

func (p *PullRequest) GetCommentsURL()string

GetCommentsURL returns the CommentsURL field if it's non-nil, zero value otherwise.

func (*PullRequest)GetCommits ¶

func (p *PullRequest) GetCommits()int

GetCommits returns the Commits field if it's non-nil, zero value otherwise.

func (*PullRequest)GetCommitsURL ¶

func (p *PullRequest) GetCommitsURL()string

GetCommitsURL returns the CommitsURL field if it's non-nil, zero value otherwise.

func (*PullRequest)GetCreatedAt ¶

func (p *PullRequest) GetCreatedAt()time.Time

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*PullRequest)GetDeletions ¶

func (p *PullRequest) GetDeletions()int

GetDeletions returns the Deletions field if it's non-nil, zero value otherwise.

func (*PullRequest)GetDiffURL ¶

func (p *PullRequest) GetDiffURL()string

GetDiffURL returns the DiffURL field if it's non-nil, zero value otherwise.

func (*PullRequest)GetDraft ¶

func (p *PullRequest) GetDraft()bool

GetDraft returns the Draft field if it's non-nil, zero value otherwise.

func (*PullRequest)GetHTMLURL ¶

func (p *PullRequest) GetHTMLURL()string

GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.

func (*PullRequest)GetHead ¶

func (p *PullRequest) GetHead() *PullRequestBranch

GetHead returns the Head field.

func (*PullRequest)GetID ¶

func (p *PullRequest) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*PullRequest)GetIssueURL ¶

func (p *PullRequest) GetIssueURL()string

GetIssueURL returns the IssueURL field if it's non-nil, zero value otherwise.

func (*PullRequest)GetLinks ¶

func (p *PullRequest) GetLinks() *PRLinks

GetLinks returns the Links field.

func (*PullRequest)GetLocked ¶

func (p *PullRequest) GetLocked()bool

GetLocked returns the Locked field if it's non-nil, zero value otherwise.

func (*PullRequest)GetMaintainerCanModify ¶

func (p *PullRequest) GetMaintainerCanModify()bool

GetMaintainerCanModify returns the MaintainerCanModify field if it's non-nil, zero value otherwise.

func (*PullRequest)GetMergeCommitSHA ¶

func (p *PullRequest) GetMergeCommitSHA()string

GetMergeCommitSHA returns the MergeCommitSHA field if it's non-nil, zero value otherwise.

func (*PullRequest)GetMergeable ¶

func (p *PullRequest) GetMergeable()bool

GetMergeable returns the Mergeable field if it's non-nil, zero value otherwise.

func (*PullRequest)GetMergeableState ¶

func (p *PullRequest) GetMergeableState()string

GetMergeableState returns the MergeableState field if it's non-nil, zero value otherwise.

func (*PullRequest)GetMerged ¶

func (p *PullRequest) GetMerged()bool

GetMerged returns the Merged field if it's non-nil, zero value otherwise.

func (*PullRequest)GetMergedAt ¶

func (p *PullRequest) GetMergedAt()time.Time

GetMergedAt returns the MergedAt field if it's non-nil, zero value otherwise.

func (*PullRequest)GetMergedBy ¶

func (p *PullRequest) GetMergedBy() *User

GetMergedBy returns the MergedBy field.

func (*PullRequest)GetMilestone ¶

func (p *PullRequest) GetMilestone() *Milestone

GetMilestone returns the Milestone field.

func (*PullRequest)GetNodeID ¶

func (p *PullRequest) GetNodeID()string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*PullRequest)GetNumber ¶

func (p *PullRequest) GetNumber()int

GetNumber returns the Number field if it's non-nil, zero value otherwise.

func (*PullRequest)GetPatchURL ¶

func (p *PullRequest) GetPatchURL()string

GetPatchURL returns the PatchURL field if it's non-nil, zero value otherwise.

func (*PullRequest)GetRebaseable ¶

func (p *PullRequest) GetRebaseable()bool

GetRebaseable returns the Rebaseable field if it's non-nil, zero value otherwise.

func (*PullRequest)GetReviewCommentURL ¶

func (p *PullRequest) GetReviewCommentURL()string

GetReviewCommentURL returns the ReviewCommentURL field if it's non-nil, zero value otherwise.

func (*PullRequest)GetReviewComments ¶

func (p *PullRequest) GetReviewComments()int

GetReviewComments returns the ReviewComments field if it's non-nil, zero value otherwise.

func (*PullRequest)GetReviewCommentsURL ¶

func (p *PullRequest) GetReviewCommentsURL()string

GetReviewCommentsURL returns the ReviewCommentsURL field if it's non-nil, zero value otherwise.

func (*PullRequest)GetState ¶

func (p *PullRequest) GetState()string

GetState returns the State field if it's non-nil, zero value otherwise.

func (*PullRequest)GetStatusesURL ¶

func (p *PullRequest) GetStatusesURL()string

GetStatusesURL returns the StatusesURL field if it's non-nil, zero value otherwise.

func (*PullRequest)GetTitle ¶

func (p *PullRequest) GetTitle()string

GetTitle returns the Title field if it's non-nil, zero value otherwise.

func (*PullRequest)GetURL ¶

func (p *PullRequest) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (*PullRequest)GetUpdatedAt ¶

func (p *PullRequest) GetUpdatedAt()time.Time

GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.

func (*PullRequest)GetUser ¶

func (p *PullRequest) GetUser() *User

GetUser returns the User field.

func (PullRequest)String ¶

func (pPullRequest) String()string

typePullRequestBranch ¶

type PullRequestBranch struct {Label *string     `json:"label,omitempty"`Ref   *string     `json:"ref,omitempty"`SHA   *string     `json:"sha,omitempty"`Repo  *Repository `json:"repo,omitempty"`User  *User       `json:"user,omitempty"`}

PullRequestBranch represents a base or head branch in a GitHub pull request.

func (*PullRequestBranch)GetLabel ¶

func (p *PullRequestBranch) GetLabel()string

GetLabel returns the Label field if it's non-nil, zero value otherwise.

func (*PullRequestBranch)GetRef ¶

func (p *PullRequestBranch) GetRef()string

GetRef returns the Ref field if it's non-nil, zero value otherwise.

func (*PullRequestBranch)GetRepo ¶

func (p *PullRequestBranch) GetRepo() *Repository

GetRepo returns the Repo field.

func (*PullRequestBranch)GetSHA ¶

func (p *PullRequestBranch) GetSHA()string

GetSHA returns the SHA field if it's non-nil, zero value otherwise.

func (*PullRequestBranch)GetUser ¶

func (p *PullRequestBranch) GetUser() *User

GetUser returns the User field.

typePullRequestBranchUpdateOptions ¶

type PullRequestBranchUpdateOptions struct {// ExpectedHeadSHA specifies the most recent commit on the pull request's branch.// Default value is the SHA of the pull request's current HEAD ref.ExpectedHeadSHA *string `json:"expected_head_sha,omitempty"`}

PullRequestBranchUpdateOptions specifies the optional parameters to thePullRequestsService.UpdateBranch method.

func (*PullRequestBranchUpdateOptions)GetExpectedHeadSHA ¶

func (p *PullRequestBranchUpdateOptions) GetExpectedHeadSHA()string

GetExpectedHeadSHA returns the ExpectedHeadSHA field if it's non-nil, zero value otherwise.

typePullRequestBranchUpdateResponse ¶

type PullRequestBranchUpdateResponse struct {Message *string `json:"message,omitempty"`URL     *string `json:"url,omitempty"`}

PullRequestBranchUpdateResponse specifies the response of pull request branch update.

func (*PullRequestBranchUpdateResponse)GetMessage ¶

func (p *PullRequestBranchUpdateResponse) GetMessage()string

GetMessage returns the Message field if it's non-nil, zero value otherwise.

func (*PullRequestBranchUpdateResponse)GetURL ¶

func (p *PullRequestBranchUpdateResponse) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

typePullRequestComment ¶

type PullRequestComment struct {ID                  *int64     `json:"id,omitempty"`NodeID              *string    `json:"node_id,omitempty"`InReplyTo           *int64     `json:"in_reply_to_id,omitempty"`Body                *string    `json:"body,omitempty"`Path                *string    `json:"path,omitempty"`DiffHunk            *string    `json:"diff_hunk,omitempty"`PullRequestReviewID *int64     `json:"pull_request_review_id,omitempty"`Position            *int       `json:"position,omitempty"`OriginalPosition    *int       `json:"original_position,omitempty"`StartLine           *int       `json:"start_line,omitempty"`Line                *int       `json:"line,omitempty"`OriginalLine        *int       `json:"original_line,omitempty"`OriginalStartLine   *int       `json:"original_start_line,omitempty"`Side                *string    `json:"side,omitempty"`StartSide           *string    `json:"start_side,omitempty"`CommitID            *string    `json:"commit_id,omitempty"`OriginalCommitID    *string    `json:"original_commit_id,omitempty"`User                *User      `json:"user,omitempty"`Reactions           *Reactions `json:"reactions,omitempty"`CreatedAt           *time.Time `json:"created_at,omitempty"`UpdatedAt           *time.Time `json:"updated_at,omitempty"`// AuthorAssociation is the comment author's relationship to the pull request's repository.// Possible values are "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MEMBER", "OWNER", or "NONE".AuthorAssociation *string `json:"author_association,omitempty"`URL               *string `json:"url,omitempty"`HTMLURL           *string `json:"html_url,omitempty"`PullRequestURL    *string `json:"pull_request_url,omitempty"`}

PullRequestComment represents a comment left on a pull request.

func (*PullRequestComment)GetAuthorAssociation ¶

func (p *PullRequestComment) GetAuthorAssociation()string

GetAuthorAssociation returns the AuthorAssociation field if it's non-nil, zero value otherwise.

func (*PullRequestComment)GetBody ¶

func (p *PullRequestComment) GetBody()string

GetBody returns the Body field if it's non-nil, zero value otherwise.

func (*PullRequestComment)GetCommitID ¶

func (p *PullRequestComment) GetCommitID()string

GetCommitID returns the CommitID field if it's non-nil, zero value otherwise.

func (*PullRequestComment)GetCreatedAt ¶

func (p *PullRequestComment) GetCreatedAt()time.Time

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*PullRequestComment)GetDiffHunk ¶

func (p *PullRequestComment) GetDiffHunk()string

GetDiffHunk returns the DiffHunk field if it's non-nil, zero value otherwise.

func (*PullRequestComment)GetHTMLURL ¶

func (p *PullRequestComment) GetHTMLURL()string

GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.

func (*PullRequestComment)GetID ¶

func (p *PullRequestComment) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*PullRequestComment)GetInReplyTo ¶

func (p *PullRequestComment) GetInReplyTo()int64

GetInReplyTo returns the InReplyTo field if it's non-nil, zero value otherwise.

func (*PullRequestComment)GetLine ¶

func (p *PullRequestComment) GetLine()int

GetLine returns the Line field if it's non-nil, zero value otherwise.

func (*PullRequestComment)GetNodeID ¶

func (p *PullRequestComment) GetNodeID()string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*PullRequestComment)GetOriginalCommitID ¶

func (p *PullRequestComment) GetOriginalCommitID()string

GetOriginalCommitID returns the OriginalCommitID field if it's non-nil, zero value otherwise.

func (*PullRequestComment)GetOriginalLine ¶

func (p *PullRequestComment) GetOriginalLine()int

GetOriginalLine returns the OriginalLine field if it's non-nil, zero value otherwise.

func (*PullRequestComment)GetOriginalPosition ¶

func (p *PullRequestComment) GetOriginalPosition()int

GetOriginalPosition returns the OriginalPosition field if it's non-nil, zero value otherwise.

func (*PullRequestComment)GetOriginalStartLine ¶

func (p *PullRequestComment) GetOriginalStartLine()int

GetOriginalStartLine returns the OriginalStartLine field if it's non-nil, zero value otherwise.

func (*PullRequestComment)GetPath ¶

func (p *PullRequestComment) GetPath()string

GetPath returns the Path field if it's non-nil, zero value otherwise.

func (*PullRequestComment)GetPosition ¶

func (p *PullRequestComment) GetPosition()int

GetPosition returns the Position field if it's non-nil, zero value otherwise.

func (*PullRequestComment)GetPullRequestReviewID ¶

func (p *PullRequestComment) GetPullRequestReviewID()int64

GetPullRequestReviewID returns the PullRequestReviewID field if it's non-nil, zero value otherwise.

func (*PullRequestComment)GetPullRequestURL ¶

func (p *PullRequestComment) GetPullRequestURL()string

GetPullRequestURL returns the PullRequestURL field if it's non-nil, zero value otherwise.

func (*PullRequestComment)GetReactions ¶

func (p *PullRequestComment) GetReactions() *Reactions

GetReactions returns the Reactions field.

func (*PullRequestComment)GetSide ¶

func (p *PullRequestComment) GetSide()string

GetSide returns the Side field if it's non-nil, zero value otherwise.

func (*PullRequestComment)GetStartLine ¶

func (p *PullRequestComment) GetStartLine()int

GetStartLine returns the StartLine field if it's non-nil, zero value otherwise.

func (*PullRequestComment)GetStartSide ¶

func (p *PullRequestComment) GetStartSide()string

GetStartSide returns the StartSide field if it's non-nil, zero value otherwise.

func (*PullRequestComment)GetURL ¶

func (p *PullRequestComment) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (*PullRequestComment)GetUpdatedAt ¶

func (p *PullRequestComment) GetUpdatedAt()time.Time

GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.

func (*PullRequestComment)GetUser ¶

func (p *PullRequestComment) GetUser() *User

GetUser returns the User field.

func (PullRequestComment)String ¶

func (pPullRequestComment) String()string

typePullRequestEvent ¶

type PullRequestEvent struct {// Action is the action that was performed. Possible values are:// "assigned", "unassigned", "review_requested", "review_request_removed", "labeled", "unlabeled",// "opened", "edited", "closed", "ready_for_review", "locked", "unlocked", or "reopened".// If the action is "closed" and the "merged" key is "false", the pull request was closed with unmerged commits.// If the action is "closed" and the "merged" key is "true", the pull request was merged.// While webhooks are also triggered when a pull request is synchronized, Events API timelines// don't include pull request events with the "synchronize" action.Action      *string      `json:"action,omitempty"`Assignee    *User        `json:"assignee,omitempty"`Number      *int         `json:"number,omitempty"`PullRequest *PullRequest `json:"pull_request,omitempty"`// The following fields are only populated by Webhook events.Changes *EditChange `json:"changes,omitempty"`// RequestedReviewer is populated in "review_requested", "review_request_removed" event deliveries.// A request affecting multiple reviewers at once is split into multiple// such event deliveries, each with a single, different RequestedReviewer.RequestedReviewer *User `json:"requested_reviewer,omitempty"`// In the event that a team is requested instead of a user, "requested_team" gets sent in place of// "requested_user" with the same delivery behavior.RequestedTeam *Team         `json:"requested_team,omitempty"`Repo          *Repository   `json:"repository,omitempty"`Sender        *User         `json:"sender,omitempty"`Installation  *Installation `json:"installation,omitempty"`Label         *Label        `json:"label,omitempty"`// Populated in "labeled" event deliveries.// The following field is only present when the webhook is triggered on// a repository belonging to an organization.Organization *Organization `json:"organization,omitempty"`// The following fields are only populated when the Action is "synchronize".Before *string `json:"before,omitempty"`After  *string `json:"after,omitempty"`}

PullRequestEvent is triggered when a pull request is assigned, unassigned, labeled,unlabeled, opened, edited, closed, reopened, synchronize, ready_for_review,locked, unlocked, a pull request review is requested, or a review request is removed.The Webhook event name is "pull_request".

GitHub API docs:https://developer.github.com/v3/activity/events/types/#pullrequestevent

func (*PullRequestEvent)GetAction ¶

func (p *PullRequestEvent) GetAction()string

GetAction returns the Action field if it's non-nil, zero value otherwise.

func (*PullRequestEvent)GetAfter ¶added inv29.0.3

func (p *PullRequestEvent) GetAfter()string

GetAfter returns the After field if it's non-nil, zero value otherwise.

func (*PullRequestEvent)GetAssignee ¶

func (p *PullRequestEvent) GetAssignee() *User

GetAssignee returns the Assignee field.

func (*PullRequestEvent)GetBefore ¶added inv29.0.3

func (p *PullRequestEvent) GetBefore()string

GetBefore returns the Before field if it's non-nil, zero value otherwise.

func (*PullRequestEvent)GetChanges ¶

func (p *PullRequestEvent) GetChanges() *EditChange

GetChanges returns the Changes field.

func (*PullRequestEvent)GetInstallation ¶

func (p *PullRequestEvent) GetInstallation() *Installation

GetInstallation returns the Installation field.

func (*PullRequestEvent)GetLabel ¶

func (p *PullRequestEvent) GetLabel() *Label

GetLabel returns the Label field.

func (*PullRequestEvent)GetNumber ¶

func (p *PullRequestEvent) GetNumber()int

GetNumber returns the Number field if it's non-nil, zero value otherwise.

func (*PullRequestEvent)GetOrganization ¶

func (p *PullRequestEvent) GetOrganization() *Organization

GetOrganization returns the Organization field.

func (*PullRequestEvent)GetPullRequest ¶

func (p *PullRequestEvent) GetPullRequest() *PullRequest

GetPullRequest returns the PullRequest field.

func (*PullRequestEvent)GetRepo ¶

func (p *PullRequestEvent) GetRepo() *Repository

GetRepo returns the Repo field.

func (*PullRequestEvent)GetRequestedReviewer ¶

func (p *PullRequestEvent) GetRequestedReviewer() *User

GetRequestedReviewer returns the RequestedReviewer field.

func (*PullRequestEvent)GetRequestedTeam ¶

func (p *PullRequestEvent) GetRequestedTeam() *Team

GetRequestedTeam returns the RequestedTeam field.

func (*PullRequestEvent)GetSender ¶

func (p *PullRequestEvent) GetSender() *User

GetSender returns the Sender field.

typePullRequestLinks ¶

type PullRequestLinks struct {URL      *string `json:"url,omitempty"`HTMLURL  *string `json:"html_url,omitempty"`DiffURL  *string `json:"diff_url,omitempty"`PatchURL *string `json:"patch_url,omitempty"`}

PullRequestLinks object is added to the Issue object when it's an issue includedin the IssueCommentEvent webhook payload, if the webhook is fired by a comment on a PR.

func (*PullRequestLinks)GetDiffURL ¶

func (p *PullRequestLinks) GetDiffURL()string

GetDiffURL returns the DiffURL field if it's non-nil, zero value otherwise.

func (*PullRequestLinks)GetHTMLURL ¶

func (p *PullRequestLinks) GetHTMLURL()string

GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.

func (*PullRequestLinks)GetPatchURL ¶

func (p *PullRequestLinks) GetPatchURL()string

GetPatchURL returns the PatchURL field if it's non-nil, zero value otherwise.

func (*PullRequestLinks)GetURL ¶

func (p *PullRequestLinks) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

typePullRequestListCommentsOptions ¶

type PullRequestListCommentsOptions struct {// Sort specifies how to sort comments. Possible values are: created, updated.Sortstring `url:"sort,omitempty"`// Direction in which to sort comments. Possible values are: asc, desc.Directionstring `url:"direction,omitempty"`// Since filters comments by time.Sincetime.Time `url:"since,omitempty"`ListOptions}

PullRequestListCommentsOptions specifies the optional parameters to thePullRequestsService.ListComments method.

typePullRequestListOptions ¶

type PullRequestListOptions struct {// State filters pull requests based on their state. Possible values are:// open, closed, all. Default is "open".Statestring `url:"state,omitempty"`// Head filters pull requests by head user and branch name in the format of:// "user:ref-name".Headstring `url:"head,omitempty"`// Base filters pull requests by base branch name.Basestring `url:"base,omitempty"`// Sort specifies how to sort pull requests. Possible values are: created,// updated, popularity, long-running. Default is "created".Sortstring `url:"sort,omitempty"`// Direction in which to sort pull requests. Possible values are: asc, desc.// If Sort is "created" or not specified, Default is "desc", otherwise Default// is "asc"Directionstring `url:"direction,omitempty"`ListOptions}

PullRequestListOptions specifies the optional parameters to thePullRequestsService.List method.

typePullRequestMergeResult ¶

type PullRequestMergeResult struct {SHA     *string `json:"sha,omitempty"`Merged  *bool   `json:"merged,omitempty"`Message *string `json:"message,omitempty"`}

PullRequestMergeResult represents the result of merging a pull request.

func (*PullRequestMergeResult)GetMerged ¶

func (p *PullRequestMergeResult) GetMerged()bool

GetMerged returns the Merged field if it's non-nil, zero value otherwise.

func (*PullRequestMergeResult)GetMessage ¶

func (p *PullRequestMergeResult) GetMessage()string

GetMessage returns the Message field if it's non-nil, zero value otherwise.

func (*PullRequestMergeResult)GetSHA ¶

func (p *PullRequestMergeResult) GetSHA()string

GetSHA returns the SHA field if it's non-nil, zero value otherwise.

typePullRequestOptions ¶

type PullRequestOptions struct {CommitTitlestring// Extra detail to append to automatic commit message. (Optional.)SHAstring// SHA that pull request head must match to allow merge. (Optional.)// The merge method to use. Possible values include: "merge", "squash", and "rebase" with the default being merge. (Optional.)MergeMethodstring}

PullRequestOptions lets you define how a pull request will be merged.

typePullRequestReview ¶

type PullRequestReview struct {ID             *int64     `json:"id,omitempty"`NodeID         *string    `json:"node_id,omitempty"`User           *User      `json:"user,omitempty"`Body           *string    `json:"body,omitempty"`SubmittedAt    *time.Time `json:"submitted_at,omitempty"`CommitID       *string    `json:"commit_id,omitempty"`HTMLURL        *string    `json:"html_url,omitempty"`PullRequestURL *string    `json:"pull_request_url,omitempty"`State          *string    `json:"state,omitempty"`// AuthorAssociation is the comment author's relationship to the issue's repository.// Possible values are "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MEMBER", "OWNER", or "NONE".AuthorAssociation *string `json:"author_association,omitempty"`}

PullRequestReview represents a review of a pull request.

func (*PullRequestReview)GetAuthorAssociation ¶added inv29.0.3

func (p *PullRequestReview) GetAuthorAssociation()string

GetAuthorAssociation returns the AuthorAssociation field if it's non-nil, zero value otherwise.

func (*PullRequestReview)GetBody ¶

func (p *PullRequestReview) GetBody()string

GetBody returns the Body field if it's non-nil, zero value otherwise.

func (*PullRequestReview)GetCommitID ¶

func (p *PullRequestReview) GetCommitID()string

GetCommitID returns the CommitID field if it's non-nil, zero value otherwise.

func (*PullRequestReview)GetHTMLURL ¶

func (p *PullRequestReview) GetHTMLURL()string

GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.

func (*PullRequestReview)GetID ¶

func (p *PullRequestReview) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*PullRequestReview)GetNodeID ¶

func (p *PullRequestReview) GetNodeID()string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*PullRequestReview)GetPullRequestURL ¶

func (p *PullRequestReview) GetPullRequestURL()string

GetPullRequestURL returns the PullRequestURL field if it's non-nil, zero value otherwise.

func (*PullRequestReview)GetState ¶

func (p *PullRequestReview) GetState()string

GetState returns the State field if it's non-nil, zero value otherwise.

func (*PullRequestReview)GetSubmittedAt ¶

func (p *PullRequestReview) GetSubmittedAt()time.Time

GetSubmittedAt returns the SubmittedAt field if it's non-nil, zero value otherwise.

func (*PullRequestReview)GetUser ¶

func (p *PullRequestReview) GetUser() *User

GetUser returns the User field.

func (PullRequestReview)String ¶

func (pPullRequestReview) String()string

typePullRequestReviewCommentEvent ¶

type PullRequestReviewCommentEvent struct {// Action is the action that was performed on the comment.// Possible values are: "created", "edited", "deleted".Action      *string             `json:"action,omitempty"`PullRequest *PullRequest        `json:"pull_request,omitempty"`Comment     *PullRequestComment `json:"comment,omitempty"`// The following fields are only populated by Webhook events.Changes      *EditChange   `json:"changes,omitempty"`Repo         *Repository   `json:"repository,omitempty"`Sender       *User         `json:"sender,omitempty"`Installation *Installation `json:"installation,omitempty"`}

PullRequestReviewCommentEvent is triggered when a comment is created on aportion of the unified diff of a pull request.The Webhook event name is "pull_request_review_comment".

GitHub API docs:https://developer.github.com/v3/activity/events/types/#pullrequestreviewcommentevent

func (*PullRequestReviewCommentEvent)GetAction ¶

func (p *PullRequestReviewCommentEvent) GetAction()string

GetAction returns the Action field if it's non-nil, zero value otherwise.

func (*PullRequestReviewCommentEvent)GetChanges ¶

func (p *PullRequestReviewCommentEvent) GetChanges() *EditChange

GetChanges returns the Changes field.

func (*PullRequestReviewCommentEvent)GetComment ¶

func (p *PullRequestReviewCommentEvent) GetComment() *PullRequestComment

GetComment returns the Comment field.

func (*PullRequestReviewCommentEvent)GetInstallation ¶

func (p *PullRequestReviewCommentEvent) GetInstallation() *Installation

GetInstallation returns the Installation field.

func (*PullRequestReviewCommentEvent)GetPullRequest ¶

func (p *PullRequestReviewCommentEvent) GetPullRequest() *PullRequest

GetPullRequest returns the PullRequest field.

func (*PullRequestReviewCommentEvent)GetRepo ¶

func (p *PullRequestReviewCommentEvent) GetRepo() *Repository

GetRepo returns the Repo field.

func (*PullRequestReviewCommentEvent)GetSender ¶

func (p *PullRequestReviewCommentEvent) GetSender() *User

GetSender returns the Sender field.

typePullRequestReviewDismissalRequest ¶

type PullRequestReviewDismissalRequest struct {Message *string `json:"message,omitempty"`}

PullRequestReviewDismissalRequest represents a request to dismiss a review.

func (*PullRequestReviewDismissalRequest)GetMessage ¶

func (p *PullRequestReviewDismissalRequest) GetMessage()string

GetMessage returns the Message field if it's non-nil, zero value otherwise.

func (PullRequestReviewDismissalRequest)String ¶

func (rPullRequestReviewDismissalRequest) String()string

typePullRequestReviewEvent ¶

type PullRequestReviewEvent struct {// Action is always "submitted".Action      *string            `json:"action,omitempty"`Review      *PullRequestReview `json:"review,omitempty"`PullRequest *PullRequest       `json:"pull_request,omitempty"`// The following fields are only populated by Webhook events.Repo         *Repository   `json:"repository,omitempty"`Sender       *User         `json:"sender,omitempty"`Installation *Installation `json:"installation,omitempty"`// The following field is only present when the webhook is triggered on// a repository belonging to an organization.Organization *Organization `json:"organization,omitempty"`}

PullRequestReviewEvent is triggered when a review is submitted on a pullrequest.The Webhook event name is "pull_request_review".

GitHub API docs:https://developer.github.com/v3/activity/events/types/#pullrequestreviewevent

func (*PullRequestReviewEvent)GetAction ¶

func (p *PullRequestReviewEvent) GetAction()string

GetAction returns the Action field if it's non-nil, zero value otherwise.

func (*PullRequestReviewEvent)GetInstallation ¶

func (p *PullRequestReviewEvent) GetInstallation() *Installation

GetInstallation returns the Installation field.

func (*PullRequestReviewEvent)GetOrganization ¶

func (p *PullRequestReviewEvent) GetOrganization() *Organization

GetOrganization returns the Organization field.

func (*PullRequestReviewEvent)GetPullRequest ¶

func (p *PullRequestReviewEvent) GetPullRequest() *PullRequest

GetPullRequest returns the PullRequest field.

func (*PullRequestReviewEvent)GetRepo ¶

func (p *PullRequestReviewEvent) GetRepo() *Repository

GetRepo returns the Repo field.

func (*PullRequestReviewEvent)GetReview ¶

func (p *PullRequestReviewEvent) GetReview() *PullRequestReview

GetReview returns the Review field.

func (*PullRequestReviewEvent)GetSender ¶

func (p *PullRequestReviewEvent) GetSender() *User

GetSender returns the Sender field.

typePullRequestReviewRequest ¶

type PullRequestReviewRequest struct {NodeID   *string               `json:"node_id,omitempty"`CommitID *string               `json:"commit_id,omitempty"`Body     *string               `json:"body,omitempty"`Event    *string               `json:"event,omitempty"`Comments []*DraftReviewComment `json:"comments,omitempty"`}

PullRequestReviewRequest represents a request to create a review.

func (*PullRequestReviewRequest)GetBody ¶

func (p *PullRequestReviewRequest) GetBody()string

GetBody returns the Body field if it's non-nil, zero value otherwise.

func (*PullRequestReviewRequest)GetCommitID ¶

func (p *PullRequestReviewRequest) GetCommitID()string

GetCommitID returns the CommitID field if it's non-nil, zero value otherwise.

func (*PullRequestReviewRequest)GetEvent ¶

func (p *PullRequestReviewRequest) GetEvent()string

GetEvent returns the Event field if it's non-nil, zero value otherwise.

func (*PullRequestReviewRequest)GetNodeID ¶

func (p *PullRequestReviewRequest) GetNodeID()string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (PullRequestReviewRequest)String ¶

func (rPullRequestReviewRequest) String()string

typePullRequestReviewsEnforcement ¶

type PullRequestReviewsEnforcement struct {// Specifies which users and teams can dismiss pull request reviews.DismissalRestrictions *DismissalRestrictions `json:"dismissal_restrictions,omitempty"`// Specifies if approved reviews are dismissed automatically, when a new commit is pushed.DismissStaleReviewsbool `json:"dismiss_stale_reviews"`// RequireCodeOwnerReviews specifies if an approved review is required in pull requests including files with a designated code owner.RequireCodeOwnerReviewsbool `json:"require_code_owner_reviews"`// RequiredApprovingReviewCount specifies the number of approvals required before the pull request can be merged.// Valid values are 1-6.RequiredApprovingReviewCountint `json:"required_approving_review_count"`}

PullRequestReviewsEnforcement represents the pull request reviews enforcement of a protected branch.

func (*PullRequestReviewsEnforcement)GetDismissalRestrictions ¶

func (p *PullRequestReviewsEnforcement) GetDismissalRestrictions() *DismissalRestrictions

GetDismissalRestrictions returns the DismissalRestrictions field.

typePullRequestReviewsEnforcementRequest ¶

type PullRequestReviewsEnforcementRequest struct {// Specifies which users and teams should be allowed to dismiss pull request reviews.// User and team dismissal restrictions are only available for// organization-owned repositories. Must be nil for personal repositories.DismissalRestrictionsRequest *DismissalRestrictionsRequest `json:"dismissal_restrictions,omitempty"`// Specifies if approved reviews can be dismissed automatically, when a new commit is pushed. (Required)DismissStaleReviewsbool `json:"dismiss_stale_reviews"`// RequireCodeOwnerReviews specifies if an approved review is required in pull requests including files with a designated code owner.RequireCodeOwnerReviewsbool `json:"require_code_owner_reviews"`// RequiredApprovingReviewCount specifies the number of approvals required before the pull request can be merged.// Valid values are 1-6.RequiredApprovingReviewCountint `json:"required_approving_review_count"`}

PullRequestReviewsEnforcementRequest represents request to set the pull request reviewenforcement of a protected branch. It is separate from PullRequestReviewsEnforcement abovebecause the request structure is different from the response structure.

func (*PullRequestReviewsEnforcementRequest)GetDismissalRestrictionsRequest ¶

func (p *PullRequestReviewsEnforcementRequest) GetDismissalRestrictionsRequest() *DismissalRestrictionsRequest

GetDismissalRestrictionsRequest returns the DismissalRestrictionsRequest field.

typePullRequestReviewsEnforcementUpdate ¶

type PullRequestReviewsEnforcementUpdate struct {// Specifies which users and teams can dismiss pull request reviews. Can be omitted.DismissalRestrictionsRequest *DismissalRestrictionsRequest `json:"dismissal_restrictions,omitempty"`// Specifies if approved reviews can be dismissed automatically, when a new commit is pushed. Can be omitted.DismissStaleReviews *bool `json:"dismiss_stale_reviews,omitempty"`// RequireCodeOwnerReviews specifies if an approved review is required in pull requests including files with a designated code owner.RequireCodeOwnerReviewsbool `json:"require_code_owner_reviews,omitempty"`// RequiredApprovingReviewCount specifies the number of approvals required before the pull request can be merged.// Valid values are 1 - 6.RequiredApprovingReviewCountint `json:"required_approving_review_count"`}

PullRequestReviewsEnforcementUpdate represents request to patch the pull request reviewenforcement of a protected branch. It is separate from PullRequestReviewsEnforcementRequest abovebecause the patch request does not require all fields to be initialized.

func (*PullRequestReviewsEnforcementUpdate)GetDismissStaleReviews ¶

func (p *PullRequestReviewsEnforcementUpdate) GetDismissStaleReviews()bool

GetDismissStaleReviews returns the DismissStaleReviews field if it's non-nil, zero value otherwise.

func (*PullRequestReviewsEnforcementUpdate)GetDismissalRestrictionsRequest ¶

func (p *PullRequestReviewsEnforcementUpdate) GetDismissalRestrictionsRequest() *DismissalRestrictionsRequest

GetDismissalRestrictionsRequest returns the DismissalRestrictionsRequest field.

typePullRequestsService ¶

type PullRequestsService service

PullRequestsService handles communication with the pull request relatedmethods of the GitHub API.

GitHub API docs:https://developer.github.com/v3/pulls/

func (*PullRequestsService)Create ¶

func (s *PullRequestsService) Create(ctxcontext.Context, ownerstring, repostring, pull *NewPullRequest) (*PullRequest, *Response,error)

Create a new pull request on the specified repository.

GitHub API docs:https://developer.github.com/v3/pulls/#create-a-pull-request

Example¶

package mainimport ("context""fmt""github.com/google/go-github/v29/github")func main() {// In this example we're creating a PR and displaying the HTML url at the end.// Note that authentication is needed here as you are performing a modification// so you will need to modify the example to provide an oauth client to// github.NewClient() instead of nil. See the following documentation for more// information on how to authenticate with the client:// https://godoc.org/github.com/google/go-github/github#hdr-Authenticationclient := github.NewClient(nil)newPR := &github.NewPullRequest{Title:               github.String("My awesome pull request"),Head:                github.String("branch_to_merge"),Base:                github.String("master"),Body:                github.String("This is the description of the PR created with the package `github.com/google/go-github/github`"),MaintainerCanModify: github.Bool(true),}pr, _, err := client.PullRequests.Create(context.Background(), "myOrganization", "myRepository", newPR)if err != nil {fmt.Println(err)return}fmt.Printf("PR created: %s\n", pr.GetHTMLURL())}

func (*PullRequestsService)CreateComment ¶

func (s *PullRequestsService) CreateComment(ctxcontext.Context, ownerstring, repostring, numberint, comment *PullRequestComment) (*PullRequestComment, *Response,error)

CreateComment creates a new comment on the specified pull request.

GitHub API docs:https://developer.github.com/v3/pulls/comments/#create-a-comment

func (*PullRequestsService)CreateCommentInReplyTo ¶

func (s *PullRequestsService) CreateCommentInReplyTo(ctxcontext.Context, ownerstring, repostring, numberint, bodystring, commentIDint64) (*PullRequestComment, *Response,error)

CreateCommentInReplyTo creates a new comment as a reply to an existing pull request comment.

GitHub API docs:https://developer.github.com/v3/pulls/comments/#alternative-input

func (*PullRequestsService)CreateReview ¶

func (s *PullRequestsService) CreateReview(ctxcontext.Context, owner, repostring, numberint, review *PullRequestReviewRequest) (*PullRequestReview, *Response,error)

CreateReview creates a new review on the specified pull request.

TODO: Follow up with GitHub support about an issue with this method'sreturned error format and remove this comment once it's fixed.Read more about it here -https://github.com/google/go-github/issues/540

GitHub API docs:https://developer.github.com/v3/pulls/reviews/#create-a-pull-request-review

func (*PullRequestsService)DeleteComment ¶

func (s *PullRequestsService) DeleteComment(ctxcontext.Context, ownerstring, repostring, commentIDint64) (*Response,error)

DeleteComment deletes a pull request comment.

GitHub API docs:https://developer.github.com/v3/pulls/comments/#delete-a-comment

func (*PullRequestsService)DeletePendingReview ¶

func (s *PullRequestsService) DeletePendingReview(ctxcontext.Context, owner, repostring, numberint, reviewIDint64) (*PullRequestReview, *Response,error)

DeletePendingReview deletes the specified pull request pending review.

GitHub API docs:https://developer.github.com/v3/pulls/reviews/#delete-a-pending-review

func (*PullRequestsService)DismissReview ¶

func (s *PullRequestsService) DismissReview(ctxcontext.Context, owner, repostring, numberint, reviewIDint64, review *PullRequestReviewDismissalRequest) (*PullRequestReview, *Response,error)

DismissReview dismisses a specified review on the specified pull request.

GitHub API docs:https://developer.github.com/v3/pulls/reviews/#dismiss-a-pull-request-review

func (*PullRequestsService)Edit ¶

func (s *PullRequestsService) Edit(ctxcontext.Context, ownerstring, repostring, numberint, pull *PullRequest) (*PullRequest, *Response,error)

Edit a pull request.pull must not be nil.

The following fields are editable: Title, Body, State, Base.Ref and MaintainerCanModify.Base.Ref updates the base branch of the pull request.

GitHub API docs:https://developer.github.com/v3/pulls/#update-a-pull-request

func (*PullRequestsService)EditComment ¶

func (s *PullRequestsService) EditComment(ctxcontext.Context, ownerstring, repostring, commentIDint64, comment *PullRequestComment) (*PullRequestComment, *Response,error)

EditComment updates a pull request comment.A non-nil comment.Body must be provided. Other comment fields should be left nil.

GitHub API docs:https://developer.github.com/v3/pulls/comments/#edit-a-comment

func (*PullRequestsService)Get ¶

func (s *PullRequestsService) Get(ctxcontext.Context, ownerstring, repostring, numberint) (*PullRequest, *Response,error)

Get a single pull request.

GitHub API docs:https://developer.github.com/v3/pulls/#get-a-single-pull-request

func (*PullRequestsService)GetComment ¶

func (s *PullRequestsService) GetComment(ctxcontext.Context, ownerstring, repostring, commentIDint64) (*PullRequestComment, *Response,error)

GetComment fetches the specified pull request comment.

GitHub API docs:https://developer.github.com/v3/pulls/comments/#get-a-single-comment

func (*PullRequestsService)GetRaw ¶

func (s *PullRequestsService) GetRaw(ctxcontext.Context, ownerstring, repostring, numberint, optsRawOptions) (string, *Response,error)

GetRaw gets a single pull request in raw (diff or patch) format.

func (*PullRequestsService)GetReview ¶

func (s *PullRequestsService) GetReview(ctxcontext.Context, owner, repostring, numberint, reviewIDint64) (*PullRequestReview, *Response,error)

GetReview fetches the specified pull request review.

GitHub API docs:https://developer.github.com/v3/pulls/reviews/#get-a-single-review

func (*PullRequestsService)IsMerged ¶

func (s *PullRequestsService) IsMerged(ctxcontext.Context, ownerstring, repostring, numberint) (bool, *Response,error)

IsMerged checks if a pull request has been merged.

GitHub API docs:https://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged

func (*PullRequestsService)List ¶

func (s *PullRequestsService) List(ctxcontext.Context, ownerstring, repostring, opts *PullRequestListOptions) ([]*PullRequest, *Response,error)

List the pull requests for the specified repository.

GitHub API docs:https://developer.github.com/v3/pulls/#list-pull-requests

func (*PullRequestsService)ListComments ¶

func (s *PullRequestsService) ListComments(ctxcontext.Context, ownerstring, repostring, numberint, opts *PullRequestListCommentsOptions) ([]*PullRequestComment, *Response,error)

ListComments lists all comments on the specified pull request. Specifying apull request number of 0 will return all comments on all pull requests forthe repository.

GitHub API docs:https://developer.github.com/v3/pulls/comments/#list-comments-on-a-pull-request

func (*PullRequestsService)ListCommits ¶

func (s *PullRequestsService) ListCommits(ctxcontext.Context, ownerstring, repostring, numberint, opts *ListOptions) ([]*RepositoryCommit, *Response,error)

ListCommits lists the commits in a pull request.

GitHub API docs:https://developer.github.com/v3/pulls/#list-commits-on-a-pull-request

func (*PullRequestsService)ListFiles ¶

func (s *PullRequestsService) ListFiles(ctxcontext.Context, ownerstring, repostring, numberint, opts *ListOptions) ([]*CommitFile, *Response,error)

ListFiles lists the files in a pull request.

GitHub API docs:https://developer.github.com/v3/pulls/#list-pull-requests-files

func (*PullRequestsService)ListPullRequestsWithCommit ¶

func (s *PullRequestsService) ListPullRequestsWithCommit(ctxcontext.Context, owner, repo, shastring, opts *PullRequestListOptions) ([]*PullRequest, *Response,error)

ListPullRequestsWithCommit returns pull requests associated with a commit SHA.

The results will include open and closed pull requests.

GitHub API docs:https://developer.github.com/v3/repos/commits/#list-pull-requests-associated-with-commit

func (*PullRequestsService)ListReviewComments ¶

func (s *PullRequestsService) ListReviewComments(ctxcontext.Context, owner, repostring, numberint, reviewIDint64, opts *ListOptions) ([]*PullRequestComment, *Response,error)

ListReviewComments lists all the comments for the specified review.

GitHub API docs:https://developer.github.com/v3/pulls/reviews/#get-comments-for-a-single-review

func (*PullRequestsService)ListReviewers ¶

func (s *PullRequestsService) ListReviewers(ctxcontext.Context, owner, repostring, numberint, opts *ListOptions) (*Reviewers, *Response,error)

ListReviewers lists reviewers whose reviews have been requested on the specified pull request.

GitHub API docs:https://developer.github.com/v3/pulls/review_requests/#list-review-requests

func (*PullRequestsService)ListReviews ¶

func (s *PullRequestsService) ListReviews(ctxcontext.Context, owner, repostring, numberint, opts *ListOptions) ([]*PullRequestReview, *Response,error)

ListReviews lists all reviews on the specified pull request.

GitHub API docs:https://developer.github.com/v3/pulls/reviews/#list-reviews-on-a-pull-request

func (*PullRequestsService)Merge ¶

func (s *PullRequestsService) Merge(ctxcontext.Context, ownerstring, repostring, numberint, commitMessagestring, options *PullRequestOptions) (*PullRequestMergeResult, *Response,error)

Merge a pull request (Merge Button™).commitMessage is the title for the automatic commit message.

GitHub API docs:https://developer.github.com/v3/pulls/#merge-a-pull-request-merge-buttontrade

func (*PullRequestsService)RemoveReviewers ¶

func (s *PullRequestsService) RemoveReviewers(ctxcontext.Context, owner, repostring, numberint, reviewersReviewersRequest) (*Response,error)

RemoveReviewers removes the review request for the provided reviewers for the specified pull request.

GitHub API docs:https://developer.github.com/v3/pulls/review_requests/#delete-a-review-request

func (*PullRequestsService)RequestReviewers ¶

func (s *PullRequestsService) RequestReviewers(ctxcontext.Context, owner, repostring, numberint, reviewersReviewersRequest) (*PullRequest, *Response,error)

RequestReviewers creates a review request for the provided reviewers for the specified pull request.

GitHub API docs:https://developer.github.com/v3/pulls/review_requests/#create-a-review-request

func (*PullRequestsService)SubmitReview ¶

func (s *PullRequestsService) SubmitReview(ctxcontext.Context, owner, repostring, numberint, reviewIDint64, review *PullRequestReviewRequest) (*PullRequestReview, *Response,error)

SubmitReview submits a specified review on the specified pull request.

GitHub API docs:https://developer.github.com/v3/pulls/reviews/#submit-a-pull-request-review

func (*PullRequestsService)UpdateBranch ¶

func (s *PullRequestsService) UpdateBranch(ctxcontext.Context, owner, repostring, numberint, opts *PullRequestBranchUpdateOptions) (*PullRequestBranchUpdateResponse, *Response,error)

UpdateBranch updates the pull request branch with latest upstream changes.

This method might return an AcceptedError and a status code of202. This is because this is the status that GitHub returns to signify thatit has now scheduled the update of the pull request branch in a background task.A follow up request, after a delay of a second or so, should resultin a successful request.

GitHub API docs:https://developer.github.com/v3/pulls/#update-a-pull-request-branch

func (*PullRequestsService)UpdateReview ¶

func (s *PullRequestsService) UpdateReview(ctxcontext.Context, owner, repostring, numberint, reviewIDint64, bodystring) (*PullRequestReview, *Response,error)

UpdateReview updates the review summary on the specified pull request.

GitHub API docs:https://developer.github.com/v3/pulls/reviews/#update-a-pull-request-review

typePullStats ¶

type PullStats struct {TotalPulls      *int `json:"total_pulls,omitempty"`MergedPulls     *int `json:"merged_pulls,omitempty"`MergablePulls   *int `json:"mergeable_pulls,omitempty"`UnmergablePulls *int `json:"unmergeable_pulls,omitempty"`}

PullStats represents the number of total, merged, mergable and unmergeablepull-requests.

func (*PullStats)GetMergablePulls ¶

func (p *PullStats) GetMergablePulls()int

GetMergablePulls returns the MergablePulls field if it's non-nil, zero value otherwise.

func (*PullStats)GetMergedPulls ¶

func (p *PullStats) GetMergedPulls()int

GetMergedPulls returns the MergedPulls field if it's non-nil, zero value otherwise.

func (*PullStats)GetTotalPulls ¶

func (p *PullStats) GetTotalPulls()int

GetTotalPulls returns the TotalPulls field if it's non-nil, zero value otherwise.

func (*PullStats)GetUnmergablePulls ¶

func (p *PullStats) GetUnmergablePulls()int

GetUnmergablePulls returns the UnmergablePulls field if it's non-nil, zero value otherwise.

func (PullStats)String ¶

func (sPullStats) String()string

typePunchCard ¶

type PunchCard struct {Day     *int// Day of the week (0-6: =Sunday - Saturday).Hour    *int// Hour of day (0-23).Commits *int// Number of commits.}

PunchCard represents the number of commits made during a given hour of aday of the week.

func (*PunchCard)GetCommits ¶

func (p *PunchCard) GetCommits()int

GetCommits returns the Commits field if it's non-nil, zero value otherwise.

func (*PunchCard)GetDay ¶

func (p *PunchCard) GetDay()int

GetDay returns the Day field if it's non-nil, zero value otherwise.

func (*PunchCard)GetHour ¶

func (p *PunchCard) GetHour()int

GetHour returns the Hour field if it's non-nil, zero value otherwise.

typePushEvent ¶

type PushEvent struct {PushID       *int64            `json:"push_id,omitempty"`Head         *string           `json:"head,omitempty"`Ref          *string           `json:"ref,omitempty"`Size         *int              `json:"size,omitempty"`Commits      []PushEventCommit `json:"commits,omitempty"`Before       *string           `json:"before,omitempty"`DistinctSize *int              `json:"distinct_size,omitempty"`// The following fields are only populated by Webhook events.After        *string              `json:"after,omitempty"`Created      *bool                `json:"created,omitempty"`Deleted      *bool                `json:"deleted,omitempty"`Forced       *bool                `json:"forced,omitempty"`BaseRef      *string              `json:"base_ref,omitempty"`Compare      *string              `json:"compare,omitempty"`Repo         *PushEventRepository `json:"repository,omitempty"`HeadCommit   *PushEventCommit     `json:"head_commit,omitempty"`Pusher       *User                `json:"pusher,omitempty"`Sender       *User                `json:"sender,omitempty"`Installation *Installation        `json:"installation,omitempty"`}

PushEvent represents a git push to a GitHub repository.

GitHub API docs:https://developer.github.com/v3/activity/events/types/#pushevent

func (*PushEvent)GetAfter ¶

func (p *PushEvent) GetAfter()string

GetAfter returns the After field if it's non-nil, zero value otherwise.

func (*PushEvent)GetBaseRef ¶

func (p *PushEvent) GetBaseRef()string

GetBaseRef returns the BaseRef field if it's non-nil, zero value otherwise.

func (*PushEvent)GetBefore ¶

func (p *PushEvent) GetBefore()string

GetBefore returns the Before field if it's non-nil, zero value otherwise.

func (*PushEvent)GetCompare ¶

func (p *PushEvent) GetCompare()string

GetCompare returns the Compare field if it's non-nil, zero value otherwise.

func (*PushEvent)GetCreated ¶

func (p *PushEvent) GetCreated()bool

GetCreated returns the Created field if it's non-nil, zero value otherwise.

func (*PushEvent)GetDeleted ¶

func (p *PushEvent) GetDeleted()bool

GetDeleted returns the Deleted field if it's non-nil, zero value otherwise.

func (*PushEvent)GetDistinctSize ¶

func (p *PushEvent) GetDistinctSize()int

GetDistinctSize returns the DistinctSize field if it's non-nil, zero value otherwise.

func (*PushEvent)GetForced ¶

func (p *PushEvent) GetForced()bool

GetForced returns the Forced field if it's non-nil, zero value otherwise.

func (*PushEvent)GetHead ¶

func (p *PushEvent) GetHead()string

GetHead returns the Head field if it's non-nil, zero value otherwise.

func (*PushEvent)GetHeadCommit ¶

func (p *PushEvent) GetHeadCommit() *PushEventCommit

GetHeadCommit returns the HeadCommit field.

func (*PushEvent)GetInstallation ¶

func (p *PushEvent) GetInstallation() *Installation

GetInstallation returns the Installation field.

func (*PushEvent)GetPushID ¶

func (p *PushEvent) GetPushID()int64

GetPushID returns the PushID field if it's non-nil, zero value otherwise.

func (*PushEvent)GetPusher ¶

func (p *PushEvent) GetPusher() *User

GetPusher returns the Pusher field.

func (*PushEvent)GetRef ¶

func (p *PushEvent) GetRef()string

GetRef returns the Ref field if it's non-nil, zero value otherwise.

func (*PushEvent)GetRepo ¶

func (p *PushEvent) GetRepo() *PushEventRepository

GetRepo returns the Repo field.

func (*PushEvent)GetSender ¶

func (p *PushEvent) GetSender() *User

GetSender returns the Sender field.

func (*PushEvent)GetSize ¶

func (p *PushEvent) GetSize()int

GetSize returns the Size field if it's non-nil, zero value otherwise.

func (PushEvent)String ¶

func (pPushEvent) String()string

typePushEventCommit ¶

type PushEventCommit struct {Message  *string       `json:"message,omitempty"`Author   *CommitAuthor `json:"author,omitempty"`URL      *string       `json:"url,omitempty"`Distinct *bool         `json:"distinct,omitempty"`// The following fields are only populated by Events API.SHA *string `json:"sha,omitempty"`// The following fields are only populated by Webhook events.ID        *string       `json:"id,omitempty"`TreeID    *string       `json:"tree_id,omitempty"`Timestamp *Timestamp    `json:"timestamp,omitempty"`Committer *CommitAuthor `json:"committer,omitempty"`Added     []string      `json:"added,omitempty"`Removed   []string      `json:"removed,omitempty"`Modified  []string      `json:"modified,omitempty"`}

PushEventCommit represents a git commit in a GitHub PushEvent.

func (*PushEventCommit)GetAuthor ¶

func (p *PushEventCommit) GetAuthor() *CommitAuthor

GetAuthor returns the Author field.

func (*PushEventCommit)GetCommitter ¶

func (p *PushEventCommit) GetCommitter() *CommitAuthor

GetCommitter returns the Committer field.

func (*PushEventCommit)GetDistinct ¶

func (p *PushEventCommit) GetDistinct()bool

GetDistinct returns the Distinct field if it's non-nil, zero value otherwise.

func (*PushEventCommit)GetID ¶

func (p *PushEventCommit) GetID()string

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*PushEventCommit)GetMessage ¶

func (p *PushEventCommit) GetMessage()string

GetMessage returns the Message field if it's non-nil, zero value otherwise.

func (*PushEventCommit)GetSHA ¶

func (p *PushEventCommit) GetSHA()string

GetSHA returns the SHA field if it's non-nil, zero value otherwise.

func (*PushEventCommit)GetTimestamp ¶

func (p *PushEventCommit) GetTimestamp()Timestamp

GetTimestamp returns the Timestamp field if it's non-nil, zero value otherwise.

func (*PushEventCommit)GetTreeID ¶

func (p *PushEventCommit) GetTreeID()string

GetTreeID returns the TreeID field if it's non-nil, zero value otherwise.

func (*PushEventCommit)GetURL ¶

func (p *PushEventCommit) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (PushEventCommit)String ¶

func (pPushEventCommit) String()string

typePushEventRepoOwner ¶

type PushEventRepoOwner struct {Name  *string `json:"name,omitempty"`Email *string `json:"email,omitempty"`}

PushEventRepoOwner is a basic representation of user/org in a PushEvent payload.

func (*PushEventRepoOwner)GetEmail ¶

func (p *PushEventRepoOwner) GetEmail()string

GetEmail returns the Email field if it's non-nil, zero value otherwise.

func (*PushEventRepoOwner)GetName ¶

func (p *PushEventRepoOwner) GetName()string

GetName returns the Name field if it's non-nil, zero value otherwise.

typePushEventRepository ¶

type PushEventRepository struct {ID              *int64     `json:"id,omitempty"`NodeID          *string    `json:"node_id,omitempty"`Name            *string    `json:"name,omitempty"`FullName        *string    `json:"full_name,omitempty"`Owner           *User      `json:"owner,omitempty"`Private         *bool      `json:"private,omitempty"`Description     *string    `json:"description,omitempty"`Fork            *bool      `json:"fork,omitempty"`CreatedAt       *Timestamp `json:"created_at,omitempty"`PushedAt        *Timestamp `json:"pushed_at,omitempty"`UpdatedAt       *Timestamp `json:"updated_at,omitempty"`Homepage        *string    `json:"homepage,omitempty"`PullsURL        *string    `json:"pulls_url,omitempty"`Size            *int       `json:"size,omitempty"`StargazersCount *int       `json:"stargazers_count,omitempty"`WatchersCount   *int       `json:"watchers_count,omitempty"`Language        *string    `json:"language,omitempty"`HasIssues       *bool      `json:"has_issues,omitempty"`HasDownloads    *bool      `json:"has_downloads,omitempty"`HasWiki         *bool      `json:"has_wiki,omitempty"`HasPages        *bool      `json:"has_pages,omitempty"`ForksCount      *int       `json:"forks_count,omitempty"`Archived        *bool      `json:"archived,omitempty"`Disabled        *bool      `json:"disabled,omitempty"`OpenIssuesCount *int       `json:"open_issues_count,omitempty"`DefaultBranch   *string    `json:"default_branch,omitempty"`MasterBranch    *string    `json:"master_branch,omitempty"`Organization    *string    `json:"organization,omitempty"`URL             *string    `json:"url,omitempty"`ArchiveURL      *string    `json:"archive_url,omitempty"`HTMLURL         *string    `json:"html_url,omitempty"`StatusesURL     *string    `json:"statuses_url,omitempty"`GitURL          *string    `json:"git_url,omitempty"`SSHURL          *string    `json:"ssh_url,omitempty"`CloneURL        *string    `json:"clone_url,omitempty"`SVNURL          *string    `json:"svn_url,omitempty"`}

PushEventRepository represents the repo object in a PushEvent payload.

func (*PushEventRepository)GetArchiveURL ¶

func (p *PushEventRepository) GetArchiveURL()string

GetArchiveURL returns the ArchiveURL field if it's non-nil, zero value otherwise.

func (*PushEventRepository)GetArchived ¶added inv29.0.3

func (p *PushEventRepository) GetArchived()bool

GetArchived returns the Archived field if it's non-nil, zero value otherwise.

func (*PushEventRepository)GetCloneURL ¶

func (p *PushEventRepository) GetCloneURL()string

GetCloneURL returns the CloneURL field if it's non-nil, zero value otherwise.

func (*PushEventRepository)GetCreatedAt ¶

func (p *PushEventRepository) GetCreatedAt()Timestamp

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*PushEventRepository)GetDefaultBranch ¶

func (p *PushEventRepository) GetDefaultBranch()string

GetDefaultBranch returns the DefaultBranch field if it's non-nil, zero value otherwise.

func (*PushEventRepository)GetDescription ¶

func (p *PushEventRepository) GetDescription()string

GetDescription returns the Description field if it's non-nil, zero value otherwise.

func (*PushEventRepository)GetDisabled ¶added inv29.0.3

func (p *PushEventRepository) GetDisabled()bool

GetDisabled returns the Disabled field if it's non-nil, zero value otherwise.

func (*PushEventRepository)GetFork ¶

func (p *PushEventRepository) GetFork()bool

GetFork returns the Fork field if it's non-nil, zero value otherwise.

func (*PushEventRepository)GetForksCount ¶

func (p *PushEventRepository) GetForksCount()int

GetForksCount returns the ForksCount field if it's non-nil, zero value otherwise.

func (*PushEventRepository)GetFullName ¶

func (p *PushEventRepository) GetFullName()string

GetFullName returns the FullName field if it's non-nil, zero value otherwise.

func (*PushEventRepository)GetGitURL ¶

func (p *PushEventRepository) GetGitURL()string

GetGitURL returns the GitURL field if it's non-nil, zero value otherwise.

func (*PushEventRepository)GetHTMLURL ¶

func (p *PushEventRepository) GetHTMLURL()string

GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.

func (*PushEventRepository)GetHasDownloads ¶

func (p *PushEventRepository) GetHasDownloads()bool

GetHasDownloads returns the HasDownloads field if it's non-nil, zero value otherwise.

func (*PushEventRepository)GetHasIssues ¶

func (p *PushEventRepository) GetHasIssues()bool

GetHasIssues returns the HasIssues field if it's non-nil, zero value otherwise.

func (*PushEventRepository)GetHasPages ¶

func (p *PushEventRepository) GetHasPages()bool

GetHasPages returns the HasPages field if it's non-nil, zero value otherwise.

func (*PushEventRepository)GetHasWiki ¶

func (p *PushEventRepository) GetHasWiki()bool

GetHasWiki returns the HasWiki field if it's non-nil, zero value otherwise.

func (*PushEventRepository)GetHomepage ¶

func (p *PushEventRepository) GetHomepage()string

GetHomepage returns the Homepage field if it's non-nil, zero value otherwise.

func (*PushEventRepository)GetID ¶

func (p *PushEventRepository) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*PushEventRepository)GetLanguage ¶

func (p *PushEventRepository) GetLanguage()string

GetLanguage returns the Language field if it's non-nil, zero value otherwise.

func (*PushEventRepository)GetMasterBranch ¶

func (p *PushEventRepository) GetMasterBranch()string

GetMasterBranch returns the MasterBranch field if it's non-nil, zero value otherwise.

func (*PushEventRepository)GetName ¶

func (p *PushEventRepository) GetName()string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (*PushEventRepository)GetNodeID ¶

func (p *PushEventRepository) GetNodeID()string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*PushEventRepository)GetOpenIssuesCount ¶

func (p *PushEventRepository) GetOpenIssuesCount()int

GetOpenIssuesCount returns the OpenIssuesCount field if it's non-nil, zero value otherwise.

func (*PushEventRepository)GetOrganization ¶

func (p *PushEventRepository) GetOrganization()string

GetOrganization returns the Organization field if it's non-nil, zero value otherwise.

func (*PushEventRepository)GetOwner ¶

func (p *PushEventRepository) GetOwner() *User

GetOwner returns the Owner field.

func (*PushEventRepository)GetPrivate ¶

func (p *PushEventRepository) GetPrivate()bool

GetPrivate returns the Private field if it's non-nil, zero value otherwise.

func (*PushEventRepository)GetPullsURL ¶

func (p *PushEventRepository) GetPullsURL()string

GetPullsURL returns the PullsURL field if it's non-nil, zero value otherwise.

func (*PushEventRepository)GetPushedAt ¶

func (p *PushEventRepository) GetPushedAt()Timestamp

GetPushedAt returns the PushedAt field if it's non-nil, zero value otherwise.

func (*PushEventRepository)GetSSHURL ¶

func (p *PushEventRepository) GetSSHURL()string

GetSSHURL returns the SSHURL field if it's non-nil, zero value otherwise.

func (*PushEventRepository)GetSVNURL ¶

func (p *PushEventRepository) GetSVNURL()string

GetSVNURL returns the SVNURL field if it's non-nil, zero value otherwise.

func (*PushEventRepository)GetSize ¶

func (p *PushEventRepository) GetSize()int

GetSize returns the Size field if it's non-nil, zero value otherwise.

func (*PushEventRepository)GetStargazersCount ¶

func (p *PushEventRepository) GetStargazersCount()int

GetStargazersCount returns the StargazersCount field if it's non-nil, zero value otherwise.

func (*PushEventRepository)GetStatusesURL ¶

func (p *PushEventRepository) GetStatusesURL()string

GetStatusesURL returns the StatusesURL field if it's non-nil, zero value otherwise.

func (*PushEventRepository)GetURL ¶

func (p *PushEventRepository) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (*PushEventRepository)GetUpdatedAt ¶

func (p *PushEventRepository) GetUpdatedAt()Timestamp

GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.

func (*PushEventRepository)GetWatchersCount ¶

func (p *PushEventRepository) GetWatchersCount()int

GetWatchersCount returns the WatchersCount field if it's non-nil, zero value otherwise.

typeRate ¶

type Rate struct {// The number of requests per hour the client is currently limited to.Limitint `json:"limit"`// The number of remaining requests the client can make this hour.Remainingint `json:"remaining"`// The time at which the current rate limit will reset.ResetTimestamp `json:"reset"`}

Rate represents the rate limit for the current client.

func (Rate)String ¶

func (rRate) String()string

typeRateLimitError ¶

type RateLimitError struct {RateRate// Rate specifies last known rate limit for the clientResponse *http.Response// HTTP response that caused this errorMessagestring         `json:"message"`// error message}

RateLimitError occurs when GitHub returns 403 Forbidden response with a rate limitremaining value of 0.

func (*RateLimitError)Error ¶

func (r *RateLimitError) Error()string

typeRateLimits ¶

type RateLimits struct {// The rate limit for non-search API requests. Unauthenticated// requests are limited to 60 per hour. Authenticated requests are// limited to 5,000 per hour.//// GitHub API docs:https://developer.github.com/v3/#rate-limitingCore *Rate `json:"core"`// The rate limit for search API requests. Unauthenticated requests// are limited to 10 requests per minutes. Authenticated requests are// limited to 30 per minute.//// GitHub API docs:https://developer.github.com/v3/search/#rate-limitSearch *Rate `json:"search"`}

RateLimits represents the rate limits for the current client.

func (*RateLimits)GetCore ¶

func (r *RateLimits) GetCore() *Rate

GetCore returns the Core field.

func (*RateLimits)GetSearch ¶

func (r *RateLimits) GetSearch() *Rate

GetSearch returns the Search field.

func (RateLimits)String ¶

func (rRateLimits) String()string

typeRawOptions ¶

type RawOptions struct {TypeRawType}

RawOptions specifies parameters when user wants to get raw format ofa response instead of JSON.

typeRawType ¶

type RawTypeuint8

RawType represents type of raw format of a request instead of JSON.

const (// Diff format.DiffRawType = 1 +iota// Patch format.Patch)

typeReaction ¶

type Reaction struct {// ID is the Reaction ID.ID     *int64  `json:"id,omitempty"`User   *User   `json:"user,omitempty"`NodeID *string `json:"node_id,omitempty"`// Content is the type of reaction.// Possible values are://     "+1", "-1", "laugh", "confused", "heart", "hooray".Content *string `json:"content,omitempty"`}

Reaction represents a GitHub reaction.

func (*Reaction)GetContent ¶

func (r *Reaction) GetContent()string

GetContent returns the Content field if it's non-nil, zero value otherwise.

func (*Reaction)GetID ¶

func (r *Reaction) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*Reaction)GetNodeID ¶

func (r *Reaction) GetNodeID()string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*Reaction)GetUser ¶

func (r *Reaction) GetUser() *User

GetUser returns the User field.

func (Reaction)String ¶

func (rReaction) String()string

typeReactions ¶

type Reactions struct {TotalCount *int    `json:"total_count,omitempty"`PlusOne    *int    `json:"+1,omitempty"`MinusOne   *int    `json:"-1,omitempty"`Laugh      *int    `json:"laugh,omitempty"`Confused   *int    `json:"confused,omitempty"`Heart      *int    `json:"heart,omitempty"`Hooray     *int    `json:"hooray,omitempty"`URL        *string `json:"url,omitempty"`}

Reactions represents a summary of GitHub reactions.

func (*Reactions)GetConfused ¶

func (r *Reactions) GetConfused()int

GetConfused returns the Confused field if it's non-nil, zero value otherwise.

func (*Reactions)GetHeart ¶

func (r *Reactions) GetHeart()int

GetHeart returns the Heart field if it's non-nil, zero value otherwise.

func (*Reactions)GetHooray ¶

func (r *Reactions) GetHooray()int

GetHooray returns the Hooray field if it's non-nil, zero value otherwise.

func (*Reactions)GetLaugh ¶

func (r *Reactions) GetLaugh()int

GetLaugh returns the Laugh field if it's non-nil, zero value otherwise.

func (*Reactions)GetMinusOne ¶

func (r *Reactions) GetMinusOne()int

GetMinusOne returns the MinusOne field if it's non-nil, zero value otherwise.

func (*Reactions)GetPlusOne ¶

func (r *Reactions) GetPlusOne()int

GetPlusOne returns the PlusOne field if it's non-nil, zero value otherwise.

func (*Reactions)GetTotalCount ¶

func (r *Reactions) GetTotalCount()int

GetTotalCount returns the TotalCount field if it's non-nil, zero value otherwise.

func (*Reactions)GetURL ¶

func (r *Reactions) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

typeReactionsService ¶

type ReactionsService service

ReactionsService provides access to the reactions-related functions in theGitHub API.

GitHub API docs:https://developer.github.com/v3/reactions/

func (ReactionsService)CreateCommentReaction ¶

func (sReactionsService) CreateCommentReaction(ctxcontext.Context, owner, repostring, idint64, contentstring) (*Reaction, *Response,error)

CreateCommentReaction creates a reaction for a commit comment.Note that if you have already created a reaction of type content, thepreviously created reaction will be returned with Status: 200 OK.The content should have one of the following values: "+1", "-1", "laugh", "confused", "heart", "hooray".

GitHub API docs:https://developer.github.com/v3/reactions/#create-reaction-for-a-commit-comment

func (ReactionsService)CreateIssueCommentReaction ¶

func (sReactionsService) CreateIssueCommentReaction(ctxcontext.Context, owner, repostring, idint64, contentstring) (*Reaction, *Response,error)

CreateIssueCommentReaction creates a reaction for an issue comment.Note that if you have already created a reaction of type content, thepreviously created reaction will be returned with Status: 200 OK.The content should have one of the following values: "+1", "-1", "laugh", "confused", "heart", "hooray".

GitHub API docs:https://developer.github.com/v3/reactions/#create-reaction-for-an-issue-comment

func (ReactionsService)CreateIssueReaction ¶

func (sReactionsService) CreateIssueReaction(ctxcontext.Context, owner, repostring, numberint, contentstring) (*Reaction, *Response,error)

CreateIssueReaction creates a reaction for an issue.Note that if you have already created a reaction of type content, thepreviously created reaction will be returned with Status: 200 OK.The content should have one of the following values: "+1", "-1", "laugh", "confused", "heart", "hooray".

GitHub API docs:https://developer.github.com/v3/reactions/#create-reaction-for-an-issue

func (ReactionsService)CreatePullRequestCommentReaction ¶

func (sReactionsService) CreatePullRequestCommentReaction(ctxcontext.Context, owner, repostring, idint64, contentstring) (*Reaction, *Response,error)

CreatePullRequestCommentReaction creates a reaction for a pull request review comment.Note that if you have already created a reaction of type content, thepreviously created reaction will be returned with Status: 200 OK.The content should have one of the following values: "+1", "-1", "laugh", "confused", "heart", "hooray".

GitHub API docs:https://developer.github.com/v3/reactions/#create-reaction-for-an-issue-comment

func (*ReactionsService)CreateTeamDiscussionCommentReaction ¶

func (s *ReactionsService) CreateTeamDiscussionCommentReaction(ctxcontext.Context, teamIDint64, discussionNumber, commentNumberint, contentstring) (*Reaction, *Response,error)

CreateTeamDiscussionCommentReaction creates a reaction for a team discussion comment.The content should have one of the following values: "+1", "-1", "laugh", "confused", "heart", "hooray".

GitHub API docs:https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion-comment

func (*ReactionsService)CreateTeamDiscussionReaction ¶

func (s *ReactionsService) CreateTeamDiscussionReaction(ctxcontext.Context, teamIDint64, discussionNumberint, contentstring) (*Reaction, *Response,error)

CreateTeamDiscussionReaction creates a reaction for a team discussion.The content should have one of the following values: "+1", "-1", "laugh", "confused", "heart", "hooray".

GitHub API docs:https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion

func (*ReactionsService)DeleteReaction ¶

func (s *ReactionsService) DeleteReaction(ctxcontext.Context, idint64) (*Response,error)

DeleteReaction deletes a reaction.

GitHub API docs:https://developer.github.com/v3/reaction/reactions/#delete-a-reaction-archive

func (*ReactionsService)ListCommentReactions ¶

func (s *ReactionsService) ListCommentReactions(ctxcontext.Context, owner, repostring, idint64, opts *ListCommentReactionOptions) ([]*Reaction, *Response,error)

ListCommentReactions lists the reactions for a commit comment.

GitHub API docs:https://developer.github.com/v3/reactions/#list-reactions-for-a-commit-comment

func (*ReactionsService)ListIssueCommentReactions ¶

func (s *ReactionsService) ListIssueCommentReactions(ctxcontext.Context, owner, repostring, idint64, opts *ListOptions) ([]*Reaction, *Response,error)

ListIssueCommentReactions lists the reactions for an issue comment.

GitHub API docs:https://developer.github.com/v3/reactions/#list-reactions-for-an-issue-comment

func (*ReactionsService)ListIssueReactions ¶

func (s *ReactionsService) ListIssueReactions(ctxcontext.Context, owner, repostring, numberint, opts *ListOptions) ([]*Reaction, *Response,error)

ListIssueReactions lists the reactions for an issue.

GitHub API docs:https://developer.github.com/v3/reactions/#list-reactions-for-an-issue

func (*ReactionsService)ListPullRequestCommentReactions ¶

func (s *ReactionsService) ListPullRequestCommentReactions(ctxcontext.Context, owner, repostring, idint64, opts *ListOptions) ([]*Reaction, *Response,error)

ListPullRequestCommentReactions lists the reactions for a pull request review comment.

GitHub API docs:https://developer.github.com/v3/reactions/#list-reactions-for-an-issue-comment

func (*ReactionsService)ListTeamDiscussionCommentReactions ¶

func (s *ReactionsService) ListTeamDiscussionCommentReactions(ctxcontext.Context, teamIDint64, discussionNumber, commentNumberint, opts *ListOptions) ([]*Reaction, *Response,error)

ListTeamDiscussionCommentReactions lists the reactions for a team discussion comment.

GitHub API docs:https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-comment

func (*ReactionsService)ListTeamDiscussionReactions ¶

func (s *ReactionsService) ListTeamDiscussionReactions(ctxcontext.Context, teamIDint64, discussionNumberint, opts *ListOptions) ([]*Reaction, *Response,error)

ListTeamDiscussionReactions lists the reactions for a team discussion.

GitHub API docs:https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion

typeReference ¶

type Reference struct {Ref    *string    `json:"ref"`URL    *string    `json:"url"`Object *GitObject `json:"object"`NodeID *string    `json:"node_id,omitempty"`}

Reference represents a GitHub reference.

func (*Reference)GetNodeID ¶

func (r *Reference) GetNodeID()string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*Reference)GetObject ¶

func (r *Reference) GetObject() *GitObject

GetObject returns the Object field.

func (*Reference)GetRef ¶

func (r *Reference) GetRef()string

GetRef returns the Ref field if it's non-nil, zero value otherwise.

func (*Reference)GetURL ¶

func (r *Reference) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (Reference)String ¶

func (rReference) String()string

typeReferenceListOptions ¶

type ReferenceListOptions struct {Typestring `url:"-"`ListOptions}

ReferenceListOptions specifies optional parameters to theGitService.ListRefs method.

typeReleaseAsset ¶

type ReleaseAsset struct {ID                 *int64     `json:"id,omitempty"`URL                *string    `json:"url,omitempty"`Name               *string    `json:"name,omitempty"`Label              *string    `json:"label,omitempty"`State              *string    `json:"state,omitempty"`ContentType        *string    `json:"content_type,omitempty"`Size               *int       `json:"size,omitempty"`DownloadCount      *int       `json:"download_count,omitempty"`CreatedAt          *Timestamp `json:"created_at,omitempty"`UpdatedAt          *Timestamp `json:"updated_at,omitempty"`BrowserDownloadURL *string    `json:"browser_download_url,omitempty"`Uploader           *User      `json:"uploader,omitempty"`NodeID             *string    `json:"node_id,omitempty"`}

ReleaseAsset represents a GitHub release asset in a repository.

func (*ReleaseAsset)GetBrowserDownloadURL ¶

func (r *ReleaseAsset) GetBrowserDownloadURL()string

GetBrowserDownloadURL returns the BrowserDownloadURL field if it's non-nil, zero value otherwise.

func (*ReleaseAsset)GetContentType ¶

func (r *ReleaseAsset) GetContentType()string

GetContentType returns the ContentType field if it's non-nil, zero value otherwise.

func (*ReleaseAsset)GetCreatedAt ¶

func (r *ReleaseAsset) GetCreatedAt()Timestamp

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*ReleaseAsset)GetDownloadCount ¶

func (r *ReleaseAsset) GetDownloadCount()int

GetDownloadCount returns the DownloadCount field if it's non-nil, zero value otherwise.

func (*ReleaseAsset)GetID ¶

func (r *ReleaseAsset) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*ReleaseAsset)GetLabel ¶

func (r *ReleaseAsset) GetLabel()string

GetLabel returns the Label field if it's non-nil, zero value otherwise.

func (*ReleaseAsset)GetName ¶

func (r *ReleaseAsset) GetName()string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (*ReleaseAsset)GetNodeID ¶

func (r *ReleaseAsset) GetNodeID()string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*ReleaseAsset)GetSize ¶

func (r *ReleaseAsset) GetSize()int

GetSize returns the Size field if it's non-nil, zero value otherwise.

func (*ReleaseAsset)GetState ¶

func (r *ReleaseAsset) GetState()string

GetState returns the State field if it's non-nil, zero value otherwise.

func (*ReleaseAsset)GetURL ¶

func (r *ReleaseAsset) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (*ReleaseAsset)GetUpdatedAt ¶

func (r *ReleaseAsset) GetUpdatedAt()Timestamp

GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.

func (*ReleaseAsset)GetUploader ¶

func (r *ReleaseAsset) GetUploader() *User

GetUploader returns the Uploader field.

func (ReleaseAsset)String ¶

func (rReleaseAsset) String()string

typeReleaseEvent ¶

type ReleaseEvent struct {// Action is the action that was performed. Possible values are: "published", "unpublished",// "created", "edited", "deleted", or "prereleased".Action  *string            `json:"action,omitempty"`Release *RepositoryRelease `json:"release,omitempty"`// The following fields are only populated by Webhook events.Repo         *Repository   `json:"repository,omitempty"`Sender       *User         `json:"sender,omitempty"`Installation *Installation `json:"installation,omitempty"`}

ReleaseEvent is triggered when a release is published, unpublished, created,edited, deleted, or prereleased.The Webhook event name is "release".

GitHub API docs:https://developer.github.com/v3/activity/events/types/#releaseevent

func (*ReleaseEvent)GetAction ¶

func (r *ReleaseEvent) GetAction()string

GetAction returns the Action field if it's non-nil, zero value otherwise.

func (*ReleaseEvent)GetInstallation ¶

func (r *ReleaseEvent) GetInstallation() *Installation

GetInstallation returns the Installation field.

func (*ReleaseEvent)GetRelease ¶

func (r *ReleaseEvent) GetRelease() *RepositoryRelease

GetRelease returns the Release field.

func (*ReleaseEvent)GetRepo ¶

func (r *ReleaseEvent) GetRepo() *Repository

GetRepo returns the Repo field.

func (*ReleaseEvent)GetSender ¶

func (r *ReleaseEvent) GetSender() *User

GetSender returns the Sender field.

typeRename ¶

type Rename struct {From *string `json:"from,omitempty"`To   *string `json:"to,omitempty"`}

Rename contains details for 'renamed' events.

func (*Rename)GetFrom ¶

func (r *Rename) GetFrom()string

GetFrom returns the From field if it's non-nil, zero value otherwise.

func (*Rename)GetTo ¶

func (r *Rename) GetTo()string

GetTo returns the To field if it's non-nil, zero value otherwise.

func (Rename)String ¶

func (rRename) String()string

typeRepoStats ¶

type RepoStats struct {TotalRepos  *int `json:"total_repos,omitempty"`RootRepos   *int `json:"root_repos,omitempty"`ForkRepos   *int `json:"fork_repos,omitempty"`OrgRepos    *int `json:"org_repos,omitempty"`TotalPushes *int `json:"total_pushes,omitempty"`TotalWikis  *int `json:"total_wikis,omitempty"`}

RepoStats represents the number of total, root, fork, organization repositoriestogether with the total number of pushes and wikis.

func (*RepoStats)GetForkRepos ¶

func (r *RepoStats) GetForkRepos()int

GetForkRepos returns the ForkRepos field if it's non-nil, zero value otherwise.

func (*RepoStats)GetOrgRepos ¶

func (r *RepoStats) GetOrgRepos()int

GetOrgRepos returns the OrgRepos field if it's non-nil, zero value otherwise.

func (*RepoStats)GetRootRepos ¶

func (r *RepoStats) GetRootRepos()int

GetRootRepos returns the RootRepos field if it's non-nil, zero value otherwise.

func (*RepoStats)GetTotalPushes ¶

func (r *RepoStats) GetTotalPushes()int

GetTotalPushes returns the TotalPushes field if it's non-nil, zero value otherwise.

func (*RepoStats)GetTotalRepos ¶

func (r *RepoStats) GetTotalRepos()int

GetTotalRepos returns the TotalRepos field if it's non-nil, zero value otherwise.

func (*RepoStats)GetTotalWikis ¶

func (r *RepoStats) GetTotalWikis()int

GetTotalWikis returns the TotalWikis field if it's non-nil, zero value otherwise.

func (RepoStats)String ¶

func (sRepoStats) String()string

typeRepoStatus ¶

type RepoStatus struct {ID     *int64  `json:"id,omitempty"`NodeID *string `json:"node_id,omitempty"`URL    *string `json:"url,omitempty"`// State is the current state of the repository. Possible values are:// pending, success, error, or failure.State *string `json:"state,omitempty"`// TargetURL is the URL of the page representing this status. It will be// linked from the GitHub UI to allow users to see the source of the status.TargetURL *string `json:"target_url,omitempty"`// Description is a short high level summary of the status.Description *string `json:"description,omitempty"`// A string label to differentiate this status from the statuses of other systems.Context *string `json:"context,omitempty"`Creator   *User      `json:"creator,omitempty"`CreatedAt *time.Time `json:"created_at,omitempty"`UpdatedAt *time.Time `json:"updated_at,omitempty"`}

RepoStatus represents the status of a repository at a particular reference.

func (*RepoStatus)GetContext ¶

func (r *RepoStatus) GetContext()string

GetContext returns the Context field if it's non-nil, zero value otherwise.

func (*RepoStatus)GetCreatedAt ¶

func (r *RepoStatus) GetCreatedAt()time.Time

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*RepoStatus)GetCreator ¶

func (r *RepoStatus) GetCreator() *User

GetCreator returns the Creator field.

func (*RepoStatus)GetDescription ¶

func (r *RepoStatus) GetDescription()string

GetDescription returns the Description field if it's non-nil, zero value otherwise.

func (*RepoStatus)GetID ¶

func (r *RepoStatus) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*RepoStatus)GetNodeID ¶

func (r *RepoStatus) GetNodeID()string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*RepoStatus)GetState ¶

func (r *RepoStatus) GetState()string

GetState returns the State field if it's non-nil, zero value otherwise.

func (*RepoStatus)GetTargetURL ¶

func (r *RepoStatus) GetTargetURL()string

GetTargetURL returns the TargetURL field if it's non-nil, zero value otherwise.

func (*RepoStatus)GetURL ¶

func (r *RepoStatus) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (*RepoStatus)GetUpdatedAt ¶

func (r *RepoStatus) GetUpdatedAt()time.Time

GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.

func (RepoStatus)String ¶

func (rRepoStatus) String()string

typeRepositoriesSearchResult ¶

type RepositoriesSearchResult struct {Total             *int         `json:"total_count,omitempty"`IncompleteResults *bool        `json:"incomplete_results,omitempty"`Repositories      []Repository `json:"items,omitempty"`}

RepositoriesSearchResult represents the result of a repositories search.

func (*RepositoriesSearchResult)GetIncompleteResults ¶

func (r *RepositoriesSearchResult) GetIncompleteResults()bool

GetIncompleteResults returns the IncompleteResults field if it's non-nil, zero value otherwise.

func (*RepositoriesSearchResult)GetTotal ¶

func (r *RepositoriesSearchResult) GetTotal()int

GetTotal returns the Total field if it's non-nil, zero value otherwise.

typeRepositoriesService ¶

type RepositoriesService service

RepositoriesService handles communication with the repository relatedmethods of the GitHub API.

GitHub API docs:https://developer.github.com/v3/repos/

func (*RepositoriesService)AddAdminEnforcement ¶

func (s *RepositoriesService) AddAdminEnforcement(ctxcontext.Context, owner, repo, branchstring) (*AdminEnforcement, *Response,error)

AddAdminEnforcement adds admin enforcement to a protected branch.It requires admin access and branch protection to be enabled.

GitHub API docs:https://developer.github.com/v3/repos/branches/#add-admin-enforcement-of-protected-branch

func (*RepositoriesService)AddAppRestrictions ¶

func (s *RepositoriesService) AddAppRestrictions(ctxcontext.Context, owner, repo, branchstring, slug []string) ([]*App, *Response,error)

AddAppRestrictions grants the specified apps push access to a given protected branch.It requires the Github apps to have `write` access to the `content` permission.

Note: The list of users, apps, and teams in total is limited to 100 items.

GitHub API docs:https://developer.github.com/v3/repos/branches/#add-app-restrictions-of-protected-branch

func (*RepositoriesService)AddCollaborator ¶

func (s *RepositoriesService) AddCollaborator(ctxcontext.Context, owner, repo, userstring, opts *RepositoryAddCollaboratorOptions) (*CollaboratorInvitation, *Response,error)

AddCollaborator sends an invitation to the specified GitHub userto become a collaborator to the given repo.

GitHub API docs:https://developer.github.com/v3/repos/collaborators/#add-user-as-a-collaborator

func (*RepositoriesService)CompareCommits ¶

func (s *RepositoriesService) CompareCommits(ctxcontext.Context, owner, repostring, base, headstring) (*CommitsComparison, *Response,error)

CompareCommits compares a range of commits with each other.todo: support media formats -https://github.com/google/go-github/issues/6

GitHub API docs:https://developer.github.com/v3/repos/commits/#compare-two-commits

func (*RepositoriesService)Create ¶

func (s *RepositoriesService) Create(ctxcontext.Context, orgstring, repo *Repository) (*Repository, *Response,error)

Create a new repository. If an organization is specified, the newrepository will be created under that org. If the empty string isspecified, it will be created for the authenticated user.

Note that only a subset of the repo fields are used and repo mustnot be nil.

GitHub API docs:https://developer.github.com/v3/repos/#create

func (*RepositoriesService)CreateComment ¶

func (s *RepositoriesService) CreateComment(ctxcontext.Context, owner, repo, shastring, comment *RepositoryComment) (*RepositoryComment, *Response,error)

CreateComment creates a comment for the given commit.Note: GitHub allows for comments to be created for non-existing files and positions.

GitHub API docs:https://developer.github.com/v3/repos/comments/#create-a-commit-comment

func (*RepositoriesService)CreateDeployment ¶

func (s *RepositoriesService) CreateDeployment(ctxcontext.Context, owner, repostring, request *DeploymentRequest) (*Deployment, *Response,error)

CreateDeployment creates a new deployment for a repository.

GitHub API docs:https://developer.github.com/v3/repos/deployments/#create-a-deployment

func (*RepositoriesService)CreateDeploymentStatus ¶

func (s *RepositoriesService) CreateDeploymentStatus(ctxcontext.Context, owner, repostring, deploymentint64, request *DeploymentStatusRequest) (*DeploymentStatus, *Response,error)

CreateDeploymentStatus creates a new status for a deployment.

GitHub API docs:https://developer.github.com/v3/repos/deployments/#create-a-deployment-status

func (*RepositoriesService)CreateFile ¶

func (s *RepositoriesService) CreateFile(ctxcontext.Context, owner, repo, pathstring, opts *RepositoryContentFileOptions) (*RepositoryContentResponse, *Response,error)

CreateFile creates a new file in a repository at the given path and returnsthe commit and file metadata.

GitHub API docs:https://developer.github.com/v3/repos/contents/#create-a-file

Example¶

package mainimport ("context""fmt""github.com/google/go-github/v29/github")func main() {// In this example we're creating a new file in a repository using the// Contents API. Only 1 file per commit can be managed through that API.// Note that authentication is needed here as you are performing a modification// so you will need to modify the example to provide an oauth client to// github.NewClient() instead of nil. See the following documentation for more// information on how to authenticate with the client:// https://godoc.org/github.com/google/go-github/github#hdr-Authenticationclient := github.NewClient(nil)ctx := context.Background()fileContent := []byte("This is the content of my file\nand the 2nd line of it")// Note: the file needs to be absent from the repository as you are not// specifying a SHA reference here.opts := &github.RepositoryContentFileOptions{Message:   github.String("This is my commit message"),Content:   fileContent,Branch:    github.String("master"),Committer: &github.CommitAuthor{Name: github.String("FirstName LastName"), Email: github.String("user@example.com")},}_, _, err := client.Repositories.CreateFile(ctx, "myOrganization", "myRepository", "myNewFile.md", opts)if err != nil {fmt.Println(err)return}}

func (*RepositoriesService)CreateFork ¶

func (s *RepositoriesService) CreateFork(ctxcontext.Context, owner, repostring, opts *RepositoryCreateForkOptions) (*Repository, *Response,error)

CreateFork creates a fork of the specified repository.

This method might return an *AcceptedError and a status code of202. This is because this is the status that GitHub returns to signify thatit is now computing creating the fork in a background task. In this event,the Repository value will be returned, which includes the details about the pending fork.A follow up request, after a delay of a second or so, should resultin a successful request.

GitHub API docs:https://developer.github.com/v3/repos/forks/#create-a-fork

func (*RepositoriesService)CreateFromTemplate ¶

func (s *RepositoriesService) CreateFromTemplate(ctxcontext.Context, templateOwner, templateRepostring, templateRepoReq *TemplateRepoRequest) (*Repository, *Response,error)

CreateFromTemplate generates a repository from a template.

GitHub API docs:https://developer.github.com/v3/repos/#create-repository-using-a-repository-template

func (*RepositoriesService)CreateHook ¶

func (s *RepositoriesService) CreateHook(ctxcontext.Context, owner, repostring, hook *Hook) (*Hook, *Response,error)

CreateHook creates a Hook for the specified repository.Config is a required field.

Note that only a subset of the hook fields are used and hook mustnot be nil.

GitHub API docs:https://developer.github.com/v3/repos/hooks/#create-a-hook

func (*RepositoriesService)CreateKey ¶

func (s *RepositoriesService) CreateKey(ctxcontext.Context, ownerstring, repostring, key *Key) (*Key, *Response,error)

CreateKey adds a deploy key for a repository.

GitHub API docs:https://developer.github.com/v3/repos/keys/#create

func (*RepositoriesService)CreateProject ¶

func (s *RepositoriesService) CreateProject(ctxcontext.Context, owner, repostring, opts *ProjectOptions) (*Project, *Response,error)

CreateProject creates a GitHub Project for the specified repository.

GitHub API docs:https://developer.github.com/v3/projects/#create-a-repository-project

func (*RepositoriesService)CreateRelease ¶

func (s *RepositoriesService) CreateRelease(ctxcontext.Context, owner, repostring, release *RepositoryRelease) (*RepositoryRelease, *Response,error)

CreateRelease adds a new release for a repository.

Note that only a subset of the release fields are used.See RepositoryRelease for more information.

GitHub API docs:https://developer.github.com/v3/repos/releases/#create-a-release

func (*RepositoriesService)CreateStatus ¶

func (s *RepositoriesService) CreateStatus(ctxcontext.Context, owner, repo, refstring, status *RepoStatus) (*RepoStatus, *Response,error)

CreateStatus creates a new status for a repository at the specifiedreference. Ref can be a SHA, a branch name, or a tag name.

GitHub API docs:https://developer.github.com/v3/repos/statuses/#create-a-status

func (*RepositoriesService)Delete ¶

func (s *RepositoriesService) Delete(ctxcontext.Context, owner, repostring) (*Response,error)

Delete a repository.

GitHub API docs:https://developer.github.com/v3/repos/#delete-a-repository

func (*RepositoriesService)DeleteComment ¶

func (s *RepositoriesService) DeleteComment(ctxcontext.Context, owner, repostring, idint64) (*Response,error)

DeleteComment deletes a single comment from a repository.

GitHub API docs:https://developer.github.com/v3/repos/comments/#delete-a-commit-comment

func (*RepositoriesService)DeleteFile ¶

func (s *RepositoriesService) DeleteFile(ctxcontext.Context, owner, repo, pathstring, opts *RepositoryContentFileOptions) (*RepositoryContentResponse, *Response,error)

DeleteFile deletes a file from a repository and returns the commit.Requires the blob SHA of the file to be deleted.

GitHub API docs:https://developer.github.com/v3/repos/contents/#delete-a-file

func (*RepositoriesService)DeleteHook ¶

func (s *RepositoriesService) DeleteHook(ctxcontext.Context, owner, repostring, idint64) (*Response,error)

DeleteHook deletes a specified Hook.

GitHub API docs:https://developer.github.com/v3/repos/hooks/#delete-a-hook

func (*RepositoriesService)DeleteInvitation ¶

func (s *RepositoriesService) DeleteInvitation(ctxcontext.Context, owner, repostring, invitationIDint64) (*Response,error)

DeleteInvitation deletes a repository invitation.

GitHub API docs:https://developer.github.com/v3/repos/invitations/#delete-a-repository-invitation

func (*RepositoriesService)DeleteKey ¶

func (s *RepositoriesService) DeleteKey(ctxcontext.Context, ownerstring, repostring, idint64) (*Response,error)

DeleteKey deletes a deploy key.

GitHub API docs:https://developer.github.com/v3/repos/keys/#delete

func (*RepositoriesService)DeletePreReceiveHook ¶

func (s *RepositoriesService) DeletePreReceiveHook(ctxcontext.Context, owner, repostring, idint64) (*Response,error)

DeletePreReceiveHook deletes a specified pre-receive hook.

GitHub API docs:https://developer.github.com/enterprise/2.13/v3/repos/pre_receive_hooks/#remove-enforcement-overrides-for-a-pre-receive-hook

func (*RepositoriesService)DeleteRelease ¶

func (s *RepositoriesService) DeleteRelease(ctxcontext.Context, owner, repostring, idint64) (*Response,error)

DeleteRelease delete a single release from a repository.

GitHub API docs:https://developer.github.com/v3/repos/releases/#delete-a-release

func (*RepositoriesService)DeleteReleaseAsset ¶

func (s *RepositoriesService) DeleteReleaseAsset(ctxcontext.Context, owner, repostring, idint64) (*Response,error)

DeleteReleaseAsset delete a single release asset from a repository.

GitHub API docs:https://developer.github.com/v3/repos/releases/#delete-a-release-asset

func (*RepositoriesService)DisableAutomatedSecurityFixes ¶

func (s *RepositoriesService) DisableAutomatedSecurityFixes(ctxcontext.Context, owner, repositorystring) (*Response,error)

DisableAutomatedSecurityFixes disables vulnerability alerts and the dependency graph for a repository.

GitHub API docs:https://developer.github.com/v3/repos/#disable-automated-security-fixes

func (*RepositoriesService)DisableDismissalRestrictions ¶

func (s *RepositoriesService) DisableDismissalRestrictions(ctxcontext.Context, owner, repo, branchstring) (*PullRequestReviewsEnforcement, *Response,error)

DisableDismissalRestrictions disables dismissal restrictions of a protected branch.It requires admin access and branch protection to be enabled.

GitHub API docs:https://developer.github.com/v3/repos/branches/#update-pull-request-review-enforcement-of-protected-branch

func (*RepositoriesService)DisablePages ¶

func (s *RepositoriesService) DisablePages(ctxcontext.Context, owner, repostring) (*Response,error)

DisablePages disables GitHub Pages for the named repo.

GitHub API docs:https://developer.github.com/v3/repos/pages/#disable-a-pages-site

func (*RepositoriesService)DisableVulnerabilityAlerts ¶

func (s *RepositoriesService) DisableVulnerabilityAlerts(ctxcontext.Context, owner, repositorystring) (*Response,error)

DisableVulnerabilityAlerts disables vulnerability alerts and the dependency graph for a repository.

GitHub API docs:https://developer.github.com/v3/repos/#disable-vulnerability-alerts

func (*RepositoriesService)Dispatch ¶

func (s *RepositoriesService) Dispatch(ctxcontext.Context, owner, repostring, optsDispatchRequestOptions) (*Repository, *Response,error)

Dispatch triggers a repository_dispatch event in a GitHub Actions workflow.

GitHub API docs:https://developer.github.com/v3/repos/#create-a-repository-dispatch-event

func (*RepositoriesService)DownloadContents ¶

func (s *RepositoriesService) DownloadContents(ctxcontext.Context, owner, repo, filepathstring, opts *RepositoryContentGetOptions) (io.ReadCloser,error)

DownloadContents returns an io.ReadCloser that reads the contents of thespecified file. This function will work with files of any size, as opposedto GetContents which is limited to 1 Mb files. It is the caller'sresponsibility to close the ReadCloser.

func (*RepositoriesService)DownloadReleaseAsset ¶

func (s *RepositoriesService) DownloadReleaseAsset(ctxcontext.Context, owner, repostring, idint64, followRedirectsClient *http.Client) (rcio.ReadCloser, redirectURLstring, errerror)

DownloadReleaseAsset downloads a release asset or returns a redirect URL.

DownloadReleaseAsset returns an io.ReadCloser that reads the contents of thespecified release asset. It is the caller's responsibility to close the ReadCloser.If a redirect is returned, the redirect URL will be returned as a string insteadof the io.ReadCloser. Exactly one of rc and redirectURL will be zero.

followRedirectsClient can be passed to download the asset from a redirectedlocation. Passing http.DefaultClient is recommended unless special circumstancesexist, but it's possible to pass any http.Client. If nil is passed theredirectURL will be returned instead.

GitHub API docs:https://developer.github.com/v3/repos/releases/#get-a-single-release-asset

func (*RepositoriesService)Edit ¶

func (s *RepositoriesService) Edit(ctxcontext.Context, owner, repostring, repository *Repository) (*Repository, *Response,error)

Edit updates a repository.

GitHub API docs:https://developer.github.com/v3/repos/#edit

func (*RepositoriesService)EditHook ¶

func (s *RepositoriesService) EditHook(ctxcontext.Context, owner, repostring, idint64, hook *Hook) (*Hook, *Response,error)

EditHook updates a specified Hook.

GitHub API docs:https://developer.github.com/v3/repos/hooks/#edit-a-hook

func (*RepositoriesService)EditKey ¶

func (s *RepositoriesService) EditKey(ctxcontext.Context, ownerstring, repostring, idint64, key *Key) (*Key, *Response,error)

EditKey edits a deploy key.

GitHub API docs:https://developer.github.com/v3/repos/keys/#edit

func (*RepositoriesService)EditRelease ¶

func (s *RepositoriesService) EditRelease(ctxcontext.Context, owner, repostring, idint64, release *RepositoryRelease) (*RepositoryRelease, *Response,error)

EditRelease edits a repository release.

Note that only a subset of the release fields are used.See RepositoryRelease for more information.

GitHub API docs:https://developer.github.com/v3/repos/releases/#edit-a-release

func (*RepositoriesService)EditReleaseAsset ¶

func (s *RepositoriesService) EditReleaseAsset(ctxcontext.Context, owner, repostring, idint64, release *ReleaseAsset) (*ReleaseAsset, *Response,error)

EditReleaseAsset edits a repository release asset.

GitHub API docs:https://developer.github.com/v3/repos/releases/#edit-a-release-asset

func (*RepositoriesService)EnableAutomatedSecurityFixes ¶

func (s *RepositoriesService) EnableAutomatedSecurityFixes(ctxcontext.Context, owner, repositorystring) (*Response,error)

EnableAutomatedSecurityFixes enables the automated security fixes for a repository.

GitHub API docs:https://developer.github.com/v3/repos/#enable-automated-security-fixes

func (*RepositoriesService)EnablePages ¶

func (s *RepositoriesService) EnablePages(ctxcontext.Context, owner, repostring, pages *Pages) (*Pages, *Response,error)

EnablePages enables GitHub Pages for the named repo.

GitHub API docs:https://developer.github.com/v3/repos/pages/#enable-a-pages-site

func (*RepositoriesService)EnableVulnerabilityAlerts ¶

func (s *RepositoriesService) EnableVulnerabilityAlerts(ctxcontext.Context, owner, repositorystring) (*Response,error)

EnableVulnerabilityAlerts enables vulnerability alerts and the dependency graph for a repository.

GitHub API docs:https://developer.github.com/v3/repos/#enable-vulnerability-alerts

func (*RepositoriesService)Get ¶

func (s *RepositoriesService) Get(ctxcontext.Context, owner, repostring) (*Repository, *Response,error)

Get fetches a repository.

GitHub API docs:https://developer.github.com/v3/repos/#get

func (*RepositoriesService)GetAdminEnforcement ¶

func (s *RepositoriesService) GetAdminEnforcement(ctxcontext.Context, owner, repo, branchstring) (*AdminEnforcement, *Response,error)

GetAdminEnforcement gets admin enforcement information of a protected branch.

GitHub API docs:https://developer.github.com/v3/repos/branches/#get-admin-enforcement-of-protected-branch

func (*RepositoriesService)GetArchiveLink ¶

func (s *RepositoriesService) GetArchiveLink(ctxcontext.Context, owner, repostring, archiveformat archiveFormat, opts *RepositoryContentGetOptions, followRedirectsbool) (*url.URL, *Response,error)

GetArchiveLink returns an URL to download a tarball or zipball archive for arepository. The archiveFormat can be specified by either the github.Tarballor github.Zipball constant.

GitHub API docs:https://developer.github.com/v3/repos/contents/#get-archive-link

func (*RepositoriesService)GetBranch ¶

func (s *RepositoriesService) GetBranch(ctxcontext.Context, owner, repo, branchstring) (*Branch, *Response,error)

GetBranch gets the specified branch for a repository.

GitHub API docs:https://developer.github.com/v3/repos/#get-branch

func (*RepositoriesService)GetBranchProtection ¶

func (s *RepositoriesService) GetBranchProtection(ctxcontext.Context, owner, repo, branchstring) (*Protection, *Response,error)

GetBranchProtection gets the protection of a given branch.

GitHub API docs:https://developer.github.com/v3/repos/branches/#get-branch-protection

func (*RepositoriesService)GetByID ¶

func (s *RepositoriesService) GetByID(ctxcontext.Context, idint64) (*Repository, *Response,error)

GetByID fetches a repository.

Note: GetByID uses the undocumented GitHub API endpoint /repositories/:id.

func (*RepositoriesService)GetCodeOfConduct ¶

func (s *RepositoriesService) GetCodeOfConduct(ctxcontext.Context, owner, repostring) (*CodeOfConduct, *Response,error)

GetCodeOfConduct gets the contents of a repository's code of conduct.

GitHub API docs:https://developer.github.com/v3/codes_of_conduct/#get-the-contents-of-a-repositorys-code-of-conduct

func (*RepositoriesService)GetCombinedStatus ¶

func (s *RepositoriesService) GetCombinedStatus(ctxcontext.Context, owner, repo, refstring, opts *ListOptions) (*CombinedStatus, *Response,error)

GetCombinedStatus returns the combined status of a repository at the specifiedreference. ref can be a SHA, a branch name, or a tag name.

GitHub API docs:https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref

func (*RepositoriesService)GetComment ¶

func (s *RepositoriesService) GetComment(ctxcontext.Context, owner, repostring, idint64) (*RepositoryComment, *Response,error)

GetComment gets a single comment from a repository.

GitHub API docs:https://developer.github.com/v3/repos/comments/#get-a-single-commit-comment

func (*RepositoriesService)GetCommit ¶

func (s *RepositoriesService) GetCommit(ctxcontext.Context, owner, repo, shastring) (*RepositoryCommit, *Response,error)

GetCommit fetches the specified commit, including all details about it.

GitHub API docs:https://developer.github.com/v3/repos/commits/#get-a-single-commitSee also:https://developer.github.com/v3/git/commits/#get-a-single-commit provides the same functionality

func (*RepositoriesService)GetCommitRaw ¶

func (s *RepositoriesService) GetCommitRaw(ctxcontext.Context, ownerstring, repostring, shastring, optsRawOptions) (string, *Response,error)

GetCommitRaw fetches the specified commit in raw (diff or patch) format.

func (*RepositoriesService)GetCommitSHA1 ¶

func (s *RepositoriesService) GetCommitSHA1(ctxcontext.Context, owner, repo, ref, lastSHAstring) (string, *Response,error)

GetCommitSHA1 gets the SHA-1 of a commit reference. If a last-known SHA1 issupplied and no new commits have occurred, a 304 Unmodified response is returned.

GitHub API docs:https://developer.github.com/v3/repos/commits/#get-the-sha-1-of-a-commit-reference

func (*RepositoriesService)GetCommunityHealthMetrics ¶

func (s *RepositoriesService) GetCommunityHealthMetrics(ctxcontext.Context, owner, repostring) (*CommunityHealthMetrics, *Response,error)

GetCommunityHealthMetrics retrieves all the community health metrics for a repository.

GitHub API docs:https://developer.github.com/v3/repos/community/#retrieve-community-health-metrics

func (*RepositoriesService)GetContents ¶

func (s *RepositoriesService) GetContents(ctxcontext.Context, owner, repo, pathstring, opts *RepositoryContentGetOptions) (fileContent *RepositoryContent, directoryContent []*RepositoryContent, resp *Response, errerror)

GetContents can return either the metadata and content of a single file(when path references a file) or the metadata of all the files and/orsubdirectories of a directory (when path references a directory). To make iteasy to distinguish between both result types and to mimic the API as muchas possible, both result types will be returned but only one will contain avalue and the other will be nil.

GitHub API docs:https://developer.github.com/v3/repos/contents/#get-contents

func (*RepositoriesService)GetDeployment ¶

func (s *RepositoriesService) GetDeployment(ctxcontext.Context, owner, repostring, deploymentIDint64) (*Deployment, *Response,error)

GetDeployment returns a single deployment of a repository.

GitHub API docs:https://developer.github.com/v3/repos/deployments/#get-a-single-deployment

func (*RepositoriesService)GetDeploymentStatus ¶

func (s *RepositoriesService) GetDeploymentStatus(ctxcontext.Context, owner, repostring, deploymentID, deploymentStatusIDint64) (*DeploymentStatus, *Response,error)

GetDeploymentStatus returns a single deployment status of a repository.

GitHub API docs:https://developer.github.com/v3/repos/deployments/#get-a-single-deployment-status

func (*RepositoriesService)GetHook ¶

func (s *RepositoriesService) GetHook(ctxcontext.Context, owner, repostring, idint64) (*Hook, *Response,error)

GetHook returns a single specified Hook.

GitHub API docs:https://developer.github.com/v3/repos/hooks/#get-single-hook

func (*RepositoriesService)GetKey ¶

func (s *RepositoriesService) GetKey(ctxcontext.Context, ownerstring, repostring, idint64) (*Key, *Response,error)

GetKey fetches a single deploy key.

GitHub API docs:https://developer.github.com/v3/repos/keys/#get

func (*RepositoriesService)GetLatestPagesBuild ¶

func (s *RepositoriesService) GetLatestPagesBuild(ctxcontext.Context, owner, repostring) (*PagesBuild, *Response,error)

GetLatestPagesBuild fetches the latest build information for a GitHub pages site.

GitHub API docs:https://developer.github.com/v3/repos/pages/#list-latest-pages-build

func (*RepositoriesService)GetLatestRelease ¶

func (s *RepositoriesService) GetLatestRelease(ctxcontext.Context, owner, repostring) (*RepositoryRelease, *Response,error)

GetLatestRelease fetches the latest published release for the repository.

GitHub API docs:https://developer.github.com/v3/repos/releases/#get-the-latest-release

func (*RepositoriesService)GetPageBuild ¶

func (s *RepositoriesService) GetPageBuild(ctxcontext.Context, owner, repostring, idint64) (*PagesBuild, *Response,error)

GetPageBuild fetches the specific build information for a GitHub pages site.

GitHub API docs:https://developer.github.com/v3/repos/pages/#list-a-specific-pages-build

func (*RepositoriesService)GetPagesInfo ¶

func (s *RepositoriesService) GetPagesInfo(ctxcontext.Context, owner, repostring) (*Pages, *Response,error)

GetPagesInfo fetches information about a GitHub Pages site.

GitHub API docs:https://developer.github.com/v3/repos/pages/#get-information-about-a-pages-site

func (*RepositoriesService)GetPermissionLevel ¶

func (s *RepositoriesService) GetPermissionLevel(ctxcontext.Context, owner, repo, userstring) (*RepositoryPermissionLevel, *Response,error)

GetPermissionLevel retrieves the specific permission level a collaborator has for a given repository.GitHub API docs:https://developer.github.com/v3/repos/collaborators/#review-a-users-permission-level

func (*RepositoriesService)GetPreReceiveHook ¶

func (s *RepositoriesService) GetPreReceiveHook(ctxcontext.Context, owner, repostring, idint64) (*PreReceiveHook, *Response,error)

GetPreReceiveHook returns a single specified pre-receive hook.

GitHub API docs:https://developer.github.com/enterprise/2.13/v3/repos/pre_receive_hooks/#get-a-single-pre-receive-hook

func (*RepositoriesService)GetPullRequestReviewEnforcement ¶

func (s *RepositoriesService) GetPullRequestReviewEnforcement(ctxcontext.Context, owner, repo, branchstring) (*PullRequestReviewsEnforcement, *Response,error)

GetPullRequestReviewEnforcement gets pull request review enforcement of a protected branch.

GitHub API docs:https://developer.github.com/v3/repos/branches/#get-pull-request-review-enforcement-of-protected-branch

func (*RepositoriesService)GetReadme ¶

func (s *RepositoriesService) GetReadme(ctxcontext.Context, owner, repostring, opts *RepositoryContentGetOptions) (*RepositoryContent, *Response,error)

GetReadme gets the Readme file for the repository.

GitHub API docs:https://developer.github.com/v3/repos/contents/#get-the-readme

Example¶

package mainimport ("context""fmt""github.com/google/go-github/v29/github")func main() {client := github.NewClient(nil)readme, _, err := client.Repositories.GetReadme(context.Background(), "google", "go-github", nil)if err != nil {fmt.Println(err)return}content, err := readme.GetContent()if err != nil {fmt.Println(err)return}fmt.Printf("google/go-github README:\n%v\n", content)}

func (*RepositoriesService)GetRelease ¶

func (s *RepositoriesService) GetRelease(ctxcontext.Context, owner, repostring, idint64) (*RepositoryRelease, *Response,error)

GetRelease fetches a single release.

GitHub API docs:https://developer.github.com/v3/repos/releases/#get-a-single-release

func (*RepositoriesService)GetReleaseAsset ¶

func (s *RepositoriesService) GetReleaseAsset(ctxcontext.Context, owner, repostring, idint64) (*ReleaseAsset, *Response,error)

GetReleaseAsset fetches a single release asset.

GitHub API docs:https://developer.github.com/v3/repos/releases/#get-a-single-release-asset

func (*RepositoriesService)GetReleaseByTag ¶

func (s *RepositoriesService) GetReleaseByTag(ctxcontext.Context, owner, repo, tagstring) (*RepositoryRelease, *Response,error)

GetReleaseByTag fetches a release with the specified tag.

GitHub API docs:https://developer.github.com/v3/repos/releases/#get-a-release-by-tag-name

func (*RepositoriesService)GetRequiredStatusChecks ¶

func (s *RepositoriesService) GetRequiredStatusChecks(ctxcontext.Context, owner, repo, branchstring) (*RequiredStatusChecks, *Response,error)

GetRequiredStatusChecks gets the required status checks for a given protected branch.

GitHub API docs:https://developer.github.com/v3/repos/branches/#get-required-status-checks-of-protected-branch

func (*RepositoriesService)GetSignaturesProtectedBranch ¶

func (s *RepositoriesService) GetSignaturesProtectedBranch(ctxcontext.Context, owner, repo, branchstring) (*SignaturesProtectedBranch, *Response,error)

GetSignaturesProtectedBranch gets required signatures of protected branch.

GitHub API docs:https://developer.github.com/v3/repos/branches/#get-required-signatures-of-protected-branch

func (*RepositoriesService)GetVulnerabilityAlerts ¶

func (s *RepositoriesService) GetVulnerabilityAlerts(ctxcontext.Context, owner, repositorystring) (bool, *Response,error)

GetVulnerabilityAlerts checks if vulnerability alerts are enabled for a repository.

GitHub API docs:https://developer.github.com/v3/repos/#check-if-vulnerability-alerts-are-enabled-for-a-repository

func (*RepositoriesService)IsCollaborator ¶

func (s *RepositoriesService) IsCollaborator(ctxcontext.Context, owner, repo, userstring) (bool, *Response,error)

IsCollaborator checks whether the specified GitHub user has collaboratoraccess to the given repo.Note: This will return false if the user is not a collaborator OR the useris not a GitHub user.

GitHub API docs:https://developer.github.com/v3/repos/collaborators/#get

func (*RepositoriesService)License ¶

func (s *RepositoriesService) License(ctxcontext.Context, owner, repostring) (*RepositoryLicense, *Response,error)

License gets the contents of a repository's license if one is detected.

GitHub API docs:https://developer.github.com/v3/licenses/#get-the-contents-of-a-repositorys-license

func (*RepositoriesService)List ¶

func (s *RepositoriesService) List(ctxcontext.Context, userstring, opts *RepositoryListOptions) ([]*Repository, *Response,error)

List the repositories for a user. Passing the empty string will listrepositories for the authenticated user.

GitHub API docs:https://developer.github.com/v3/repos/#list-user-repositories

Example¶

package mainimport ("context""fmt""github.com/google/go-github/v29/github")func main() {client := github.NewClient(nil)user := "willnorris"opt := &github.RepositoryListOptions{Type: "owner", Sort: "updated", Direction: "desc"}repos, _, err := client.Repositories.List(context.Background(), user, opt)if err != nil {fmt.Println(err)}fmt.Printf("Recently updated repositories by %q: %v", user, github.Stringify(repos))}

func (*RepositoriesService)ListAll ¶

func (s *RepositoriesService) ListAll(ctxcontext.Context, opts *RepositoryListAllOptions) ([]*Repository, *Response,error)

ListAll lists all GitHub repositories in the order that they were created.

GitHub API docs:https://developer.github.com/v3/repos/#list-all-public-repositories

func (*RepositoriesService)ListAllTopics ¶

func (s *RepositoriesService) ListAllTopics(ctxcontext.Context, owner, repostring) ([]string, *Response,error)

ListAllTopics lists topics for a repository.

GitHub API docs:https://developer.github.com/v3/repos/#list-all-topics-for-a-repository

func (*RepositoriesService)ListApps ¶

func (s *RepositoriesService) ListApps(ctxcontext.Context, owner, repo, branchstring) ([]*App, *Response,error)

ListApps lists the Github apps that have push access to a given protected branch.It requires the Github apps to have `write` access to the `content` permission.

GitHub API docs:https://developer.github.com/v3/repos/branches/#list-apps-with-access-to-protected-branch

func (*RepositoriesService)ListBranches ¶

func (s *RepositoriesService) ListBranches(ctxcontext.Context, ownerstring, repostring, opts *BranchListOptions) ([]*Branch, *Response,error)

ListBranches lists branches for the specified repository.

GitHub API docs:https://developer.github.com/v3/repos/#list-branches

func (*RepositoriesService)ListBranchesHeadCommit ¶

func (s *RepositoriesService) ListBranchesHeadCommit(ctxcontext.Context, owner, repo, shastring) ([]*BranchCommit, *Response,error)

ListBranchesHeadCommit gets all branches where the given commit SHA is the HEAD,or latest commit for the branch.

GitHub API docs:https://developer.github.com/v3/repos/commits/#list-branches-for-head-commit

func (*RepositoriesService)ListByOrg ¶

func (s *RepositoriesService) ListByOrg(ctxcontext.Context, orgstring, opts *RepositoryListByOrgOptions) ([]*Repository, *Response,error)

ListByOrg lists the repositories for an organization.

GitHub API docs:https://developer.github.com/v3/repos/#list-organization-repositories

func (*RepositoriesService)ListCodeFrequency ¶

func (s *RepositoriesService) ListCodeFrequency(ctxcontext.Context, owner, repostring) ([]*WeeklyStats, *Response,error)

ListCodeFrequency returns a weekly aggregate of the number of additions anddeletions pushed to a repository. Returned WeeklyStats will containadditions and deletions, but not total commits.

If this is the first time these statistics are requested for the givenrepository, this method will return an *AcceptedError and a status code of202. This is because this is the status that GitHub returns to signify thatit is now computing the requested statistics. A follow up request, after adelay of a second or so, should result in a successful request.

GitHub API docs:https://developer.github.com/v3/repos/statistics/#code-frequency

func (*RepositoriesService)ListCollaborators ¶

func (s *RepositoriesService) ListCollaborators(ctxcontext.Context, owner, repostring, opts *ListCollaboratorsOptions) ([]*User, *Response,error)

ListCollaborators lists the GitHub users that have access to the repository.

GitHub API docs:https://developer.github.com/v3/repos/collaborators/#list-collaborators

func (*RepositoriesService)ListComments ¶

func (s *RepositoriesService) ListComments(ctxcontext.Context, owner, repostring, opts *ListOptions) ([]*RepositoryComment, *Response,error)

ListComments lists all the comments for the repository.

GitHub API docs:https://developer.github.com/v3/repos/comments/#list-commit-comments-for-a-repository

func (*RepositoriesService)ListCommitActivity ¶

func (s *RepositoriesService) ListCommitActivity(ctxcontext.Context, owner, repostring) ([]*WeeklyCommitActivity, *Response,error)

ListCommitActivity returns the last year of commit activitygrouped by week. The days array is a group of commits per day,starting on Sunday.

GitHub API docs:https://developer.github.com/v3/repos/statistics/#commit-activity

func (*RepositoriesService)ListCommitComments ¶

func (s *RepositoriesService) ListCommitComments(ctxcontext.Context, owner, repo, shastring, opts *ListOptions) ([]*RepositoryComment, *Response,error)

ListCommitComments lists all the comments for a given commit SHA.

GitHub API docs:https://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit

func (*RepositoriesService)ListCommits ¶

func (s *RepositoriesService) ListCommits(ctxcontext.Context, owner, repostring, opts *CommitsListOptions) ([]*RepositoryCommit, *Response,error)

ListCommits lists the commits of a repository.

GitHub API docs:https://developer.github.com/v3/repos/commits/#list

func (*RepositoriesService)ListContributors ¶

func (s *RepositoriesService) ListContributors(ctxcontext.Context, ownerstring, repositorystring, opts *ListContributorsOptions) ([]*Contributor, *Response,error)

ListContributors lists contributors for a repository.

GitHub API docs:https://developer.github.com/v3/repos/#list-contributors

func (*RepositoriesService)ListContributorsStats ¶

func (s *RepositoriesService) ListContributorsStats(ctxcontext.Context, owner, repostring) ([]*ContributorStats, *Response,error)

ListContributorsStats gets a repo's contributor list with additions,deletions and commit counts.

GitHub API docs:https://developer.github.com/v3/repos/statistics/#contributors

func (*RepositoriesService)ListDeploymentStatuses ¶

func (s *RepositoriesService) ListDeploymentStatuses(ctxcontext.Context, owner, repostring, deploymentint64, opts *ListOptions) ([]*DeploymentStatus, *Response,error)

ListDeploymentStatuses lists the statuses of a given deployment of a repository.

GitHub API docs:https://developer.github.com/v3/repos/deployments/#list-deployment-statuses

func (*RepositoriesService)ListDeployments ¶

func (s *RepositoriesService) ListDeployments(ctxcontext.Context, owner, repostring, opts *DeploymentsListOptions) ([]*Deployment, *Response,error)

ListDeployments lists the deployments of a repository.

GitHub API docs:https://developer.github.com/v3/repos/deployments/#list-deployments

func (*RepositoriesService)ListForks ¶

func (s *RepositoriesService) ListForks(ctxcontext.Context, owner, repostring, opts *RepositoryListForksOptions) ([]*Repository, *Response,error)

ListForks lists the forks of the specified repository.

GitHub API docs:https://developer.github.com/v3/repos/forks/#list-forks

func (*RepositoriesService)ListHooks ¶

func (s *RepositoriesService) ListHooks(ctxcontext.Context, owner, repostring, opts *ListOptions) ([]*Hook, *Response,error)

ListHooks lists all Hooks for the specified repository.

GitHub API docs:https://developer.github.com/v3/repos/hooks/#list

func (*RepositoriesService)ListInvitations ¶

func (s *RepositoriesService) ListInvitations(ctxcontext.Context, owner, repostring, opts *ListOptions) ([]*RepositoryInvitation, *Response,error)

ListInvitations lists all currently-open repository invitations.

GitHub API docs:https://developer.github.com/v3/repos/invitations/#list-invitations-for-a-repository

func (*RepositoriesService)ListKeys ¶

func (s *RepositoriesService) ListKeys(ctxcontext.Context, ownerstring, repostring, opts *ListOptions) ([]*Key, *Response,error)

ListKeys lists the deploy keys for a repository.

GitHub API docs:https://developer.github.com/v3/repos/keys/#list

func (*RepositoriesService)ListLanguages ¶

func (s *RepositoriesService) ListLanguages(ctxcontext.Context, ownerstring, repostring) (map[string]int, *Response,error)

ListLanguages lists languages for the specified repository. The returned mapspecifies the languages and the number of bytes of code written in thatlanguage. For example:

{  "C": 78769,  "Python": 7769}

GitHub API docs:https://developer.github.com/v3/repos/#list-languages

func (*RepositoriesService)ListPagesBuilds ¶

func (s *RepositoriesService) ListPagesBuilds(ctxcontext.Context, owner, repostring, opts *ListOptions) ([]*PagesBuild, *Response,error)

ListPagesBuilds lists the builds for a GitHub Pages site.

GitHub API docs:https://developer.github.com/v3/repos/pages/#list-pages-builds

func (*RepositoriesService)ListParticipation ¶

func (s *RepositoriesService) ListParticipation(ctxcontext.Context, owner, repostring) (*RepositoryParticipation, *Response,error)

ListParticipation 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 getthe commit counts for non-owners, you can subtract 'all' from 'owner'.

The array order is oldest week (index 0) to most recent week.

GitHub API docs:https://developer.github.com/v3/repos/statistics/#participation

func (*RepositoriesService)ListPreReceiveHooks ¶

func (s *RepositoriesService) ListPreReceiveHooks(ctxcontext.Context, owner, repostring, opts *ListOptions) ([]*PreReceiveHook, *Response,error)

ListPreReceiveHooks lists all pre-receive hooks for the specified repository.

GitHub API docs:https://developer.github.com/enterprise/2.13/v3/repos/pre_receive_hooks/#list-pre-receive-hooks

func (*RepositoriesService)ListProjects ¶

func (s *RepositoriesService) ListProjects(ctxcontext.Context, owner, repostring, opts *ProjectListOptions) ([]*Project, *Response,error)

ListProjects lists the projects for a repo.

GitHub API docs:https://developer.github.com/v3/projects/#list-repository-projects

func (*RepositoriesService)ListPunchCard ¶

func (s *RepositoriesService) ListPunchCard(ctxcontext.Context, owner, repostring) ([]*PunchCard, *Response,error)

ListPunchCard returns the number of commits per hour in each day.

GitHub API docs:https://developer.github.com/v3/repos/statistics/#punch-card

func (*RepositoriesService)ListReleaseAssets ¶

func (s *RepositoriesService) ListReleaseAssets(ctxcontext.Context, owner, repostring, idint64, opts *ListOptions) ([]*ReleaseAsset, *Response,error)

ListReleaseAssets lists the release's assets.

GitHub API docs:https://developer.github.com/v3/repos/releases/#list-assets-for-a-release

func (*RepositoriesService)ListReleases ¶

func (s *RepositoriesService) ListReleases(ctxcontext.Context, owner, repostring, opts *ListOptions) ([]*RepositoryRelease, *Response,error)

ListReleases lists the releases for a repository.

GitHub API docs:https://developer.github.com/v3/repos/releases/#list-releases-for-a-repository

func (*RepositoriesService)ListRequiredStatusChecksContexts ¶

func (s *RepositoriesService) ListRequiredStatusChecksContexts(ctxcontext.Context, owner, repo, branchstring) (contexts []string, resp *Response, errerror)

ListRequiredStatusChecksContexts lists the required status checks contexts for a given protected branch.

GitHub API docs:https://developer.github.com/v3/repos/branches/#list-required-status-checks-contexts-of-protected-branch

func (*RepositoriesService)ListStatuses ¶

func (s *RepositoriesService) ListStatuses(ctxcontext.Context, owner, repo, refstring, opts *ListOptions) ([]*RepoStatus, *Response,error)

ListStatuses lists the statuses of a repository at the specifiedreference. ref can be a SHA, a branch name, or a tag name.

GitHub API docs:https://developer.github.com/v3/repos/statuses/#list-statuses-for-a-specific-ref

func (*RepositoriesService)ListTags ¶

func (s *RepositoriesService) ListTags(ctxcontext.Context, ownerstring, repostring, opts *ListOptions) ([]*RepositoryTag, *Response,error)

ListTags lists tags for the specified repository.

GitHub API docs:https://developer.github.com/v3/repos/#list-tags

func (*RepositoriesService)ListTeams ¶

func (s *RepositoriesService) ListTeams(ctxcontext.Context, ownerstring, repostring, opts *ListOptions) ([]*Team, *Response,error)

ListTeams lists the teams for the specified repository.

GitHub API docs:https://developer.github.com/v3/repos/#list-teams

func (*RepositoriesService)ListTrafficClones ¶

func (s *RepositoriesService) ListTrafficClones(ctxcontext.Context, owner, repostring, opts *TrafficBreakdownOptions) (*TrafficClones, *Response,error)

ListTrafficClones get total number of clones for the last 14 days and breaks it down either per day or week for the last 14 days.

GitHub API docs:https://developer.github.com/v3/repos/traffic/#views

func (*RepositoriesService)ListTrafficPaths ¶

func (s *RepositoriesService) ListTrafficPaths(ctxcontext.Context, owner, repostring) ([]*TrafficPath, *Response,error)

ListTrafficPaths list the top 10 popular content over the last 14 days.

GitHub API docs:https://developer.github.com/v3/repos/traffic/#list-paths

func (*RepositoriesService)ListTrafficReferrers ¶

func (s *RepositoriesService) ListTrafficReferrers(ctxcontext.Context, owner, repostring) ([]*TrafficReferrer, *Response,error)

ListTrafficReferrers list the top 10 referrers over the last 14 days.

GitHub API docs:https://developer.github.com/v3/repos/traffic/#list-referrers

func (*RepositoriesService)ListTrafficViews ¶

func (s *RepositoriesService) ListTrafficViews(ctxcontext.Context, owner, repostring, opts *TrafficBreakdownOptions) (*TrafficViews, *Response,error)

ListTrafficViews get total number of views for the last 14 days and breaks it down either per day or week.

GitHub API docs:https://developer.github.com/v3/repos/traffic/#views

func (*RepositoriesService)Merge ¶

func (s *RepositoriesService) Merge(ctxcontext.Context, owner, repostring, request *RepositoryMergeRequest) (*RepositoryCommit, *Response,error)

Merge a branch in the specified repository.

GitHub API docs:https://developer.github.com/v3/repos/merging/#perform-a-merge

func (*RepositoriesService)OptionalSignaturesOnProtectedBranch ¶

func (s *RepositoriesService) OptionalSignaturesOnProtectedBranch(ctxcontext.Context, owner, repo, branchstring) (*Response,error)

OptionalSignaturesOnProtectedBranch removes required signed commits on a given branch.

GitHub API docs:https://developer.github.com/v3/repos/branches/#remove-required-signatures-of-protected-branch

func (*RepositoriesService)PingHook ¶

func (s *RepositoriesService) PingHook(ctxcontext.Context, owner, repostring, idint64) (*Response,error)

PingHook triggers a 'ping' event to be sent to the Hook.

GitHub API docs:https://developer.github.com/v3/repos/hooks/#ping-a-hook

func (*RepositoriesService)RemoveAdminEnforcement ¶

func (s *RepositoriesService) RemoveAdminEnforcement(ctxcontext.Context, owner, repo, branchstring) (*Response,error)

RemoveAdminEnforcement removes admin enforcement from a protected branch.

GitHub API docs:https://developer.github.com/v3/repos/branches/#remove-admin-enforcement-of-protected-branch

func (*RepositoriesService)RemoveAppRestrictions ¶

func (s *RepositoriesService) RemoveAppRestrictions(ctxcontext.Context, owner, repo, branchstring, slug []string) ([]*App, *Response,error)

RemoveAppRestrictions removes the ability of an app to push to this branch.It requires the Github apps to have `write` access to the `content` permission.

Note: The list of users, apps, and teams in total is limited to 100 items.

GitHub API docs:https://developer.github.com/v3/repos/branches/#remove-app-restrictions-of-protected-branch

func (*RepositoriesService)RemoveBranchProtection ¶

func (s *RepositoriesService) RemoveBranchProtection(ctxcontext.Context, owner, repo, branchstring) (*Response,error)

RemoveBranchProtection removes the protection of a given branch.

GitHub API docs:https://developer.github.com/v3/repos/branches/#remove-branch-protection

func (*RepositoriesService)RemoveCollaborator ¶

func (s *RepositoriesService) RemoveCollaborator(ctxcontext.Context, owner, repo, userstring) (*Response,error)

RemoveCollaborator removes the specified GitHub user as collaborator from the given repo.Note: Does not return error if a valid user that is not a collaborator is removed.

GitHub API docs:https://developer.github.com/v3/repos/collaborators/#remove-collaborator

func (*RepositoriesService)RemovePullRequestReviewEnforcement ¶

func (s *RepositoriesService) RemovePullRequestReviewEnforcement(ctxcontext.Context, owner, repo, branchstring) (*Response,error)

RemovePullRequestReviewEnforcement removes pull request enforcement of a protected branch.

GitHub API docs:https://developer.github.com/v3/repos/branches/#remove-pull-request-review-enforcement-of-protected-branch

func (*RepositoriesService)ReplaceAllTopics ¶

func (s *RepositoriesService) ReplaceAllTopics(ctxcontext.Context, owner, repostring, topics []string) ([]string, *Response,error)

ReplaceAllTopics replaces topics for a repository.

GitHub API docs:https://developer.github.com/v3/repos/#replace-all-topics-for-a-repository

func (*RepositoriesService)ReplaceAppRestrictions ¶

func (s *RepositoriesService) ReplaceAppRestrictions(ctxcontext.Context, owner, repo, branchstring, slug []string) ([]*App, *Response,error)

ReplaceAppRestrictions replaces the apps that have push access to a given protected branch.It removes all apps that previously had push access and grants push access to the new list of apps.It requires the Github apps to have `write` access to the `content` permission.

Note: The list of users, apps, and teams in total is limited to 100 items.

GitHub API docs:https://developer.github.com/v3/repos/branches/#replace-app-restrictions-of-protected-branch

func (*RepositoriesService)RequestPageBuild ¶

func (s *RepositoriesService) RequestPageBuild(ctxcontext.Context, owner, repostring) (*PagesBuild, *Response,error)

RequestPageBuild requests a build of a GitHub Pages site without needing to push new commit.

GitHub API docs:https://developer.github.com/v3/repos/pages/#request-a-page-build

func (*RepositoriesService)RequireSignaturesOnProtectedBranch ¶

func (s *RepositoriesService) RequireSignaturesOnProtectedBranch(ctxcontext.Context, owner, repo, branchstring) (*SignaturesProtectedBranch, *Response,error)

RequireSignaturesOnProtectedBranch makes signed commits required on a protected branch.It requires admin access and branch protection to be enabled.

GitHub API docs:https://developer.github.com/v3/repos/branches/#add-required-signatures-of-protected-branch

func (*RepositoriesService)TestHook ¶

func (s *RepositoriesService) TestHook(ctxcontext.Context, owner, repostring, idint64) (*Response,error)

TestHook triggers a test Hook by github.

GitHub API docs:https://developer.github.com/v3/repos/hooks/#test-a-push-hook

func (*RepositoriesService)Transfer ¶

func (s *RepositoriesService) Transfer(ctxcontext.Context, owner, repostring, transferTransferRequest) (*Repository, *Response,error)

Transfer transfers a repository from one account or organization to another.

This method might return an *AcceptedError and a status code of202. This is because this is the status that GitHub returns to signify thatit has now scheduled the transfer of the repository in a background task.A follow up request, after a delay of a second or so, should resultin a successful request.

GitHub API docs:https://developer.github.com/v3/repos/#transfer-a-repository

func (*RepositoriesService)UpdateBranchProtection ¶

func (s *RepositoriesService) UpdateBranchProtection(ctxcontext.Context, owner, repo, branchstring, preq *ProtectionRequest) (*Protection, *Response,error)

UpdateBranchProtection updates the protection of a given branch.

GitHub API docs:https://developer.github.com/v3/repos/branches/#update-branch-protection

func (*RepositoriesService)UpdateComment ¶

func (s *RepositoriesService) UpdateComment(ctxcontext.Context, owner, repostring, idint64, comment *RepositoryComment) (*RepositoryComment, *Response,error)

UpdateComment updates the body of a single comment.

GitHub API docs:https://developer.github.com/v3/repos/comments/#update-a-commit-comment

func (*RepositoriesService)UpdateFile ¶

func (s *RepositoriesService) UpdateFile(ctxcontext.Context, owner, repo, pathstring, opts *RepositoryContentFileOptions) (*RepositoryContentResponse, *Response,error)

UpdateFile updates a file in a repository at the given path and returns thecommit and file metadata. Requires the blob SHA of the file being updated.

GitHub API docs:https://developer.github.com/v3/repos/contents/#update-a-file

func (*RepositoriesService)UpdateInvitation ¶

func (s *RepositoriesService) UpdateInvitation(ctxcontext.Context, owner, repostring, invitationIDint64, permissionsstring) (*RepositoryInvitation, *Response,error)

UpdateInvitation updates the permissions associated with a repositoryinvitation.

permissions represents the permissions that the associated user will haveon the repository. Possible values are: "read", "write", "admin".

GitHub API docs:https://developer.github.com/v3/repos/invitations/#update-a-repository-invitation

func (*RepositoriesService)UpdatePreReceiveHook ¶

func (s *RepositoriesService) UpdatePreReceiveHook(ctxcontext.Context, owner, repostring, idint64, hook *PreReceiveHook) (*PreReceiveHook, *Response,error)

UpdatePreReceiveHook updates a specified pre-receive hook.

GitHub API docs:https://developer.github.com/enterprise/2.13/v3/repos/pre_receive_hooks/#update-pre-receive-hook-enforcement

func (*RepositoriesService)UpdatePullRequestReviewEnforcement ¶

func (s *RepositoriesService) UpdatePullRequestReviewEnforcement(ctxcontext.Context, owner, repo, branchstring, patch *PullRequestReviewsEnforcementUpdate) (*PullRequestReviewsEnforcement, *Response,error)

UpdatePullRequestReviewEnforcement patches pull request review enforcement of a protected branch.It requires admin access and branch protection to be enabled.

GitHub API docs:https://developer.github.com/v3/repos/branches/#update-pull-request-review-enforcement-of-protected-branch

func (*RepositoriesService)UpdateRequiredStatusChecks ¶

func (s *RepositoriesService) UpdateRequiredStatusChecks(ctxcontext.Context, owner, repo, branchstring, sreq *RequiredStatusChecksRequest) (*RequiredStatusChecks, *Response,error)

UpdateRequiredStatusChecks updates the required status checks for a given protected branch.

GitHub API docs:https://developer.github.com/v3/repos/branches/#update-required-status-checks-of-protected-branch

func (*RepositoriesService)UploadReleaseAsset ¶

func (s *RepositoriesService) UploadReleaseAsset(ctxcontext.Context, owner, repostring, idint64, opts *UploadOptions, file *os.File) (*ReleaseAsset, *Response,error)

UploadReleaseAsset creates an asset by uploading a file into a release repository.To upload assets that cannot be represented by an os.File, call NewUploadRequest directly.

GitHub API docs:https://developer.github.com/v3/repos/releases/#upload-a-release-asset

typeRepository ¶

type Repository struct {ID                  *int64           `json:"id,omitempty"`NodeID              *string          `json:"node_id,omitempty"`Owner               *User            `json:"owner,omitempty"`Name                *string          `json:"name,omitempty"`FullName            *string          `json:"full_name,omitempty"`Description         *string          `json:"description,omitempty"`Homepage            *string          `json:"homepage,omitempty"`CodeOfConduct       *CodeOfConduct   `json:"code_of_conduct,omitempty"`DefaultBranch       *string          `json:"default_branch,omitempty"`MasterBranch        *string          `json:"master_branch,omitempty"`CreatedAt           *Timestamp       `json:"created_at,omitempty"`PushedAt            *Timestamp       `json:"pushed_at,omitempty"`UpdatedAt           *Timestamp       `json:"updated_at,omitempty"`HTMLURL             *string          `json:"html_url,omitempty"`CloneURL            *string          `json:"clone_url,omitempty"`GitURL              *string          `json:"git_url,omitempty"`MirrorURL           *string          `json:"mirror_url,omitempty"`SSHURL              *string          `json:"ssh_url,omitempty"`SVNURL              *string          `json:"svn_url,omitempty"`Language            *string          `json:"language,omitempty"`Fork                *bool            `json:"fork,omitempty"`ForksCount          *int             `json:"forks_count,omitempty"`NetworkCount        *int             `json:"network_count,omitempty"`OpenIssuesCount     *int             `json:"open_issues_count,omitempty"`StargazersCount     *int             `json:"stargazers_count,omitempty"`SubscribersCount    *int             `json:"subscribers_count,omitempty"`WatchersCount       *int             `json:"watchers_count,omitempty"`Size                *int             `json:"size,omitempty"`AutoInit            *bool            `json:"auto_init,omitempty"`Parent              *Repository      `json:"parent,omitempty"`Source              *Repository      `json:"source,omitempty"`TemplateRepository  *Repository      `json:"template_repository,omitempty"`Organization        *Organization    `json:"organization,omitempty"`Permissions         *map[string]bool `json:"permissions,omitempty"`AllowRebaseMerge    *bool            `json:"allow_rebase_merge,omitempty"`AllowSquashMerge    *bool            `json:"allow_squash_merge,omitempty"`AllowMergeCommit    *bool            `json:"allow_merge_commit,omitempty"`DeleteBranchOnMerge *bool            `json:"delete_branch_on_merge,omitempty"`Topics              []string         `json:"topics,omitempty"`Archived            *bool            `json:"archived,omitempty"`Disabled            *bool            `json:"disabled,omitempty"`// Only provided when using RepositoriesService.Get while in previewLicense *License `json:"license,omitempty"`// Additional mutable fields when creating and editing a repositoryPrivate           *bool   `json:"private,omitempty"`HasIssues         *bool   `json:"has_issues,omitempty"`HasWiki           *bool   `json:"has_wiki,omitempty"`HasPages          *bool   `json:"has_pages,omitempty"`HasProjects       *bool   `json:"has_projects,omitempty"`HasDownloads      *bool   `json:"has_downloads,omitempty"`IsTemplate        *bool   `json:"is_template,omitempty"`LicenseTemplate   *string `json:"license_template,omitempty"`GitignoreTemplate *string `json:"gitignore_template,omitempty"`// Creating an organization repository. Required for non-owners.TeamID *int64 `json:"team_id,omitempty"`// API URLsURL              *string `json:"url,omitempty"`ArchiveURL       *string `json:"archive_url,omitempty"`AssigneesURL     *string `json:"assignees_url,omitempty"`BlobsURL         *string `json:"blobs_url,omitempty"`BranchesURL      *string `json:"branches_url,omitempty"`CollaboratorsURL *string `json:"collaborators_url,omitempty"`CommentsURL      *string `json:"comments_url,omitempty"`CommitsURL       *string `json:"commits_url,omitempty"`CompareURL       *string `json:"compare_url,omitempty"`ContentsURL      *string `json:"contents_url,omitempty"`ContributorsURL  *string `json:"contributors_url,omitempty"`DeploymentsURL   *string `json:"deployments_url,omitempty"`DownloadsURL     *string `json:"downloads_url,omitempty"`EventsURL        *string `json:"events_url,omitempty"`ForksURL         *string `json:"forks_url,omitempty"`GitCommitsURL    *string `json:"git_commits_url,omitempty"`GitRefsURL       *string `json:"git_refs_url,omitempty"`GitTagsURL       *string `json:"git_tags_url,omitempty"`HooksURL         *string `json:"hooks_url,omitempty"`IssueCommentURL  *string `json:"issue_comment_url,omitempty"`IssueEventsURL   *string `json:"issue_events_url,omitempty"`IssuesURL        *string `json:"issues_url,omitempty"`KeysURL          *string `json:"keys_url,omitempty"`LabelsURL        *string `json:"labels_url,omitempty"`LanguagesURL     *string `json:"languages_url,omitempty"`MergesURL        *string `json:"merges_url,omitempty"`MilestonesURL    *string `json:"milestones_url,omitempty"`NotificationsURL *string `json:"notifications_url,omitempty"`PullsURL         *string `json:"pulls_url,omitempty"`ReleasesURL      *string `json:"releases_url,omitempty"`StargazersURL    *string `json:"stargazers_url,omitempty"`StatusesURL      *string `json:"statuses_url,omitempty"`SubscribersURL   *string `json:"subscribers_url,omitempty"`SubscriptionURL  *string `json:"subscription_url,omitempty"`TagsURL          *string `json:"tags_url,omitempty"`TreesURL         *string `json:"trees_url,omitempty"`TeamsURL         *string `json:"teams_url,omitempty"`// TextMatches is only populated from search results that request text matches// See: search.go andhttps://developer.github.com/v3/search/#text-match-metadataTextMatches []TextMatch `json:"text_matches,omitempty"`}

Repository represents a GitHub repository.

func (*Repository)GetAllowMergeCommit ¶

func (r *Repository) GetAllowMergeCommit()bool

GetAllowMergeCommit returns the AllowMergeCommit field if it's non-nil, zero value otherwise.

func (*Repository)GetAllowRebaseMerge ¶

func (r *Repository) GetAllowRebaseMerge()bool

GetAllowRebaseMerge returns the AllowRebaseMerge field if it's non-nil, zero value otherwise.

func (*Repository)GetAllowSquashMerge ¶

func (r *Repository) GetAllowSquashMerge()bool

GetAllowSquashMerge returns the AllowSquashMerge field if it's non-nil, zero value otherwise.

func (*Repository)GetArchiveURL ¶

func (r *Repository) GetArchiveURL()string

GetArchiveURL returns the ArchiveURL field if it's non-nil, zero value otherwise.

func (*Repository)GetArchived ¶

func (r *Repository) GetArchived()bool

GetArchived returns the Archived field if it's non-nil, zero value otherwise.

func (*Repository)GetAssigneesURL ¶

func (r *Repository) GetAssigneesURL()string

GetAssigneesURL returns the AssigneesURL field if it's non-nil, zero value otherwise.

func (*Repository)GetAutoInit ¶

func (r *Repository) GetAutoInit()bool

GetAutoInit returns the AutoInit field if it's non-nil, zero value otherwise.

func (*Repository)GetBlobsURL ¶

func (r *Repository) GetBlobsURL()string

GetBlobsURL returns the BlobsURL field if it's non-nil, zero value otherwise.

func (*Repository)GetBranchesURL ¶

func (r *Repository) GetBranchesURL()string

GetBranchesURL returns the BranchesURL field if it's non-nil, zero value otherwise.

func (*Repository)GetCloneURL ¶

func (r *Repository) GetCloneURL()string

GetCloneURL returns the CloneURL field if it's non-nil, zero value otherwise.

func (*Repository)GetCodeOfConduct ¶

func (r *Repository) GetCodeOfConduct() *CodeOfConduct

GetCodeOfConduct returns the CodeOfConduct field.

func (*Repository)GetCollaboratorsURL ¶

func (r *Repository) GetCollaboratorsURL()string

GetCollaboratorsURL returns the CollaboratorsURL field if it's non-nil, zero value otherwise.

func (*Repository)GetCommentsURL ¶

func (r *Repository) GetCommentsURL()string

GetCommentsURL returns the CommentsURL field if it's non-nil, zero value otherwise.

func (*Repository)GetCommitsURL ¶

func (r *Repository) GetCommitsURL()string

GetCommitsURL returns the CommitsURL field if it's non-nil, zero value otherwise.

func (*Repository)GetCompareURL ¶

func (r *Repository) GetCompareURL()string

GetCompareURL returns the CompareURL field if it's non-nil, zero value otherwise.

func (*Repository)GetContentsURL ¶

func (r *Repository) GetContentsURL()string

GetContentsURL returns the ContentsURL field if it's non-nil, zero value otherwise.

func (*Repository)GetContributorsURL ¶

func (r *Repository) GetContributorsURL()string

GetContributorsURL returns the ContributorsURL field if it's non-nil, zero value otherwise.

func (*Repository)GetCreatedAt ¶

func (r *Repository) GetCreatedAt()Timestamp

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*Repository)GetDefaultBranch ¶

func (r *Repository) GetDefaultBranch()string

GetDefaultBranch returns the DefaultBranch field if it's non-nil, zero value otherwise.

func (*Repository)GetDeleteBranchOnMerge ¶added inv29.0.3

func (r *Repository) GetDeleteBranchOnMerge()bool

GetDeleteBranchOnMerge returns the DeleteBranchOnMerge field if it's non-nil, zero value otherwise.

func (*Repository)GetDeploymentsURL ¶

func (r *Repository) GetDeploymentsURL()string

GetDeploymentsURL returns the DeploymentsURL field if it's non-nil, zero value otherwise.

func (*Repository)GetDescription ¶

func (r *Repository) GetDescription()string

GetDescription returns the Description field if it's non-nil, zero value otherwise.

func (*Repository)GetDisabled ¶

func (r *Repository) GetDisabled()bool

GetDisabled returns the Disabled field if it's non-nil, zero value otherwise.

func (*Repository)GetDownloadsURL ¶

func (r *Repository) GetDownloadsURL()string

GetDownloadsURL returns the DownloadsURL field if it's non-nil, zero value otherwise.

func (*Repository)GetEventsURL ¶

func (r *Repository) GetEventsURL()string

GetEventsURL returns the EventsURL field if it's non-nil, zero value otherwise.

func (*Repository)GetFork ¶

func (r *Repository) GetFork()bool

GetFork returns the Fork field if it's non-nil, zero value otherwise.

func (*Repository)GetForksCount ¶

func (r *Repository) GetForksCount()int

GetForksCount returns the ForksCount field if it's non-nil, zero value otherwise.

func (*Repository)GetForksURL ¶

func (r *Repository) GetForksURL()string

GetForksURL returns the ForksURL field if it's non-nil, zero value otherwise.

func (*Repository)GetFullName ¶

func (r *Repository) GetFullName()string

GetFullName returns the FullName field if it's non-nil, zero value otherwise.

func (*Repository)GetGitCommitsURL ¶

func (r *Repository) GetGitCommitsURL()string

GetGitCommitsURL returns the GitCommitsURL field if it's non-nil, zero value otherwise.

func (*Repository)GetGitRefsURL ¶

func (r *Repository) GetGitRefsURL()string

GetGitRefsURL returns the GitRefsURL field if it's non-nil, zero value otherwise.

func (*Repository)GetGitTagsURL ¶

func (r *Repository) GetGitTagsURL()string

GetGitTagsURL returns the GitTagsURL field if it's non-nil, zero value otherwise.

func (*Repository)GetGitURL ¶

func (r *Repository) GetGitURL()string

GetGitURL returns the GitURL field if it's non-nil, zero value otherwise.

func (*Repository)GetGitignoreTemplate ¶

func (r *Repository) GetGitignoreTemplate()string

GetGitignoreTemplate returns the GitignoreTemplate field if it's non-nil, zero value otherwise.

func (*Repository)GetHTMLURL ¶

func (r *Repository) GetHTMLURL()string

GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.

func (*Repository)GetHasDownloads ¶

func (r *Repository) GetHasDownloads()bool

GetHasDownloads returns the HasDownloads field if it's non-nil, zero value otherwise.

func (*Repository)GetHasIssues ¶

func (r *Repository) GetHasIssues()bool

GetHasIssues returns the HasIssues field if it's non-nil, zero value otherwise.

func (*Repository)GetHasPages ¶

func (r *Repository) GetHasPages()bool

GetHasPages returns the HasPages field if it's non-nil, zero value otherwise.

func (*Repository)GetHasProjects ¶

func (r *Repository) GetHasProjects()bool

GetHasProjects returns the HasProjects field if it's non-nil, zero value otherwise.

func (*Repository)GetHasWiki ¶

func (r *Repository) GetHasWiki()bool

GetHasWiki returns the HasWiki field if it's non-nil, zero value otherwise.

func (*Repository)GetHomepage ¶

func (r *Repository) GetHomepage()string

GetHomepage returns the Homepage field if it's non-nil, zero value otherwise.

func (*Repository)GetHooksURL ¶

func (r *Repository) GetHooksURL()string

GetHooksURL returns the HooksURL field if it's non-nil, zero value otherwise.

func (*Repository)GetID ¶

func (r *Repository) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*Repository)GetIsTemplate ¶

func (r *Repository) GetIsTemplate()bool

GetIsTemplate returns the IsTemplate field if it's non-nil, zero value otherwise.

func (*Repository)GetIssueCommentURL ¶

func (r *Repository) GetIssueCommentURL()string

GetIssueCommentURL returns the IssueCommentURL field if it's non-nil, zero value otherwise.

func (*Repository)GetIssueEventsURL ¶

func (r *Repository) GetIssueEventsURL()string

GetIssueEventsURL returns the IssueEventsURL field if it's non-nil, zero value otherwise.

func (*Repository)GetIssuesURL ¶

func (r *Repository) GetIssuesURL()string

GetIssuesURL returns the IssuesURL field if it's non-nil, zero value otherwise.

func (*Repository)GetKeysURL ¶

func (r *Repository) GetKeysURL()string

GetKeysURL returns the KeysURL field if it's non-nil, zero value otherwise.

func (*Repository)GetLabelsURL ¶

func (r *Repository) GetLabelsURL()string

GetLabelsURL returns the LabelsURL field if it's non-nil, zero value otherwise.

func (*Repository)GetLanguage ¶

func (r *Repository) GetLanguage()string

GetLanguage returns the Language field if it's non-nil, zero value otherwise.

func (*Repository)GetLanguagesURL ¶

func (r *Repository) GetLanguagesURL()string

GetLanguagesURL returns the LanguagesURL field if it's non-nil, zero value otherwise.

func (*Repository)GetLicense ¶

func (r *Repository) GetLicense() *License

GetLicense returns the License field.

func (*Repository)GetLicenseTemplate ¶

func (r *Repository) GetLicenseTemplate()string

GetLicenseTemplate returns the LicenseTemplate field if it's non-nil, zero value otherwise.

func (*Repository)GetMasterBranch ¶

func (r *Repository) GetMasterBranch()string

GetMasterBranch returns the MasterBranch field if it's non-nil, zero value otherwise.

func (*Repository)GetMergesURL ¶

func (r *Repository) GetMergesURL()string

GetMergesURL returns the MergesURL field if it's non-nil, zero value otherwise.

func (*Repository)GetMilestonesURL ¶

func (r *Repository) GetMilestonesURL()string

GetMilestonesURL returns the MilestonesURL field if it's non-nil, zero value otherwise.

func (*Repository)GetMirrorURL ¶

func (r *Repository) GetMirrorURL()string

GetMirrorURL returns the MirrorURL field if it's non-nil, zero value otherwise.

func (*Repository)GetName ¶

func (r *Repository) GetName()string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (*Repository)GetNetworkCount ¶

func (r *Repository) GetNetworkCount()int

GetNetworkCount returns the NetworkCount field if it's non-nil, zero value otherwise.

func (*Repository)GetNodeID ¶

func (r *Repository) GetNodeID()string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*Repository)GetNotificationsURL ¶

func (r *Repository) GetNotificationsURL()string

GetNotificationsURL returns the NotificationsURL field if it's non-nil, zero value otherwise.

func (*Repository)GetOpenIssuesCount ¶

func (r *Repository) GetOpenIssuesCount()int

GetOpenIssuesCount returns the OpenIssuesCount field if it's non-nil, zero value otherwise.

func (*Repository)GetOrganization ¶

func (r *Repository) GetOrganization() *Organization

GetOrganization returns the Organization field.

func (*Repository)GetOwner ¶

func (r *Repository) GetOwner() *User

GetOwner returns the Owner field.

func (*Repository)GetParent ¶

func (r *Repository) GetParent() *Repository

GetParent returns the Parent field.

func (*Repository)GetPermissions ¶

func (r *Repository) GetPermissions() map[string]bool

GetPermissions returns the Permissions field if it's non-nil, zero value otherwise.

func (*Repository)GetPrivate ¶

func (r *Repository) GetPrivate()bool

GetPrivate returns the Private field if it's non-nil, zero value otherwise.

func (*Repository)GetPullsURL ¶

func (r *Repository) GetPullsURL()string

GetPullsURL returns the PullsURL field if it's non-nil, zero value otherwise.

func (*Repository)GetPushedAt ¶

func (r *Repository) GetPushedAt()Timestamp

GetPushedAt returns the PushedAt field if it's non-nil, zero value otherwise.

func (*Repository)GetReleasesURL ¶

func (r *Repository) GetReleasesURL()string

GetReleasesURL returns the ReleasesURL field if it's non-nil, zero value otherwise.

func (*Repository)GetSSHURL ¶

func (r *Repository) GetSSHURL()string

GetSSHURL returns the SSHURL field if it's non-nil, zero value otherwise.

func (*Repository)GetSVNURL ¶

func (r *Repository) GetSVNURL()string

GetSVNURL returns the SVNURL field if it's non-nil, zero value otherwise.

func (*Repository)GetSize ¶

func (r *Repository) GetSize()int

GetSize returns the Size field if it's non-nil, zero value otherwise.

func (*Repository)GetSource ¶

func (r *Repository) GetSource() *Repository

GetSource returns the Source field.

func (*Repository)GetStargazersCount ¶

func (r *Repository) GetStargazersCount()int

GetStargazersCount returns the StargazersCount field if it's non-nil, zero value otherwise.

func (*Repository)GetStargazersURL ¶

func (r *Repository) GetStargazersURL()string

GetStargazersURL returns the StargazersURL field if it's non-nil, zero value otherwise.

func (*Repository)GetStatusesURL ¶

func (r *Repository) GetStatusesURL()string

GetStatusesURL returns the StatusesURL field if it's non-nil, zero value otherwise.

func (*Repository)GetSubscribersCount ¶

func (r *Repository) GetSubscribersCount()int

GetSubscribersCount returns the SubscribersCount field if it's non-nil, zero value otherwise.

func (*Repository)GetSubscribersURL ¶

func (r *Repository) GetSubscribersURL()string

GetSubscribersURL returns the SubscribersURL field if it's non-nil, zero value otherwise.

func (*Repository)GetSubscriptionURL ¶

func (r *Repository) GetSubscriptionURL()string

GetSubscriptionURL returns the SubscriptionURL field if it's non-nil, zero value otherwise.

func (*Repository)GetTagsURL ¶

func (r *Repository) GetTagsURL()string

GetTagsURL returns the TagsURL field if it's non-nil, zero value otherwise.

func (*Repository)GetTeamID ¶

func (r *Repository) GetTeamID()int64

GetTeamID returns the TeamID field if it's non-nil, zero value otherwise.

func (*Repository)GetTeamsURL ¶

func (r *Repository) GetTeamsURL()string

GetTeamsURL returns the TeamsURL field if it's non-nil, zero value otherwise.

func (*Repository)GetTemplateRepository ¶

func (r *Repository) GetTemplateRepository() *Repository

GetTemplateRepository returns the TemplateRepository field.

func (*Repository)GetTreesURL ¶

func (r *Repository) GetTreesURL()string

GetTreesURL returns the TreesURL field if it's non-nil, zero value otherwise.

func (*Repository)GetURL ¶

func (r *Repository) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (*Repository)GetUpdatedAt ¶

func (r *Repository) GetUpdatedAt()Timestamp

GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.

func (*Repository)GetWatchersCount ¶

func (r *Repository) GetWatchersCount()int

GetWatchersCount returns the WatchersCount field if it's non-nil, zero value otherwise.

func (Repository)String ¶

func (rRepository) String()string

typeRepositoryAddCollaboratorOptions ¶

type RepositoryAddCollaboratorOptions struct {// Permission specifies the permission to grant the user on this repository.// Possible values are://     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//// Default value is "push". This option is only valid for organization-owned repositories.Permissionstring `json:"permission,omitempty"`}

RepositoryAddCollaboratorOptions specifies the optional parameters to theRepositoriesService.AddCollaborator method.

typeRepositoryComment ¶

type RepositoryComment struct {HTMLURL   *string    `json:"html_url,omitempty"`URL       *string    `json:"url,omitempty"`ID        *int64     `json:"id,omitempty"`NodeID    *string    `json:"node_id,omitempty"`CommitID  *string    `json:"commit_id,omitempty"`User      *User      `json:"user,omitempty"`Reactions *Reactions `json:"reactions,omitempty"`CreatedAt *time.Time `json:"created_at,omitempty"`UpdatedAt *time.Time `json:"updated_at,omitempty"`// User-mutable fieldsBody *string `json:"body"`// User-initialized fieldsPath     *string `json:"path,omitempty"`Position *int    `json:"position,omitempty"`}

RepositoryComment represents a comment for a commit, file, or line in a repository.

func (*RepositoryComment)GetBody ¶

func (r *RepositoryComment) GetBody()string

GetBody returns the Body field if it's non-nil, zero value otherwise.

func (*RepositoryComment)GetCommitID ¶

func (r *RepositoryComment) GetCommitID()string

GetCommitID returns the CommitID field if it's non-nil, zero value otherwise.

func (*RepositoryComment)GetCreatedAt ¶

func (r *RepositoryComment) GetCreatedAt()time.Time

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*RepositoryComment)GetHTMLURL ¶

func (r *RepositoryComment) GetHTMLURL()string

GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.

func (*RepositoryComment)GetID ¶

func (r *RepositoryComment) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*RepositoryComment)GetNodeID ¶

func (r *RepositoryComment) GetNodeID()string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*RepositoryComment)GetPath ¶

func (r *RepositoryComment) GetPath()string

GetPath returns the Path field if it's non-nil, zero value otherwise.

func (*RepositoryComment)GetPosition ¶

func (r *RepositoryComment) GetPosition()int

GetPosition returns the Position field if it's non-nil, zero value otherwise.

func (*RepositoryComment)GetReactions ¶

func (r *RepositoryComment) GetReactions() *Reactions

GetReactions returns the Reactions field.

func (*RepositoryComment)GetURL ¶

func (r *RepositoryComment) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (*RepositoryComment)GetUpdatedAt ¶

func (r *RepositoryComment) GetUpdatedAt()time.Time

GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.

func (*RepositoryComment)GetUser ¶

func (r *RepositoryComment) GetUser() *User

GetUser returns the User field.

func (RepositoryComment)String ¶

func (rRepositoryComment) String()string

typeRepositoryCommit ¶

type RepositoryCommit struct {NodeID      *string  `json:"node_id,omitempty"`SHA         *string  `json:"sha,omitempty"`Commit      *Commit  `json:"commit,omitempty"`Author      *User    `json:"author,omitempty"`Committer   *User    `json:"committer,omitempty"`Parents     []Commit `json:"parents,omitempty"`HTMLURL     *string  `json:"html_url,omitempty"`URL         *string  `json:"url,omitempty"`CommentsURL *string  `json:"comments_url,omitempty"`// Details about how many changes were made in this commit. Only filled in during GetCommit!Stats *CommitStats `json:"stats,omitempty"`// Details about which files, and how this commit touched. Only filled in during GetCommit!Files []CommitFile `json:"files,omitempty"`}

RepositoryCommit represents a commit in a repo.Note that it's wrapping a Commit, so author/committer information is in two places,but contain different details about them: in RepositoryCommit "github details", in Commit - "git details".

func (*RepositoryCommit)GetAuthor ¶

func (r *RepositoryCommit) GetAuthor() *User

GetAuthor returns the Author field.

func (*RepositoryCommit)GetCommentsURL ¶

func (r *RepositoryCommit) GetCommentsURL()string

GetCommentsURL returns the CommentsURL field if it's non-nil, zero value otherwise.

func (*RepositoryCommit)GetCommit ¶

func (r *RepositoryCommit) GetCommit() *Commit

GetCommit returns the Commit field.

func (*RepositoryCommit)GetCommitter ¶

func (r *RepositoryCommit) GetCommitter() *User

GetCommitter returns the Committer field.

func (*RepositoryCommit)GetHTMLURL ¶

func (r *RepositoryCommit) GetHTMLURL()string

GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.

func (*RepositoryCommit)GetNodeID ¶

func (r *RepositoryCommit) GetNodeID()string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*RepositoryCommit)GetSHA ¶

func (r *RepositoryCommit) GetSHA()string

GetSHA returns the SHA field if it's non-nil, zero value otherwise.

func (*RepositoryCommit)GetStats ¶

func (r *RepositoryCommit) GetStats() *CommitStats

GetStats returns the Stats field.

func (*RepositoryCommit)GetURL ¶

func (r *RepositoryCommit) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (RepositoryCommit)String ¶

func (rRepositoryCommit) String()string

typeRepositoryContent ¶

type RepositoryContent struct {Type *string `json:"type,omitempty"`// Target is only set if the type is "symlink" and the target is not a normal file.// If Target is set, Path will be the symlink path.Target   *string `json:"target,omitempty"`Encoding *string `json:"encoding,omitempty"`Size     *int    `json:"size,omitempty"`Name     *string `json:"name,omitempty"`Path     *string `json:"path,omitempty"`// Content contains the actual file content, which may be encoded.// Callers should call GetContent which will decode the content if// necessary.Content     *string `json:"content,omitempty"`SHA         *string `json:"sha,omitempty"`URL         *string `json:"url,omitempty"`GitURL      *string `json:"git_url,omitempty"`HTMLURL     *string `json:"html_url,omitempty"`DownloadURL *string `json:"download_url,omitempty"`}

RepositoryContent represents a file or directory in a github repository.

func (*RepositoryContent)GetContent ¶

func (r *RepositoryContent) GetContent() (string,error)

GetContent returns the content of r, decoding it if necessary.

func (*RepositoryContent)GetDownloadURL ¶

func (r *RepositoryContent) GetDownloadURL()string

GetDownloadURL returns the DownloadURL field if it's non-nil, zero value otherwise.

func (*RepositoryContent)GetEncoding ¶

func (r *RepositoryContent) GetEncoding()string

GetEncoding returns the Encoding field if it's non-nil, zero value otherwise.

func (*RepositoryContent)GetGitURL ¶

func (r *RepositoryContent) GetGitURL()string

GetGitURL returns the GitURL field if it's non-nil, zero value otherwise.

func (*RepositoryContent)GetHTMLURL ¶

func (r *RepositoryContent) GetHTMLURL()string

GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.

func (*RepositoryContent)GetName ¶

func (r *RepositoryContent) GetName()string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (*RepositoryContent)GetPath ¶

func (r *RepositoryContent) GetPath()string

GetPath returns the Path field if it's non-nil, zero value otherwise.

func (*RepositoryContent)GetSHA ¶

func (r *RepositoryContent) GetSHA()string

GetSHA returns the SHA field if it's non-nil, zero value otherwise.

func (*RepositoryContent)GetSize ¶

func (r *RepositoryContent) GetSize()int

GetSize returns the Size field if it's non-nil, zero value otherwise.

func (*RepositoryContent)GetTarget ¶

func (r *RepositoryContent) GetTarget()string

GetTarget returns the Target field if it's non-nil, zero value otherwise.

func (*RepositoryContent)GetType ¶

func (r *RepositoryContent) GetType()string

GetType returns the Type field if it's non-nil, zero value otherwise.

func (*RepositoryContent)GetURL ¶

func (r *RepositoryContent) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (RepositoryContent)String ¶

func (rRepositoryContent) String()string

String converts RepositoryContent to a string. It's primarily for testing.

typeRepositoryContentFileOptions ¶

type RepositoryContentFileOptions struct {Message   *string       `json:"message,omitempty"`Content   []byte        `json:"content,omitempty"`// unencodedSHA       *string       `json:"sha,omitempty"`Branch    *string       `json:"branch,omitempty"`Author    *CommitAuthor `json:"author,omitempty"`Committer *CommitAuthor `json:"committer,omitempty"`}

RepositoryContentFileOptions specifies optional parameters for CreateFile, UpdateFile, and DeleteFile.

func (*RepositoryContentFileOptions)GetAuthor ¶

func (r *RepositoryContentFileOptions) GetAuthor() *CommitAuthor

GetAuthor returns the Author field.

func (*RepositoryContentFileOptions)GetBranch ¶

func (r *RepositoryContentFileOptions) GetBranch()string

GetBranch returns the Branch field if it's non-nil, zero value otherwise.

func (*RepositoryContentFileOptions)GetCommitter ¶

func (r *RepositoryContentFileOptions) GetCommitter() *CommitAuthor

GetCommitter returns the Committer field.

func (*RepositoryContentFileOptions)GetMessage ¶

func (r *RepositoryContentFileOptions) GetMessage()string

GetMessage returns the Message field if it's non-nil, zero value otherwise.

func (*RepositoryContentFileOptions)GetSHA ¶

func (r *RepositoryContentFileOptions) GetSHA()string

GetSHA returns the SHA field if it's non-nil, zero value otherwise.

typeRepositoryContentGetOptions ¶

type RepositoryContentGetOptions struct {Refstring `url:"ref,omitempty"`}

RepositoryContentGetOptions represents an optional ref parameter, which can be a SHA,branch, or tag

typeRepositoryContentResponse ¶

type RepositoryContentResponse struct {Content *RepositoryContent `json:"content,omitempty"`Commit  `json:"commit,omitempty"`}

RepositoryContentResponse holds the parsed response from CreateFile, UpdateFile, and DeleteFile.

func (*RepositoryContentResponse)GetContent ¶

func (r *RepositoryContentResponse) GetContent() *RepositoryContent

GetContent returns the Content field.

typeRepositoryCreateForkOptions ¶

type RepositoryCreateForkOptions struct {// The organization to fork the repository into.Organizationstring `url:"organization,omitempty"`}

RepositoryCreateForkOptions specifies the optional parameters to theRepositoriesService.CreateFork method.

typeRepositoryDispatchEvent ¶

type RepositoryDispatchEvent struct {// Action is the event_type that submitted with the repository dispatch payload. Value can be any string.Action        *string         `json:"action,omitempty"`Branch        *string         `json:"branch,omitempty"`ClientPayloadjson.RawMessage `json:"client_payload,omitempty"`Repo          *Repository     `json:"repository,omitempty"`// The following fields are only populated by Webhook events.Org          *Organization `json:"organization,omitempty"`Sender       *User         `json:"sender,omitempty"`Installation *Installation `json:"installation,omitempty"`}

RepositoryDispatchEvent is triggered when a client sends a POST request to the repository dispatch event endpoint.

GitHub API docs:https://developer.github.com/v3/activity/events/types/#repositorydispatchevent

func (*RepositoryDispatchEvent)GetAction ¶

func (r *RepositoryDispatchEvent) GetAction()string

GetAction returns the Action field if it's non-nil, zero value otherwise.

func (*RepositoryDispatchEvent)GetBranch ¶

func (r *RepositoryDispatchEvent) GetBranch()string

GetBranch returns the Branch field if it's non-nil, zero value otherwise.

func (*RepositoryDispatchEvent)GetInstallation ¶

func (r *RepositoryDispatchEvent) GetInstallation() *Installation

GetInstallation returns the Installation field.

func (*RepositoryDispatchEvent)GetOrg ¶

func (r *RepositoryDispatchEvent) GetOrg() *Organization

GetOrg returns the Org field.

func (*RepositoryDispatchEvent)GetRepo ¶

func (r *RepositoryDispatchEvent) GetRepo() *Repository

GetRepo returns the Repo field.

func (*RepositoryDispatchEvent)GetSender ¶

func (r *RepositoryDispatchEvent) GetSender() *User

GetSender returns the Sender field.

typeRepositoryEvent ¶

type RepositoryEvent struct {// Action is the action that was performed. Possible values are: "created",// "deleted" (organization hooks only), "archived", "unarchived", "edited", "renamed",// "transferred", "publicized", or "privatized".Action *string     `json:"action,omitempty"`Repo   *Repository `json:"repository,omitempty"`// The following fields are only populated by Webhook events.Org          *Organization `json:"organization,omitempty"`Sender       *User         `json:"sender,omitempty"`Installation *Installation `json:"installation,omitempty"`}

RepositoryEvent is triggered when a repository is created, archived, unarchived,renamed, edited, transferred, made public, or made private. Organization hooks arealso trigerred when a repository is deleted.The Webhook event name is "repository".

Events of this type are not visible in timelines, they are only used totrigger organization webhooks.

GitHub API docs:https://developer.github.com/v3/activity/events/types/#repositoryevent

func (*RepositoryEvent)GetAction ¶

func (r *RepositoryEvent) GetAction()string

GetAction returns the Action field if it's non-nil, zero value otherwise.

func (*RepositoryEvent)GetInstallation ¶

func (r *RepositoryEvent) GetInstallation() *Installation

GetInstallation returns the Installation field.

func (*RepositoryEvent)GetOrg ¶

func (r *RepositoryEvent) GetOrg() *Organization

GetOrg returns the Org field.

func (*RepositoryEvent)GetRepo ¶

func (r *RepositoryEvent) GetRepo() *Repository

GetRepo returns the Repo field.

func (*RepositoryEvent)GetSender ¶

func (r *RepositoryEvent) GetSender() *User

GetSender returns the Sender field.

typeRepositoryInvitation ¶

type RepositoryInvitation struct {ID      *int64      `json:"id,omitempty"`Repo    *Repository `json:"repository,omitempty"`Invitee *User       `json:"invitee,omitempty"`Inviter *User       `json:"inviter,omitempty"`// Permissions represents the permissions that the associated user will have// on the repository. Possible values are: "read", "write", "admin".Permissions *string    `json:"permissions,omitempty"`CreatedAt   *Timestamp `json:"created_at,omitempty"`URL         *string    `json:"url,omitempty"`HTMLURL     *string    `json:"html_url,omitempty"`}

RepositoryInvitation represents an invitation to collaborate on a repo.

func (*RepositoryInvitation)GetCreatedAt ¶

func (r *RepositoryInvitation) GetCreatedAt()Timestamp

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*RepositoryInvitation)GetHTMLURL ¶

func (r *RepositoryInvitation) GetHTMLURL()string

GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.

func (*RepositoryInvitation)GetID ¶

func (r *RepositoryInvitation) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*RepositoryInvitation)GetInvitee ¶

func (r *RepositoryInvitation) GetInvitee() *User

GetInvitee returns the Invitee field.

func (*RepositoryInvitation)GetInviter ¶

func (r *RepositoryInvitation) GetInviter() *User

GetInviter returns the Inviter field.

func (*RepositoryInvitation)GetPermissions ¶

func (r *RepositoryInvitation) GetPermissions()string

GetPermissions returns the Permissions field if it's non-nil, zero value otherwise.

func (*RepositoryInvitation)GetRepo ¶

func (r *RepositoryInvitation) GetRepo() *Repository

GetRepo returns the Repo field.

func (*RepositoryInvitation)GetURL ¶

func (r *RepositoryInvitation) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

typeRepositoryLicense ¶

type RepositoryLicense struct {Name *string `json:"name,omitempty"`Path *string `json:"path,omitempty"`SHA         *string  `json:"sha,omitempty"`Size        *int     `json:"size,omitempty"`URL         *string  `json:"url,omitempty"`HTMLURL     *string  `json:"html_url,omitempty"`GitURL      *string  `json:"git_url,omitempty"`DownloadURL *string  `json:"download_url,omitempty"`Type        *string  `json:"type,omitempty"`Content     *string  `json:"content,omitempty"`Encoding    *string  `json:"encoding,omitempty"`License     *License `json:"license,omitempty"`}

RepositoryLicense represents the license for a repository.

func (*RepositoryLicense)GetContent ¶

func (r *RepositoryLicense) GetContent()string

GetContent returns the Content field if it's non-nil, zero value otherwise.

func (*RepositoryLicense)GetDownloadURL ¶

func (r *RepositoryLicense) GetDownloadURL()string

GetDownloadURL returns the DownloadURL field if it's non-nil, zero value otherwise.

func (*RepositoryLicense)GetEncoding ¶

func (r *RepositoryLicense) GetEncoding()string

GetEncoding returns the Encoding field if it's non-nil, zero value otherwise.

func (*RepositoryLicense)GetGitURL ¶

func (r *RepositoryLicense) GetGitURL()string

GetGitURL returns the GitURL field if it's non-nil, zero value otherwise.

func (*RepositoryLicense)GetHTMLURL ¶

func (r *RepositoryLicense) GetHTMLURL()string

GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.

func (*RepositoryLicense)GetLicense ¶

func (r *RepositoryLicense) GetLicense() *License

GetLicense returns the License field.

func (*RepositoryLicense)GetName ¶

func (r *RepositoryLicense) GetName()string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (*RepositoryLicense)GetPath ¶

func (r *RepositoryLicense) GetPath()string

GetPath returns the Path field if it's non-nil, zero value otherwise.

func (*RepositoryLicense)GetSHA ¶

func (r *RepositoryLicense) GetSHA()string

GetSHA returns the SHA field if it's non-nil, zero value otherwise.

func (*RepositoryLicense)GetSize ¶

func (r *RepositoryLicense) GetSize()int

GetSize returns the Size field if it's non-nil, zero value otherwise.

func (*RepositoryLicense)GetType ¶

func (r *RepositoryLicense) GetType()string

GetType returns the Type field if it's non-nil, zero value otherwise.

func (*RepositoryLicense)GetURL ¶

func (r *RepositoryLicense) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (RepositoryLicense)String ¶

func (lRepositoryLicense) String()string

typeRepositoryListAllOptions ¶

type RepositoryListAllOptions struct {// ID of the last repository seenSinceint64 `url:"since,omitempty"`}

RepositoryListAllOptions specifies the optional parameters to theRepositoriesService.ListAll method.

typeRepositoryListByOrgOptions ¶

type RepositoryListByOrgOptions struct {// Type of repositories to list. Possible values are: all, public, private,// forks, sources, member. Default is "all".Typestring `url:"type,omitempty"`// How to sort the repository list. Can be one of created, updated, pushed,// full_name. Default is "created".Sortstring `url:"sort,omitempty"`// Direction in which to sort repositories. Can be one of asc or desc.// Default when using full_name: asc; otherwise desc.Directionstring `url:"direction,omitempty"`ListOptions}

RepositoryListByOrgOptions specifies the optional parameters to theRepositoriesService.ListByOrg method.

typeRepositoryListForksOptions ¶

type RepositoryListForksOptions struct {// How to sort the forks list. Possible values are: newest, oldest,// watchers. Default is "newest".Sortstring `url:"sort,omitempty"`ListOptions}

RepositoryListForksOptions specifies the optional parameters to theRepositoriesService.ListForks method.

typeRepositoryListOptions ¶

type RepositoryListOptions struct {// Visibility of repositories to list. Can be one of all, public, or private.// Default: allVisibilitystring `url:"visibility,omitempty"`// List repos of given affiliation[s].// 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.// Default: owner,collaborator,organization_memberAffiliationstring `url:"affiliation,omitempty"`// Type of repositories to list.// 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.Typestring `url:"type,omitempty"`// How to sort the repository list. Can be one of created, updated, pushed,// full_name. Default: full_nameSortstring `url:"sort,omitempty"`// Direction in which to sort repositories. Can be one of asc or desc.// Default: when using full_name: asc; otherwise descDirectionstring `url:"direction,omitempty"`ListOptions}

RepositoryListOptions specifies the optional parameters to theRepositoriesService.List method.

typeRepositoryMergeRequest ¶

type RepositoryMergeRequest struct {Base          *string `json:"base,omitempty"`Head          *string `json:"head,omitempty"`CommitMessage *string `json:"commit_message,omitempty"`}

RepositoryMergeRequest represents a request to merge a branch in arepository.

func (*RepositoryMergeRequest)GetBase ¶

func (r *RepositoryMergeRequest) GetBase()string

GetBase returns the Base field if it's non-nil, zero value otherwise.

func (*RepositoryMergeRequest)GetCommitMessage ¶

func (r *RepositoryMergeRequest) GetCommitMessage()string

GetCommitMessage returns the CommitMessage field if it's non-nil, zero value otherwise.

func (*RepositoryMergeRequest)GetHead ¶

func (r *RepositoryMergeRequest) GetHead()string

GetHead returns the Head field if it's non-nil, zero value otherwise.

typeRepositoryParticipation ¶

type RepositoryParticipation struct {All   []int `json:"all,omitempty"`Owner []int `json:"owner,omitempty"`}

RepositoryParticipation is the number of commits by everyonewho has contributed to the repository (including the owner)as well as the number of commits by the owner themself.

func (RepositoryParticipation)String ¶

func (rRepositoryParticipation) String()string

typeRepositoryPermissionLevel ¶

type RepositoryPermissionLevel struct {// Possible values: "admin", "write", "read", "none"Permission *string `json:"permission,omitempty"`User *User `json:"user,omitempty"`}

RepositoryPermissionLevel represents the permission level an organizationmember has for a given repository.

func (*RepositoryPermissionLevel)GetPermission ¶

func (r *RepositoryPermissionLevel) GetPermission()string

GetPermission returns the Permission field if it's non-nil, zero value otherwise.

func (*RepositoryPermissionLevel)GetUser ¶

func (r *RepositoryPermissionLevel) GetUser() *User

GetUser returns the User field.

typeRepositoryRelease ¶

type RepositoryRelease struct {TagName         *string `json:"tag_name,omitempty"`TargetCommitish *string `json:"target_commitish,omitempty"`Name            *string `json:"name,omitempty"`Body            *string `json:"body,omitempty"`Draft           *bool   `json:"draft,omitempty"`Prerelease      *bool   `json:"prerelease,omitempty"`// The following fields are not used in CreateRelease or EditRelease:ID          *int64         `json:"id,omitempty"`CreatedAt   *Timestamp     `json:"created_at,omitempty"`PublishedAt *Timestamp     `json:"published_at,omitempty"`URL         *string        `json:"url,omitempty"`HTMLURL     *string        `json:"html_url,omitempty"`AssetsURL   *string        `json:"assets_url,omitempty"`Assets      []ReleaseAsset `json:"assets,omitempty"`UploadURL   *string        `json:"upload_url,omitempty"`ZipballURL  *string        `json:"zipball_url,omitempty"`TarballURL  *string        `json:"tarball_url,omitempty"`Author      *User          `json:"author,omitempty"`NodeID      *string        `json:"node_id,omitempty"`}

RepositoryRelease represents a GitHub release in a repository.

func (*RepositoryRelease)GetAssetsURL ¶

func (r *RepositoryRelease) GetAssetsURL()string

GetAssetsURL returns the AssetsURL field if it's non-nil, zero value otherwise.

func (*RepositoryRelease)GetAuthor ¶

func (r *RepositoryRelease) GetAuthor() *User

GetAuthor returns the Author field.

func (*RepositoryRelease)GetBody ¶

func (r *RepositoryRelease) GetBody()string

GetBody returns the Body field if it's non-nil, zero value otherwise.

func (*RepositoryRelease)GetCreatedAt ¶

func (r *RepositoryRelease) GetCreatedAt()Timestamp

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*RepositoryRelease)GetDraft ¶

func (r *RepositoryRelease) GetDraft()bool

GetDraft returns the Draft field if it's non-nil, zero value otherwise.

func (*RepositoryRelease)GetHTMLURL ¶

func (r *RepositoryRelease) GetHTMLURL()string

GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.

func (*RepositoryRelease)GetID ¶

func (r *RepositoryRelease) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*RepositoryRelease)GetName ¶

func (r *RepositoryRelease) GetName()string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (*RepositoryRelease)GetNodeID ¶

func (r *RepositoryRelease) GetNodeID()string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*RepositoryRelease)GetPrerelease ¶

func (r *RepositoryRelease) GetPrerelease()bool

GetPrerelease returns the Prerelease field if it's non-nil, zero value otherwise.

func (*RepositoryRelease)GetPublishedAt ¶

func (r *RepositoryRelease) GetPublishedAt()Timestamp

GetPublishedAt returns the PublishedAt field if it's non-nil, zero value otherwise.

func (*RepositoryRelease)GetTagName ¶

func (r *RepositoryRelease) GetTagName()string

GetTagName returns the TagName field if it's non-nil, zero value otherwise.

func (*RepositoryRelease)GetTarballURL ¶

func (r *RepositoryRelease) GetTarballURL()string

GetTarballURL returns the TarballURL field if it's non-nil, zero value otherwise.

func (*RepositoryRelease)GetTargetCommitish ¶

func (r *RepositoryRelease) GetTargetCommitish()string

GetTargetCommitish returns the TargetCommitish field if it's non-nil, zero value otherwise.

func (*RepositoryRelease)GetURL ¶

func (r *RepositoryRelease) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (*RepositoryRelease)GetUploadURL ¶

func (r *RepositoryRelease) GetUploadURL()string

GetUploadURL returns the UploadURL field if it's non-nil, zero value otherwise.

func (*RepositoryRelease)GetZipballURL ¶

func (r *RepositoryRelease) GetZipballURL()string

GetZipballURL returns the ZipballURL field if it's non-nil, zero value otherwise.

func (RepositoryRelease)String ¶

func (rRepositoryRelease) String()string

typeRepositoryTag ¶

type RepositoryTag struct {Name       *string `json:"name,omitempty"`Commit     *Commit `json:"commit,omitempty"`ZipballURL *string `json:"zipball_url,omitempty"`TarballURL *string `json:"tarball_url,omitempty"`}

RepositoryTag represents a repository tag.

func (*RepositoryTag)GetCommit ¶

func (r *RepositoryTag) GetCommit() *Commit

GetCommit returns the Commit field.

func (*RepositoryTag)GetName ¶

func (r *RepositoryTag) GetName()string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (*RepositoryTag)GetTarballURL ¶

func (r *RepositoryTag) GetTarballURL()string

GetTarballURL returns the TarballURL field if it's non-nil, zero value otherwise.

func (*RepositoryTag)GetZipballURL ¶

func (r *RepositoryTag) GetZipballURL()string

GetZipballURL returns the ZipballURL field if it's non-nil, zero value otherwise.

typeRepositoryVulnerabilityAlertEvent ¶

type RepositoryVulnerabilityAlertEvent struct {// Action is the action that was performed. Possible values are: "create", "dismiss", "resolve".Action *string `json:"action,omitempty"`//The security alert of the vulnerable dependency.Alert *struct {ID                  *int64     `json:"id,omitempty"`AffectedRange       *string    `json:"affected_range,omitempty"`AffectedPackageName *string    `json:"affected_package_name,omitempty"`ExternalReference   *string    `json:"external_reference,omitempty"`ExternalIdentifier  *string    `json:"external_identifier,omitempty"`FixedIn             *string    `json:"fixed_in,omitempty"`Dismisser           *User      `json:"dismisser,omitempty"`DismissReason       *string    `json:"dismiss_reason,omitempty"`DismissedAt         *Timestamp `json:"dismissed_at,omitempty"`} `json:"alert,omitempty"`}

RepositoryVulnerabilityAlertEvent is triggered when a security alert is created, dismissed, or resolved.

GitHub API docs:https://developer.github.com/v3/activity/events/types/#repositoryvulnerabilityalertevent

func (*RepositoryVulnerabilityAlertEvent)GetAction ¶

func (r *RepositoryVulnerabilityAlertEvent) GetAction()string

GetAction returns the Action field if it's non-nil, zero value otherwise.

typeRequestedAction ¶

type RequestedAction struct {Identifierstring `json:"identifier"`// The integrator reference of the action requested by the user.}

RequestedAction is included in a CheckRunEvent when a user has invoked an action,i.e. when the CheckRunEvent's Action field is "requested_action".

typeRequireLinearHistory ¶added inv29.0.3

type RequireLinearHistory struct {Enabledbool `json:"enabled"`}

RequireLinearHistory represents the configuration to enfore branches with no merge commit.

typeRequiredStatusChecks ¶

type RequiredStatusChecks struct {// Require branches to be up to date before merging. (Required.)Strictbool `json:"strict"`// The list of status checks to require in order to merge into this// branch. (Required; use []string{} instead of nil for empty list.)Contexts []string `json:"contexts"`}

RequiredStatusChecks represents the protection status of a individual branch.

typeRequiredStatusChecksRequest ¶

type RequiredStatusChecksRequest struct {Strict   *bool    `json:"strict,omitempty"`Contexts []string `json:"contexts,omitempty"`}

RequiredStatusChecksRequest represents a request to edit a protected branch's status checks.

func (*RequiredStatusChecksRequest)GetStrict ¶

func (r *RequiredStatusChecksRequest) GetStrict()bool

GetStrict returns the Strict field if it's non-nil, zero value otherwise.

typeResponse ¶

type Response struct {*http.Response// These fields provide the page values for paginating through a set of// results. Any or all of these may be set to the zero value for// responses that are not part of a paginated set, or for which there// are no additional pages.//// These fields support what is called "offset pagination" and should// be used with the ListOptions struct.NextPageintPrevPageintFirstPageintLastPageint// Additionally, some APIs support "cursor pagination" instead of offset.// This means that a token points directly to the next record which// can lead to O(1) performance compared to O(n) performance provided// by offset pagination.//// For APIs that support cursor pagination (such as// TeamsService.ListIDPGroupsInOrganization), the following field// will be populated to point to the next page.//// To use this token, set ListCursorOptions.Page to this value before// calling the endpoint again.NextPageTokenstring// Explicitly specify the Rate type so Rate's String() receiver doesn't// propagate to Response.RateRate}

Response is a GitHub API response. This wraps the standard http.Responsereturned from GitHub and provides convenient access to things likepagination links.

typeReviewers ¶

type Reviewers struct {Users []*User `json:"users,omitempty"`Teams []*Team `json:"teams,omitempty"`}

Reviewers represents reviewers of a pull request.

typeReviewersRequest ¶

type ReviewersRequest struct {NodeID        *string  `json:"node_id,omitempty"`Reviewers     []string `json:"reviewers,omitempty"`TeamReviewers []string `json:"team_reviewers,omitempty"`}

ReviewersRequest specifies users and teams for a pull request review request.

func (*ReviewersRequest)GetNodeID ¶

func (r *ReviewersRequest) GetNodeID()string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

typeScope ¶

type Scopestring

Scope models a GitHub authorization scope.

GitHub API docs:https://developer.github.com/v3/oauth/#scopes

const (ScopeNoneScope = "(no scope)"// REVISIT: is this actually returned, or just a documentation artifact?ScopeUserScope = "user"ScopeUserEmailScope = "user:email"ScopeUserFollowScope = "user:follow"ScopePublicRepoScope = "public_repo"ScopeRepoScope = "repo"ScopeRepoDeploymentScope = "repo_deployment"ScopeRepoStatusScope = "repo:status"ScopeDeleteRepoScope = "delete_repo"ScopeNotificationsScope = "notifications"ScopeGistScope = "gist"ScopeReadRepoHookScope = "read:repo_hook"ScopeWriteRepoHookScope = "write:repo_hook"ScopeAdminRepoHookScope = "admin:repo_hook"ScopeAdminOrgHookScope = "admin:org_hook"ScopeReadOrgScope = "read:org"ScopeWriteOrgScope = "write:org"ScopeAdminOrgScope = "admin:org"ScopeReadPublicKeyScope = "read:public_key"ScopeWritePublicKeyScope = "write:public_key"ScopeAdminPublicKeyScope = "admin:public_key"ScopeReadGPGKeyScope = "read:gpg_key"ScopeWriteGPGKeyScope = "write:gpg_key"ScopeAdminGPGKeyScope = "admin:gpg_key")

This is the set of scopes for GitHub API V3

typeSearchOptions ¶

type SearchOptions struct {// How to sort the search results. Possible values are://   - for repositories: stars, fork, updated//   - for commits: author-date, committer-date//   - for code: indexed//   - for issues: comments, created, updated//   - for users: followers, repositories, joined//// Default is to sort by best match.Sortstring `url:"sort,omitempty"`// Sort order if sort parameter is provided. Possible values are: asc,// desc. Default is desc.Orderstring `url:"order,omitempty"`// Whether to retrieve text match metadata with a queryTextMatchbool `url:"-"`ListOptions}

SearchOptions specifies optional parameters to the SearchService methods.

typeSearchService ¶

type SearchService service

SearchService provides access to the search related functionsin the GitHub API.

Each method takes a query string defining the search keywords and any search qualifiers.For example, when searching issues, the query "gopher is:issue language:go" will searchfor issues containing the word "gopher" in Go repositories. The method call

opts :=  &github.SearchOptions{Sort: "created", Order: "asc"}cl.Search.Issues(ctx, "gopher is:issue language:go", opts)

will search for such issues, sorting by creation date in ascending order(i.e., oldest first).

If query includes multiple conditions, it MUST NOT include "+" as the condition separator.You have to use " " as the separator instead.For example, querying with "language:c++" and "leveldb", then query should be"language:c++ leveldb" but not "language:c+++leveldb".

GitHub API docs:https://developer.github.com/v3/search/

func (*SearchService)Code ¶

func (s *SearchService) Code(ctxcontext.Context, querystring, opts *SearchOptions) (*CodeSearchResult, *Response,error)

Code searches code via various criteria.

GitHub API docs:https://developer.github.com/v3/search/#search-code

func (*SearchService)Commits ¶

func (s *SearchService) Commits(ctxcontext.Context, querystring, opts *SearchOptions) (*CommitsSearchResult, *Response,error)

Commits searches commits via various criteria.

GitHub API docs:https://developer.github.com/v3/search/#search-commits

func (*SearchService)Issues ¶

func (s *SearchService) Issues(ctxcontext.Context, querystring, opts *SearchOptions) (*IssuesSearchResult, *Response,error)

Issues searches issues via various criteria.

GitHub API docs:https://developer.github.com/v3/search/#search-issues

func (*SearchService)Labels ¶

func (s *SearchService) Labels(ctxcontext.Context, repoIDint64, querystring, opts *SearchOptions) (*LabelsSearchResult, *Response,error)

Labels searches labels in the repository with ID repoID via various criteria.

GitHub API docs:https://developer.github.com/v3/search/#search-labels

func (*SearchService)Repositories ¶

func (s *SearchService) Repositories(ctxcontext.Context, querystring, opts *SearchOptions) (*RepositoriesSearchResult, *Response,error)

Repositories searches repositories via various criteria.

GitHub API docs:https://developer.github.com/v3/search/#search-repositories

func (*SearchService)Topics ¶

func (s *SearchService) Topics(ctxcontext.Context, querystring, opts *SearchOptions) (*TopicsSearchResult, *Response,error)

Topics finds topics via various criteria. Results are sorted by best match.Please seehttps://help.github.com/en/articles/searching-topics for moreinformation about search qualifiers.

GitHub API docs:https://developer.github.com/v3/search/#search-topics

func (*SearchService)Users ¶

func (s *SearchService) Users(ctxcontext.Context, querystring, opts *SearchOptions) (*UsersSearchResult, *Response,error)

Users searches users via various criteria.

GitHub API docs:https://developer.github.com/v3/search/#search-users

typeSecret ¶added inv29.0.3

type Secret struct {Namestring    `json:"name"`CreatedAtTimestamp `json:"created_at"`UpdatedAtTimestamp `json:"updated_at"`}

Secret represents a repository action secret.

typeSecrets ¶added inv29.0.3

type Secrets struct {TotalCountint       `json:"total_count"`Secrets    []*Secret `json:"secrets"`}

Secrets represents one item from the ListSecrets response.

typeServiceHook ¶

type ServiceHook struct {Name            *string    `json:"name,omitempty"`Events          []string   `json:"events,omitempty"`SupportedEvents []string   `json:"supported_events,omitempty"`Schema          [][]string `json:"schema,omitempty"`}

ServiceHook represents a hook that has configuration settings, a list ofavailable events, and default events.

func (*ServiceHook)GetName ¶

func (s *ServiceHook) GetName()string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (*ServiceHook)String ¶

func (s *ServiceHook) String()string

typeSignatureVerification ¶

type SignatureVerification struct {Verified  *bool   `json:"verified,omitempty"`Reason    *string `json:"reason,omitempty"`Signature *string `json:"signature,omitempty"`Payload   *string `json:"payload,omitempty"`}

SignatureVerification represents GPG signature verification.

func (*SignatureVerification)GetPayload ¶

func (s *SignatureVerification) GetPayload()string

GetPayload returns the Payload field if it's non-nil, zero value otherwise.

func (*SignatureVerification)GetReason ¶

func (s *SignatureVerification) GetReason()string

GetReason returns the Reason field if it's non-nil, zero value otherwise.

func (*SignatureVerification)GetSignature ¶

func (s *SignatureVerification) GetSignature()string

GetSignature returns the Signature field if it's non-nil, zero value otherwise.

func (*SignatureVerification)GetVerified ¶

func (s *SignatureVerification) GetVerified()bool

GetVerified returns the Verified field if it's non-nil, zero value otherwise.

typeSignaturesProtectedBranch ¶

type SignaturesProtectedBranch struct {URL *string `json:"url,omitempty"`// Commits pushed to matching branches must have verified signatures.Enabled *bool `json:"enabled,omitempty"`}

SignaturesProtectedBranch represents the protection status of an individual branch.

func (*SignaturesProtectedBranch)GetEnabled ¶

func (s *SignaturesProtectedBranch) GetEnabled()bool

GetEnabled returns the Enabled field if it's non-nil, zero value otherwise.

func (*SignaturesProtectedBranch)GetURL ¶

func (s *SignaturesProtectedBranch) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

typeSource ¶

type Source struct {ID    *int64  `json:"id,omitempty"`URL   *string `json:"url,omitempty"`Actor *User   `json:"actor,omitempty"`Type  *string `json:"type,omitempty"`Issue *Issue  `json:"issue,omitempty"`}

Source represents a reference's source.

func (*Source)GetActor ¶

func (s *Source) GetActor() *User

GetActor returns the Actor field.

func (*Source)GetID ¶

func (s *Source) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*Source)GetIssue ¶

func (s *Source) GetIssue() *Issue

GetIssue returns the Issue field.

func (*Source)GetType ¶

func (s *Source) GetType()string

GetType returns the Type field if it's non-nil, zero value otherwise.

func (*Source)GetURL ¶

func (s *Source) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

typeSourceImportAuthor ¶

type SourceImportAuthor struct {ID         *int64  `json:"id,omitempty"`RemoteID   *string `json:"remote_id,omitempty"`RemoteName *string `json:"remote_name,omitempty"`Email      *string `json:"email,omitempty"`Name       *string `json:"name,omitempty"`URL        *string `json:"url,omitempty"`ImportURL  *string `json:"import_url,omitempty"`}

SourceImportAuthor identifies an author imported from a source repository.

GitHub API docs:https://developer.github.com/v3/migration/source_imports/#get-commit-authors

func (*SourceImportAuthor)GetEmail ¶

func (s *SourceImportAuthor) GetEmail()string

GetEmail returns the Email field if it's non-nil, zero value otherwise.

func (*SourceImportAuthor)GetID ¶

func (s *SourceImportAuthor) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*SourceImportAuthor)GetImportURL ¶

func (s *SourceImportAuthor) GetImportURL()string

GetImportURL returns the ImportURL field if it's non-nil, zero value otherwise.

func (*SourceImportAuthor)GetName ¶

func (s *SourceImportAuthor) GetName()string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (*SourceImportAuthor)GetRemoteID ¶

func (s *SourceImportAuthor) GetRemoteID()string

GetRemoteID returns the RemoteID field if it's non-nil, zero value otherwise.

func (*SourceImportAuthor)GetRemoteName ¶

func (s *SourceImportAuthor) GetRemoteName()string

GetRemoteName returns the RemoteName field if it's non-nil, zero value otherwise.

func (*SourceImportAuthor)GetURL ¶

func (s *SourceImportAuthor) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (SourceImportAuthor)String ¶

func (aSourceImportAuthor) String()string

typeStarEvent ¶

type StarEvent struct {// Action is the action that was performed. Possible values are: "created" or "deleted".Action *string `json:"action,omitempty"`// StarredAt is the time the star was created. It will be null for the "deleted" action.StarredAt *Timestamp `json:"starred_at,omitempty"`}

StarEvent is triggered when a star is added or removed from a repository.The Webhook event name is "star".

GitHub API docs:https://developer.github.com/v3/activity/events/types/#starevent

func (*StarEvent)GetAction ¶

func (s *StarEvent) GetAction()string

GetAction returns the Action field if it's non-nil, zero value otherwise.

func (*StarEvent)GetStarredAt ¶

func (s *StarEvent) GetStarredAt()Timestamp

GetStarredAt returns the StarredAt field if it's non-nil, zero value otherwise.

typeStargazer ¶

type Stargazer struct {StarredAt *Timestamp `json:"starred_at,omitempty"`User      *User      `json:"user,omitempty"`}

Stargazer represents a user that has starred a repository.

func (*Stargazer)GetStarredAt ¶

func (s *Stargazer) GetStarredAt()Timestamp

GetStarredAt returns the StarredAt field if it's non-nil, zero value otherwise.

func (*Stargazer)GetUser ¶

func (s *Stargazer) GetUser() *User

GetUser returns the User field.

typeStarredRepository ¶

type StarredRepository struct {StarredAt  *Timestamp  `json:"starred_at,omitempty"`Repository *Repository `json:"repo,omitempty"`}

StarredRepository is returned by ListStarred.

func (*StarredRepository)GetRepository ¶

func (s *StarredRepository) GetRepository() *Repository

GetRepository returns the Repository field.

func (*StarredRepository)GetStarredAt ¶

func (s *StarredRepository) GetStarredAt()Timestamp

GetStarredAt returns the StarredAt field if it's non-nil, zero value otherwise.

typeStatusEvent ¶

type StatusEvent struct {SHA *string `json:"sha,omitempty"`// State is the new state. Possible values are: "pending", "success", "failure", "error".State       *string   `json:"state,omitempty"`Description *string   `json:"description,omitempty"`TargetURL   *string   `json:"target_url,omitempty"`Branches    []*Branch `json:"branches,omitempty"`// The following fields are only populated by Webhook events.ID           *int64            `json:"id,omitempty"`Name         *string           `json:"name,omitempty"`Context      *string           `json:"context,omitempty"`Commit       *RepositoryCommit `json:"commit,omitempty"`CreatedAt    *Timestamp        `json:"created_at,omitempty"`UpdatedAt    *Timestamp        `json:"updated_at,omitempty"`Repo         *Repository       `json:"repository,omitempty"`Sender       *User             `json:"sender,omitempty"`Installation *Installation     `json:"installation,omitempty"`}

StatusEvent is triggered when the status of a Git commit changes.The Webhook event name is "status".

Events of this type are not visible in timelines, they are only used totrigger hooks.

GitHub API docs:https://developer.github.com/v3/activity/events/types/#statusevent

func (*StatusEvent)GetCommit ¶

func (s *StatusEvent) GetCommit() *RepositoryCommit

GetCommit returns the Commit field.

func (*StatusEvent)GetContext ¶

func (s *StatusEvent) GetContext()string

GetContext returns the Context field if it's non-nil, zero value otherwise.

func (*StatusEvent)GetCreatedAt ¶

func (s *StatusEvent) GetCreatedAt()Timestamp

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*StatusEvent)GetDescription ¶

func (s *StatusEvent) GetDescription()string

GetDescription returns the Description field if it's non-nil, zero value otherwise.

func (*StatusEvent)GetID ¶

func (s *StatusEvent) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*StatusEvent)GetInstallation ¶

func (s *StatusEvent) GetInstallation() *Installation

GetInstallation returns the Installation field.

func (*StatusEvent)GetName ¶

func (s *StatusEvent) GetName()string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (*StatusEvent)GetRepo ¶

func (s *StatusEvent) GetRepo() *Repository

GetRepo returns the Repo field.

func (*StatusEvent)GetSHA ¶

func (s *StatusEvent) GetSHA()string

GetSHA returns the SHA field if it's non-nil, zero value otherwise.

func (*StatusEvent)GetSender ¶

func (s *StatusEvent) GetSender() *User

GetSender returns the Sender field.

func (*StatusEvent)GetState ¶

func (s *StatusEvent) GetState()string

GetState returns the State field if it's non-nil, zero value otherwise.

func (*StatusEvent)GetTargetURL ¶

func (s *StatusEvent) GetTargetURL()string

GetTargetURL returns the TargetURL field if it's non-nil, zero value otherwise.

func (*StatusEvent)GetUpdatedAt ¶

func (s *StatusEvent) GetUpdatedAt()Timestamp

GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.

typeSubscription ¶

type Subscription struct {Subscribed *bool      `json:"subscribed,omitempty"`Ignored    *bool      `json:"ignored,omitempty"`Reason     *string    `json:"reason,omitempty"`CreatedAt  *Timestamp `json:"created_at,omitempty"`URL        *string    `json:"url,omitempty"`// only populated for repository subscriptionsRepositoryURL *string `json:"repository_url,omitempty"`// only populated for thread subscriptionsThreadURL *string `json:"thread_url,omitempty"`}

Subscription identifies a repository or thread subscription.

func (*Subscription)GetCreatedAt ¶

func (s *Subscription) GetCreatedAt()Timestamp

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*Subscription)GetIgnored ¶

func (s *Subscription) GetIgnored()bool

GetIgnored returns the Ignored field if it's non-nil, zero value otherwise.

func (*Subscription)GetReason ¶

func (s *Subscription) GetReason()string

GetReason returns the Reason field if it's non-nil, zero value otherwise.

func (*Subscription)GetRepositoryURL ¶

func (s *Subscription) GetRepositoryURL()string

GetRepositoryURL returns the RepositoryURL field if it's non-nil, zero value otherwise.

func (*Subscription)GetSubscribed ¶

func (s *Subscription) GetSubscribed()bool

GetSubscribed returns the Subscribed field if it's non-nil, zero value otherwise.

func (*Subscription)GetThreadURL ¶

func (s *Subscription) GetThreadURL()string

GetThreadURL returns the ThreadURL field if it's non-nil, zero value otherwise.

func (*Subscription)GetURL ¶

func (s *Subscription) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

typeTag ¶

type Tag struct {Tag          *string                `json:"tag,omitempty"`SHA          *string                `json:"sha,omitempty"`URL          *string                `json:"url,omitempty"`Message      *string                `json:"message,omitempty"`Tagger       *CommitAuthor          `json:"tagger,omitempty"`Object       *GitObject             `json:"object,omitempty"`Verification *SignatureVerification `json:"verification,omitempty"`NodeID       *string                `json:"node_id,omitempty"`}

Tag represents a tag object.

func (*Tag)GetMessage ¶

func (t *Tag) GetMessage()string

GetMessage returns the Message field if it's non-nil, zero value otherwise.

func (*Tag)GetNodeID ¶

func (t *Tag) GetNodeID()string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*Tag)GetObject ¶

func (t *Tag) GetObject() *GitObject

GetObject returns the Object field.

func (*Tag)GetSHA ¶

func (t *Tag) GetSHA()string

GetSHA returns the SHA field if it's non-nil, zero value otherwise.

func (*Tag)GetTag ¶

func (t *Tag) GetTag()string

GetTag returns the Tag field if it's non-nil, zero value otherwise.

func (*Tag)GetTagger ¶

func (t *Tag) GetTagger() *CommitAuthor

GetTagger returns the Tagger field.

func (*Tag)GetURL ¶

func (t *Tag) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (*Tag)GetVerification ¶

func (t *Tag) GetVerification() *SignatureVerification

GetVerification returns the Verification field.

typeTeam ¶

type Team struct {ID          *int64  `json:"id,omitempty"`NodeID      *string `json:"node_id,omitempty"`Name        *string `json:"name,omitempty"`Description *string `json:"description,omitempty"`URL         *string `json:"url,omitempty"`Slug        *string `json:"slug,omitempty"`// Permission specifies the default permission for repositories owned by the team.Permission *string `json:"permission,omitempty"`// Privacy identifies the level of privacy this team should have.// Possible values are://     secret - only visible to organization owners and members of this team//     closed - visible to all members of this organization// Default is "secret".Privacy *string `json:"privacy,omitempty"`MembersCount    *int          `json:"members_count,omitempty"`ReposCount      *int          `json:"repos_count,omitempty"`Organization    *Organization `json:"organization,omitempty"`MembersURL      *string       `json:"members_url,omitempty"`RepositoriesURL *string       `json:"repositories_url,omitempty"`Parent          *Team         `json:"parent,omitempty"`// LDAPDN is only available in GitHub Enterprise and when the team// membership is synchronized with LDAP.LDAPDN *string `json:"ldap_dn,omitempty"`}

Team represents a team within a GitHub organization. Teams are used tomanage access to an organization's repositories.

func (*Team)GetDescription ¶

func (t *Team) GetDescription()string

GetDescription returns the Description field if it's non-nil, zero value otherwise.

func (*Team)GetID ¶

func (t *Team) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*Team)GetLDAPDN ¶

func (t *Team) GetLDAPDN()string

GetLDAPDN returns the LDAPDN field if it's non-nil, zero value otherwise.

func (*Team)GetMembersCount ¶

func (t *Team) GetMembersCount()int

GetMembersCount returns the MembersCount field if it's non-nil, zero value otherwise.

func (*Team)GetMembersURL ¶

func (t *Team) GetMembersURL()string

GetMembersURL returns the MembersURL field if it's non-nil, zero value otherwise.

func (*Team)GetName ¶

func (t *Team) GetName()string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (*Team)GetNodeID ¶

func (t *Team) GetNodeID()string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*Team)GetOrganization ¶

func (t *Team) GetOrganization() *Organization

GetOrganization returns the Organization field.

func (*Team)GetParent ¶

func (t *Team) GetParent() *Team

GetParent returns the Parent field.

func (*Team)GetPermission ¶

func (t *Team) GetPermission()string

GetPermission returns the Permission field if it's non-nil, zero value otherwise.

func (*Team)GetPrivacy ¶

func (t *Team) GetPrivacy()string

GetPrivacy returns the Privacy field if it's non-nil, zero value otherwise.

func (*Team)GetReposCount ¶

func (t *Team) GetReposCount()int

GetReposCount returns the ReposCount field if it's non-nil, zero value otherwise.

func (*Team)GetRepositoriesURL ¶

func (t *Team) GetRepositoriesURL()string

GetRepositoriesURL returns the RepositoriesURL field if it's non-nil, zero value otherwise.

func (*Team)GetSlug ¶

func (t *Team) GetSlug()string

GetSlug returns the Slug field if it's non-nil, zero value otherwise.

func (*Team)GetURL ¶

func (t *Team) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (Team)String ¶

func (tTeam) String()string

typeTeamAddEvent ¶

type TeamAddEvent struct {Team *Team       `json:"team,omitempty"`Repo *Repository `json:"repository,omitempty"`// The following fields are only populated by Webhook events.Org          *Organization `json:"organization,omitempty"`Sender       *User         `json:"sender,omitempty"`Installation *Installation `json:"installation,omitempty"`}

TeamAddEvent is triggered when a repository is added to a team.The Webhook event name is "team_add".

Events of this type are not visible in timelines. These events are only usedto trigger hooks.

GitHub API docs:https://developer.github.com/v3/activity/events/types/#teamaddevent

func (*TeamAddEvent)GetInstallation ¶

func (t *TeamAddEvent) GetInstallation() *Installation

GetInstallation returns the Installation field.

func (*TeamAddEvent)GetOrg ¶

func (t *TeamAddEvent) GetOrg() *Organization

GetOrg returns the Org field.

func (*TeamAddEvent)GetRepo ¶

func (t *TeamAddEvent) GetRepo() *Repository

GetRepo returns the Repo field.

func (*TeamAddEvent)GetSender ¶

func (t *TeamAddEvent) GetSender() *User

GetSender returns the Sender field.

func (*TeamAddEvent)GetTeam ¶

func (t *TeamAddEvent) GetTeam() *Team

GetTeam returns the Team field.

typeTeamAddTeamMembershipOptions ¶

type TeamAddTeamMembershipOptions struct {// Role specifies the role the user should have in the team. Possible// values are://     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//// Default value is "member".Rolestring `json:"role,omitempty"`}

TeamAddTeamMembershipOptions specifies the optionalparameters to the TeamsService.AddTeamMembership method.

typeTeamAddTeamRepoOptions ¶

type TeamAddTeamRepoOptions struct {// Permission specifies the permission to grant the team on this repository.// Possible values are://     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 not specified, the team's permission attribute will be used.Permissionstring `json:"permission,omitempty"`}

TeamAddTeamRepoOptions specifies the optional parameters to theTeamsService.AddTeamRepo method.

typeTeamChange ¶

type TeamChange struct {Description *struct {From *string `json:"from,omitempty"`} `json:"description,omitempty"`Name *struct {From *string `json:"from,omitempty"`} `json:"name,omitempty"`Privacy *struct {From *string `json:"from,omitempty"`} `json:"privacy,omitempty"`Repository *struct {Permissions *struct {From *struct {Admin *bool `json:"admin,omitempty"`Pull  *bool `json:"pull,omitempty"`Push  *bool `json:"push,omitempty"`} `json:"from,omitempty"`} `json:"permissions,omitempty"`} `json:"repository,omitempty"`}

TeamChange represents the changes when a team has been edited.

typeTeamDiscussion ¶

type TeamDiscussion struct {Author        *User      `json:"author,omitempty"`Body          *string    `json:"body,omitempty"`BodyHTML      *string    `json:"body_html,omitempty"`BodyVersion   *string    `json:"body_version,omitempty"`CommentsCount *int       `json:"comments_count,omitempty"`CommentsURL   *string    `json:"comments_url,omitempty"`CreatedAt     *Timestamp `json:"created_at,omitempty"`LastEditedAt  *Timestamp `json:"last_edited_at,omitempty"`HTMLURL       *string    `json:"html_url,omitempty"`NodeID        *string    `json:"node_id,omitempty"`Number        *int       `json:"number,omitempty"`Pinned        *bool      `json:"pinned,omitempty"`Private       *bool      `json:"private,omitempty"`TeamURL       *string    `json:"team_url,omitempty"`Title         *string    `json:"title,omitempty"`UpdatedAt     *Timestamp `json:"updated_at,omitempty"`URL           *string    `json:"url,omitempty"`Reactions     *Reactions `json:"reactions,omitempty"`}

TeamDiscussion represents a GitHub dicussion in a team.

func (*TeamDiscussion)GetAuthor ¶

func (t *TeamDiscussion) GetAuthor() *User

GetAuthor returns the Author field.

func (*TeamDiscussion)GetBody ¶

func (t *TeamDiscussion) GetBody()string

GetBody returns the Body field if it's non-nil, zero value otherwise.

func (*TeamDiscussion)GetBodyHTML ¶

func (t *TeamDiscussion) GetBodyHTML()string

GetBodyHTML returns the BodyHTML field if it's non-nil, zero value otherwise.

func (*TeamDiscussion)GetBodyVersion ¶

func (t *TeamDiscussion) GetBodyVersion()string

GetBodyVersion returns the BodyVersion field if it's non-nil, zero value otherwise.

func (*TeamDiscussion)GetCommentsCount ¶

func (t *TeamDiscussion) GetCommentsCount()int

GetCommentsCount returns the CommentsCount field if it's non-nil, zero value otherwise.

func (*TeamDiscussion)GetCommentsURL ¶

func (t *TeamDiscussion) GetCommentsURL()string

GetCommentsURL returns the CommentsURL field if it's non-nil, zero value otherwise.

func (*TeamDiscussion)GetCreatedAt ¶

func (t *TeamDiscussion) GetCreatedAt()Timestamp

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*TeamDiscussion)GetHTMLURL ¶

func (t *TeamDiscussion) GetHTMLURL()string

GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.

func (*TeamDiscussion)GetLastEditedAt ¶

func (t *TeamDiscussion) GetLastEditedAt()Timestamp

GetLastEditedAt returns the LastEditedAt field if it's non-nil, zero value otherwise.

func (*TeamDiscussion)GetNodeID ¶

func (t *TeamDiscussion) GetNodeID()string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*TeamDiscussion)GetNumber ¶

func (t *TeamDiscussion) GetNumber()int

GetNumber returns the Number field if it's non-nil, zero value otherwise.

func (*TeamDiscussion)GetPinned ¶

func (t *TeamDiscussion) GetPinned()bool

GetPinned returns the Pinned field if it's non-nil, zero value otherwise.

func (*TeamDiscussion)GetPrivate ¶

func (t *TeamDiscussion) GetPrivate()bool

GetPrivate returns the Private field if it's non-nil, zero value otherwise.

func (*TeamDiscussion)GetReactions ¶

func (t *TeamDiscussion) GetReactions() *Reactions

GetReactions returns the Reactions field.

func (*TeamDiscussion)GetTeamURL ¶

func (t *TeamDiscussion) GetTeamURL()string

GetTeamURL returns the TeamURL field if it's non-nil, zero value otherwise.

func (*TeamDiscussion)GetTitle ¶

func (t *TeamDiscussion) GetTitle()string

GetTitle returns the Title field if it's non-nil, zero value otherwise.

func (*TeamDiscussion)GetURL ¶

func (t *TeamDiscussion) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (*TeamDiscussion)GetUpdatedAt ¶

func (t *TeamDiscussion) GetUpdatedAt()Timestamp

GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.

func (TeamDiscussion)String ¶

func (dTeamDiscussion) String()string

typeTeamEvent ¶

type TeamEvent struct {Action  *string     `json:"action,omitempty"`Team    *Team       `json:"team,omitempty"`Changes *TeamChange `json:"changes,omitempty"`Repo    *Repository `json:"repository,omitempty"`// The following fields are only populated by Webhook events.Org          *Organization `json:"organization,omitempty"`Sender       *User         `json:"sender,omitempty"`Installation *Installation `json:"installation,omitempty"`}

TeamEvent is triggered when an organization's team is created, modified or deleted.The Webhook event name is "team".

Events of this type are not visible in timelines. These events are only usedto trigger hooks.

GitHub API docs:https://developer.github.com/v3/activity/events/types/#teamevent

func (*TeamEvent)GetAction ¶

func (t *TeamEvent) GetAction()string

GetAction returns the Action field if it's non-nil, zero value otherwise.

func (*TeamEvent)GetChanges ¶

func (t *TeamEvent) GetChanges() *TeamChange

GetChanges returns the Changes field.

func (*TeamEvent)GetInstallation ¶

func (t *TeamEvent) GetInstallation() *Installation

GetInstallation returns the Installation field.

func (*TeamEvent)GetOrg ¶

func (t *TeamEvent) GetOrg() *Organization

GetOrg returns the Org field.

func (*TeamEvent)GetRepo ¶

func (t *TeamEvent) GetRepo() *Repository

GetRepo returns the Repo field.

func (*TeamEvent)GetSender ¶

func (t *TeamEvent) GetSender() *User

GetSender returns the Sender field.

func (*TeamEvent)GetTeam ¶

func (t *TeamEvent) GetTeam() *Team

GetTeam returns the Team field.

typeTeamLDAPMapping ¶

type TeamLDAPMapping struct {ID          *int64  `json:"id,omitempty"`LDAPDN      *string `json:"ldap_dn,omitempty"`URL         *string `json:"url,omitempty"`Name        *string `json:"name,omitempty"`Slug        *string `json:"slug,omitempty"`Description *string `json:"description,omitempty"`Privacy     *string `json:"privacy,omitempty"`Permission  *string `json:"permission,omitempty"`MembersURL      *string `json:"members_url,omitempty"`RepositoriesURL *string `json:"repositories_url,omitempty"`}

TeamLDAPMapping represents the mapping between a GitHub team and an LDAP group.

func (*TeamLDAPMapping)GetDescription ¶

func (t *TeamLDAPMapping) GetDescription()string

GetDescription returns the Description field if it's non-nil, zero value otherwise.

func (*TeamLDAPMapping)GetID ¶

func (t *TeamLDAPMapping) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*TeamLDAPMapping)GetLDAPDN ¶

func (t *TeamLDAPMapping) GetLDAPDN()string

GetLDAPDN returns the LDAPDN field if it's non-nil, zero value otherwise.

func (*TeamLDAPMapping)GetMembersURL ¶

func (t *TeamLDAPMapping) GetMembersURL()string

GetMembersURL returns the MembersURL field if it's non-nil, zero value otherwise.

func (*TeamLDAPMapping)GetName ¶

func (t *TeamLDAPMapping) GetName()string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (*TeamLDAPMapping)GetPermission ¶

func (t *TeamLDAPMapping) GetPermission()string

GetPermission returns the Permission field if it's non-nil, zero value otherwise.

func (*TeamLDAPMapping)GetPrivacy ¶

func (t *TeamLDAPMapping) GetPrivacy()string

GetPrivacy returns the Privacy field if it's non-nil, zero value otherwise.

func (*TeamLDAPMapping)GetRepositoriesURL ¶

func (t *TeamLDAPMapping) GetRepositoriesURL()string

GetRepositoriesURL returns the RepositoriesURL field if it's non-nil, zero value otherwise.

func (*TeamLDAPMapping)GetSlug ¶

func (t *TeamLDAPMapping) GetSlug()string

GetSlug returns the Slug field if it's non-nil, zero value otherwise.

func (*TeamLDAPMapping)GetURL ¶

func (t *TeamLDAPMapping) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (TeamLDAPMapping)String ¶

func (mTeamLDAPMapping) String()string

typeTeamListTeamMembersOptions ¶

type TeamListTeamMembersOptions struct {// Role filters members returned by their role in the team. Possible// values are "all", "member", "maintainer". Default is "all".Rolestring `url:"role,omitempty"`ListOptions}

TeamListTeamMembersOptions specifies the optional parameters to theTeamsService.ListTeamMembers method.

typeTeamProjectOptions ¶

type TeamProjectOptions struct {// Permission specifies the permission to grant to the team for this project.// Possible values are://     "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.//Permission *string `json:"permission,omitempty"`}

TeamProjectOptions specifies the optional parameters to theTeamsService.AddTeamProject method.

func (*TeamProjectOptions)GetPermission ¶

func (t *TeamProjectOptions) GetPermission()string

GetPermission returns the Permission field if it's non-nil, zero value otherwise.

typeTeamsService ¶

type TeamsService service

TeamsService provides access to the team-related functionsin the GitHub API.

GitHub API docs:https://developer.github.com/v3/teams/

func (*TeamsService)AddTeamMembership ¶

func (s *TeamsService) AddTeamMembership(ctxcontext.Context, teamint64, userstring, opts *TeamAddTeamMembershipOptions) (*Membership, *Response,error)

AddTeamMembership adds or invites a user to a team.

In order to add a membership between a user and a team, the authenticateduser must have 'admin' permissions to the team or be an owner of theorganization that the team is associated with.

If the user is already a part of the team's organization (meaning they're onat least one other team in the organization), this endpoint will add theuser to the team.

If the user is completely unaffiliated with the team's organization (meaningthey're on none of the organization's teams), this endpoint will send aninvitation to the user via email. This newly-created membership will be inthe "pending" state until the user accepts the invitation, at which pointthe membership will transition to the "active" state and the user will beadded as a member of the team.

GitHub API docs:https://developer.github.com/v3/teams/members/#add-or-update-team-membership

func (*TeamsService)AddTeamProjectByID ¶added inv29.0.3

func (s *TeamsService) AddTeamProjectByID(ctxcontext.Context, orgID, teamID, projectIDint64, opts *TeamProjectOptions) (*Response,error)

AddTeamProjectByID adds an organization project to a team given the team ID.To add a project to a team or update the team's permission on a project, theauthenticated user must have admin permissions for the project.

GitHub API docs:https://developer.github.com/v3/teams/#add-or-update-team-project

func (*TeamsService)AddTeamProjectBySlug ¶added inv29.0.3

func (s *TeamsService) AddTeamProjectBySlug(ctxcontext.Context, org, slugstring, projectIDint64, opts *TeamProjectOptions) (*Response,error)

AddTeamProjectBySlug adds an organization project to a team given the team slug.To add a project to a team or update the team's permission on a project, theauthenticated user must have admin permissions for the project.

GitHub API docs:https://developer.github.com/v3/teams/#add-or-update-team-project

func (*TeamsService)AddTeamRepoByID ¶added inv29.0.3

func (s *TeamsService) AddTeamRepoByID(ctxcontext.Context, orgID, teamIDint64, owner, repostring, opts *TeamAddTeamRepoOptions) (*Response,error)

AddTeamRepoByID adds a repository to be managed by the specified team given the team ID.The specified repository must be owned by the organization to which the teambelongs, or a direct fork of a repository owned by the organization.

GitHub API docs:https://developer.github.com/v3/teams/#add-team-repo

func (*TeamsService)AddTeamRepoBySlug ¶added inv29.0.3

func (s *TeamsService) AddTeamRepoBySlug(ctxcontext.Context, org, slug, owner, repostring, opts *TeamAddTeamRepoOptions) (*Response,error)

AddTeamRepoBySlug adds a repository to be managed by the specified team given the team slug.The specified repository must be owned by the organization to which the teambelongs, or a direct fork of a repository owned by the organization.

GitHub API docs:https://developer.github.com/v3/teams/#add-team-repo

func (*TeamsService)CreateComment ¶

func (s *TeamsService) CreateComment(ctxcontext.Context, teamIDint64, discsusionNumberint, commentDiscussionComment) (*DiscussionComment, *Response,error)

CreateComment creates a new discussion post on a team discussion.Authenticated user must grant write:discussion scope.

GitHub API docs:https://developer.github.com/v3/teams/discussion_comments/#create-a-comment

func (*TeamsService)CreateDiscussion ¶

func (s *TeamsService) CreateDiscussion(ctxcontext.Context, teamIDint64, discussionTeamDiscussion) (*TeamDiscussion, *Response,error)

CreateDiscussion creates a new discussion post on a team's page.Authenticated user must grant write:discussion scope.

GitHub API docs:https://developer.github.com/v3/teams/discussions/#create-a-discussion

func (*TeamsService)CreateOrUpdateIDPGroupConnections ¶

func (s *TeamsService) CreateOrUpdateIDPGroupConnections(ctxcontext.Context, teamIDstring, optsIDPGroupList) (*IDPGroupList, *Response,error)

CreateOrUpdateIDPGroupConnections creates, updates, or removes a connection between a teamand an IDP group.

GitHub API docs:https://developer.github.com/v3/teams/team_sync/#create-or-update-idp-group-connections

func (*TeamsService)CreateTeam ¶

func (s *TeamsService) CreateTeam(ctxcontext.Context, orgstring, teamNewTeam) (*Team, *Response,error)

CreateTeam creates a new team within an organization.

GitHub API docs:https://developer.github.com/v3/teams/#create-team

func (*TeamsService)DeleteComment ¶

func (s *TeamsService) DeleteComment(ctxcontext.Context, teamIDint64, discussionNumber, commentNumberint) (*Response,error)

DeleteComment deletes a comment on a team discussion.Authenticated user must grant write:discussion scope.

GitHub API docs:https://developer.github.com/v3/teams/discussion_comments/#delete-a-comment

func (*TeamsService)DeleteDiscussion ¶

func (s *TeamsService) DeleteDiscussion(ctxcontext.Context, teamIDint64, discussionNumberint) (*Response,error)

DeleteDiscussion deletes a discussion from team's page.Authenticated user must grant write:discussion scope.

GitHub API docs:https://developer.github.com/v3/teams/discussions/#delete-a-discussion

func (*TeamsService)DeleteTeamByID ¶added inv29.0.3

func (s *TeamsService) DeleteTeamByID(ctxcontext.Context, orgID, teamIDint64) (*Response,error)

DeleteTeamByID deletes a team referenced by ID.

GitHub API docs:https://developer.github.com/v3/teams/#delete-team

func (*TeamsService)DeleteTeamBySlug ¶added inv29.0.3

func (s *TeamsService) DeleteTeamBySlug(ctxcontext.Context, org, slugstring) (*Response,error)

DeleteTeamBySlug deletes a team reference by slug.

GitHub API docs:https://developer.github.com/v3/teams/#delete-team

func (*TeamsService)EditComment ¶

func (s *TeamsService) EditComment(ctxcontext.Context, teamIDint64, discussionNumber, commentNumberint, commentDiscussionComment) (*DiscussionComment, *Response,error)

EditComment edits the body text of a discussion comment.Authenticated user must grant write:discussion scope.User is allowed to edit body of a comment only.

GitHub API docs:https://developer.github.com/v3/teams/discussion_comments/#edit-a-comment

func (*TeamsService)EditDiscussion ¶

func (s *TeamsService) EditDiscussion(ctxcontext.Context, teamIDint64, discussionNumberint, discussionTeamDiscussion) (*TeamDiscussion, *Response,error)

EditDiscussion edits the title and body text of a discussion post.Authenticated user must grant write:discussion scope.User is allowed to change Title and Body of a discussion only.

GitHub API docs:https://developer.github.com/v3/teams/discussions/#edit-a-discussion

func (*TeamsService)EditTeamByID ¶added inv29.0.3

func (s *TeamsService) EditTeamByID(ctxcontext.Context, orgID, teamIDint64, teamNewTeam, removeParentbool) (*Team, *Response,error)

EditTeamByID edits a team, given an organization ID, selected by ID.

GitHub API docs:https://developer.github.com/v3/teams/#edit-team

func (*TeamsService)EditTeamBySlug ¶added inv29.0.3

func (s *TeamsService) EditTeamBySlug(ctxcontext.Context, org, slugstring, teamNewTeam, removeParentbool) (*Team, *Response,error)

EditTeamBySlug edits a team, given an organization name, by slug.

GitHub API docs:https://developer.github.com/v3/teams/#edit-team

func (*TeamsService)GetComment ¶

func (s *TeamsService) GetComment(ctxcontext.Context, teamIDint64, discussionNumber, commentNumberint) (*DiscussionComment, *Response,error)

GetComment gets a specific comment on a team discussion.Authenticated user must grant read:discussion scope.

GitHub API docs:https://developer.github.com/v3/teams/discussion_comments/#get-a-single-comment

func (*TeamsService)GetDiscussion ¶

func (s *TeamsService) GetDiscussion(ctxcontext.Context, teamIDint64, discussionNumberint) (*TeamDiscussion, *Response,error)

GetDiscussion gets a specific discussion on a team's page.Authenticated user must grant read:discussion scope.

GitHub API docs:https://developer.github.com/v3/teams/discussions/#get-a-single-discussion

func (*TeamsService)GetTeamByID ¶added inv29.0.3

func (s *TeamsService) GetTeamByID(ctxcontext.Context, orgID, teamIDint64) (*Team, *Response,error)

GetTeamByID fetches a team, given a specified organization ID, by ID.

GitHub API docs:https://developer.github.com/v3/teams/#get-team-by-name

func (*TeamsService)GetTeamBySlug ¶

func (s *TeamsService) GetTeamBySlug(ctxcontext.Context, org, slugstring) (*Team, *Response,error)

GetTeamBySlug fetches a team, given a specified organization name, by slug.

GitHub API docs:https://developer.github.com/v3/teams/#get-team-by-name

func (*TeamsService)GetTeamMembership ¶

func (s *TeamsService) GetTeamMembership(ctxcontext.Context, teamint64, userstring) (*Membership, *Response,error)

GetTeamMembership returns the membership status for a user in a team.

GitHub API docs:https://developer.github.com/v3/teams/members/#get-team-membership

func (*TeamsService)IsTeamMemberdeprecated

func (s *TeamsService) IsTeamMember(ctxcontext.Context, teamint64, userstring) (bool, *Response,error)

IsTeamMember checks if a user is a member of the specified team.

GitHub API docs:https://developer.github.com/v3/teams/members/#get-team-member

Deprecated: This API has been marked as deprecated in the Github API docs,TeamsService.GetTeamMembership method should be used instead.

func (*TeamsService)IsTeamRepoByID ¶added inv29.0.3

func (s *TeamsService) IsTeamRepoByID(ctxcontext.Context, orgID, teamIDint64, owner, repostring) (*Repository, *Response,error)

IsTeamRepoByID checks if a team, given its ID, manages the specified repository. If therepository is managed by team, a Repository is returned which includes thepermissions team has for that repo.

GitHub API docs:https://developer.github.com/v3/teams/#check-if-a-team-manages-a-repository

func (*TeamsService)IsTeamRepoBySlug ¶added inv29.0.3

func (s *TeamsService) IsTeamRepoBySlug(ctxcontext.Context, org, slug, owner, repostring) (*Repository, *Response,error)

IsTeamRepoBySlug checks if a team, given its slug, manages the specified repository. If therepository is managed by team, a Repository is returned which includes thepermissions team has for that repo.

GitHub API docs:https://developer.github.com/v3/teams/#check-if-a-team-manages-a-repository

func (*TeamsService)ListChildTeamsByParentID ¶added inv29.0.3

func (s *TeamsService) ListChildTeamsByParentID(ctxcontext.Context, orgID, teamIDint64, opts *ListOptions) ([]*Team, *Response,error)

ListChildTeamsByParentID lists child teams for a parent team given parent ID.

GitHub API docs:https://developer.github.com/v3/teams/#list-child-teams

func (*TeamsService)ListChildTeamsByParentSlug ¶added inv29.0.3

func (s *TeamsService) ListChildTeamsByParentSlug(ctxcontext.Context, org, slugstring, opts *ListOptions) ([]*Team, *Response,error)

ListChildTeamsByParentSlug lists child teams for a parent team given parent slug.

GitHub API docs:https://developer.github.com/v3/teams/#list-child-teams

func (*TeamsService)ListComments ¶

func (s *TeamsService) ListComments(ctxcontext.Context, teamIDint64, discussionNumberint, options *DiscussionCommentListOptions) ([]*DiscussionComment, *Response,error)

ListComments lists all comments on a team discussion.Authenticated user must grant read:discussion scope.

GitHub API docs:https://developer.github.com/v3/teams/discussion_comments/#list-comments

func (*TeamsService)ListDiscussions ¶

func (s *TeamsService) ListDiscussions(ctxcontext.Context, teamIDint64, options *DiscussionListOptions) ([]*TeamDiscussion, *Response,error)

ListDiscussions lists all discussions on team's page.Authenticated user must grant read:discussion scope.

GitHub API docs:https://developer.github.com/v3/teams/discussions/#list-discussions

func (*TeamsService)ListIDPGroupsForTeam ¶

func (s *TeamsService) ListIDPGroupsForTeam(ctxcontext.Context, teamIDstring) (*IDPGroupList, *Response,error)

ListIDPGroupsForTeam lists IDP groups connected to a team on GitHub.

GitHub API docs:https://developer.github.com/v3/teams/team_sync/#list-idp-groups-for-a-team

func (*TeamsService)ListIDPGroupsInOrganization ¶

func (s *TeamsService) ListIDPGroupsInOrganization(ctxcontext.Context, orgstring, opts *ListCursorOptions) (*IDPGroupList, *Response,error)

ListIDPGroupsInOrganization lists IDP groups available in an organization.

GitHub API docs:https://developer.github.com/v3/teams/team_sync/#list-idp-groups-in-an-organization

func (*TeamsService)ListPendingTeamInvitations ¶

func (s *TeamsService) ListPendingTeamInvitations(ctxcontext.Context, teamint64, opts *ListOptions) ([]*Invitation, *Response,error)

ListPendingTeamInvitations get pending invitaion list in team.Warning: The API may change without advance notice during the preview period.Preview features are not supported for production use.

GitHub API docs:https://developer.github.com/v3/teams/members/#list-pending-team-invitations

func (*TeamsService)ListTeamMembers ¶

func (s *TeamsService) ListTeamMembers(ctxcontext.Context, teamint64, opts *TeamListTeamMembersOptions) ([]*User, *Response,error)

ListTeamMembers lists all of the users who are members of the specifiedteam.

GitHub API docs:https://developer.github.com/v3/teams/members/#list-team-members

func (*TeamsService)ListTeamProjectsByID ¶added inv29.0.3

func (s *TeamsService) ListTeamProjectsByID(ctxcontext.Context, orgID, teamIDint64) ([]*Project, *Response,error)

ListTeamProjectsByID lists the organization projects for a team given the team ID.

GitHub API docs:https://developer.github.com/v3/teams/#list-team-projects

func (*TeamsService)ListTeamProjectsBySlug ¶added inv29.0.3

func (s *TeamsService) ListTeamProjectsBySlug(ctxcontext.Context, org, slugstring) ([]*Project, *Response,error)

ListTeamProjectsBySlug lists the organization projects for a team given the team slug.

GitHub API docs:https://developer.github.com/v3/teams/#list-team-projects

func (*TeamsService)ListTeamReposByID ¶added inv29.0.3

func (s *TeamsService) ListTeamReposByID(ctxcontext.Context, orgID, teamIDint64, opts *ListOptions) ([]*Repository, *Response,error)

ListTeamReposByID lists the repositories given a team ID that the specified team has access to.

GitHub API docs:https://developer.github.com/v3/teams/#list-team-repos

func (*TeamsService)ListTeamReposBySlug ¶added inv29.0.3

func (s *TeamsService) ListTeamReposBySlug(ctxcontext.Context, org, slugstring, opts *ListOptions) ([]*Repository, *Response,error)

ListTeamReposBySlug lists the repositories given a team slug that the specified team has access to.

GitHub API docs:https://developer.github.com/v3/teams/#list-team-repos

func (*TeamsService)ListTeams ¶

func (s *TeamsService) ListTeams(ctxcontext.Context, orgstring, opts *ListOptions) ([]*Team, *Response,error)

ListTeams lists all of the teams for an organization.

GitHub API docs:https://developer.github.com/v3/teams/#list-teams

Example¶

package mainimport ("context""fmt""github.com/google/go-github/v29/github")func main() {// This example shows how to get a team ID corresponding to a given team name.// Note that authentication is needed here as you are performing a lookup on// an organization's administrative configuration, so you will need to modify// the example to provide an oauth client to github.NewClient() instead of nil.// See the following documentation for more information on how to authenticate// with the client:// https://godoc.org/github.com/google/go-github/github#hdr-Authenticationclient := github.NewClient(nil)teamName := "Developers team"ctx := context.Background()opts := &github.ListOptions{}for {teams, resp, err := client.Teams.ListTeams(ctx, "myOrganization", opts)if err != nil {fmt.Println(err)return}for _, t := range teams {if t.GetName() == teamName {fmt.Printf("Team %q has ID %d\n", teamName, t.GetID())return}}if resp.NextPage == 0 {break}opts.Page = resp.NextPage}fmt.Printf("Team %q was not found\n", teamName)}

func (*TeamsService)ListUserTeams ¶

func (s *TeamsService) ListUserTeams(ctxcontext.Context, opts *ListOptions) ([]*Team, *Response,error)

ListUserTeams lists a user's teamsGitHub API docs:https://developer.github.com/v3/teams/#list-user-teams

func (*TeamsService)RemoveTeamMembership ¶

func (s *TeamsService) RemoveTeamMembership(ctxcontext.Context, teamint64, userstring) (*Response,error)

RemoveTeamMembership removes a user from a team.

GitHub API docs:https://developer.github.com/v3/teams/members/#remove-team-membership

func (*TeamsService)RemoveTeamProjectByID ¶added inv29.0.3

func (s *TeamsService) RemoveTeamProjectByID(ctxcontext.Context, orgID, teamID, projectIDint64) (*Response,error)

RemoveTeamProjectByID removes an organization project from a team given team ID.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 usermust have "read" access to both the team and project, or "admin" access to the teamor project.Note: This endpoint removes the project from the team, but does not delete it.

GitHub API docs:https://developer.github.com/v3/teams/#remove-team-project

func (*TeamsService)RemoveTeamProjectBySlug ¶added inv29.0.3

func (s *TeamsService) RemoveTeamProjectBySlug(ctxcontext.Context, org, slugstring, projectIDint64) (*Response,error)

RemoveTeamProjectBySlug removes an organization project from a team given team slug.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 usermust have "read" access to both the team and project, or "admin" access to the teamor project.Note: This endpoint removes the project from the team, but does not delete it.

GitHub API docs:https://developer.github.com/v3/teams/#remove-team-project

func (*TeamsService)RemoveTeamRepoByID ¶added inv29.0.3

func (s *TeamsService) RemoveTeamRepoByID(ctxcontext.Context, orgID, teamIDint64, owner, repostring) (*Response,error)

RemoveTeamRepoByID removes a repository from being managed by the specifiedteam given the team ID. Note that this does not delete the repository, itjust removes it from the team.

GitHub API docs:https://developer.github.com/v3/teams/#remove-team-repo

func (*TeamsService)RemoveTeamRepoBySlug ¶added inv29.0.3

func (s *TeamsService) RemoveTeamRepoBySlug(ctxcontext.Context, org, slug, owner, repostring) (*Response,error)

RemoveTeamRepoBySlug removes a repository from being managed by the specifiedteam given the team slug. Note that this does not delete the repository, itjust removes it from the team.

GitHub API docs:https://developer.github.com/v3/teams/#remove-team-repo

func (*TeamsService)ReviewTeamProjectsByID ¶added inv29.0.3

func (s *TeamsService) ReviewTeamProjectsByID(ctxcontext.Context, orgID, teamID, projectIDint64) (*Project, *Response,error)

ReviewTeamProjectsByID checks whether a team, given its ID, has read, write, or adminpermissions for an organization project.

GitHub API docs:https://developer.github.com/v3/teams/#review-a-team-project

func (*TeamsService)ReviewTeamProjectsBySlug ¶added inv29.0.3

func (s *TeamsService) ReviewTeamProjectsBySlug(ctxcontext.Context, org, slugstring, projectIDint64) (*Project, *Response,error)

ReviewTeamProjectsBySlug checks whether a team, given its slug, has read, write, or adminpermissions for an organization project.

GitHub API docs:https://developer.github.com/v3/teams/#review-a-team-project

typeTemplateRepoRequest ¶

type TemplateRepoRequest struct {// Name is required when creating a repo.Name        *string `json:"name,omitempty"`Owner       *string `json:"owner,omitempty"`Description *string `json:"description,omitempty"`Private *bool `json:"private,omitempty"`}

TemplateRepoRequest represents a request to create a repository from a template.

func (*TemplateRepoRequest)GetDescription ¶

func (t *TemplateRepoRequest) GetDescription()string

GetDescription returns the Description field if it's non-nil, zero value otherwise.

func (*TemplateRepoRequest)GetName ¶

func (t *TemplateRepoRequest) GetName()string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (*TemplateRepoRequest)GetOwner ¶

func (t *TemplateRepoRequest) GetOwner()string

GetOwner returns the Owner field if it's non-nil, zero value otherwise.

func (*TemplateRepoRequest)GetPrivate ¶

func (t *TemplateRepoRequest) GetPrivate()bool

GetPrivate returns the Private field if it's non-nil, zero value otherwise.

typeTextMatch ¶

type TextMatch struct {ObjectURL  *string `json:"object_url,omitempty"`ObjectType *string `json:"object_type,omitempty"`Property   *string `json:"property,omitempty"`Fragment   *string `json:"fragment,omitempty"`Matches    []Match `json:"matches,omitempty"`}

TextMatch represents a text match for a SearchResult

func (*TextMatch)GetFragment ¶

func (t *TextMatch) GetFragment()string

GetFragment returns the Fragment field if it's non-nil, zero value otherwise.

func (*TextMatch)GetObjectType ¶

func (t *TextMatch) GetObjectType()string

GetObjectType returns the ObjectType field if it's non-nil, zero value otherwise.

func (*TextMatch)GetObjectURL ¶

func (t *TextMatch) GetObjectURL()string

GetObjectURL returns the ObjectURL field if it's non-nil, zero value otherwise.

func (*TextMatch)GetProperty ¶

func (t *TextMatch) GetProperty()string

GetProperty returns the Property field if it's non-nil, zero value otherwise.

func (TextMatch)String ¶

func (tmTextMatch) String()string

typeTimeline ¶

type Timeline struct {ID        *int64  `json:"id,omitempty"`URL       *string `json:"url,omitempty"`CommitURL *string `json:"commit_url,omitempty"`// The User object that generated the event.Actor *User `json:"actor,omitempty"`// Event identifies the actual type of Event that occurred. Possible values// are:////     assigned//       The issue was assigned to the assignee.////     closed//       The issue was closed by the actor. When the commit_id is present, it//       identifies the commit that closed the issue using "closes / fixes #NN"//       syntax.////     commented//       A comment was added to the issue.////     committed//       A commit was added to the pull request's 'HEAD' branch. Only provided//       for pull requests.////     cross-referenced//       The issue was referenced from another issue. The 'source' attribute//       contains the 'id', 'actor', and 'url' of the reference's source.////     demilestoned//       The issue was removed from a milestone.////     head_ref_deleted//       The pull request's branch was deleted.////     head_ref_restored//       The pull request's branch was restored.////     labeled//       A label was added to the issue.////     locked//       The issue was locked by the actor.////     mentioned//       The actor was @mentioned in an issue body.////     merged//       The issue was merged by the actor. The 'commit_id' attribute is the//       SHA1 of the HEAD commit that was merged.////     milestoned//       The issue was added to a milestone.////     referenced//       The issue was referenced from a commit message. The 'commit_id'//       attribute is the commit SHA1 of where that happened.////     renamed//       The issue title was changed.////     reopened//       The issue was reopened by the actor.////     subscribed//       The actor subscribed to receive notifications for an issue.////     unassigned//       The assignee was unassigned from the issue.////     unlabeled//       A label was removed from the issue.////     unlocked//       The issue was unlocked by the actor.////     unsubscribed//       The actor unsubscribed to stop receiving notifications for an issue.//Event *string `json:"event,omitempty"`// The string SHA of a commit that referenced this Issue or Pull Request.CommitID *string `json:"commit_id,omitempty"`// The timestamp indicating when the event occurred.CreatedAt *time.Time `json:"created_at,omitempty"`// The Label object including `name` and `color` attributes. Only provided for// 'labeled' and 'unlabeled' events.Label *Label `json:"label,omitempty"`// The User object which was assigned to (or unassigned from) this Issue or// Pull Request. Only provided for 'assigned' and 'unassigned' events.Assignee *User `json:"assignee,omitempty"`// The Milestone object including a 'title' attribute.// Only provided for 'milestoned' and 'demilestoned' events.Milestone *Milestone `json:"milestone,omitempty"`// The 'id', 'actor', and 'url' for the source of a reference from another issue.// Only provided for 'cross-referenced' events.Source *Source `json:"source,omitempty"`// An object containing rename details including 'from' and 'to' attributes.// Only provided for 'renamed' events.Rename      *Rename      `json:"rename,omitempty"`ProjectCard *ProjectCard `json:"project_card,omitempty"`}

Timeline represents an event that occurred around an Issue or Pull Request.

It is similar to an IssueEvent but may contain more information.GitHub API docs:https://developer.github.com/v3/issues/timeline/

func (*Timeline)GetActor ¶

func (t *Timeline) GetActor() *User

GetActor returns the Actor field.

func (*Timeline)GetAssignee ¶

func (t *Timeline) GetAssignee() *User

GetAssignee returns the Assignee field.

func (*Timeline)GetCommitID ¶

func (t *Timeline) GetCommitID()string

GetCommitID returns the CommitID field if it's non-nil, zero value otherwise.

func (*Timeline)GetCommitURL ¶

func (t *Timeline) GetCommitURL()string

GetCommitURL returns the CommitURL field if it's non-nil, zero value otherwise.

func (*Timeline)GetCreatedAt ¶

func (t *Timeline) GetCreatedAt()time.Time

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*Timeline)GetEvent ¶

func (t *Timeline) GetEvent()string

GetEvent returns the Event field if it's non-nil, zero value otherwise.

func (*Timeline)GetID ¶

func (t *Timeline) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*Timeline)GetLabel ¶

func (t *Timeline) GetLabel() *Label

GetLabel returns the Label field.

func (*Timeline)GetMilestone ¶

func (t *Timeline) GetMilestone() *Milestone

GetMilestone returns the Milestone field.

func (*Timeline)GetProjectCard ¶

func (t *Timeline) GetProjectCard() *ProjectCard

GetProjectCard returns the ProjectCard field.

func (*Timeline)GetRename ¶

func (t *Timeline) GetRename() *Rename

GetRename returns the Rename field.

func (*Timeline)GetSource ¶

func (t *Timeline) GetSource() *Source

GetSource returns the Source field.

func (*Timeline)GetURL ¶

func (t *Timeline) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

typeTimestamp ¶

type Timestamp struct {time.Time}

Timestamp represents a time that can be unmarshalled from a JSON stringformatted as either an RFC3339 or Unix timestamp. This is necessary for somefields since the GitHub API is inconsistent in how it represents times. Allexported methods of time.Time can be called on Timestamp.

func (Timestamp)Equal ¶

func (tTimestamp) Equal(uTimestamp)bool

Equal reports whether t and u are equal based on time.Equal

func (Timestamp)String ¶

func (tTimestamp) String()string

func (*Timestamp)UnmarshalJSON ¶

func (t *Timestamp) UnmarshalJSON(data []byte) (errerror)

UnmarshalJSON implements the json.Unmarshaler interface.Time is expected in RFC3339 or Unix format.

typeTopicResult ¶

type TopicResult struct {Name             *string    `json:"name,omitempty"`DisplayName      *string    `json:"display_name,omitempty"`ShortDescription *string    `json:"short_description,omitempty"`Description      *string    `json:"description,omitempty"`CreatedBy        *string    `json:"created_by,omitempty"`CreatedAt        *Timestamp `json:"created_at,omitempty"`UpdatedAt        *string    `json:"updated_at,omitempty"`Featured         *bool      `json:"featured,omitempty"`Curated          *bool      `json:"curated,omitempty"`Score            *float64   `json:"score,omitempty"`}

func (*TopicResult)GetCreatedAt ¶

func (t *TopicResult) GetCreatedAt()Timestamp

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*TopicResult)GetCreatedBy ¶

func (t *TopicResult) GetCreatedBy()string

GetCreatedBy returns the CreatedBy field if it's non-nil, zero value otherwise.

func (*TopicResult)GetCurated ¶

func (t *TopicResult) GetCurated()bool

GetCurated returns the Curated field if it's non-nil, zero value otherwise.

func (*TopicResult)GetDescription ¶

func (t *TopicResult) GetDescription()string

GetDescription returns the Description field if it's non-nil, zero value otherwise.

func (*TopicResult)GetDisplayName ¶

func (t *TopicResult) GetDisplayName()string

GetDisplayName returns the DisplayName field if it's non-nil, zero value otherwise.

func (*TopicResult)GetFeatured ¶

func (t *TopicResult) GetFeatured()bool

GetFeatured returns the Featured field if it's non-nil, zero value otherwise.

func (*TopicResult)GetName ¶

func (t *TopicResult) GetName()string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (*TopicResult)GetScore ¶

func (t *TopicResult) GetScore() *float64

GetScore returns the Score field.

func (*TopicResult)GetShortDescription ¶

func (t *TopicResult) GetShortDescription()string

GetShortDescription returns the ShortDescription field if it's non-nil, zero value otherwise.

func (*TopicResult)GetUpdatedAt ¶

func (t *TopicResult) GetUpdatedAt()string

GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.

typeTopicsSearchResult ¶

type TopicsSearchResult struct {Total             *int           `json:"total_count,omitempty"`IncompleteResults *bool          `json:"incomplete_results,omitempty"`Topics            []*TopicResult `json:"items,omitempty"`}

TopicsSearchResult represents the result of a topics search.

func (*TopicsSearchResult)GetIncompleteResults ¶

func (t *TopicsSearchResult) GetIncompleteResults()bool

GetIncompleteResults returns the IncompleteResults field if it's non-nil, zero value otherwise.

func (*TopicsSearchResult)GetTotal ¶

func (t *TopicsSearchResult) GetTotal()int

GetTotal returns the Total field if it's non-nil, zero value otherwise.

typeTrafficBreakdownOptions ¶

type TrafficBreakdownOptions struct {Perstring `url:"per,omitempty"`}

TrafficBreakdownOptions specifies the parameters to methods that support breakdown per day or week.Can be one of: day, week. Default: day.

typeTrafficClones ¶

type TrafficClones struct {Clones  []*TrafficData `json:"clones,omitempty"`Count   *int           `json:"count,omitempty"`Uniques *int           `json:"uniques,omitempty"`}

TrafficClones represent information about the number of clones in the last 14 days.

func (*TrafficClones)GetCount ¶

func (t *TrafficClones) GetCount()int

GetCount returns the Count field if it's non-nil, zero value otherwise.

func (*TrafficClones)GetUniques ¶

func (t *TrafficClones) GetUniques()int

GetUniques returns the Uniques field if it's non-nil, zero value otherwise.

typeTrafficData ¶

type TrafficData struct {Timestamp *Timestamp `json:"timestamp,omitempty"`Count     *int       `json:"count,omitempty"`Uniques   *int       `json:"uniques,omitempty"`}

TrafficData represent information about a specific timestamp in views or clones list.

func (*TrafficData)GetCount ¶

func (t *TrafficData) GetCount()int

GetCount returns the Count field if it's non-nil, zero value otherwise.

func (*TrafficData)GetTimestamp ¶

func (t *TrafficData) GetTimestamp()Timestamp

GetTimestamp returns the Timestamp field if it's non-nil, zero value otherwise.

func (*TrafficData)GetUniques ¶

func (t *TrafficData) GetUniques()int

GetUniques returns the Uniques field if it's non-nil, zero value otherwise.

typeTrafficPath ¶

type TrafficPath struct {Path    *string `json:"path,omitempty"`Title   *string `json:"title,omitempty"`Count   *int    `json:"count,omitempty"`Uniques *int    `json:"uniques,omitempty"`}

TrafficPath represent information about the traffic on a path of the repo.

func (*TrafficPath)GetCount ¶

func (t *TrafficPath) GetCount()int

GetCount returns the Count field if it's non-nil, zero value otherwise.

func (*TrafficPath)GetPath ¶

func (t *TrafficPath) GetPath()string

GetPath returns the Path field if it's non-nil, zero value otherwise.

func (*TrafficPath)GetTitle ¶

func (t *TrafficPath) GetTitle()string

GetTitle returns the Title field if it's non-nil, zero value otherwise.

func (*TrafficPath)GetUniques ¶

func (t *TrafficPath) GetUniques()int

GetUniques returns the Uniques field if it's non-nil, zero value otherwise.

typeTrafficReferrer ¶

type TrafficReferrer struct {Referrer *string `json:"referrer,omitempty"`Count    *int    `json:"count,omitempty"`Uniques  *int    `json:"uniques,omitempty"`}

TrafficReferrer represent information about traffic from a referrer .

func (*TrafficReferrer)GetCount ¶

func (t *TrafficReferrer) GetCount()int

GetCount returns the Count field if it's non-nil, zero value otherwise.

func (*TrafficReferrer)GetReferrer ¶

func (t *TrafficReferrer) GetReferrer()string

GetReferrer returns the Referrer field if it's non-nil, zero value otherwise.

func (*TrafficReferrer)GetUniques ¶

func (t *TrafficReferrer) GetUniques()int

GetUniques returns the Uniques field if it's non-nil, zero value otherwise.

typeTrafficViews ¶

type TrafficViews struct {Views   []*TrafficData `json:"views,omitempty"`Count   *int           `json:"count,omitempty"`Uniques *int           `json:"uniques,omitempty"`}

TrafficViews represent information about the number of views in the last 14 days.

func (*TrafficViews)GetCount ¶

func (t *TrafficViews) GetCount()int

GetCount returns the Count field if it's non-nil, zero value otherwise.

func (*TrafficViews)GetUniques ¶

func (t *TrafficViews) GetUniques()int

GetUniques returns the Uniques field if it's non-nil, zero value otherwise.

typeTransferRequest ¶

type TransferRequest struct {NewOwnerstring  `json:"new_owner"`TeamID   []int64 `json:"team_ids,omitempty"`}

TransferRequest represents a request to transfer a repository.

typeTree ¶

type Tree struct {SHA     *string     `json:"sha,omitempty"`Entries []TreeEntry `json:"tree,omitempty"`// Truncated is true if the number of items in the tree// exceeded GitHub's maximum limit and the Entries were truncated// in the response. Only populated for requests that fetch// trees like Git.GetTree.Truncated *bool `json:"truncated,omitempty"`}

Tree represents a GitHub tree.

func (*Tree)GetSHA ¶

func (t *Tree) GetSHA()string

GetSHA returns the SHA field if it's non-nil, zero value otherwise.

func (*Tree)GetTruncated ¶

func (t *Tree) GetTruncated()bool

GetTruncated returns the Truncated field if it's non-nil, zero value otherwise.

func (Tree)String ¶

func (tTree) String()string

typeTreeEntry ¶

type TreeEntry struct {SHA     *string `json:"sha,omitempty"`Path    *string `json:"path,omitempty"`Mode    *string `json:"mode,omitempty"`Type    *string `json:"type,omitempty"`Size    *int    `json:"size,omitempty"`Content *string `json:"content,omitempty"`URL     *string `json:"url,omitempty"`}

TreeEntry represents the contents of a tree structure. TreeEntry canrepresent either a blob, a commit (in the case of a submodule), or anothertree.

func (*TreeEntry)GetContent ¶

func (t *TreeEntry) GetContent()string

GetContent returns the Content field if it's non-nil, zero value otherwise.

func (*TreeEntry)GetMode ¶

func (t *TreeEntry) GetMode()string

GetMode returns the Mode field if it's non-nil, zero value otherwise.

func (*TreeEntry)GetPath ¶

func (t *TreeEntry) GetPath()string

GetPath returns the Path field if it's non-nil, zero value otherwise.

func (*TreeEntry)GetSHA ¶

func (t *TreeEntry) GetSHA()string

GetSHA returns the SHA field if it's non-nil, zero value otherwise.

func (*TreeEntry)GetSize ¶

func (t *TreeEntry) GetSize()int

GetSize returns the Size field if it's non-nil, zero value otherwise.

func (*TreeEntry)GetType ¶

func (t *TreeEntry) GetType()string

GetType returns the Type field if it's non-nil, zero value otherwise.

func (*TreeEntry)GetURL ¶

func (t *TreeEntry) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (*TreeEntry)MarshalJSON ¶

func (t *TreeEntry) MarshalJSON() ([]byte,error)

func (TreeEntry)String ¶

func (tTreeEntry) String()string

typeTwoFactorAuthError ¶

type TwoFactorAuthErrorErrorResponse

TwoFactorAuthError occurs when using HTTP Basic Authentication for a userthat has two-factor authentication enabled. The request can be reattemptedby providing a one-time password in the request.

func (*TwoFactorAuthError)Error ¶

func (r *TwoFactorAuthError) Error()string

typeUnauthenticatedRateLimitedTransport ¶

type UnauthenticatedRateLimitedTransport struct {// ClientID is the GitHub OAuth client ID of the current application, which// can be found by selecting its entry in the list at//https://github.com/settings/applications.ClientIDstring// ClientSecret is the GitHub OAuth client secret of the current// application.ClientSecretstring// Transport is the underlying HTTP transport to use when making requests.// It will default to http.DefaultTransport if nil.Transporthttp.RoundTripper}

UnauthenticatedRateLimitedTransport allows you to make unauthenticated callsthat need to use a higher rate limit associated with your OAuth application.

t := &github.UnauthenticatedRateLimitedTransport{ClientID:     "your app's client ID",ClientSecret: "your app's client secret",}client := github.NewClient(t.Client())

This will append the querystring params client_id=xxx&client_secret=yyy to allrequests.

Seehttps://developer.github.com/v3/#unauthenticated-rate-limited-requests formore information.

func (*UnauthenticatedRateLimitedTransport)Client ¶

func (t *UnauthenticatedRateLimitedTransport) Client() *http.Client

Client returns an *http.Client that makes requests which are subject to therate limit of your OAuth application.

func (*UnauthenticatedRateLimitedTransport)RoundTrip ¶

func (t *UnauthenticatedRateLimitedTransport) RoundTrip(req *http.Request) (*http.Response,error)

RoundTrip implements the RoundTripper interface.

typeUpdateCheckRunOptions ¶

type UpdateCheckRunOptions struct {Namestring            `json:"name"`// The name of the check (e.g., "code-coverage"). (Required.)HeadSHA     *string           `json:"head_sha,omitempty"`// The SHA of the commit. (Optional.)DetailsURL  *string           `json:"details_url,omitempty"`// The URL of the integrator's site that has the full details of the check. (Optional.)ExternalID  *string           `json:"external_id,omitempty"`// A reference for the run on the integrator's system. (Optional.)Status      *string           `json:"status,omitempty"`// The current status. Can be one of "queued", "in_progress", or "completed". Default: "queued". (Optional.)Conclusion  *string           `json:"conclusion,omitempty"`// Can be one of "success", "failure", "neutral", "cancelled", "timed_out", or "action_required". (Optional. Required if you provide a status of "completed".)CompletedAt *Timestamp        `json:"completed_at,omitempty"`// The time the check completed. (Optional. Required if you provide conclusion.)Output      *CheckRunOutput   `json:"output,omitempty"`// Provide descriptive details about the run. (Optional)Actions     []*CheckRunAction `json:"actions,omitempty"`// Possible further actions the integrator can perform, which a user may trigger. (Optional.)}

UpdateCheckRunOptions sets up parameters needed to update a CheckRun.

func (*UpdateCheckRunOptions)GetCompletedAt ¶

func (u *UpdateCheckRunOptions) GetCompletedAt()Timestamp

GetCompletedAt returns the CompletedAt field if it's non-nil, zero value otherwise.

func (*UpdateCheckRunOptions)GetConclusion ¶

func (u *UpdateCheckRunOptions) GetConclusion()string

GetConclusion returns the Conclusion field if it's non-nil, zero value otherwise.

func (*UpdateCheckRunOptions)GetDetailsURL ¶

func (u *UpdateCheckRunOptions) GetDetailsURL()string

GetDetailsURL returns the DetailsURL field if it's non-nil, zero value otherwise.

func (*UpdateCheckRunOptions)GetExternalID ¶

func (u *UpdateCheckRunOptions) GetExternalID()string

GetExternalID returns the ExternalID field if it's non-nil, zero value otherwise.

func (*UpdateCheckRunOptions)GetHeadSHA ¶

func (u *UpdateCheckRunOptions) GetHeadSHA()string

GetHeadSHA returns the HeadSHA field if it's non-nil, zero value otherwise.

func (*UpdateCheckRunOptions)GetOutput ¶

func (u *UpdateCheckRunOptions) GetOutput() *CheckRunOutput

GetOutput returns the Output field.

func (*UpdateCheckRunOptions)GetStatus ¶

func (u *UpdateCheckRunOptions) GetStatus()string

GetStatus returns the Status field if it's non-nil, zero value otherwise.

typeUploadOptions ¶

type UploadOptions struct {Namestring `url:"name,omitempty"`Labelstring `url:"label,omitempty"`MediaTypestring `url:"-"`}

UploadOptions specifies the parameters to methods that support uploads.

typeUser ¶

type User struct {Login                   *string    `json:"login,omitempty"`ID                      *int64     `json:"id,omitempty"`NodeID                  *string    `json:"node_id,omitempty"`AvatarURL               *string    `json:"avatar_url,omitempty"`HTMLURL                 *string    `json:"html_url,omitempty"`GravatarID              *string    `json:"gravatar_id,omitempty"`Name                    *string    `json:"name,omitempty"`Company                 *string    `json:"company,omitempty"`Blog                    *string    `json:"blog,omitempty"`Location                *string    `json:"location,omitempty"`Email                   *string    `json:"email,omitempty"`Hireable                *bool      `json:"hireable,omitempty"`Bio                     *string    `json:"bio,omitempty"`PublicRepos             *int       `json:"public_repos,omitempty"`PublicGists             *int       `json:"public_gists,omitempty"`Followers               *int       `json:"followers,omitempty"`Following               *int       `json:"following,omitempty"`CreatedAt               *Timestamp `json:"created_at,omitempty"`UpdatedAt               *Timestamp `json:"updated_at,omitempty"`SuspendedAt             *Timestamp `json:"suspended_at,omitempty"`Type                    *string    `json:"type,omitempty"`SiteAdmin               *bool      `json:"site_admin,omitempty"`TotalPrivateRepos       *int       `json:"total_private_repos,omitempty"`OwnedPrivateRepos       *int       `json:"owned_private_repos,omitempty"`PrivateGists            *int       `json:"private_gists,omitempty"`DiskUsage               *int       `json:"disk_usage,omitempty"`Collaborators           *int       `json:"collaborators,omitempty"`TwoFactorAuthentication *bool      `json:"two_factor_authentication,omitempty"`Plan                    *Plan      `json:"plan,omitempty"`LdapDn                  *string    `json:"ldap_dn,omitempty"`// API URLsURL               *string `json:"url,omitempty"`EventsURL         *string `json:"events_url,omitempty"`FollowingURL      *string `json:"following_url,omitempty"`FollowersURL      *string `json:"followers_url,omitempty"`GistsURL          *string `json:"gists_url,omitempty"`OrganizationsURL  *string `json:"organizations_url,omitempty"`ReceivedEventsURL *string `json:"received_events_url,omitempty"`ReposURL          *string `json:"repos_url,omitempty"`StarredURL        *string `json:"starred_url,omitempty"`SubscriptionsURL  *string `json:"subscriptions_url,omitempty"`// TextMatches is only populated from search results that request text matches// See: search.go andhttps://developer.github.com/v3/search/#text-match-metadataTextMatches []TextMatch `json:"text_matches,omitempty"`// Permissions identifies the permissions that a user has on a given// repository. This is only populated when calling Repositories.ListCollaborators.Permissions *map[string]bool `json:"permissions,omitempty"`}

User represents a GitHub user.

func (*User)GetAvatarURL ¶

func (u *User) GetAvatarURL()string

GetAvatarURL returns the AvatarURL field if it's non-nil, zero value otherwise.

func (*User)GetBio ¶

func (u *User) GetBio()string

GetBio returns the Bio field if it's non-nil, zero value otherwise.

func (*User)GetBlog ¶

func (u *User) GetBlog()string

GetBlog returns the Blog field if it's non-nil, zero value otherwise.

func (*User)GetCollaborators ¶

func (u *User) GetCollaborators()int

GetCollaborators returns the Collaborators field if it's non-nil, zero value otherwise.

func (*User)GetCompany ¶

func (u *User) GetCompany()string

GetCompany returns the Company field if it's non-nil, zero value otherwise.

func (*User)GetCreatedAt ¶

func (u *User) GetCreatedAt()Timestamp

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*User)GetDiskUsage ¶

func (u *User) GetDiskUsage()int

GetDiskUsage returns the DiskUsage field if it's non-nil, zero value otherwise.

func (*User)GetEmail ¶

func (u *User) GetEmail()string

GetEmail returns the Email field if it's non-nil, zero value otherwise.

func (*User)GetEventsURL ¶

func (u *User) GetEventsURL()string

GetEventsURL returns the EventsURL field if it's non-nil, zero value otherwise.

func (*User)GetFollowers ¶

func (u *User) GetFollowers()int

GetFollowers returns the Followers field if it's non-nil, zero value otherwise.

func (*User)GetFollowersURL ¶

func (u *User) GetFollowersURL()string

GetFollowersURL returns the FollowersURL field if it's non-nil, zero value otherwise.

func (*User)GetFollowing ¶

func (u *User) GetFollowing()int

GetFollowing returns the Following field if it's non-nil, zero value otherwise.

func (*User)GetFollowingURL ¶

func (u *User) GetFollowingURL()string

GetFollowingURL returns the FollowingURL field if it's non-nil, zero value otherwise.

func (*User)GetGistsURL ¶

func (u *User) GetGistsURL()string

GetGistsURL returns the GistsURL field if it's non-nil, zero value otherwise.

func (*User)GetGravatarID ¶

func (u *User) GetGravatarID()string

GetGravatarID returns the GravatarID field if it's non-nil, zero value otherwise.

func (*User)GetHTMLURL ¶

func (u *User) GetHTMLURL()string

GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.

func (*User)GetHireable ¶

func (u *User) GetHireable()bool

GetHireable returns the Hireable field if it's non-nil, zero value otherwise.

func (*User)GetID ¶

func (u *User) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*User)GetLdapDn ¶

func (u *User) GetLdapDn()string

GetLdapDn returns the LdapDn field if it's non-nil, zero value otherwise.

func (*User)GetLocation ¶

func (u *User) GetLocation()string

GetLocation returns the Location field if it's non-nil, zero value otherwise.

func (*User)GetLogin ¶

func (u *User) GetLogin()string

GetLogin returns the Login field if it's non-nil, zero value otherwise.

func (*User)GetName ¶

func (u *User) GetName()string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (*User)GetNodeID ¶

func (u *User) GetNodeID()string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*User)GetOrganizationsURL ¶

func (u *User) GetOrganizationsURL()string

GetOrganizationsURL returns the OrganizationsURL field if it's non-nil, zero value otherwise.

func (*User)GetOwnedPrivateRepos ¶

func (u *User) GetOwnedPrivateRepos()int

GetOwnedPrivateRepos returns the OwnedPrivateRepos field if it's non-nil, zero value otherwise.

func (*User)GetPermissions ¶

func (u *User) GetPermissions() map[string]bool

GetPermissions returns the Permissions field if it's non-nil, zero value otherwise.

func (*User)GetPlan ¶

func (u *User) GetPlan() *Plan

GetPlan returns the Plan field.

func (*User)GetPrivateGists ¶

func (u *User) GetPrivateGists()int

GetPrivateGists returns the PrivateGists field if it's non-nil, zero value otherwise.

func (*User)GetPublicGists ¶

func (u *User) GetPublicGists()int

GetPublicGists returns the PublicGists field if it's non-nil, zero value otherwise.

func (*User)GetPublicRepos ¶

func (u *User) GetPublicRepos()int

GetPublicRepos returns the PublicRepos field if it's non-nil, zero value otherwise.

func (*User)GetReceivedEventsURL ¶

func (u *User) GetReceivedEventsURL()string

GetReceivedEventsURL returns the ReceivedEventsURL field if it's non-nil, zero value otherwise.

func (*User)GetReposURL ¶

func (u *User) GetReposURL()string

GetReposURL returns the ReposURL field if it's non-nil, zero value otherwise.

func (*User)GetSiteAdmin ¶

func (u *User) GetSiteAdmin()bool

GetSiteAdmin returns the SiteAdmin field if it's non-nil, zero value otherwise.

func (*User)GetStarredURL ¶

func (u *User) GetStarredURL()string

GetStarredURL returns the StarredURL field if it's non-nil, zero value otherwise.

func (*User)GetSubscriptionsURL ¶

func (u *User) GetSubscriptionsURL()string

GetSubscriptionsURL returns the SubscriptionsURL field if it's non-nil, zero value otherwise.

func (*User)GetSuspendedAt ¶

func (u *User) GetSuspendedAt()Timestamp

GetSuspendedAt returns the SuspendedAt field if it's non-nil, zero value otherwise.

func (*User)GetTotalPrivateRepos ¶

func (u *User) GetTotalPrivateRepos()int

GetTotalPrivateRepos returns the TotalPrivateRepos field if it's non-nil, zero value otherwise.

func (*User)GetTwoFactorAuthentication ¶

func (u *User) GetTwoFactorAuthentication()bool

GetTwoFactorAuthentication returns the TwoFactorAuthentication field if it's non-nil, zero value otherwise.

func (*User)GetType ¶

func (u *User) GetType()string

GetType returns the Type field if it's non-nil, zero value otherwise.

func (*User)GetURL ¶

func (u *User) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (*User)GetUpdatedAt ¶

func (u *User) GetUpdatedAt()Timestamp

GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.

func (User)String ¶

func (uUser) String()string

typeUserAuthorization ¶

type UserAuthorization struct {ID             *int64     `json:"id,omitempty"`URL            *string    `json:"url,omitempty"`Scopes         []string   `json:"scopes,omitempty"`Token          *string    `json:"token,omitempty"`TokenLastEight *string    `json:"token_last_eight,omitempty"`HashedToken    *string    `json:"hashed_token,omitempty"`App            *OAuthAPP  `json:"app,omitempty"`Note           *string    `json:"note,omitempty"`NoteURL        *string    `json:"note_url,omitempty"`UpdatedAt      *Timestamp `json:"updated_at,omitempty"`CreatedAt      *Timestamp `json:"created_at,omitempty"`Fingerprint    *string    `json:"fingerprint,omitempty"`}

UserAuthorization represents the impersonation response.

func (*UserAuthorization)GetApp ¶

func (u *UserAuthorization) GetApp() *OAuthAPP

GetApp returns the App field.

func (*UserAuthorization)GetCreatedAt ¶

func (u *UserAuthorization) GetCreatedAt()Timestamp

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*UserAuthorization)GetFingerprint ¶

func (u *UserAuthorization) GetFingerprint()string

GetFingerprint returns the Fingerprint field if it's non-nil, zero value otherwise.

func (*UserAuthorization)GetHashedToken ¶

func (u *UserAuthorization) GetHashedToken()string

GetHashedToken returns the HashedToken field if it's non-nil, zero value otherwise.

func (*UserAuthorization)GetID ¶

func (u *UserAuthorization) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*UserAuthorization)GetNote ¶

func (u *UserAuthorization) GetNote()string

GetNote returns the Note field if it's non-nil, zero value otherwise.

func (*UserAuthorization)GetNoteURL ¶

func (u *UserAuthorization) GetNoteURL()string

GetNoteURL returns the NoteURL field if it's non-nil, zero value otherwise.

func (*UserAuthorization)GetToken ¶

func (u *UserAuthorization) GetToken()string

GetToken returns the Token field if it's non-nil, zero value otherwise.

func (*UserAuthorization)GetTokenLastEight ¶

func (u *UserAuthorization) GetTokenLastEight()string

GetTokenLastEight returns the TokenLastEight field if it's non-nil, zero value otherwise.

func (*UserAuthorization)GetURL ¶

func (u *UserAuthorization) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (*UserAuthorization)GetUpdatedAt ¶

func (u *UserAuthorization) GetUpdatedAt()Timestamp

GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.

typeUserContext ¶

type UserContext struct {Message *string `json:"message,omitempty"`Octicon *string `json:"octicon,omitempty"`}

UserContext represents the contextual information about user.

func (*UserContext)GetMessage ¶

func (u *UserContext) GetMessage()string

GetMessage returns the Message field if it's non-nil, zero value otherwise.

func (*UserContext)GetOcticon ¶

func (u *UserContext) GetOcticon()string

GetOcticon returns the Octicon field if it's non-nil, zero value otherwise.

typeUserEmail ¶

type UserEmail struct {Email      *string `json:"email,omitempty"`Primary    *bool   `json:"primary,omitempty"`Verified   *bool   `json:"verified,omitempty"`Visibility *string `json:"visibility,omitempty"`}

UserEmail represents user's email address

func (*UserEmail)GetEmail ¶

func (u *UserEmail) GetEmail()string

GetEmail returns the Email field if it's non-nil, zero value otherwise.

func (*UserEmail)GetPrimary ¶

func (u *UserEmail) GetPrimary()bool

GetPrimary returns the Primary field if it's non-nil, zero value otherwise.

func (*UserEmail)GetVerified ¶

func (u *UserEmail) GetVerified()bool

GetVerified returns the Verified field if it's non-nil, zero value otherwise.

func (*UserEmail)GetVisibility ¶

func (u *UserEmail) GetVisibility()string

GetVisibility returns the Visibility field if it's non-nil, zero value otherwise.

typeUserEvent ¶

type UserEvent struct {User *User `json:"user,omitempty"`// The action performed. Possible values are: "created" or "deleted".Action     *string     `json:"action,omitempty"`Enterprise *Enterprise `json:"enterprise,omitempty"`Sender     *User       `json:"sender,omitempty"`}

UserEvent is triggered when a user is created or deleted.The Webhook event name is "user".

Only global webhooks can subscribe to this event type.

GitHub API docs:https://developer.github.com/enterprise/v3/activity/events/types/#userevent-enterprise

func (*UserEvent)GetAction ¶

func (u *UserEvent) GetAction()string

GetAction returns the Action field if it's non-nil, zero value otherwise.

func (*UserEvent)GetEnterprise ¶

func (u *UserEvent) GetEnterprise() *Enterprise

GetEnterprise returns the Enterprise field.

func (*UserEvent)GetSender ¶

func (u *UserEvent) GetSender() *User

GetSender returns the Sender field.

func (*UserEvent)GetUser ¶

func (u *UserEvent) GetUser() *User

GetUser returns the User field.

typeUserLDAPMapping ¶

type UserLDAPMapping struct {ID         *int64  `json:"id,omitempty"`LDAPDN     *string `json:"ldap_dn,omitempty"`Login      *string `json:"login,omitempty"`AvatarURL  *string `json:"avatar_url,omitempty"`GravatarID *string `json:"gravatar_id,omitempty"`Type       *string `json:"type,omitempty"`SiteAdmin  *bool   `json:"site_admin,omitempty"`URL               *string `json:"url,omitempty"`EventsURL         *string `json:"events_url,omitempty"`FollowingURL      *string `json:"following_url,omitempty"`FollowersURL      *string `json:"followers_url,omitempty"`GistsURL          *string `json:"gists_url,omitempty"`OrganizationsURL  *string `json:"organizations_url,omitempty"`ReceivedEventsURL *string `json:"received_events_url,omitempty"`ReposURL          *string `json:"repos_url,omitempty"`StarredURL        *string `json:"starred_url,omitempty"`SubscriptionsURL  *string `json:"subscriptions_url,omitempty"`}

UserLDAPMapping represents the mapping between a GitHub user and an LDAP user.

func (*UserLDAPMapping)GetAvatarURL ¶

func (u *UserLDAPMapping) GetAvatarURL()string

GetAvatarURL returns the AvatarURL field if it's non-nil, zero value otherwise.

func (*UserLDAPMapping)GetEventsURL ¶

func (u *UserLDAPMapping) GetEventsURL()string

GetEventsURL returns the EventsURL field if it's non-nil, zero value otherwise.

func (*UserLDAPMapping)GetFollowersURL ¶

func (u *UserLDAPMapping) GetFollowersURL()string

GetFollowersURL returns the FollowersURL field if it's non-nil, zero value otherwise.

func (*UserLDAPMapping)GetFollowingURL ¶

func (u *UserLDAPMapping) GetFollowingURL()string

GetFollowingURL returns the FollowingURL field if it's non-nil, zero value otherwise.

func (*UserLDAPMapping)GetGistsURL ¶

func (u *UserLDAPMapping) GetGistsURL()string

GetGistsURL returns the GistsURL field if it's non-nil, zero value otherwise.

func (*UserLDAPMapping)GetGravatarID ¶

func (u *UserLDAPMapping) GetGravatarID()string

GetGravatarID returns the GravatarID field if it's non-nil, zero value otherwise.

func (*UserLDAPMapping)GetID ¶

func (u *UserLDAPMapping) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*UserLDAPMapping)GetLDAPDN ¶

func (u *UserLDAPMapping) GetLDAPDN()string

GetLDAPDN returns the LDAPDN field if it's non-nil, zero value otherwise.

func (*UserLDAPMapping)GetLogin ¶

func (u *UserLDAPMapping) GetLogin()string

GetLogin returns the Login field if it's non-nil, zero value otherwise.

func (*UserLDAPMapping)GetOrganizationsURL ¶

func (u *UserLDAPMapping) GetOrganizationsURL()string

GetOrganizationsURL returns the OrganizationsURL field if it's non-nil, zero value otherwise.

func (*UserLDAPMapping)GetReceivedEventsURL ¶

func (u *UserLDAPMapping) GetReceivedEventsURL()string

GetReceivedEventsURL returns the ReceivedEventsURL field if it's non-nil, zero value otherwise.

func (*UserLDAPMapping)GetReposURL ¶

func (u *UserLDAPMapping) GetReposURL()string

GetReposURL returns the ReposURL field if it's non-nil, zero value otherwise.

func (*UserLDAPMapping)GetSiteAdmin ¶

func (u *UserLDAPMapping) GetSiteAdmin()bool

GetSiteAdmin returns the SiteAdmin field if it's non-nil, zero value otherwise.

func (*UserLDAPMapping)GetStarredURL ¶

func (u *UserLDAPMapping) GetStarredURL()string

GetStarredURL returns the StarredURL field if it's non-nil, zero value otherwise.

func (*UserLDAPMapping)GetSubscriptionsURL ¶

func (u *UserLDAPMapping) GetSubscriptionsURL()string

GetSubscriptionsURL returns the SubscriptionsURL field if it's non-nil, zero value otherwise.

func (*UserLDAPMapping)GetType ¶

func (u *UserLDAPMapping) GetType()string

GetType returns the Type field if it's non-nil, zero value otherwise.

func (*UserLDAPMapping)GetURL ¶

func (u *UserLDAPMapping) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (UserLDAPMapping)String ¶

func (mUserLDAPMapping) String()string

typeUserListOptions ¶

type UserListOptions struct {// ID of the last user seenSinceint64 `url:"since,omitempty"`// Note: Pagination is powered exclusively by the Since parameter,// ListOptions.Page has no effect.// ListOptions.PerPage controls an undocumented GitHub API parameter.ListOptions}

UserListOptions specifies optional parameters to the UsersService.ListAllmethod.

typeUserMigration ¶

type UserMigration struct {ID   *int64  `json:"id,omitempty"`GUID *string `json:"guid,omitempty"`// State is the current state of a migration.// Possible values are://     "pending" which means the migration hasn't started yet,//     "exporting" which means the migration is in progress,//     "exported" which means the migration finished successfully, or//     "failed" which means the migration failed.State *string `json:"state,omitempty"`// LockRepositories indicates whether repositories are locked (to prevent// manipulation) while migrating data.LockRepositories *bool `json:"lock_repositories,omitempty"`// ExcludeAttachments indicates whether attachments should be excluded from// the migration (to reduce migration archive file size).ExcludeAttachments *bool         `json:"exclude_attachments,omitempty"`URL                *string       `json:"url,omitempty"`CreatedAt          *string       `json:"created_at,omitempty"`UpdatedAt          *string       `json:"updated_at,omitempty"`Repositories       []*Repository `json:"repositories,omitempty"`}

UserMigration represents a GitHub migration (archival).

func (*UserMigration)GetCreatedAt ¶

func (u *UserMigration) GetCreatedAt()string

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*UserMigration)GetExcludeAttachments ¶

func (u *UserMigration) GetExcludeAttachments()bool

GetExcludeAttachments returns the ExcludeAttachments field if it's non-nil, zero value otherwise.

func (*UserMigration)GetGUID ¶

func (u *UserMigration) GetGUID()string

GetGUID returns the GUID field if it's non-nil, zero value otherwise.

func (*UserMigration)GetID ¶

func (u *UserMigration) GetID()int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*UserMigration)GetLockRepositories ¶

func (u *UserMigration) GetLockRepositories()bool

GetLockRepositories returns the LockRepositories field if it's non-nil, zero value otherwise.

func (*UserMigration)GetState ¶

func (u *UserMigration) GetState()string

GetState returns the State field if it's non-nil, zero value otherwise.

func (*UserMigration)GetURL ¶

func (u *UserMigration) GetURL()string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (*UserMigration)GetUpdatedAt ¶

func (u *UserMigration) GetUpdatedAt()string

GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.

func (UserMigration)String ¶

func (mUserMigration) String()string

typeUserMigrationOptions ¶

type UserMigrationOptions struct {// LockRepositories indicates whether repositories should be locked (to prevent// manipulation) while migrating data.LockRepositoriesbool// ExcludeAttachments indicates whether attachments should be excluded from// the migration (to reduce migration archive file size).ExcludeAttachmentsbool}

UserMigrationOptions specifies the optional parameters to Migration methods.

typeUserStats ¶

type UserStats struct {TotalUsers     *int `json:"total_users,omitempty"`AdminUsers     *int `json:"admin_users,omitempty"`SuspendedUsers *int `json:"suspended_users,omitempty"`}

UserStats represents the number of total, admin and suspended users.

func (*UserStats)GetAdminUsers ¶

func (u *UserStats) GetAdminUsers()int

GetAdminUsers returns the AdminUsers field if it's non-nil, zero value otherwise.

func (*UserStats)GetSuspendedUsers ¶

func (u *UserStats) GetSuspendedUsers()int

GetSuspendedUsers returns the SuspendedUsers field if it's non-nil, zero value otherwise.

func (*UserStats)GetTotalUsers ¶

func (u *UserStats) GetTotalUsers()int

GetTotalUsers returns the TotalUsers field if it's non-nil, zero value otherwise.

func (UserStats)String ¶

func (sUserStats) String()string

typeUserSuspendOptions ¶

type UserSuspendOptions struct {Reason *string `json:"reason,omitempty"`}

UserSuspendOptions represents the reason a user is being suspended.

func (*UserSuspendOptions)GetReason ¶

func (u *UserSuspendOptions) GetReason()string

GetReason returns the Reason field if it's non-nil, zero value otherwise.

typeUsersSearchResult ¶

type UsersSearchResult struct {Total             *int   `json:"total_count,omitempty"`IncompleteResults *bool  `json:"incomplete_results,omitempty"`Users             []User `json:"items,omitempty"`}

UsersSearchResult represents the result of a users search.

func (*UsersSearchResult)GetIncompleteResults ¶

func (u *UsersSearchResult) GetIncompleteResults()bool

GetIncompleteResults returns the IncompleteResults field if it's non-nil, zero value otherwise.

func (*UsersSearchResult)GetTotal ¶

func (u *UsersSearchResult) GetTotal()int

GetTotal returns the Total field if it's non-nil, zero value otherwise.

typeUsersService ¶

type UsersService service

UsersService handles communication with the user relatedmethods of the GitHub API.

GitHub API docs:https://developer.github.com/v3/users/

func (*UsersService)AcceptInvitation ¶

func (s *UsersService) AcceptInvitation(ctxcontext.Context, invitationIDint64) (*Response,error)

AcceptInvitation accepts the currently-open repository invitation for theauthenticated user.

GitHub API docs:https://developer.github.com/v3/repos/invitations/#accept-a-repository-invitation

func (*UsersService)AddEmails ¶

func (s *UsersService) AddEmails(ctxcontext.Context, emails []string) ([]*UserEmail, *Response,error)

AddEmails adds email addresses of the authenticated user.

GitHub API docs:https://developer.github.com/v3/users/emails/#add-email-addresses

func (*UsersService)BlockUser ¶

func (s *UsersService) BlockUser(ctxcontext.Context, userstring) (*Response,error)

BlockUser blocks specified user for the authenticated user.

GitHub API docs:https://developer.github.com/v3/users/blocking/#block-a-user

func (*UsersService)CreateGPGKey ¶

func (s *UsersService) CreateGPGKey(ctxcontext.Context, armoredPublicKeystring) (*GPGKey, *Response,error)

CreateGPGKey creates a GPG key. It requires authenticatation via Basic Author OAuth with at least write:gpg_key scope.

GitHub API docs:https://developer.github.com/v3/users/gpg_keys/#create-a-gpg-key

func (*UsersService)CreateKey ¶

func (s *UsersService) CreateKey(ctxcontext.Context, key *Key) (*Key, *Response,error)

CreateKey adds a public key for the authenticated user.

GitHub API docs:https://developer.github.com/v3/users/keys/#create-a-public-key

func (*UsersService)CreateProject ¶

func (s *UsersService) CreateProject(ctxcontext.Context, opts *CreateUserProjectOptions) (*Project, *Response,error)

CreateProject creates a GitHub Project for the current user.

GitHub API docs:https://developer.github.com/v3/projects/#create-a-user-project

func (*UsersService)DeclineInvitation ¶

func (s *UsersService) DeclineInvitation(ctxcontext.Context, invitationIDint64) (*Response,error)

DeclineInvitation declines the currently-open repository invitation for theauthenticated user.

GitHub API docs:https://developer.github.com/v3/repos/invitations/#decline-a-repository-invitation

func (*UsersService)DeleteEmails ¶

func (s *UsersService) DeleteEmails(ctxcontext.Context, emails []string) (*Response,error)

DeleteEmails deletes email addresses from authenticated user.

GitHub API docs:https://developer.github.com/v3/users/emails/#delete-email-addresses

func (*UsersService)DeleteGPGKey ¶

func (s *UsersService) DeleteGPGKey(ctxcontext.Context, idint64) (*Response,error)

DeleteGPGKey deletes a GPG key. It requires authentication via Basic Auth orvia OAuth with at least admin:gpg_key scope.

GitHub API docs:https://developer.github.com/v3/users/gpg_keys/#delete-a-gpg-key

func (*UsersService)DeleteKey ¶

func (s *UsersService) DeleteKey(ctxcontext.Context, idint64) (*Response,error)

DeleteKey deletes a public key.

GitHub API docs:https://developer.github.com/v3/users/keys/#delete-a-public-key

func (*UsersService)DemoteSiteAdmin ¶

func (s *UsersService) DemoteSiteAdmin(ctxcontext.Context, userstring) (*Response,error)

DemoteSiteAdmin demotes a user from site administrator of a GitHub Enterprise instance.

GitHub API docs:https://developer.github.com/enterprise/v3/enterprise-admin/users/#demote-a-site-administrator-to-an-ordinary-user

func (*UsersService)Edit ¶

func (s *UsersService) Edit(ctxcontext.Context, user *User) (*User, *Response,error)

Edit the authenticated user.

GitHub API docs:https://developer.github.com/v3/users/#update-the-authenticated-user

func (*UsersService)Follow ¶

func (s *UsersService) Follow(ctxcontext.Context, userstring) (*Response,error)

Follow will cause the authenticated user to follow the specified user.

GitHub API docs:https://developer.github.com/v3/users/followers/#follow-a-user

func (*UsersService)Get ¶

func (s *UsersService) Get(ctxcontext.Context, userstring) (*User, *Response,error)

Get fetches a user. Passing the empty string will fetch the authenticateduser.

GitHub API docs:https://developer.github.com/v3/users/#get-a-single-userand:https://developer.github.com/v3/users/#get-the-authenticated-user

func (*UsersService)GetByID ¶

func (s *UsersService) GetByID(ctxcontext.Context, idint64) (*User, *Response,error)

GetByID fetches a user.

Note: GetByID uses the undocumented GitHub API endpoint /user/:id.

func (*UsersService)GetGPGKey ¶

func (s *UsersService) GetGPGKey(ctxcontext.Context, idint64) (*GPGKey, *Response,error)

GetGPGKey gets extended details for a single GPG key. It requires authenticationvia Basic Auth or via OAuth with at least read:gpg_key scope.

GitHub API docs:https://developer.github.com/v3/users/gpg_keys/#get-a-single-gpg-key

func (*UsersService)GetHovercard ¶

func (s *UsersService) GetHovercard(ctxcontext.Context, userstring, opts *HovercardOptions) (*Hovercard, *Response,error)

GetHovercard fetches contextual information about user. It requires authenticationvia Basic Auth or via OAuth with the repo scope.

GitHub API docs:https://developer.github.com/v3/users/#get-contextual-information-about-a-user

func (*UsersService)GetKey ¶

func (s *UsersService) GetKey(ctxcontext.Context, idint64) (*Key, *Response,error)

GetKey fetches a single public key.

GitHub API docs:https://developer.github.com/v3/users/keys/#get-a-single-public-key

func (*UsersService)IsBlocked ¶

func (s *UsersService) IsBlocked(ctxcontext.Context, userstring) (bool, *Response,error)

IsBlocked reports whether specified user is blocked by the authenticated user.

GitHub API docs:https://developer.github.com/v3/users/blocking/#check-whether-youve-blocked-a-user

func (*UsersService)IsFollowing ¶

func (s *UsersService) IsFollowing(ctxcontext.Context, user, targetstring) (bool, *Response,error)

IsFollowing checks if "user" is following "target". Passing the emptystring for "user" will check if the authenticated user is following "target".

GitHub API docs:https://developer.github.com/v3/users/followers/#check-if-you-are-following-a-user

func (*UsersService)ListAll ¶

func (s *UsersService) ListAll(ctxcontext.Context, opts *UserListOptions) ([]*User, *Response,error)

ListAll lists all GitHub users.

To paginate through all users, populate 'Since' with the ID of the last user.

GitHub API docs:https://developer.github.com/v3/users/#get-all-users

Example¶

package mainimport ("context""log""github.com/google/go-github/v29/github")func main() {client := github.NewClient(nil)opts := &github.UserListOptions{}for {users, _, err := client.Users.ListAll(context.Background(), opts)if err != nil {log.Fatalf("error listing users: %v", err)}if len(users) == 0 {break}opts.Since = *users[len(users)-1].ID// Process users...}}

func (*UsersService)ListBlockedUsers ¶

func (s *UsersService) ListBlockedUsers(ctxcontext.Context, opts *ListOptions) ([]*User, *Response,error)

ListBlockedUsers lists all the blocked users by the authenticated user.

GitHub API docs:https://developer.github.com/v3/users/blocking/#list-blocked-users

func (*UsersService)ListEmails ¶

func (s *UsersService) ListEmails(ctxcontext.Context, opts *ListOptions) ([]*UserEmail, *Response,error)

ListEmails lists all email addresses for the authenticated user.

GitHub API docs:https://developer.github.com/v3/users/emails/#list-email-addresses-for-a-user

func (*UsersService)ListFollowers ¶

func (s *UsersService) ListFollowers(ctxcontext.Context, userstring, opts *ListOptions) ([]*User, *Response,error)

ListFollowers lists the followers for a user. Passing the empty string willfetch followers for the authenticated user.

GitHub API docs:https://developer.github.com/v3/users/followers/#list-followers-of-a-user

func (*UsersService)ListFollowing ¶

func (s *UsersService) ListFollowing(ctxcontext.Context, userstring, opts *ListOptions) ([]*User, *Response,error)

ListFollowing lists the people that a user is following. Passing the emptystring will list people the authenticated user is following.

GitHub API docs:https://developer.github.com/v3/users/followers/#list-users-followed-by-another-user

func (*UsersService)ListGPGKeys ¶

func (s *UsersService) ListGPGKeys(ctxcontext.Context, userstring, opts *ListOptions) ([]*GPGKey, *Response,error)

ListGPGKeys lists the public GPG keys for a user. Passing the emptystring will fetch keys for the authenticated user. It requires authenticationvia Basic Auth or via OAuth with at least read:gpg_key scope.

GitHub API docs:https://developer.github.com/v3/users/gpg_keys/#list-gpg-keys-for-a-user

func (*UsersService)ListInvitations ¶

func (s *UsersService) ListInvitations(ctxcontext.Context, opts *ListOptions) ([]*RepositoryInvitation, *Response,error)

ListInvitations lists all currently-open repository invitations for theauthenticated user.

GitHub API docs:https://developer.github.com/v3/repos/invitations/#list-a-users-repository-invitations

func (*UsersService)ListKeys ¶

func (s *UsersService) ListKeys(ctxcontext.Context, userstring, opts *ListOptions) ([]*Key, *Response,error)

ListKeys lists the verified public keys for a user. Passing the emptystring will fetch keys for the authenticated user.

GitHub API docs:https://developer.github.com/v3/users/keys/#list-public-keys-for-a-user

func (*UsersService)ListProjects ¶

func (s *UsersService) ListProjects(ctxcontext.Context, userstring, opts *ProjectListOptions) ([]*Project, *Response,error)

ListProjects lists the projects for the specified user.

GitHub API docs:https://developer.github.com/v3/projects/#list-user-projects

func (*UsersService)PromoteSiteAdmin ¶

func (s *UsersService) PromoteSiteAdmin(ctxcontext.Context, userstring) (*Response,error)

PromoteSiteAdmin promotes a user to a site administrator of a GitHub Enterprise instance.

GitHub API docs:https://developer.github.com/enterprise/v3/enterprise-admin/users/#promote-an-ordinary-user-to-a-site-administrator

func (*UsersService)Suspend ¶

func (s *UsersService) Suspend(ctxcontext.Context, userstring, opts *UserSuspendOptions) (*Response,error)

Suspend a user on a GitHub Enterprise instance.

GitHub API docs:https://developer.github.com/enterprise/v3/enterprise-admin/users/#suspend-a-user

func (*UsersService)UnblockUser ¶

func (s *UsersService) UnblockUser(ctxcontext.Context, userstring) (*Response,error)

UnblockUser unblocks specified user for the authenticated user.

GitHub API docs:https://developer.github.com/v3/users/blocking/#unblock-a-user

func (*UsersService)Unfollow ¶

func (s *UsersService) Unfollow(ctxcontext.Context, userstring) (*Response,error)

Unfollow will cause the authenticated user to unfollow the specified user.

GitHub API docs:https://developer.github.com/v3/users/followers/#unfollow-a-user

func (*UsersService)Unsuspend ¶

func (s *UsersService) Unsuspend(ctxcontext.Context, userstring) (*Response,error)

Unsuspend a user on a GitHub Enterprise instance.

GitHub API docs:https://developer.github.com/enterprise/v3/enterprise-admin/users/#unsuspend-a-user

typeWatchEvent ¶

type WatchEvent struct {// Action is the action that was performed. Possible value is: "started".Action *string `json:"action,omitempty"`// The following fields are only populated by Webhook events.Repo         *Repository   `json:"repository,omitempty"`Sender       *User         `json:"sender,omitempty"`Installation *Installation `json:"installation,omitempty"`}

WatchEvent is related to starring a repository, not watching. See this APIblog post for an explanation:https://developer.github.com/changes/2012-09-05-watcher-api/

The event’s actor is the user who starred a repository, and the event’srepository is the repository that was starred.

GitHub API docs:https://developer.github.com/v3/activity/events/types/#watchevent

func (*WatchEvent)GetAction ¶

func (w *WatchEvent) GetAction()string

GetAction returns the Action field if it's non-nil, zero value otherwise.

func (*WatchEvent)GetInstallation ¶

func (w *WatchEvent) GetInstallation() *Installation

GetInstallation returns the Installation field.

func (*WatchEvent)GetRepo ¶

func (w *WatchEvent) GetRepo() *Repository

GetRepo returns the Repo field.

func (*WatchEvent)GetSender ¶

func (w *WatchEvent) GetSender() *User

GetSender returns the Sender field.

typeWebHookAuthor ¶

type WebHookAuthor struct {Email    *string `json:"email,omitempty"`Name     *string `json:"name,omitempty"`Username *string `json:"username,omitempty"`}

WebHookAuthor represents the author or committer of a commit, as specifiedin a WebHookCommit. The commit author may not correspond to a GitHub User.

func (*WebHookAuthor)GetEmail ¶

func (w *WebHookAuthor) GetEmail()string

GetEmail returns the Email field if it's non-nil, zero value otherwise.

func (*WebHookAuthor)GetName ¶

func (w *WebHookAuthor) GetName()string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (*WebHookAuthor)GetUsername ¶

func (w *WebHookAuthor) GetUsername()string

GetUsername returns the Username field if it's non-nil, zero value otherwise.

func (WebHookAuthor)String ¶

func (wWebHookAuthor) String()string

typeWebHookCommit ¶

type WebHookCommit struct {Added     []string       `json:"added,omitempty"`Author    *WebHookAuthor `json:"author,omitempty"`Committer *WebHookAuthor `json:"committer,omitempty"`Distinct  *bool          `json:"distinct,omitempty"`ID        *string        `json:"id,omitempty"`Message   *string        `json:"message,omitempty"`Modified  []string       `json:"modified,omitempty"`Removed   []string       `json:"removed,omitempty"`Timestamp *time.Time     `json:"timestamp,omitempty"`}

WebHookCommit represents the commit variant we receive from GitHub in aWebHookPayload.

func (*WebHookCommit)GetAuthor ¶

func (w *WebHookCommit) GetAuthor() *WebHookAuthor

GetAuthor returns the Author field.

func (*WebHookCommit)GetCommitter ¶

func (w *WebHookCommit) GetCommitter() *WebHookAuthor

GetCommitter returns the Committer field.

func (*WebHookCommit)GetDistinct ¶

func (w *WebHookCommit) GetDistinct()bool

GetDistinct returns the Distinct field if it's non-nil, zero value otherwise.

func (*WebHookCommit)GetID ¶

func (w *WebHookCommit) GetID()string

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*WebHookCommit)GetMessage ¶

func (w *WebHookCommit) GetMessage()string

GetMessage returns the Message field if it's non-nil, zero value otherwise.

func (*WebHookCommit)GetTimestamp ¶

func (w *WebHookCommit) GetTimestamp()time.Time

GetTimestamp returns the Timestamp field if it's non-nil, zero value otherwise.

func (WebHookCommit)String ¶

func (wWebHookCommit) String()string

typeWebHookPayload ¶

type WebHookPayload struct {After      *string         `json:"after,omitempty"`Before     *string         `json:"before,omitempty"`Commits    []WebHookCommit `json:"commits,omitempty"`Compare    *string         `json:"compare,omitempty"`Created    *bool           `json:"created,omitempty"`Deleted    *bool           `json:"deleted,omitempty"`Forced     *bool           `json:"forced,omitempty"`HeadCommit *WebHookCommit  `json:"head_commit,omitempty"`Pusher     *User           `json:"pusher,omitempty"`Ref        *string         `json:"ref,omitempty"`Repo       *Repository     `json:"repository,omitempty"`Sender     *User           `json:"sender,omitempty"`}

WebHookPayload represents the data that is received from GitHub when a pushevent hook is triggered. The format of these payloads pre-date most of theGitHub v3 API, so there are lots of minor incompatibilities with the typesdefined in the rest of the API. Therefore, several types are duplicatedhere to account for these differences.

GitHub API docs:https://help.github.com/articles/post-receive-hooks

func (*WebHookPayload)GetAfter ¶

func (w *WebHookPayload) GetAfter()string

GetAfter returns the After field if it's non-nil, zero value otherwise.

func (*WebHookPayload)GetBefore ¶

func (w *WebHookPayload) GetBefore()string

GetBefore returns the Before field if it's non-nil, zero value otherwise.

func (*WebHookPayload)GetCompare ¶

func (w *WebHookPayload) GetCompare()string

GetCompare returns the Compare field if it's non-nil, zero value otherwise.

func (*WebHookPayload)GetCreated ¶

func (w *WebHookPayload) GetCreated()bool

GetCreated returns the Created field if it's non-nil, zero value otherwise.

func (*WebHookPayload)GetDeleted ¶

func (w *WebHookPayload) GetDeleted()bool

GetDeleted returns the Deleted field if it's non-nil, zero value otherwise.

func (*WebHookPayload)GetForced ¶

func (w *WebHookPayload) GetForced()bool

GetForced returns the Forced field if it's non-nil, zero value otherwise.

func (*WebHookPayload)GetHeadCommit ¶

func (w *WebHookPayload) GetHeadCommit() *WebHookCommit

GetHeadCommit returns the HeadCommit field.

func (*WebHookPayload)GetPusher ¶

func (w *WebHookPayload) GetPusher() *User

GetPusher returns the Pusher field.

func (*WebHookPayload)GetRef ¶

func (w *WebHookPayload) GetRef()string

GetRef returns the Ref field if it's non-nil, zero value otherwise.

func (*WebHookPayload)GetRepo ¶

func (w *WebHookPayload) GetRepo() *Repository

GetRepo returns the Repo field.

func (*WebHookPayload)GetSender ¶

func (w *WebHookPayload) GetSender() *User

GetSender returns the Sender field.

func (WebHookPayload)String ¶

func (wWebHookPayload) String()string

typeWeeklyCommitActivity ¶

type WeeklyCommitActivity struct {Days  []int      `json:"days,omitempty"`Total *int       `json:"total,omitempty"`Week  *Timestamp `json:"week,omitempty"`}

WeeklyCommitActivity represents the weekly commit activity for a repository.The days array is a group of commits per day, starting on Sunday.

func (*WeeklyCommitActivity)GetTotal ¶

func (w *WeeklyCommitActivity) GetTotal()int

GetTotal returns the Total field if it's non-nil, zero value otherwise.

func (*WeeklyCommitActivity)GetWeek ¶

func (w *WeeklyCommitActivity) GetWeek()Timestamp

GetWeek returns the Week field if it's non-nil, zero value otherwise.

func (WeeklyCommitActivity)String ¶

func (wWeeklyCommitActivity) String()string

typeWeeklyStats ¶

type WeeklyStats struct {Week      *Timestamp `json:"w,omitempty"`Additions *int       `json:"a,omitempty"`Deletions *int       `json:"d,omitempty"`Commits   *int       `json:"c,omitempty"`}

WeeklyStats represents the number of additions, deletions and commitsa Contributor made in a given week.

func (*WeeklyStats)GetAdditions ¶

func (w *WeeklyStats) GetAdditions()int

GetAdditions returns the Additions field if it's non-nil, zero value otherwise.

func (*WeeklyStats)GetCommits ¶

func (w *WeeklyStats) GetCommits()int

GetCommits returns the Commits field if it's non-nil, zero value otherwise.

func (*WeeklyStats)GetDeletions ¶

func (w *WeeklyStats) GetDeletions()int

GetDeletions returns the Deletions field if it's non-nil, zero value otherwise.

func (*WeeklyStats)GetWeek ¶

func (w *WeeklyStats) GetWeek()Timestamp

GetWeek returns the Week field if it's non-nil, zero value otherwise.

func (WeeklyStats)String ¶

func (wWeeklyStats) String()string

typeWorkflow ¶added inv29.0.3

type Workflow struct {IDint64     `json:"id"`NodeIDstring    `json:"node_id"`Namestring    `json:"name"`Pathstring    `json:"path"`Statestring    `json:"state"`CreatedAtTimestamp `json:"created_at"`UpdatedAtTimestamp `json:"updated_at"`URLstring    `json:"url"`HTMLURLstring    `json:"html_url"`BadgeURLstring    `json:"badge_url"`}

Workflow represents a repository action workflow.

typeWorkflows ¶added inv29.0.3

type Workflows struct {TotalCountint         `json:"total_count"`Workflows  []*Workflow `json:"workflows"`}

Workflows represents a slice of repository action workflows.

Source Files¶

View all Source files

?	: This menu
/	: Search site
f orF	: Jump to
y orY	: Canonical URL

Movatterモバイル変換

Details

Repository

Links

Documentation¶

Overview¶

Authentication¶

Rate Limiting¶

Accepted Status¶

Conditional Requests¶

Creating and Updating Resources¶

Pagination¶

Index¶

Examples¶

Constants¶

Variables¶

Functions¶

funcBool¶

funcCheckResponse¶

funcDeliveryID¶

funcInt¶

funcInt64¶

funcParseWebHook¶

funcString¶

funcStringify¶

funcValidatePayload¶

funcValidateSignature¶

funcWebHookType¶

Types¶

typeAPIMeta¶

func (*APIMeta)GetVerifiablePasswordAuthentication¶

typeAbuseRateLimitError¶

func (*AbuseRateLimitError)Error¶

func (*AbuseRateLimitError)GetRetryAfter¶

typeAcceptedError¶

func (*AcceptedError)Error¶

typeActionsService¶added inv29.0.3

func (*ActionsService)CreateOrUpdateSecret¶added inv29.0.3

func (*ActionsService)DeleteSecret¶added inv29.0.3

func (*ActionsService)GetPublicKey¶added inv29.0.3

func (*ActionsService)GetSecret¶added inv29.0.3

func (*ActionsService)GetWorkflowByFileName¶added inv29.0.3

func (*ActionsService)GetWorkflowByID¶added inv29.0.3

func (*ActionsService)ListSecrets¶added inv29.0.3

func (*ActionsService)ListWorkflows¶added inv29.0.3

typeActivityListStarredOptions¶

typeActivityService¶

func (*ActivityService)DeleteRepositorySubscription¶

func (*ActivityService)DeleteThreadSubscription¶

func (*ActivityService)GetRepositorySubscription¶

func (*ActivityService)GetThread¶

func (*ActivityService)GetThreadSubscription¶

func (*ActivityService)IsStarred¶

func (*ActivityService)ListEvents¶

func (*ActivityService)ListEventsForOrganization¶

func (*ActivityService)ListEventsForRepoNetwork¶

func (*ActivityService)ListEventsPerformedByUser¶

func (*ActivityService)ListEventsReceivedByUser¶

func (*ActivityService)ListFeeds¶

func (*ActivityService)ListIssueEventsForRepository¶

func (*ActivityService)ListNotifications¶

func (*ActivityService)ListRepositoryEvents¶

func (*ActivityService)ListRepositoryNotifications¶

func (*ActivityService)ListStargazers¶

func (*ActivityService)ListStarred¶

func (*ActivityService)ListUserEventsForOrganization¶

func (*ActivityService)ListWatched¶

func (*ActivityService)ListWatchers¶

func (*ActivityService)MarkNotificationsRead¶

func (*ActivityService)MarkRepositoryNotificationsRead¶

func (*ActivityService)MarkThreadRead¶

func (*ActivityService)SetRepositorySubscription¶

func (*ActivityService)SetThreadSubscription¶

func (*ActivityService)Star¶

func (*ActivityService)Unstar¶

typeAdminEnforcement¶

func (*AdminEnforcement)GetURL¶

typeAdminService¶

func (*AdminService)CreateOrg¶

func (*AdminService)CreateUser¶

Documentation ¶

funcBool ¶

funcCheckResponse ¶

funcDeliveryID ¶

funcInt ¶

funcInt64 ¶

funcParseWebHook ¶

funcString ¶

funcStringify ¶

funcValidatePayload ¶

funcValidateSignature ¶

funcWebHookType ¶

typeAPIMeta ¶

func (*APIMeta)GetVerifiablePasswordAuthentication ¶

typeAbuseRateLimitError ¶

func (*AbuseRateLimitError)Error ¶

func (*AbuseRateLimitError)GetRetryAfter ¶

typeAcceptedError ¶

func (*AcceptedError)Error ¶

typeActionsService ¶added inv29.0.3

func (*ActionsService)CreateOrUpdateSecret ¶added inv29.0.3

func (*ActionsService)DeleteSecret ¶added inv29.0.3

func (*ActionsService)GetPublicKey ¶added inv29.0.3

func (*ActionsService)GetSecret ¶added inv29.0.3

func (*ActionsService)GetWorkflowByFileName ¶added inv29.0.3

func (*ActionsService)GetWorkflowByID ¶added inv29.0.3

func (*ActionsService)ListSecrets ¶added inv29.0.3

func (*ActionsService)ListWorkflows ¶added inv29.0.3

typeActivityListStarredOptions ¶

typeActivityService ¶

func (*ActivityService)DeleteRepositorySubscription ¶

func (*ActivityService)DeleteThreadSubscription ¶

func (*ActivityService)GetRepositorySubscription ¶

func (*ActivityService)GetThread ¶

func (*ActivityService)GetThreadSubscription ¶

func (*ActivityService)IsStarred ¶

func (*ActivityService)ListEvents ¶

func (*ActivityService)ListEventsForOrganization ¶

func (*ActivityService)ListEventsForRepoNetwork ¶

func (*ActivityService)ListEventsPerformedByUser ¶

func (*ActivityService)ListEventsReceivedByUser ¶

func (*ActivityService)ListFeeds ¶

func (*ActivityService)ListIssueEventsForRepository ¶

func (*ActivityService)ListNotifications ¶

func (*ActivityService)ListRepositoryEvents ¶

func (*ActivityService)ListRepositoryNotifications ¶

func (*ActivityService)ListStargazers ¶

func (*ActivityService)ListStarred ¶

func (*ActivityService)ListUserEventsForOrganization ¶

func (*ActivityService)ListWatched ¶

func (*ActivityService)ListWatchers ¶

func (*ActivityService)MarkNotificationsRead ¶

func (*ActivityService)MarkRepositoryNotificationsRead ¶

func (*ActivityService)MarkThreadRead ¶

func (*ActivityService)SetRepositorySubscription ¶

func (*ActivityService)SetThreadSubscription ¶

func (*ActivityService)Star ¶

func (*ActivityService)Unstar ¶

typeAdminEnforcement ¶

func (*AdminEnforcement)GetURL ¶

typeAdminService ¶

func (*AdminService)CreateOrg ¶

func (*AdminService)CreateUser ¶

func (*AdminService)CreateUserImpersonation ¶

func (*AdminService)DeleteUser ¶

func (*AdminService)DeleteUserImpersonation ¶

func (*AdminService)GetAdminStats ¶

func (*AdminService)UpdateTeamLDAPMapping ¶

func (*AdminService)UpdateUserLDAPMapping ¶

typeAdminStats ¶

func (*AdminStats)GetComments ¶

func (*AdminStats)GetGists ¶

func (*AdminStats)GetHooks ¶

func (*AdminStats)GetIssues ¶

func (*AdminStats)GetMilestones ¶

func (*AdminStats)GetOrgs ¶

func (*AdminStats)GetPages ¶

func (*AdminStats)GetPulls ¶

func (*AdminStats)GetRepos ¶

func (*AdminStats)GetUsers ¶