GitHubKit 0.12.10__py3-none-any.whl → 0.12.11__py3-none-any.whl

githubkit/versions/v2022_11_28/rest/users.py

@@ -86,7 +86,14 @@ class UsersClient:
     ) -> Response[
         Union[PrivateUser, PublicUser], Union[PrivateUserType, PublicUserType]
     ]:
-        """See also: https://docs.github.com/rest/users/users#get-the-authenticated-user"""
+        """users/get-authenticated
+
+        GET /user
+
+        OAuth app tokens and personal access tokens (classic) need the `user` scope in order for the response to include private profile information.
+
+        See also: https://docs.github.com/rest/users/users#get-the-authenticated-user
+        """
 
         from typing import Union
 
@@ -114,7 +121,14 @@ class UsersClient:
     ) -> Response[
         Union[PrivateUser, PublicUser], Union[PrivateUserType, PublicUserType]
     ]:
-        """See also: https://docs.github.com/rest/users/users#get-the-authenticated-user"""
+        """users/get-authenticated
+
+        GET /user
+
+        OAuth app tokens and personal access tokens (classic) need the `user` scope in order for the response to include private profile information.
+
+        See also: https://docs.github.com/rest/users/users#get-the-authenticated-user
+        """
 
         from typing import Union
 
@@ -166,7 +180,14 @@ class UsersClient:
         data: Missing[UserPatchBodyType] = UNSET,
         **kwargs,
     ) -> Response[PrivateUser, PrivateUserType]:
-        """See also: https://docs.github.com/rest/users/users#update-the-authenticated-user"""
+        """users/update-authenticated
+
+        PATCH /user
+
+        **Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API.
+
+        See also: https://docs.github.com/rest/users/users#update-the-authenticated-user
+        """
 
         from ..models import BasicError, PrivateUser, UserPatchBody, ValidationError
 
@@ -228,7 +249,14 @@ class UsersClient:
         data: Missing[UserPatchBodyType] = UNSET,
         **kwargs,
     ) -> Response[PrivateUser, PrivateUserType]:
-        """See also: https://docs.github.com/rest/users/users#update-the-authenticated-user"""
+        """users/update-authenticated
+
+        PATCH /user
+
+        **Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API.
+
+        See also: https://docs.github.com/rest/users/users#update-the-authenticated-user
+        """
 
         from ..models import BasicError, PrivateUser, UserPatchBody, ValidationError
 
@@ -266,7 +294,14 @@ class UsersClient:
         page: Missing[int] = UNSET,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[list[SimpleUser], list[SimpleUserType]]:
-        """See also: https://docs.github.com/rest/users/blocking#list-users-blocked-by-the-authenticated-user"""
+        """users/list-blocked-by-authenticated-user
+
+        GET /user/blocks
+
+        List the users you've blocked on your personal account.
+
+        See also: https://docs.github.com/rest/users/blocking#list-users-blocked-by-the-authenticated-user
+        """
 
         from ..models import BasicError, SimpleUser
 
@@ -299,7 +334,14 @@ class UsersClient:
         page: Missing[int] = UNSET,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[list[SimpleUser], list[SimpleUserType]]:
-        """See also: https://docs.github.com/rest/users/blocking#list-users-blocked-by-the-authenticated-user"""
+        """users/list-blocked-by-authenticated-user
+
+        GET /user/blocks
+
+        List the users you've blocked on your personal account.
+
+        See also: https://docs.github.com/rest/users/blocking#list-users-blocked-by-the-authenticated-user
+        """
 
         from ..models import BasicError, SimpleUser
 
@@ -331,7 +373,14 @@ class UsersClient:
         *,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response:
-        """See also: https://docs.github.com/rest/users/blocking#check-if-a-user-is-blocked-by-the-authenticated-user"""
+        """users/check-blocked
+
+        GET /user/blocks/{username}
+
+        Returns a 204 if the given user is blocked by the authenticated user. Returns a 404 if the given user is not blocked by the authenticated user, or if the given user account has been identified as spam by GitHub.
+
+        See also: https://docs.github.com/rest/users/blocking#check-if-a-user-is-blocked-by-the-authenticated-user
+        """
 
         from ..models import BasicError
 
@@ -356,7 +405,14 @@ class UsersClient:
         *,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response:
-        """See also: https://docs.github.com/rest/users/blocking#check-if-a-user-is-blocked-by-the-authenticated-user"""
+        """users/check-blocked
+
+        GET /user/blocks/{username}
+
+        Returns a 204 if the given user is blocked by the authenticated user. Returns a 404 if the given user is not blocked by the authenticated user, or if the given user account has been identified as spam by GitHub.
+
+        See also: https://docs.github.com/rest/users/blocking#check-if-a-user-is-blocked-by-the-authenticated-user
+        """
 
         from ..models import BasicError
 
@@ -381,7 +437,14 @@ class UsersClient:
         *,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response:
-        """See also: https://docs.github.com/rest/users/blocking#block-a-user"""
+        """users/block
+
+        PUT /user/blocks/{username}
+
+        Blocks the given user and returns a 204. If the authenticated user cannot block the given user a 422 is returned.
+
+        See also: https://docs.github.com/rest/users/blocking#block-a-user
+        """
 
         from ..models import BasicError, ValidationError
 
@@ -407,7 +470,14 @@ class UsersClient:
         *,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response:
-        """See also: https://docs.github.com/rest/users/blocking#block-a-user"""
+        """users/block
+
+        PUT /user/blocks/{username}
+
+        Blocks the given user and returns a 204. If the authenticated user cannot block the given user a 422 is returned.
+
+        See also: https://docs.github.com/rest/users/blocking#block-a-user
+        """
 
         from ..models import BasicError, ValidationError
 
@@ -433,7 +503,14 @@ class UsersClient:
         *,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response:
-        """See also: https://docs.github.com/rest/users/blocking#unblock-a-user"""
+        """users/unblock
+
+        DELETE /user/blocks/{username}
+
+        Unblocks the given user and returns a 204.
+
+        See also: https://docs.github.com/rest/users/blocking#unblock-a-user
+        """
 
         from ..models import BasicError
 
@@ -458,7 +535,14 @@ class UsersClient:
         *,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response:
-        """See also: https://docs.github.com/rest/users/blocking#unblock-a-user"""
+        """users/unblock
+
+        DELETE /user/blocks/{username}
+
+        Unblocks the given user and returns a 204.
+
+        See also: https://docs.github.com/rest/users/blocking#unblock-a-user
+        """
 
         from ..models import BasicError
 
@@ -501,7 +585,14 @@ class UsersClient:
         data: Missing[UserEmailVisibilityPatchBodyType] = UNSET,
         **kwargs,
     ) -> Response[list[Email], list[EmailType]]:
-        """See also: https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user"""
+        """users/set-primary-email-visibility-for-authenticated-user
+
+        PATCH /user/email/visibility
+
+        Sets the visibility for your primary email addresses.
+
+        See also: https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user
+        """
 
         from ..models import (
             BasicError,
@@ -561,7 +652,14 @@ class UsersClient:
         data: Missing[UserEmailVisibilityPatchBodyType] = UNSET,
         **kwargs,
     ) -> Response[list[Email], list[EmailType]]:
-        """See also: https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user"""
+        """users/set-primary-email-visibility-for-authenticated-user
+
+        PATCH /user/email/visibility
+
+        Sets the visibility for your primary email addresses.
+
+        See also: https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user
+        """
 
         from ..models import (
             BasicError,
@@ -604,7 +702,17 @@ class UsersClient:
         page: Missing[int] = UNSET,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[list[Email], list[EmailType]]:
-        """See also: https://docs.github.com/rest/users/emails#list-email-addresses-for-the-authenticated-user"""
+        """users/list-emails-for-authenticated-user
+
+        GET /user/emails
+
+        Lists all of your email addresses, and specifies which one is visible
+        to the public.
+
+        OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint.
+
+        See also: https://docs.github.com/rest/users/emails#list-email-addresses-for-the-authenticated-user
+        """
 
         from ..models import BasicError, Email
 
@@ -637,7 +745,17 @@ class UsersClient:
         page: Missing[int] = UNSET,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[list[Email], list[EmailType]]:
-        """See also: https://docs.github.com/rest/users/emails#list-email-addresses-for-the-authenticated-user"""
+        """users/list-emails-for-authenticated-user
+
+        GET /user/emails
+
+        Lists all of your email addresses, and specifies which one is visible
+        to the public.
+
+        OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint.
+
+        See also: https://docs.github.com/rest/users/emails#list-email-addresses-for-the-authenticated-user
+        """
 
         from ..models import BasicError, Email
 
@@ -687,7 +805,14 @@ class UsersClient:
         data: Missing[Union[UserEmailsPostBodyOneof0Type, list[str], str]] = UNSET,
         **kwargs,
     ) -> Response[list[Email], list[EmailType]]:
-        """See also: https://docs.github.com/rest/users/emails#add-an-email-address-for-the-authenticated-user"""
+        """users/add-email-for-authenticated-user
+
+        POST /user/emails
+
+        OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.
+
+        See also: https://docs.github.com/rest/users/emails#add-an-email-address-for-the-authenticated-user
+        """
 
         from typing import Union
 
@@ -758,7 +883,14 @@ class UsersClient:
         data: Missing[Union[UserEmailsPostBodyOneof0Type, list[str], str]] = UNSET,
         **kwargs,
     ) -> Response[list[Email], list[EmailType]]:
-        """See also: https://docs.github.com/rest/users/emails#add-an-email-address-for-the-authenticated-user"""
+        """users/add-email-for-authenticated-user
+
+        POST /user/emails
+
+        OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.
+
+        See also: https://docs.github.com/rest/users/emails#add-an-email-address-for-the-authenticated-user
+        """
 
         from typing import Union
 
@@ -829,7 +961,14 @@ class UsersClient:
         data: Missing[Union[UserEmailsDeleteBodyOneof0Type, list[str], str]] = UNSET,
         **kwargs,
     ) -> Response:
-        """See also: https://docs.github.com/rest/users/emails#delete-an-email-address-for-the-authenticated-user"""
+        """users/delete-email-for-authenticated-user
+
+        DELETE /user/emails
+
+        OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.
+
+        See also: https://docs.github.com/rest/users/emails#delete-an-email-address-for-the-authenticated-user
+        """
 
         from typing import Union
 
@@ -894,7 +1033,14 @@ class UsersClient:
         data: Missing[Union[UserEmailsDeleteBodyOneof0Type, list[str], str]] = UNSET,
         **kwargs,
     ) -> Response:
-        """See also: https://docs.github.com/rest/users/emails#delete-an-email-address-for-the-authenticated-user"""
+        """users/delete-email-for-authenticated-user
+
+        DELETE /user/emails
+
+        OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.
+
+        See also: https://docs.github.com/rest/users/emails#delete-an-email-address-for-the-authenticated-user
+        """
 
         from typing import Union
 
@@ -942,7 +1088,14 @@ class UsersClient:
         page: Missing[int] = UNSET,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[list[SimpleUser], list[SimpleUserType]]:
-        """See also: https://docs.github.com/rest/users/followers#list-followers-of-the-authenticated-user"""
+        """users/list-followers-for-authenticated-user
+
+        GET /user/followers
+
+        Lists the people following the authenticated user.
+
+        See also: https://docs.github.com/rest/users/followers#list-followers-of-the-authenticated-user
+        """
 
         from ..models import BasicError, SimpleUser
 
@@ -974,7 +1127,14 @@ class UsersClient:
         page: Missing[int] = UNSET,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[list[SimpleUser], list[SimpleUserType]]:
-        """See also: https://docs.github.com/rest/users/followers#list-followers-of-the-authenticated-user"""
+        """users/list-followers-for-authenticated-user
+
+        GET /user/followers
+
+        Lists the people following the authenticated user.
+
+        See also: https://docs.github.com/rest/users/followers#list-followers-of-the-authenticated-user
+        """
 
         from ..models import BasicError, SimpleUser
 
@@ -1006,7 +1166,14 @@ class UsersClient:
         page: Missing[int] = UNSET,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[list[SimpleUser], list[SimpleUserType]]:
-        """See also: https://docs.github.com/rest/users/followers#list-the-people-the-authenticated-user-follows"""
+        """users/list-followed-by-authenticated-user
+
+        GET /user/following
+
+        Lists the people who the authenticated user follows.
+
+        See also: https://docs.github.com/rest/users/followers#list-the-people-the-authenticated-user-follows
+        """
 
         from ..models import BasicError, SimpleUser
 
@@ -1038,7 +1205,14 @@ class UsersClient:
         page: Missing[int] = UNSET,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[list[SimpleUser], list[SimpleUserType]]:
-        """See also: https://docs.github.com/rest/users/followers#list-the-people-the-authenticated-user-follows"""
+        """users/list-followed-by-authenticated-user
+
+        GET /user/following
+
+        Lists the people who the authenticated user follows.
+
+        See also: https://docs.github.com/rest/users/followers#list-the-people-the-authenticated-user-follows
+        """
 
         from ..models import BasicError, SimpleUser
 
@@ -1069,7 +1243,12 @@ class UsersClient:
         *,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response:
-        """See also: https://docs.github.com/rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user"""
+        """users/check-person-is-followed-by-authenticated
+
+        GET /user/following/{username}
+
+        See also: https://docs.github.com/rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user
+        """
 
         from ..models import BasicError
 
@@ -1094,7 +1273,12 @@ class UsersClient:
         *,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response:
-        """See also: https://docs.github.com/rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user"""
+        """users/check-person-is-followed-by-authenticated
+
+        GET /user/following/{username}
+
+        See also: https://docs.github.com/rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user
+        """
 
         from ..models import BasicError
 
@@ -1119,7 +1303,16 @@ class UsersClient:
         *,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response:
-        """See also: https://docs.github.com/rest/users/followers#follow-a-user"""
+        """users/follow
+
+        PUT /user/following/{username}
+
+        Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."
+
+        OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint.
+
+        See also: https://docs.github.com/rest/users/followers#follow-a-user
+        """
 
         from ..models import BasicError, ValidationError
 
@@ -1145,7 +1338,16 @@ class UsersClient:
         *,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response:
-        """See also: https://docs.github.com/rest/users/followers#follow-a-user"""
+        """users/follow
+
+        PUT /user/following/{username}
+
+        Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."
+
+        OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint.
+
+        See also: https://docs.github.com/rest/users/followers#follow-a-user
+        """
 
         from ..models import BasicError, ValidationError
 
@@ -1171,7 +1373,14 @@ class UsersClient:
         *,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response:
-        """See also: https://docs.github.com/rest/users/followers#unfollow-a-user"""
+        """users/unfollow
+
+        DELETE /user/following/{username}
+
+        OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint.
+
+        See also: https://docs.github.com/rest/users/followers#unfollow-a-user
+        """
 
         from ..models import BasicError
 
@@ -1196,7 +1405,14 @@ class UsersClient:
         *,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response:
-        """See also: https://docs.github.com/rest/users/followers#unfollow-a-user"""
+        """users/unfollow
+
+        DELETE /user/following/{username}
+
+        OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint.
+
+        See also: https://docs.github.com/rest/users/followers#unfollow-a-user
+        """
 
         from ..models import BasicError
 
@@ -1222,7 +1438,16 @@ class UsersClient:
         page: Missing[int] = UNSET,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[list[GpgKey], list[GpgKeyType]]:
-        """See also: https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-the-authenticated-user"""
+        """users/list-gpg-keys-for-authenticated-user
+
+        GET /user/gpg_keys
+
+        Lists the current user's GPG keys.
+
+        OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint.
+
+        See also: https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-the-authenticated-user
+        """
 
         from ..models import BasicError, GpgKey
 
@@ -1255,7 +1480,16 @@ class UsersClient:
         page: Missing[int] = UNSET,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[list[GpgKey], list[GpgKeyType]]:
-        """See also: https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-the-authenticated-user"""
+        """users/list-gpg-keys-for-authenticated-user
+
+        GET /user/gpg_keys
+
+        Lists the current user's GPG keys.
+
+        OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint.
+
+        See also: https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-the-authenticated-user
+        """
 
         from ..models import BasicError, GpgKey
 
@@ -1306,7 +1540,16 @@ class UsersClient:
         data: Missing[UserGpgKeysPostBodyType] = UNSET,
         **kwargs,
     ) -> Response[GpgKey, GpgKeyType]:
-        """See also: https://docs.github.com/rest/users/gpg-keys#create-a-gpg-key-for-the-authenticated-user"""
+        """users/create-gpg-key-for-authenticated-user
+
+        POST /user/gpg_keys
+
+        Adds a GPG key to the authenticated user's GitHub account.
+
+        OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint.
+
+        See also: https://docs.github.com/rest/users/gpg-keys#create-a-gpg-key-for-the-authenticated-user
+        """
 
         from ..models import BasicError, GpgKey, UserGpgKeysPostBody, ValidationError
 
@@ -1362,7 +1605,16 @@ class UsersClient:
         data: Missing[UserGpgKeysPostBodyType] = UNSET,
         **kwargs,
     ) -> Response[GpgKey, GpgKeyType]:
-        """See also: https://docs.github.com/rest/users/gpg-keys#create-a-gpg-key-for-the-authenticated-user"""
+        """users/create-gpg-key-for-authenticated-user
+
+        POST /user/gpg_keys
+
+        Adds a GPG key to the authenticated user's GitHub account.
+
+        OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint.
+
+        See also: https://docs.github.com/rest/users/gpg-keys#create-a-gpg-key-for-the-authenticated-user
+        """
 
         from ..models import BasicError, GpgKey, UserGpgKeysPostBody, ValidationError
 
@@ -1399,7 +1651,16 @@ class UsersClient:
         *,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[GpgKey, GpgKeyType]:
-        """See also: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user"""
+        """users/get-gpg-key-for-authenticated-user
+
+        GET /user/gpg_keys/{gpg_key_id}
+
+        View extended details for a single GPG key.
+
+        OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint.
+
+        See also: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user
+        """
 
         from ..models import BasicError, GpgKey
 
@@ -1425,7 +1686,16 @@ class UsersClient:
         *,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[GpgKey, GpgKeyType]:
-        """See also: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user"""
+        """users/get-gpg-key-for-authenticated-user
+
+        GET /user/gpg_keys/{gpg_key_id}
+
+        View extended details for a single GPG key.
+
+        OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint.
+
+        See also: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user
+        """
 
         from ..models import BasicError, GpgKey
 
@@ -1451,7 +1721,16 @@ class UsersClient:
         *,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response:
-        """See also: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user"""
+        """users/delete-gpg-key-for-authenticated-user
+
+        DELETE /user/gpg_keys/{gpg_key_id}
+
+        Removes a GPG key from the authenticated user's GitHub account.
+
+        OAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint.
+
+        See also: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user
+        """
 
         from ..models import BasicError, ValidationError
 
@@ -1477,7 +1756,16 @@ class UsersClient:
         *,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response:
-        """See also: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user"""
+        """users/delete-gpg-key-for-authenticated-user
+
+        DELETE /user/gpg_keys/{gpg_key_id}
+
+        Removes a GPG key from the authenticated user's GitHub account.
+
+        OAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint.
+
+        See also: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user
+        """
 
         from ..models import BasicError, ValidationError
 
@@ -1504,7 +1792,16 @@ class UsersClient:
         page: Missing[int] = UNSET,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[list[Key], list[KeyType]]:
-        """See also: https://docs.github.com/rest/users/keys#list-public-ssh-keys-for-the-authenticated-user"""
+        """users/list-public-ssh-keys-for-authenticated-user
+
+        GET /user/keys
+
+        Lists the public SSH keys for the authenticated user's GitHub account.
+
+        OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint.
+
+        See also: https://docs.github.com/rest/users/keys#list-public-ssh-keys-for-the-authenticated-user
+        """
 
         from ..models import BasicError, Key
 
@@ -1537,7 +1834,16 @@ class UsersClient:
         page: Missing[int] = UNSET,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[list[Key], list[KeyType]]:
-        """See also: https://docs.github.com/rest/users/keys#list-public-ssh-keys-for-the-authenticated-user"""
+        """users/list-public-ssh-keys-for-authenticated-user
+
+        GET /user/keys
+
+        Lists the public SSH keys for the authenticated user's GitHub account.
+
+        OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint.
+
+        See also: https://docs.github.com/rest/users/keys#list-public-ssh-keys-for-the-authenticated-user
+        """
 
         from ..models import BasicError, Key
 
@@ -1585,7 +1891,16 @@ class UsersClient:
         data: Missing[UserKeysPostBodyType] = UNSET,
         **kwargs,
     ) -> Response[Key, KeyType]:
-        """See also: https://docs.github.com/rest/users/keys#create-a-public-ssh-key-for-the-authenticated-user"""
+        """users/create-public-ssh-key-for-authenticated-user
+
+        POST /user/keys
+
+        Adds a public SSH key to the authenticated user's GitHub account.
+
+        OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint.
+
+        See also: https://docs.github.com/rest/users/keys#create-a-public-ssh-key-for-the-authenticated-user
+        """
 
         from ..models import BasicError, Key, UserKeysPostBody, ValidationError
 
@@ -1638,7 +1953,16 @@ class UsersClient:
         data: Missing[UserKeysPostBodyType] = UNSET,
         **kwargs,
     ) -> Response[Key, KeyType]:
-        """See also: https://docs.github.com/rest/users/keys#create-a-public-ssh-key-for-the-authenticated-user"""
+        """users/create-public-ssh-key-for-authenticated-user
+
+        POST /user/keys
+
+        Adds a public SSH key to the authenticated user's GitHub account.
+
+        OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint.
+
+        See also: https://docs.github.com/rest/users/keys#create-a-public-ssh-key-for-the-authenticated-user
+        """
 
         from ..models import BasicError, Key, UserKeysPostBody, ValidationError
 
@@ -1675,7 +1999,16 @@ class UsersClient:
         *,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[Key, KeyType]:
-        """See also: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user"""
+        """users/get-public-ssh-key-for-authenticated-user
+
+        GET /user/keys/{key_id}
+
+        View extended details for a single public SSH key.
+
+        OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint.
+
+        See also: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user
+        """
 
         from ..models import BasicError, Key
 
@@ -1701,7 +2034,16 @@ class UsersClient:
         *,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[Key, KeyType]:
-        """See also: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user"""
+        """users/get-public-ssh-key-for-authenticated-user
+
+        GET /user/keys/{key_id}
+
+        View extended details for a single public SSH key.
+
+        OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint.
+
+        See also: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user
+        """
 
         from ..models import BasicError, Key
 
@@ -1727,7 +2069,16 @@ class UsersClient:
         *,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response:
-        """See also: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user"""
+        """users/delete-public-ssh-key-for-authenticated-user
+
+        DELETE /user/keys/{key_id}
+
+        Removes a public SSH key from the authenticated user's GitHub account.
+
+        OAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint.
+
+        See also: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user
+        """
 
         from ..models import BasicError
 
@@ -1752,7 +2103,16 @@ class UsersClient:
         *,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response:
-        """See also: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user"""
+        """users/delete-public-ssh-key-for-authenticated-user
+
+        DELETE /user/keys/{key_id}
+
+        Removes a public SSH key from the authenticated user's GitHub account.
+
+        OAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint.
+
+        See also: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user
+        """
 
         from ..models import BasicError
 
@@ -1778,7 +2138,18 @@ class UsersClient:
         page: Missing[int] = UNSET,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[list[Email], list[EmailType]]:
-        """See also: https://docs.github.com/rest/users/emails#list-public-email-addresses-for-the-authenticated-user"""
+        """users/list-public-emails-for-authenticated-user
+
+        GET /user/public_emails
+
+        Lists your publicly visible email address, which you can set with the
+        [Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user)
+        endpoint.
+
+        OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint.
+
+        See also: https://docs.github.com/rest/users/emails#list-public-email-addresses-for-the-authenticated-user
+        """
 
         from ..models import BasicError, Email
 
@@ -1811,7 +2182,18 @@ class UsersClient:
         page: Missing[int] = UNSET,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[list[Email], list[EmailType]]:
-        """See also: https://docs.github.com/rest/users/emails#list-public-email-addresses-for-the-authenticated-user"""
+        """users/list-public-emails-for-authenticated-user
+
+        GET /user/public_emails
+
+        Lists your publicly visible email address, which you can set with the
+        [Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user)
+        endpoint.
+
+        OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint.
+
+        See also: https://docs.github.com/rest/users/emails#list-public-email-addresses-for-the-authenticated-user
+        """
 
         from ..models import BasicError, Email
 
@@ -1844,7 +2226,14 @@ class UsersClient:
         page: Missing[int] = UNSET,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[list[SocialAccount], list[SocialAccountType]]:
-        """See also: https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-the-authenticated-user"""
+        """users/list-social-accounts-for-authenticated-user
+
+        GET /user/social_accounts
+
+        Lists all of your social accounts.
+
+        See also: https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-the-authenticated-user
+        """
 
         from ..models import BasicError, SocialAccount
 
@@ -1877,7 +2266,14 @@ class UsersClient:
         page: Missing[int] = UNSET,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[list[SocialAccount], list[SocialAccountType]]:
-        """See also: https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-the-authenticated-user"""
+        """users/list-social-accounts-for-authenticated-user
+
+        GET /user/social_accounts
+
+        Lists all of your social accounts.
+
+        See also: https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-the-authenticated-user
+        """
 
         from ..models import BasicError, SocialAccount
 
@@ -1927,7 +2323,16 @@ class UsersClient:
         data: Missing[UserSocialAccountsPostBodyType] = UNSET,
         **kwargs,
     ) -> Response[list[SocialAccount], list[SocialAccountType]]:
-        """See also: https://docs.github.com/rest/users/social-accounts#add-social-accounts-for-the-authenticated-user"""
+        """users/add-social-account-for-authenticated-user
+
+        POST /user/social_accounts
+
+        Add one or more social accounts to the authenticated user's profile.
+
+        OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.
+
+        See also: https://docs.github.com/rest/users/social-accounts#add-social-accounts-for-the-authenticated-user
+        """
 
         from ..models import (
             BasicError,
@@ -1987,7 +2392,16 @@ class UsersClient:
         data: Missing[UserSocialAccountsPostBodyType] = UNSET,
         **kwargs,
     ) -> Response[list[SocialAccount], list[SocialAccountType]]:
-        """See also: https://docs.github.com/rest/users/social-accounts#add-social-accounts-for-the-authenticated-user"""
+        """users/add-social-account-for-authenticated-user
+
+        POST /user/social_accounts
+
+        Add one or more social accounts to the authenticated user's profile.
+
+        OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.
+
+        See also: https://docs.github.com/rest/users/social-accounts#add-social-accounts-for-the-authenticated-user
+        """
 
         from ..models import (
             BasicError,
@@ -2047,7 +2461,16 @@ class UsersClient:
         data: Missing[UserSocialAccountsDeleteBodyType] = UNSET,
         **kwargs,
     ) -> Response:
-        """See also: https://docs.github.com/rest/users/social-accounts#delete-social-accounts-for-the-authenticated-user"""
+        """users/delete-social-account-for-authenticated-user
+
+        DELETE /user/social_accounts
+
+        Deletes one or more social accounts from the authenticated user's profile.
+
+        OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.
+
+        See also: https://docs.github.com/rest/users/social-accounts#delete-social-accounts-for-the-authenticated-user
+        """
 
         from ..models import BasicError, UserSocialAccountsDeleteBody, ValidationError
 
@@ -2101,7 +2524,16 @@ class UsersClient:
         data: Missing[UserSocialAccountsDeleteBodyType] = UNSET,
         **kwargs,
     ) -> Response:
-        """See also: https://docs.github.com/rest/users/social-accounts#delete-social-accounts-for-the-authenticated-user"""
+        """users/delete-social-account-for-authenticated-user
+
+        DELETE /user/social_accounts
+
+        Deletes one or more social accounts from the authenticated user's profile.
+
+        OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.
+
+        See also: https://docs.github.com/rest/users/social-accounts#delete-social-accounts-for-the-authenticated-user
+        """
 
         from ..models import BasicError, UserSocialAccountsDeleteBody, ValidationError
 
@@ -2138,7 +2570,16 @@ class UsersClient:
         page: Missing[int] = UNSET,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[list[SshSigningKey], list[SshSigningKeyType]]:
-        """See also: https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-the-authenticated-user"""
+        """users/list-ssh-signing-keys-for-authenticated-user
+
+        GET /user/ssh_signing_keys
+
+        Lists the SSH signing keys for the authenticated user's GitHub account.
+
+        OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint.
+
+        See also: https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-the-authenticated-user
+        """
 
         from ..models import BasicError, SshSigningKey
 
@@ -2171,7 +2612,16 @@ class UsersClient:
         page: Missing[int] = UNSET,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[list[SshSigningKey], list[SshSigningKeyType]]:
-        """See also: https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-the-authenticated-user"""
+        """users/list-ssh-signing-keys-for-authenticated-user
+
+        GET /user/ssh_signing_keys
+
+        Lists the SSH signing keys for the authenticated user's GitHub account.
+
+        OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint.
+
+        See also: https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-the-authenticated-user
+        """
 
         from ..models import BasicError, SshSigningKey
 
@@ -2222,7 +2672,16 @@ class UsersClient:
         data: Missing[UserSshSigningKeysPostBodyType] = UNSET,
         **kwargs,
     ) -> Response[SshSigningKey, SshSigningKeyType]:
-        """See also: https://docs.github.com/rest/users/ssh-signing-keys#create-a-ssh-signing-key-for-the-authenticated-user"""
+        """users/create-ssh-signing-key-for-authenticated-user
+
+        POST /user/ssh_signing_keys
+
+        Creates an SSH signing key for the authenticated user's GitHub account.
+
+        OAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint.
+
+        See also: https://docs.github.com/rest/users/ssh-signing-keys#create-a-ssh-signing-key-for-the-authenticated-user
+        """
 
         from ..models import (
             BasicError,
@@ -2283,7 +2742,16 @@ class UsersClient:
         data: Missing[UserSshSigningKeysPostBodyType] = UNSET,
         **kwargs,
     ) -> Response[SshSigningKey, SshSigningKeyType]:
-        """See also: https://docs.github.com/rest/users/ssh-signing-keys#create-a-ssh-signing-key-for-the-authenticated-user"""
+        """users/create-ssh-signing-key-for-authenticated-user
+
+        POST /user/ssh_signing_keys
+
+        Creates an SSH signing key for the authenticated user's GitHub account.
+
+        OAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint.
+
+        See also: https://docs.github.com/rest/users/ssh-signing-keys#create-a-ssh-signing-key-for-the-authenticated-user
+        """
 
         from ..models import (
             BasicError,
@@ -2325,7 +2793,16 @@ class UsersClient:
         *,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[SshSigningKey, SshSigningKeyType]:
-        """See also: https://docs.github.com/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user"""
+        """users/get-ssh-signing-key-for-authenticated-user
+
+        GET /user/ssh_signing_keys/{ssh_signing_key_id}
+
+        Gets extended details for an SSH signing key.
+
+        OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint.
+
+        See also: https://docs.github.com/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user
+        """
 
         from ..models import BasicError, SshSigningKey
 
@@ -2351,7 +2828,16 @@ class UsersClient:
         *,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[SshSigningKey, SshSigningKeyType]:
-        """See also: https://docs.github.com/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user"""
+        """users/get-ssh-signing-key-for-authenticated-user
+
+        GET /user/ssh_signing_keys/{ssh_signing_key_id}
+
+        Gets extended details for an SSH signing key.
+
+        OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint.
+
+        See also: https://docs.github.com/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user
+        """
 
         from ..models import BasicError, SshSigningKey
 
@@ -2377,7 +2863,16 @@ class UsersClient:
         *,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response:
-        """See also: https://docs.github.com/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user"""
+        """users/delete-ssh-signing-key-for-authenticated-user
+
+        DELETE /user/ssh_signing_keys/{ssh_signing_key_id}
+
+        Deletes an SSH signing key from the authenticated user's GitHub account.
+
+        OAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint.
+
+        See also: https://docs.github.com/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user
+        """
 
         from ..models import BasicError
 
@@ -2402,7 +2897,16 @@ class UsersClient:
         *,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response:
-        """See also: https://docs.github.com/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user"""
+        """users/delete-ssh-signing-key-for-authenticated-user
+
+        DELETE /user/ssh_signing_keys/{ssh_signing_key_id}
+
+        Deletes an SSH signing key from the authenticated user's GitHub account.
+
+        OAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint.
+
+        See also: https://docs.github.com/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user
+        """
 
         from ..models import BasicError
 
@@ -2429,7 +2933,20 @@ class UsersClient:
     ) -> Response[
         Union[PrivateUser, PublicUser], Union[PrivateUserType, PublicUserType]
     ]:
-        """See also: https://docs.github.com/rest/users/users#get-a-user-using-their-id"""
+        """users/get-by-id
+
+        GET /user/{account_id}
+
+        Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time.
+
+        If you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status.
+
+        The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication).
+
+        The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails).
+
+        See also: https://docs.github.com/rest/users/users#get-a-user-using-their-id
+        """
 
         from typing import Union
 
@@ -2457,7 +2974,20 @@ class UsersClient:
     ) -> Response[
         Union[PrivateUser, PublicUser], Union[PrivateUserType, PublicUserType]
     ]:
-        """See also: https://docs.github.com/rest/users/users#get-a-user-using-their-id"""
+        """users/get-by-id
+
+        GET /user/{account_id}
+
+        Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time.
+
+        If you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status.
+
+        The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication).
+
+        The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails).
+
+        See also: https://docs.github.com/rest/users/users#get-a-user-using-their-id
+        """
 
         from typing import Union
 
@@ -2484,7 +3014,16 @@ class UsersClient:
         per_page: Missing[int] = UNSET,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[list[SimpleUser], list[SimpleUserType]]:
-        """See also: https://docs.github.com/rest/users/users#list-users"""
+        """users/list
+
+        GET /users
+
+        Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts.
+
+        Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users.
+
+        See also: https://docs.github.com/rest/users/users#list-users
+        """
 
         from ..models import SimpleUser
 
@@ -2512,7 +3051,16 @@ class UsersClient:
         per_page: Missing[int] = UNSET,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[list[SimpleUser], list[SimpleUserType]]:
-        """See also: https://docs.github.com/rest/users/users#list-users"""
+        """users/list
+
+        GET /users
+
+        Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts.
+
+        Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users.
+
+        See also: https://docs.github.com/rest/users/users#list-users
+        """
 
         from ..models import SimpleUser
 
@@ -2541,7 +3089,20 @@ class UsersClient:
     ) -> Response[
         Union[PrivateUser, PublicUser], Union[PrivateUserType, PublicUserType]
     ]:
-        """See also: https://docs.github.com/rest/users/users#get-a-user"""
+        """users/get-by-username
+
+        GET /users/{username}
+
+        Provides publicly available information about someone with a GitHub account.
+
+        If you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status.
+
+        The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication).
+
+        The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails).
+
+        See also: https://docs.github.com/rest/users/users#get-a-user
+        """
 
         from typing import Union
 
@@ -2569,7 +3130,20 @@ class UsersClient:
     ) -> Response[
         Union[PrivateUser, PublicUser], Union[PrivateUserType, PublicUserType]
     ]:
-        """See also: https://docs.github.com/rest/users/users#get-a-user"""
+        """users/get-by-username
+
+        GET /users/{username}
+
+        Provides publicly available information about someone with a GitHub account.
+
+        If you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status.
+
+        The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication).
+
+        The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails).
+
+        See also: https://docs.github.com/rest/users/users#get-a-user
+        """
 
         from typing import Union
 
@@ -2603,7 +3177,18 @@ class UsersClient:
         UsersUsernameAttestationsSubjectDigestGetResponse200,
         UsersUsernameAttestationsSubjectDigestGetResponse200Type,
     ]:
-        """See also: https://docs.github.com/rest/users/attestations#list-attestations"""
+        """users/list-attestations
+
+        GET /users/{username}/attestations/{subject_digest}
+
+        List a collection of artifact attestations with a given subject digest that are associated with repositories owned by a user.
+
+        The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.
+
+        **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).
+
+        See also: https://docs.github.com/rest/users/attestations#list-attestations
+        """
 
         from ..models import (
             BasicError,
@@ -2646,7 +3231,18 @@ class UsersClient:
         UsersUsernameAttestationsSubjectDigestGetResponse200,
         UsersUsernameAttestationsSubjectDigestGetResponse200Type,
     ]:
-        """See also: https://docs.github.com/rest/users/attestations#list-attestations"""
+        """users/list-attestations
+
+        GET /users/{username}/attestations/{subject_digest}
+
+        List a collection of artifact attestations with a given subject digest that are associated with repositories owned by a user.
+
+        The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.
+
+        **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).
+
+        See also: https://docs.github.com/rest/users/attestations#list-attestations
+        """
 
         from ..models import (
             BasicError,
@@ -2683,7 +3279,14 @@ class UsersClient:
         page: Missing[int] = UNSET,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[list[SimpleUser], list[SimpleUserType]]:
-        """See also: https://docs.github.com/rest/users/followers#list-followers-of-a-user"""
+        """users/list-followers-for-user
+
+        GET /users/{username}/followers
+
+        Lists the people following the specified user.
+
+        See also: https://docs.github.com/rest/users/followers#list-followers-of-a-user
+        """
 
         from ..models import SimpleUser
 
@@ -2712,7 +3315,14 @@ class UsersClient:
         page: Missing[int] = UNSET,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[list[SimpleUser], list[SimpleUserType]]:
-        """See also: https://docs.github.com/rest/users/followers#list-followers-of-a-user"""
+        """users/list-followers-for-user
+
+        GET /users/{username}/followers
+
+        Lists the people following the specified user.
+
+        See also: https://docs.github.com/rest/users/followers#list-followers-of-a-user
+        """
 
         from ..models import SimpleUser
 
@@ -2741,7 +3351,14 @@ class UsersClient:
         page: Missing[int] = UNSET,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[list[SimpleUser], list[SimpleUserType]]:
-        """See also: https://docs.github.com/rest/users/followers#list-the-people-a-user-follows"""
+        """users/list-following-for-user
+
+        GET /users/{username}/following
+
+        Lists the people who the specified user follows.
+
+        See also: https://docs.github.com/rest/users/followers#list-the-people-a-user-follows
+        """
 
         from ..models import SimpleUser
 
@@ -2770,7 +3387,14 @@ class UsersClient:
         page: Missing[int] = UNSET,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[list[SimpleUser], list[SimpleUserType]]:
-        """See also: https://docs.github.com/rest/users/followers#list-the-people-a-user-follows"""
+        """users/list-following-for-user
+
+        GET /users/{username}/following
+
+        Lists the people who the specified user follows.
+
+        See also: https://docs.github.com/rest/users/followers#list-the-people-a-user-follows
+        """
 
         from ..models import SimpleUser
 
@@ -2798,7 +3422,12 @@ class UsersClient:
         *,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response:
-        """See also: https://docs.github.com/rest/users/followers#check-if-a-user-follows-another-user"""
+        """users/check-following-for-user
+
+        GET /users/{username}/following/{target_user}
+
+        See also: https://docs.github.com/rest/users/followers#check-if-a-user-follows-another-user
+        """
 
         url = f"/users/{username}/following/{target_user}"
 
@@ -2818,7 +3447,12 @@ class UsersClient:
         *,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response:
-        """See also: https://docs.github.com/rest/users/followers#check-if-a-user-follows-another-user"""
+        """users/check-following-for-user
+
+        GET /users/{username}/following/{target_user}
+
+        See also: https://docs.github.com/rest/users/followers#check-if-a-user-follows-another-user
+        """
 
         url = f"/users/{username}/following/{target_user}"
 
@@ -2839,7 +3473,14 @@ class UsersClient:
         page: Missing[int] = UNSET,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[list[GpgKey], list[GpgKeyType]]:
-        """See also: https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-a-user"""
+        """users/list-gpg-keys-for-user
+
+        GET /users/{username}/gpg_keys
+
+        Lists the GPG keys for a user. This information is accessible by anyone.
+
+        See also: https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-a-user
+        """
 
         from ..models import GpgKey
 
@@ -2868,7 +3509,14 @@ class UsersClient:
         page: Missing[int] = UNSET,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[list[GpgKey], list[GpgKeyType]]:
-        """See also: https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-a-user"""
+        """users/list-gpg-keys-for-user
+
+        GET /users/{username}/gpg_keys
+
+        Lists the GPG keys for a user. This information is accessible by anyone.
+
+        See also: https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-a-user
+        """
 
         from ..models import GpgKey
 
@@ -2899,7 +3547,18 @@ class UsersClient:
         subject_id: Missing[str] = UNSET,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[Hovercard, HovercardType]:
-        """See also: https://docs.github.com/rest/users/users#get-contextual-information-for-a-user"""
+        """users/get-context-for-user
+
+        GET /users/{username}/hovercard
+
+        Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.
+
+          The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository, you would use a `subject_type` value of `repository` and a `subject_id` value of `1300192` (the ID of the `Spoon-Knife` repository).
+
+        OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+
+        See also: https://docs.github.com/rest/users/users#get-contextual-information-for-a-user
+        """
 
         from ..models import BasicError, Hovercard, ValidationError
 
@@ -2934,7 +3593,18 @@ class UsersClient:
         subject_id: Missing[str] = UNSET,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[Hovercard, HovercardType]:
-        """See also: https://docs.github.com/rest/users/users#get-contextual-information-for-a-user"""
+        """users/get-context-for-user
+
+        GET /users/{username}/hovercard
+
+        Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.
+
+          The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository, you would use a `subject_type` value of `repository` and a `subject_id` value of `1300192` (the ID of the `Spoon-Knife` repository).
+
+        OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+
+        See also: https://docs.github.com/rest/users/users#get-contextual-information-for-a-user
+        """
 
         from ..models import BasicError, Hovercard, ValidationError
 
@@ -2967,7 +3637,14 @@ class UsersClient:
         page: Missing[int] = UNSET,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[list[KeySimple], list[KeySimpleType]]:
-        """See also: https://docs.github.com/rest/users/keys#list-public-keys-for-a-user"""
+        """users/list-public-keys-for-user
+
+        GET /users/{username}/keys
+
+        Lists the _verified_ public SSH keys for a user. This is accessible by anyone.
+
+        See also: https://docs.github.com/rest/users/keys#list-public-keys-for-a-user
+        """
 
         from ..models import KeySimple
 
@@ -2996,7 +3673,14 @@ class UsersClient:
         page: Missing[int] = UNSET,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[list[KeySimple], list[KeySimpleType]]:
-        """See also: https://docs.github.com/rest/users/keys#list-public-keys-for-a-user"""
+        """users/list-public-keys-for-user
+
+        GET /users/{username}/keys
+
+        Lists the _verified_ public SSH keys for a user. This is accessible by anyone.
+
+        See also: https://docs.github.com/rest/users/keys#list-public-keys-for-a-user
+        """
 
         from ..models import KeySimple
 
@@ -3025,7 +3709,14 @@ class UsersClient:
         page: Missing[int] = UNSET,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[list[SocialAccount], list[SocialAccountType]]:
-        """See also: https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-a-user"""
+        """users/list-social-accounts-for-user
+
+        GET /users/{username}/social_accounts
+
+        Lists social media accounts for a user. This endpoint is accessible by anyone.
+
+        See also: https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-a-user
+        """
 
         from ..models import SocialAccount
 
@@ -3054,7 +3745,14 @@ class UsersClient:
         page: Missing[int] = UNSET,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[list[SocialAccount], list[SocialAccountType]]:
-        """See also: https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-a-user"""
+        """users/list-social-accounts-for-user
+
+        GET /users/{username}/social_accounts
+
+        Lists social media accounts for a user. This endpoint is accessible by anyone.
+
+        See also: https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-a-user
+        """
 
         from ..models import SocialAccount
 
@@ -3083,7 +3781,14 @@ class UsersClient:
         page: Missing[int] = UNSET,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[list[SshSigningKey], list[SshSigningKeyType]]:
-        """See also: https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user"""
+        """users/list-ssh-signing-keys-for-user
+
+        GET /users/{username}/ssh_signing_keys
+
+        Lists the SSH signing keys for a user. This operation is accessible by anyone.
+
+        See also: https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user
+        """
 
         from ..models import SshSigningKey
 
@@ -3112,7 +3817,14 @@ class UsersClient:
         page: Missing[int] = UNSET,
         headers: Optional[Mapping[str, str]] = None,
     ) -> Response[list[SshSigningKey], list[SshSigningKeyType]]:
-        """See also: https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user"""
+        """users/list-ssh-signing-keys-for-user
+
+        GET /users/{username}/ssh_signing_keys
+
+        Lists the SSH signing keys for a user. This operation is accessible by anyone.
+
+        See also: https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user
+        """
 
         from ..models import SshSigningKey