Module aiogithubapi.namespaces.user

Methods for the authenticated user namespace

https://docs.github.com/en/rest/reference/users#get-the-authenticated-user

"""
Methods for the authenticated user namespace

https://docs.github.com/en/rest/reference/users#get-the-authenticated-user
"""
from __future__ import annotations

from typing import Any, Dict

from ..const import GitHubRequestKwarg
from ..models.organization import GitHubOrganizationMinimalModel
from ..models.repository import GitHubRepositoryModel
from ..models.response import GitHubResponseModel
from ..models.user import GitHubAuthenticatedUserModel
from .base import BaseNamespace
from .projects import GitHubUserProjectsNamespace


class GitHubUserNamespace(BaseNamespace):
    """Methods for the user namespace"""

    def __post_init__(self) -> None:
        self._projects = GitHubUserProjectsNamespace(self._client)

    @property
    def projects(self) -> GitHubUserProjectsNamespace:
        """Property to access the users projects namespace"""
        return self._projects

    async def get(
        self,
        **kwargs: Dict[GitHubRequestKwarg, Any],
    ) -> GitHubResponseModel[GitHubAuthenticatedUserModel]:
        """
         Get the authenticated user


        https://docs.github.com/en/rest/reference/users#get-a-user
        """
        response = await self._client.async_call_api(
            endpoint="/user",
            **kwargs,
        )
        response.data = GitHubAuthenticatedUserModel(response.data)

        return response

    async def starred(
        self,
        **kwargs: Dict[GitHubRequestKwarg, Any],
    ) -> GitHubResponseModel[list[GitHubRepositoryModel]]:
        """
         Get the authenticated user starred repositories


        https://docs.github.com/en/rest/reference/users#get-a-user
        """
        response = await self._client.async_call_api(
            endpoint="/user/starred",
            **kwargs,
        )

        response.data = [GitHubRepositoryModel(data) for data in response.data]

        return response

    async def repos(
        self,
        **kwargs: Dict[GitHubRequestKwarg, Any],
    ) -> GitHubResponseModel[list[GitHubRepositoryModel]]:
        """
         Get the repositories for the authenticated user


        https://docs.github.com/en/rest/reference/repos#list-repositories-for-a-user
        """
        response = await self._client.async_call_api(
            endpoint="/user/repos",
            **kwargs,
        )

        response.data = [GitHubRepositoryModel(data) for data in response.data]

        return response

    async def orgs(
        self,
        **kwargs: Dict[GitHubRequestKwarg, Any],
    ) -> GitHubResponseModel[list[GitHubOrganizationMinimalModel]]:
        """
         List public organization memberships for the specified user.


        https://docs.github.com/en/rest/reference/orgs#list-organizations-for-the-authenticated-user
        """
        response = await self._client.async_call_api(endpoint="/user/orgs", **kwargs)
        response.data = [GitHubOrganizationMinimalModel(data) for data in response.data or []]
        return response

Classes

class GitHubUserNamespace (client: GitHubClient)

Methods for the user namespace

Initialise the namespace.

Expand source code

class GitHubUserNamespace(BaseNamespace):
    """Methods for the user namespace"""

    def __post_init__(self) -> None:
        self._projects = GitHubUserProjectsNamespace(self._client)

    @property
    def projects(self) -> GitHubUserProjectsNamespace:
        """Property to access the users projects namespace"""
        return self._projects

    async def get(
        self,
        **kwargs: Dict[GitHubRequestKwarg, Any],
    ) -> GitHubResponseModel[GitHubAuthenticatedUserModel]:
        """
         Get the authenticated user


        https://docs.github.com/en/rest/reference/users#get-a-user
        """
        response = await self._client.async_call_api(
            endpoint="/user",
            **kwargs,
        )
        response.data = GitHubAuthenticatedUserModel(response.data)

        return response

    async def starred(
        self,
        **kwargs: Dict[GitHubRequestKwarg, Any],
    ) -> GitHubResponseModel[list[GitHubRepositoryModel]]:
        """
         Get the authenticated user starred repositories


        https://docs.github.com/en/rest/reference/users#get-a-user
        """
        response = await self._client.async_call_api(
            endpoint="/user/starred",
            **kwargs,
        )

        response.data = [GitHubRepositoryModel(data) for data in response.data]

        return response

    async def repos(
        self,
        **kwargs: Dict[GitHubRequestKwarg, Any],
    ) -> GitHubResponseModel[list[GitHubRepositoryModel]]:
        """
         Get the repositories for the authenticated user


        https://docs.github.com/en/rest/reference/repos#list-repositories-for-a-user
        """
        response = await self._client.async_call_api(
            endpoint="/user/repos",
            **kwargs,
        )

        response.data = [GitHubRepositoryModel(data) for data in response.data]

        return response

    async def orgs(
        self,
        **kwargs: Dict[GitHubRequestKwarg, Any],
    ) -> GitHubResponseModel[list[GitHubOrganizationMinimalModel]]:
        """
         List public organization memberships for the specified user.


        https://docs.github.com/en/rest/reference/orgs#list-organizations-for-the-authenticated-user
        """
        response = await self._client.async_call_api(endpoint="/user/orgs", **kwargs)
        response.data = [GitHubOrganizationMinimalModel(data) for data in response.data or []]
        return response

Ancestors

• BaseNamespace

Instance variables

var projects : GitHubUserProjectsNamespace

Property to access the users projects namespace

Expand source code

@property
def projects(self) -> GitHubUserProjectsNamespace:
    """Property to access the users projects namespace"""
    return self._projects

Methods

async def get(self, **kwargs: Dict[GitHubRequestKwarg, Any]) ‑> GitHubResponseModel[GitHubAuthenticatedUserModel]

Get the authenticated user

https://docs.github.com/en/rest/reference/users#get-a-user

Expand source code

async def get(
    self,
    **kwargs: Dict[GitHubRequestKwarg, Any],
) -> GitHubResponseModel[GitHubAuthenticatedUserModel]:
    """
     Get the authenticated user


    https://docs.github.com/en/rest/reference/users#get-a-user
    """
    response = await self._client.async_call_api(
        endpoint="/user",
        **kwargs,
    )
    response.data = GitHubAuthenticatedUserModel(response.data)

    return response

async def orgs(self, **kwargs: Dict[GitHubRequestKwarg, Any]) ‑> GitHubResponseModel[list[GitHubOrganizationMinimalModel]]

List public organization memberships for the specified user.

https://docs.github.com/en/rest/reference/orgs#list-organizations-for-the-authenticated-user

Expand source code

async def orgs(
    self,
    **kwargs: Dict[GitHubRequestKwarg, Any],
) -> GitHubResponseModel[list[GitHubOrganizationMinimalModel]]:
    """
     List public organization memberships for the specified user.


    https://docs.github.com/en/rest/reference/orgs#list-organizations-for-the-authenticated-user
    """
    response = await self._client.async_call_api(endpoint="/user/orgs", **kwargs)
    response.data = [GitHubOrganizationMinimalModel(data) for data in response.data or []]
    return response

async def repos(self, **kwargs: Dict[GitHubRequestKwarg, Any]) ‑> GitHubResponseModel[list[GitHubRepositoryModel]]

Get the repositories for the authenticated user

https://docs.github.com/en/rest/reference/repos#list-repositories-for-a-user

Expand source code

async def repos(
    self,
    **kwargs: Dict[GitHubRequestKwarg, Any],
) -> GitHubResponseModel[list[GitHubRepositoryModel]]:
    """
     Get the repositories for the authenticated user


    https://docs.github.com/en/rest/reference/repos#list-repositories-for-a-user
    """
    response = await self._client.async_call_api(
        endpoint="/user/repos",
        **kwargs,
    )

    response.data = [GitHubRepositoryModel(data) for data in response.data]

    return response

async def starred(self, **kwargs: Dict[GitHubRequestKwarg, Any]) ‑> GitHubResponseModel[list[GitHubRepositoryModel]]

Get the authenticated user starred repositories

https://docs.github.com/en/rest/reference/users#get-a-user

Expand source code

async def starred(
    self,
    **kwargs: Dict[GitHubRequestKwarg, Any],
) -> GitHubResponseModel[list[GitHubRepositoryModel]]:
    """
     Get the authenticated user starred repositories


    https://docs.github.com/en/rest/reference/users#get-a-user
    """
    response = await self._client.async_call_api(
        endpoint="/user/starred",
        **kwargs,
    )

    response.data = [GitHubRepositoryModel(data) for data in response.data]

    return response