package
0.8.0
Repository: https://github.com/willabides/octo-go.git
Documentation: pkg.go.dev

# Functions

AddEmailForAuthenticated performs requests for "users/add-email-for-authenticated" Add an email address for the authenticated user.
Block performs requests for "users/block" Block a user.
CheckBlocked performs requests for "users/check-blocked" Check if a user is blocked by the authenticated user.
CheckFollowingForUser performs requests for "users/check-following-for-user" Check if a user follows another user.
CheckPersonIsFollowedByAuthenticated performs requests for "users/check-person-is-followed-by-authenticated" Check if a person is followed by the authenticated user.
CreateGpgKeyForAuthenticated performs requests for "users/create-gpg-key-for-authenticated" Create a GPG key for the authenticated user.
CreatePublicSshKeyForAuthenticated performs requests for "users/create-public-ssh-key-for-authenticated" Create a public SSH key for the authenticated user.
DeleteEmailForAuthenticated performs requests for "users/delete-email-for-authenticated" Delete an email address for the authenticated user.
DeleteGpgKeyForAuthenticated performs requests for "users/delete-gpg-key-for-authenticated" Delete a GPG key for the authenticated user.
DeletePublicSshKeyForAuthenticated performs requests for "users/delete-public-ssh-key-for-authenticated" Delete a public SSH key for the authenticated user.
Follow performs requests for "users/follow" Follow a user.
GetAuthenticated performs requests for "users/get-authenticated" Get the authenticated user.
GetByUsername performs requests for "users/get-by-username" Get a user.
GetContextForUser performs requests for "users/get-context-for-user" Get contextual information for a user.
GetGpgKeyForAuthenticated performs requests for "users/get-gpg-key-for-authenticated" Get a GPG key for the authenticated user.
GetPublicSshKeyForAuthenticated performs requests for "users/get-public-ssh-key-for-authenticated" Get a public SSH key for the authenticated user.
List performs requests for "users/list" List users.
ListBlockedByAuthenticated performs requests for "users/list-blocked-by-authenticated" List users blocked by the authenticated user.
ListEmailsForAuthenticated performs requests for "users/list-emails-for-authenticated" List email addresses for the authenticated user.
ListFollowedByAuthenticated performs requests for "users/list-followed-by-authenticated" List the people the authenticated user follows.
ListFollowersForAuthenticatedUser performs requests for "users/list-followers-for-authenticated-user" List followers of the authenticated user.
ListFollowersForUser performs requests for "users/list-followers-for-user" List followers of a user.
ListFollowingForUser performs requests for "users/list-following-for-user" List the people a user follows.
ListGpgKeysForAuthenticated performs requests for "users/list-gpg-keys-for-authenticated" List GPG keys for the authenticated user.
ListGpgKeysForUser performs requests for "users/list-gpg-keys-for-user" List GPG keys for a user.
ListPublicEmailsForAuthenticated performs requests for "users/list-public-emails-for-authenticated" List public email addresses for the authenticated user.
ListPublicKeysForUser performs requests for "users/list-public-keys-for-user" List public keys for a user.
ListPublicSshKeysForAuthenticated performs requests for "users/list-public-ssh-keys-for-authenticated" List public SSH keys for the authenticated user.
NewClient returns a new Client.
SetPrimaryEmailVisibilityForAuthenticated performs requests for "users/set-primary-email-visibility-for-authenticated" Set primary email visibility for the authenticated user.
Unblock performs requests for "users/unblock" Unblock a user.
Unfollow performs requests for "users/unfollow" Unfollow a user.
UpdateAuthenticated performs requests for "users/update-authenticated" Update the authenticated user.

# Structs

AddEmailForAuthenticatedReq is request data for Client.AddEmailForAuthenticated https://developer.github.com/v3/users/emails/#add-an-email-address-for-the-authenticated-user Non-nil errors will have the type *requests.RequestError, octo.ResponseError or url.Error.
AddEmailForAuthenticatedReqBody is a request body for users/add-email-for-authenticated https://developer.github.com/v3/users/emails/#add-an-email-address-for-the-authenticated-user */.
AddEmailForAuthenticatedResponse is a response for AddEmailForAuthenticated https://developer.github.com/v3/users/emails/#add-an-email-address-for-the-authenticated-user */.
BlockReq is request data for Client.Block https://developer.github.com/v3/users/blocking/#block-a-user Non-nil errors will have the type *requests.RequestError, octo.ResponseError or url.Error.
BlockResponse is a response for Block https://developer.github.com/v3/users/blocking/#block-a-user */.
CheckBlockedReq is request data for Client.CheckBlocked https://developer.github.com/v3/users/blocking/#check-if-a-user-is-blocked-by-the-authenticated-user Non-nil errors will have the type *requests.RequestError, octo.ResponseError or url.Error.
CheckBlockedResponse is a response for CheckBlocked https://developer.github.com/v3/users/blocking/#check-if-a-user-is-blocked-by-the-authenticated-user */.
CheckFollowingForUserReq is request data for Client.CheckFollowingForUser https://developer.github.com/v3/users/followers/#check-if-a-user-follows-another-user Non-nil errors will have the type *requests.RequestError, octo.ResponseError or url.Error.
CheckFollowingForUserResponse is a response for CheckFollowingForUser https://developer.github.com/v3/users/followers/#check-if-a-user-follows-another-user */.
CheckPersonIsFollowedByAuthenticatedReq is request data for Client.CheckPersonIsFollowedByAuthenticated https://developer.github.com/v3/users/followers/#check-if-a-person-is-followed-by-the-authenticated-user Non-nil errors will have the type *requests.RequestError, octo.ResponseError or url.Error.
CheckPersonIsFollowedByAuthenticatedResponse is a response for CheckPersonIsFollowedByAuthenticated https://developer.github.com/v3/users/followers/#check-if-a-person-is-followed-by-the-authenticated-user */.
CreateGpgKeyForAuthenticatedReq is request data for Client.CreateGpgKeyForAuthenticated https://developer.github.com/v3/users/gpg_keys/#create-a-gpg-key-for-the-authenticated-user Non-nil errors will have the type *requests.RequestError, octo.ResponseError or url.Error.
CreateGpgKeyForAuthenticatedReqBody is a request body for users/create-gpg-key-for-authenticated https://developer.github.com/v3/users/gpg_keys/#create-a-gpg-key-for-the-authenticated-user */.
CreateGpgKeyForAuthenticatedResponse is a response for CreateGpgKeyForAuthenticated https://developer.github.com/v3/users/gpg_keys/#create-a-gpg-key-for-the-authenticated-user */.
CreatePublicSshKeyForAuthenticatedReq is request data for Client.CreatePublicSshKeyForAuthenticated https://developer.github.com/v3/users/keys/#create-a-public-ssh-key-for-the-authenticated-user Non-nil errors will have the type *requests.RequestError, octo.ResponseError or url.Error.
CreatePublicSshKeyForAuthenticatedReqBody is a request body for users/create-public-ssh-key-for-authenticated https://developer.github.com/v3/users/keys/#create-a-public-ssh-key-for-the-authenticated-user */.
CreatePublicSshKeyForAuthenticatedResponse is a response for CreatePublicSshKeyForAuthenticated https://developer.github.com/v3/users/keys/#create-a-public-ssh-key-for-the-authenticated-user */.
DeleteEmailForAuthenticatedReq is request data for Client.DeleteEmailForAuthenticated https://developer.github.com/v3/users/emails/#delete-an-email-address-for-the-authenticated-user Non-nil errors will have the type *requests.RequestError, octo.ResponseError or url.Error.
DeleteEmailForAuthenticatedReqBody is a request body for users/delete-email-for-authenticated https://developer.github.com/v3/users/emails/#delete-an-email-address-for-the-authenticated-user */.
DeleteEmailForAuthenticatedResponse is a response for DeleteEmailForAuthenticated https://developer.github.com/v3/users/emails/#delete-an-email-address-for-the-authenticated-user */.
DeleteGpgKeyForAuthenticatedReq is request data for Client.DeleteGpgKeyForAuthenticated https://developer.github.com/v3/users/gpg_keys/#delete-a-gpg-key-for-the-authenticated-user Non-nil errors will have the type *requests.RequestError, octo.ResponseError or url.Error.
DeleteGpgKeyForAuthenticatedResponse is a response for DeleteGpgKeyForAuthenticated https://developer.github.com/v3/users/gpg_keys/#delete-a-gpg-key-for-the-authenticated-user */.
DeletePublicSshKeyForAuthenticatedReq is request data for Client.DeletePublicSshKeyForAuthenticated https://developer.github.com/v3/users/keys/#delete-a-public-ssh-key-for-the-authenticated-user Non-nil errors will have the type *requests.RequestError, octo.ResponseError or url.Error.
DeletePublicSshKeyForAuthenticatedResponse is a response for DeletePublicSshKeyForAuthenticated https://developer.github.com/v3/users/keys/#delete-a-public-ssh-key-for-the-authenticated-user */.
FollowReq is request data for Client.Follow https://developer.github.com/v3/users/followers/#follow-a-user Non-nil errors will have the type *requests.RequestError, octo.ResponseError or url.Error.
FollowResponse is a response for Follow https://developer.github.com/v3/users/followers/#follow-a-user */.
GetAuthenticatedReq is request data for Client.GetAuthenticated https://developer.github.com/v3/users/#get-the-authenticated-user Non-nil errors will have the type *requests.RequestError, octo.ResponseError or url.Error.
GetAuthenticatedResponse is a response for GetAuthenticated https://developer.github.com/v3/users/#get-the-authenticated-user */.
GetAuthenticatedResponseBody is a response body for GetAuthenticated https://developer.github.com/v3/users/#get-the-authenticated-user */.
GetByUsernameReq is request data for Client.GetByUsername https://developer.github.com/v3/users/#get-a-user Non-nil errors will have the type *requests.RequestError, octo.ResponseError or url.Error.
GetByUsernameResponse is a response for GetByUsername https://developer.github.com/v3/users/#get-a-user */.
GetByUsernameResponseBody is a response body for GetByUsername https://developer.github.com/v3/users/#get-a-user */.
GetContextForUserReq is request data for Client.GetContextForUser https://developer.github.com/v3/users/#get-contextual-information-for-a-user Non-nil errors will have the type *requests.RequestError, octo.ResponseError or url.Error.
GetContextForUserResponse is a response for GetContextForUser https://developer.github.com/v3/users/#get-contextual-information-for-a-user */.
GetGpgKeyForAuthenticatedReq is request data for Client.GetGpgKeyForAuthenticated https://developer.github.com/v3/users/gpg_keys/#get-a-gpg-key-for-the-authenticated-user Non-nil errors will have the type *requests.RequestError, octo.ResponseError or url.Error.
GetGpgKeyForAuthenticatedResponse is a response for GetGpgKeyForAuthenticated https://developer.github.com/v3/users/gpg_keys/#get-a-gpg-key-for-the-authenticated-user */.
GetPublicSshKeyForAuthenticatedReq is request data for Client.GetPublicSshKeyForAuthenticated https://developer.github.com/v3/users/keys/#get-a-public-ssh-key-for-the-authenticated-user Non-nil errors will have the type *requests.RequestError, octo.ResponseError or url.Error.
GetPublicSshKeyForAuthenticatedResponse is a response for GetPublicSshKeyForAuthenticated https://developer.github.com/v3/users/keys/#get-a-public-ssh-key-for-the-authenticated-user */.
ListBlockedByAuthenticatedReq is request data for Client.ListBlockedByAuthenticated https://developer.github.com/v3/users/blocking/#list-users-blocked-by-the-authenticated-user Non-nil errors will have the type *requests.RequestError, octo.ResponseError or url.Error.
ListBlockedByAuthenticatedResponse is a response for ListBlockedByAuthenticated https://developer.github.com/v3/users/blocking/#list-users-blocked-by-the-authenticated-user */.
ListEmailsForAuthenticatedReq is request data for Client.ListEmailsForAuthenticated https://developer.github.com/v3/users/emails/#list-email-addresses-for-the-authenticated-user Non-nil errors will have the type *requests.RequestError, octo.ResponseError or url.Error.
ListEmailsForAuthenticatedResponse is a response for ListEmailsForAuthenticated https://developer.github.com/v3/users/emails/#list-email-addresses-for-the-authenticated-user */.
ListFollowedByAuthenticatedReq is request data for Client.ListFollowedByAuthenticated https://developer.github.com/v3/users/followers/#list-the-people-the-authenticated-user-follows Non-nil errors will have the type *requests.RequestError, octo.ResponseError or url.Error.
ListFollowedByAuthenticatedResponse is a response for ListFollowedByAuthenticated https://developer.github.com/v3/users/followers/#list-the-people-the-authenticated-user-follows */.
ListFollowersForAuthenticatedUserReq is request data for Client.ListFollowersForAuthenticatedUser https://developer.github.com/v3/users/followers/#list-followers-of-the-authenticated-user Non-nil errors will have the type *requests.RequestError, octo.ResponseError or url.Error.
ListFollowersForAuthenticatedUserResponse is a response for ListFollowersForAuthenticatedUser https://developer.github.com/v3/users/followers/#list-followers-of-the-authenticated-user */.
ListFollowersForUserReq is request data for Client.ListFollowersForUser https://developer.github.com/v3/users/followers/#list-followers-of-a-user Non-nil errors will have the type *requests.RequestError, octo.ResponseError or url.Error.
ListFollowersForUserResponse is a response for ListFollowersForUser https://developer.github.com/v3/users/followers/#list-followers-of-a-user */.
ListFollowingForUserReq is request data for Client.ListFollowingForUser https://developer.github.com/v3/users/followers/#list-the-people-a-user-follows Non-nil errors will have the type *requests.RequestError, octo.ResponseError or url.Error.
ListFollowingForUserResponse is a response for ListFollowingForUser https://developer.github.com/v3/users/followers/#list-the-people-a-user-follows */.
ListGpgKeysForAuthenticatedReq is request data for Client.ListGpgKeysForAuthenticated https://developer.github.com/v3/users/gpg_keys/#list-gpg-keys-for-the-authenticated-user Non-nil errors will have the type *requests.RequestError, octo.ResponseError or url.Error.
ListGpgKeysForAuthenticatedResponse is a response for ListGpgKeysForAuthenticated https://developer.github.com/v3/users/gpg_keys/#list-gpg-keys-for-the-authenticated-user */.
ListGpgKeysForUserReq is request data for Client.ListGpgKeysForUser https://developer.github.com/v3/users/gpg_keys/#list-gpg-keys-for-a-user Non-nil errors will have the type *requests.RequestError, octo.ResponseError or url.Error.
ListGpgKeysForUserResponse is a response for ListGpgKeysForUser https://developer.github.com/v3/users/gpg_keys/#list-gpg-keys-for-a-user */.
ListPublicEmailsForAuthenticatedReq is request data for Client.ListPublicEmailsForAuthenticated https://developer.github.com/v3/users/emails/#list-public-email-addresses-for-the-authenticated-user Non-nil errors will have the type *requests.RequestError, octo.ResponseError or url.Error.
ListPublicEmailsForAuthenticatedResponse is a response for ListPublicEmailsForAuthenticated https://developer.github.com/v3/users/emails/#list-public-email-addresses-for-the-authenticated-user */.
ListPublicKeysForUserReq is request data for Client.ListPublicKeysForUser https://developer.github.com/v3/users/keys/#list-public-keys-for-a-user Non-nil errors will have the type *requests.RequestError, octo.ResponseError or url.Error.
ListPublicKeysForUserResponse is a response for ListPublicKeysForUser https://developer.github.com/v3/users/keys/#list-public-keys-for-a-user */.
ListPublicSshKeysForAuthenticatedReq is request data for Client.ListPublicSshKeysForAuthenticated https://developer.github.com/v3/users/keys/#list-public-ssh-keys-for-the-authenticated-user Non-nil errors will have the type *requests.RequestError, octo.ResponseError or url.Error.
ListPublicSshKeysForAuthenticatedResponse is a response for ListPublicSshKeysForAuthenticated https://developer.github.com/v3/users/keys/#list-public-ssh-keys-for-the-authenticated-user */.
ListReq is request data for Client.List https://developer.github.com/v3/users/#list-users Non-nil errors will have the type *requests.RequestError, octo.ResponseError or url.Error.
ListResponse is a response for List https://developer.github.com/v3/users/#list-users */.
SetPrimaryEmailVisibilityForAuthenticatedReq is request data for Client.SetPrimaryEmailVisibilityForAuthenticated https://developer.github.com/v3/users/emails/#set-primary-email-visibility-for-the-authenticated-user Non-nil errors will have the type *requests.RequestError, octo.ResponseError or url.Error.
SetPrimaryEmailVisibilityForAuthenticatedReqBody is a request body for users/set-primary-email-visibility-for-authenticated https://developer.github.com/v3/users/emails/#set-primary-email-visibility-for-the-authenticated-user */.
SetPrimaryEmailVisibilityForAuthenticatedResponse is a response for SetPrimaryEmailVisibilityForAuthenticated https://developer.github.com/v3/users/emails/#set-primary-email-visibility-for-the-authenticated-user */.
UnblockReq is request data for Client.Unblock https://developer.github.com/v3/users/blocking/#unblock-a-user Non-nil errors will have the type *requests.RequestError, octo.ResponseError or url.Error.
UnblockResponse is a response for Unblock https://developer.github.com/v3/users/blocking/#unblock-a-user */.
UnfollowReq is request data for Client.Unfollow https://developer.github.com/v3/users/followers/#unfollow-a-user Non-nil errors will have the type *requests.RequestError, octo.ResponseError or url.Error.
UnfollowResponse is a response for Unfollow https://developer.github.com/v3/users/followers/#unfollow-a-user */.
UpdateAuthenticatedReq is request data for Client.UpdateAuthenticated https://developer.github.com/v3/users/#update-the-authenticated-user Non-nil errors will have the type *requests.RequestError, octo.ResponseError or url.Error.
UpdateAuthenticatedReqBody is a request body for users/update-authenticated https://developer.github.com/v3/users/#update-the-authenticated-user */.
UpdateAuthenticatedResponse is a response for UpdateAuthenticated https://developer.github.com/v3/users/#update-the-authenticated-user */.

# Type aliases

Client is a set of options to apply to requests.