pidgeon 1.0.0__py3-none-any.whl

pidgeon/__init__.py

@@ -0,0 +1,8 @@
+"""A client library for accessing Pidgeon API"""
+
+from .client import AuthenticatedClient, Client
+
+__all__ = (
+    "AuthenticatedClient",
+    "Client",
+)

pidgeon/api/__init__.py

@@ -0,0 +1 @@
+"""Contains methods for accessing the API"""

pidgeon/api/agent/__init__.py

@@ -0,0 +1 @@
+"""Contains endpoint functions for accessing the API"""

pidgeon/api/agent/agent_attach_human.py

@@ -0,0 +1,184 @@
+from http import HTTPStatus
+from typing import Any
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.agent_attach_human_body import AgentAttachHumanBody
+from ...models.agent_attach_human_response_200 import AgentAttachHumanResponse200
+from ...models.error import Error
+from ...types import Response
+
+
+def _get_kwargs(
+    *,
+    body: AgentAttachHumanBody,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/agent/human",
+    }
+
+    _kwargs["json"] = body.to_dict()
+
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> AgentAttachHumanResponse200 | Error | None:
+    if response.status_code == 200:
+        response_200 = AgentAttachHumanResponse200.from_dict(response.json())
+
+        return response_200
+
+    if response.status_code == 401:
+        response_401 = Error.from_dict(response.json())
+
+        return response_401
+
+    if response.status_code == 404:
+        response_404 = Error.from_dict(response.json())
+
+        return response_404
+
+    if response.status_code == 429:
+        response_429 = Error.from_dict(response.json())
+
+        return response_429
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[AgentAttachHumanResponse200 | Error]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+    body: AgentAttachHumanBody,
+) -> Response[AgentAttachHumanResponse200 | Error]:
+    """Name the human for a signup
+
+     For a signup that named none. Sends a fresh code and restarts the clock.
+
+    Args:
+        body (AgentAttachHumanBody):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[AgentAttachHumanResponse200 | Error]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient | Client,
+    body: AgentAttachHumanBody,
+) -> AgentAttachHumanResponse200 | Error | None:
+    """Name the human for a signup
+
+     For a signup that named none. Sends a fresh code and restarts the clock.
+
+    Args:
+        body (AgentAttachHumanBody):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        AgentAttachHumanResponse200 | Error
+    """
+
+    return sync_detailed(
+        client=client,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+    body: AgentAttachHumanBody,
+) -> Response[AgentAttachHumanResponse200 | Error]:
+    """Name the human for a signup
+
+     For a signup that named none. Sends a fresh code and restarts the clock.
+
+    Args:
+        body (AgentAttachHumanBody):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[AgentAttachHumanResponse200 | Error]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient | Client,
+    body: AgentAttachHumanBody,
+) -> AgentAttachHumanResponse200 | Error | None:
+    """Name the human for a signup
+
+     For a signup that named none. Sends a fresh code and restarts the clock.
+
+    Args:
+        body (AgentAttachHumanBody):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        AgentAttachHumanResponse200 | Error
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            body=body,
+        )
+    ).parsed

pidgeon/api/agent/agent_sign_up.py

@@ -0,0 +1,196 @@
+from http import HTTPStatus
+from typing import Any
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.agent_sign_up_body import AgentSignUpBody
+from ...models.agent_sign_up_response_201 import AgentSignUpResponse201
+from ...models.error import Error
+from ...types import Response
+
+
+def _get_kwargs(
+    *,
+    body: AgentSignUpBody,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/agent/signup",
+    }
+
+    _kwargs["json"] = body.to_dict()
+
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> AgentSignUpResponse201 | Error | None:
+    if response.status_code == 201:
+        response_201 = AgentSignUpResponse201.from_dict(response.json())
+
+        return response_201
+
+    if response.status_code == 401:
+        response_401 = Error.from_dict(response.json())
+
+        return response_401
+
+    if response.status_code == 404:
+        response_404 = Error.from_dict(response.json())
+
+        return response_404
+
+    if response.status_code == 429:
+        response_429 = Error.from_dict(response.json())
+
+        return response_429
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[AgentSignUpResponse201 | Error]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+    body: AgentSignUpBody,
+) -> Response[AgentSignUpResponse201 | Error]:
+    """Sign an agent up
+
+     The one call in this API that needs no key. An agent names a username and, optionally, the human who
+    will own the mailbox; a six-digit code goes to that human and **nothing is created until it comes
+    back**. Without a `human_email` the name is reserved and dormant — attach one with `POST
+    /agent/human`.
+
+    Args:
+        body (AgentSignUpBody):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[AgentSignUpResponse201 | Error]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient | Client,
+    body: AgentSignUpBody,
+) -> AgentSignUpResponse201 | Error | None:
+    """Sign an agent up
+
+     The one call in this API that needs no key. An agent names a username and, optionally, the human who
+    will own the mailbox; a six-digit code goes to that human and **nothing is created until it comes
+    back**. Without a `human_email` the name is reserved and dormant — attach one with `POST
+    /agent/human`.
+
+    Args:
+        body (AgentSignUpBody):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        AgentSignUpResponse201 | Error
+    """
+
+    return sync_detailed(
+        client=client,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+    body: AgentSignUpBody,
+) -> Response[AgentSignUpResponse201 | Error]:
+    """Sign an agent up
+
+     The one call in this API that needs no key. An agent names a username and, optionally, the human who
+    will own the mailbox; a six-digit code goes to that human and **nothing is created until it comes
+    back**. Without a `human_email` the name is reserved and dormant — attach one with `POST
+    /agent/human`.
+
+    Args:
+        body (AgentSignUpBody):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[AgentSignUpResponse201 | Error]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient | Client,
+    body: AgentSignUpBody,
+) -> AgentSignUpResponse201 | Error | None:
+    """Sign an agent up
+
+     The one call in this API that needs no key. An agent names a username and, optionally, the human who
+    will own the mailbox; a six-digit code goes to that human and **nothing is created until it comes
+    back**. Without a `human_email` the name is reserved and dormant — attach one with `POST
+    /agent/human`.
+
+    Args:
+        body (AgentSignUpBody):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        AgentSignUpResponse201 | Error
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            body=body,
+        )
+    ).parsed

pidgeon/api/agent/agent_verify.py

@@ -0,0 +1,192 @@
+from http import HTTPStatus
+from typing import Any
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.agent_verify_body import AgentVerifyBody
+from ...models.agent_verify_response_200 import AgentVerifyResponse200
+from ...models.error import Error
+from ...types import Response
+
+
+def _get_kwargs(
+    *,
+    body: AgentVerifyBody,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/agent/verify",
+    }
+
+    _kwargs["json"] = body.to_dict()
+
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> AgentVerifyResponse200 | Error | None:
+    if response.status_code == 200:
+        response_200 = AgentVerifyResponse200.from_dict(response.json())
+
+        return response_200
+
+    if response.status_code == 401:
+        response_401 = Error.from_dict(response.json())
+
+        return response_401
+
+    if response.status_code == 404:
+        response_404 = Error.from_dict(response.json())
+
+        return response_404
+
+    if response.status_code == 429:
+        response_429 = Error.from_dict(response.json())
+
+        return response_429
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[AgentVerifyResponse200 | Error]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+    body: AgentVerifyBody,
+) -> Response[AgentVerifyResponse200 | Error]:
+    """Verify an agent with the human’s code
+
+     Creates the account and the address. Ten wrong codes spend the signup, whatever comes next. It
+    returns no key: the agent asks for one through the account it now belongs to, which is how every
+    other key is made.
+
+    Args:
+        body (AgentVerifyBody):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[AgentVerifyResponse200 | Error]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient | Client,
+    body: AgentVerifyBody,
+) -> AgentVerifyResponse200 | Error | None:
+    """Verify an agent with the human’s code
+
+     Creates the account and the address. Ten wrong codes spend the signup, whatever comes next. It
+    returns no key: the agent asks for one through the account it now belongs to, which is how every
+    other key is made.
+
+    Args:
+        body (AgentVerifyBody):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        AgentVerifyResponse200 | Error
+    """
+
+    return sync_detailed(
+        client=client,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+    body: AgentVerifyBody,
+) -> Response[AgentVerifyResponse200 | Error]:
+    """Verify an agent with the human’s code
+
+     Creates the account and the address. Ten wrong codes spend the signup, whatever comes next. It
+    returns no key: the agent asks for one through the account it now belongs to, which is how every
+    other key is made.
+
+    Args:
+        body (AgentVerifyBody):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[AgentVerifyResponse200 | Error]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient | Client,
+    body: AgentVerifyBody,
+) -> AgentVerifyResponse200 | Error | None:
+    """Verify an agent with the human’s code
+
+     Creates the account and the address. Ten wrong codes spend the signup, whatever comes next. It
+    returns no key: the agent asks for one through the account it now belongs to, which is how every
+    other key is made.
+
+    Args:
+        body (AgentVerifyBody):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        AgentVerifyResponse200 | Error
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            body=body,
+        )
+    ).parsed

pidgeon/api/app_passwords/__init__.py

@@ -0,0 +1 @@
+"""Contains endpoint functions for accessing the API"""