ynab-cli 0.3.0__py3-none-any.whl

ynab_cli/adapters/ynab/api/budgets/get_budget_by_id.py

@@ -0,0 +1,188 @@
+from http import HTTPStatus
+from typing import Any
+
+import httpx
+
+from ynab_cli.adapters.ynab import errors
+from ynab_cli.adapters.ynab.client import AuthenticatedClient, Client
+from ynab_cli.adapters.ynab.models.budget_detail_response import BudgetDetailResponse
+from ynab_cli.adapters.ynab.models.error_response import ErrorResponse
+from ynab_cli.adapters.ynab.types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    budget_id: str,
+    *,
+    last_knowledge_of_server: Unset | int = UNSET,
+) -> dict[str, Any]:
+    params: dict[str, Any] = {}
+
+    params["last_knowledge_of_server"] = last_knowledge_of_server
+
+    params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": f"/budgets/{budget_id}",
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> BudgetDetailResponse | ErrorResponse | None:
+    if response.status_code == 200:
+        response_200 = BudgetDetailResponse.from_dict(response.json())
+
+        return response_200
+    if response.status_code == 404:
+        response_404 = ErrorResponse.from_dict(response.json())
+
+        return response_404
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatusError(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[BudgetDetailResponse | ErrorResponse]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    budget_id: str,
+    *,
+    client: AuthenticatedClient | Client,
+    last_knowledge_of_server: Unset | int = UNSET,
+) -> Response[BudgetDetailResponse | ErrorResponse]:
+    """Single budget
+
+     Returns a single budget with all related entities.  This resource is effectively a full budget
+    export.
+
+    Args:
+        budget_id (str):
+        last_knowledge_of_server (Union[Unset, int]):
+
+    Raises:
+        errors.UnexpectedStatusError: 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[Union[BudgetDetailResponse, ErrorResponse]]
+    """
+
+    kwargs = _get_kwargs(
+        budget_id=budget_id,
+        last_knowledge_of_server=last_knowledge_of_server,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    budget_id: str,
+    *,
+    client: AuthenticatedClient | Client,
+    last_knowledge_of_server: Unset | int = UNSET,
+) -> BudgetDetailResponse | ErrorResponse | None:
+    """Single budget
+
+     Returns a single budget with all related entities.  This resource is effectively a full budget
+    export.
+
+    Args:
+        budget_id (str):
+        last_knowledge_of_server (Union[Unset, int]):
+
+    Raises:
+        errors.UnexpectedStatusError: 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:
+        Union[BudgetDetailResponse, ErrorResponse]
+    """
+
+    return sync_detailed(
+        budget_id=budget_id,
+        client=client,
+        last_knowledge_of_server=last_knowledge_of_server,
+    ).parsed
+
+
+async def asyncio_detailed(
+    budget_id: str,
+    *,
+    client: AuthenticatedClient | Client,
+    last_knowledge_of_server: Unset | int = UNSET,
+) -> Response[BudgetDetailResponse | ErrorResponse]:
+    """Single budget
+
+     Returns a single budget with all related entities.  This resource is effectively a full budget
+    export.
+
+    Args:
+        budget_id (str):
+        last_knowledge_of_server (Union[Unset, int]):
+
+    Raises:
+        errors.UnexpectedStatusError: 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[Union[BudgetDetailResponse, ErrorResponse]]
+    """
+
+    kwargs = _get_kwargs(
+        budget_id=budget_id,
+        last_knowledge_of_server=last_knowledge_of_server,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    budget_id: str,
+    *,
+    client: AuthenticatedClient | Client,
+    last_knowledge_of_server: Unset | int = UNSET,
+) -> BudgetDetailResponse | ErrorResponse | None:
+    """Single budget
+
+     Returns a single budget with all related entities.  This resource is effectively a full budget
+    export.
+
+    Args:
+        budget_id (str):
+        last_knowledge_of_server (Union[Unset, int]):
+
+    Raises:
+        errors.UnexpectedStatusError: 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:
+        Union[BudgetDetailResponse, ErrorResponse]
+    """
+
+    return (
+        await asyncio_detailed(
+            budget_id=budget_id,
+            client=client,
+            last_knowledge_of_server=last_knowledge_of_server,
+        )
+    ).parsed

ynab_cli/adapters/ynab/api/budgets/get_budget_settings_by_id.py

@@ -0,0 +1,163 @@
+from http import HTTPStatus
+from typing import Any
+
+import httpx
+
+from ynab_cli.adapters.ynab import errors
+from ynab_cli.adapters.ynab.client import AuthenticatedClient, Client
+from ynab_cli.adapters.ynab.models.budget_settings_response import BudgetSettingsResponse
+from ynab_cli.adapters.ynab.models.error_response import ErrorResponse
+from ynab_cli.adapters.ynab.types import Response
+
+
+def _get_kwargs(
+    budget_id: str,
+) -> dict[str, Any]:
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": f"/budgets/{budget_id}/settings",
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> BudgetSettingsResponse | ErrorResponse | None:
+    if response.status_code == 200:
+        response_200 = BudgetSettingsResponse.from_dict(response.json())
+
+        return response_200
+    if response.status_code == 404:
+        response_404 = ErrorResponse.from_dict(response.json())
+
+        return response_404
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatusError(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[BudgetSettingsResponse | ErrorResponse]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    budget_id: str,
+    *,
+    client: AuthenticatedClient | Client,
+) -> Response[BudgetSettingsResponse | ErrorResponse]:
+    """Budget Settings
+
+     Returns settings for a budget
+
+    Args:
+        budget_id (str):
+
+    Raises:
+        errors.UnexpectedStatusError: 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[Union[BudgetSettingsResponse, ErrorResponse]]
+    """
+
+    kwargs = _get_kwargs(
+        budget_id=budget_id,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    budget_id: str,
+    *,
+    client: AuthenticatedClient | Client,
+) -> BudgetSettingsResponse | ErrorResponse | None:
+    """Budget Settings
+
+     Returns settings for a budget
+
+    Args:
+        budget_id (str):
+
+    Raises:
+        errors.UnexpectedStatusError: 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:
+        Union[BudgetSettingsResponse, ErrorResponse]
+    """
+
+    return sync_detailed(
+        budget_id=budget_id,
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    budget_id: str,
+    *,
+    client: AuthenticatedClient | Client,
+) -> Response[BudgetSettingsResponse | ErrorResponse]:
+    """Budget Settings
+
+     Returns settings for a budget
+
+    Args:
+        budget_id (str):
+
+    Raises:
+        errors.UnexpectedStatusError: 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[Union[BudgetSettingsResponse, ErrorResponse]]
+    """
+
+    kwargs = _get_kwargs(
+        budget_id=budget_id,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    budget_id: str,
+    *,
+    client: AuthenticatedClient | Client,
+) -> BudgetSettingsResponse | ErrorResponse | None:
+    """Budget Settings
+
+     Returns settings for a budget
+
+    Args:
+        budget_id (str):
+
+    Raises:
+        errors.UnexpectedStatusError: 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:
+        Union[BudgetSettingsResponse, ErrorResponse]
+    """
+
+    return (
+        await asyncio_detailed(
+            budget_id=budget_id,
+            client=client,
+        )
+    ).parsed

ynab_cli/adapters/ynab/api/budgets/get_budgets.py

@@ -0,0 +1,171 @@
+from http import HTTPStatus
+from typing import Any
+
+import httpx
+
+from ynab_cli.adapters.ynab import errors
+from ynab_cli.adapters.ynab.client import AuthenticatedClient, Client
+from ynab_cli.adapters.ynab.models.budget_summary_response import BudgetSummaryResponse
+from ynab_cli.adapters.ynab.models.error_response import ErrorResponse
+from ynab_cli.adapters.ynab.types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    *,
+    include_accounts: Unset | bool = UNSET,
+) -> dict[str, Any]:
+    params: dict[str, Any] = {}
+
+    params["include_accounts"] = include_accounts
+
+    params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/budgets",
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> BudgetSummaryResponse | ErrorResponse | None:
+    if response.status_code == 200:
+        response_200 = BudgetSummaryResponse.from_dict(response.json())
+
+        return response_200
+    if response.status_code == 404:
+        response_404 = ErrorResponse.from_dict(response.json())
+
+        return response_404
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatusError(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[BudgetSummaryResponse | ErrorResponse]:
+    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,
+    include_accounts: Unset | bool = UNSET,
+) -> Response[BudgetSummaryResponse | ErrorResponse]:
+    """List budgets
+
+     Returns budgets list with summary information
+
+    Args:
+        include_accounts (Union[Unset, bool]):
+
+    Raises:
+        errors.UnexpectedStatusError: 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[Union[BudgetSummaryResponse, ErrorResponse]]
+    """
+
+    kwargs = _get_kwargs(
+        include_accounts=include_accounts,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient | Client,
+    include_accounts: Unset | bool = UNSET,
+) -> BudgetSummaryResponse | ErrorResponse | None:
+    """List budgets
+
+     Returns budgets list with summary information
+
+    Args:
+        include_accounts (Union[Unset, bool]):
+
+    Raises:
+        errors.UnexpectedStatusError: 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:
+        Union[BudgetSummaryResponse, ErrorResponse]
+    """
+
+    return sync_detailed(
+        client=client,
+        include_accounts=include_accounts,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+    include_accounts: Unset | bool = UNSET,
+) -> Response[BudgetSummaryResponse | ErrorResponse]:
+    """List budgets
+
+     Returns budgets list with summary information
+
+    Args:
+        include_accounts (Union[Unset, bool]):
+
+    Raises:
+        errors.UnexpectedStatusError: 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[Union[BudgetSummaryResponse, ErrorResponse]]
+    """
+
+    kwargs = _get_kwargs(
+        include_accounts=include_accounts,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient | Client,
+    include_accounts: Unset | bool = UNSET,
+) -> BudgetSummaryResponse | ErrorResponse | None:
+    """List budgets
+
+     Returns budgets list with summary information
+
+    Args:
+        include_accounts (Union[Unset, bool]):
+
+    Raises:
+        errors.UnexpectedStatusError: 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:
+        Union[BudgetSummaryResponse, ErrorResponse]
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            include_accounts=include_accounts,
+        )
+    ).parsed

ynab_cli/adapters/ynab/api/categories/__init__.py

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

ynab_cli/adapters/ynab/api/categories/get_categories.py

@@ -0,0 +1,188 @@
+from http import HTTPStatus
+from typing import Any
+
+import httpx
+
+from ynab_cli.adapters.ynab import errors
+from ynab_cli.adapters.ynab.client import AuthenticatedClient, Client
+from ynab_cli.adapters.ynab.models.categories_response import CategoriesResponse
+from ynab_cli.adapters.ynab.models.error_response import ErrorResponse
+from ynab_cli.adapters.ynab.types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    budget_id: str,
+    *,
+    last_knowledge_of_server: Unset | int = UNSET,
+) -> dict[str, Any]:
+    params: dict[str, Any] = {}
+
+    params["last_knowledge_of_server"] = last_knowledge_of_server
+
+    params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": f"/budgets/{budget_id}/categories",
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> CategoriesResponse | ErrorResponse | None:
+    if response.status_code == 200:
+        response_200 = CategoriesResponse.from_dict(response.json())
+
+        return response_200
+    if response.status_code == 404:
+        response_404 = ErrorResponse.from_dict(response.json())
+
+        return response_404
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatusError(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[CategoriesResponse | ErrorResponse]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    budget_id: str,
+    *,
+    client: AuthenticatedClient | Client,
+    last_knowledge_of_server: Unset | int = UNSET,
+) -> Response[CategoriesResponse | ErrorResponse]:
+    """List categories
+
+     Returns all categories grouped by category group.  Amounts (budgeted, activity, balance, etc.) are
+    specific to the current budget month (UTC).
+
+    Args:
+        budget_id (str):
+        last_knowledge_of_server (Union[Unset, int]):
+
+    Raises:
+        errors.UnexpectedStatusError: 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[Union[CategoriesResponse, ErrorResponse]]
+    """
+
+    kwargs = _get_kwargs(
+        budget_id=budget_id,
+        last_knowledge_of_server=last_knowledge_of_server,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    budget_id: str,
+    *,
+    client: AuthenticatedClient | Client,
+    last_knowledge_of_server: Unset | int = UNSET,
+) -> CategoriesResponse | ErrorResponse | None:
+    """List categories
+
+     Returns all categories grouped by category group.  Amounts (budgeted, activity, balance, etc.) are
+    specific to the current budget month (UTC).
+
+    Args:
+        budget_id (str):
+        last_knowledge_of_server (Union[Unset, int]):
+
+    Raises:
+        errors.UnexpectedStatusError: 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:
+        Union[CategoriesResponse, ErrorResponse]
+    """
+
+    return sync_detailed(
+        budget_id=budget_id,
+        client=client,
+        last_knowledge_of_server=last_knowledge_of_server,
+    ).parsed
+
+
+async def asyncio_detailed(
+    budget_id: str,
+    *,
+    client: AuthenticatedClient | Client,
+    last_knowledge_of_server: Unset | int = UNSET,
+) -> Response[CategoriesResponse | ErrorResponse]:
+    """List categories
+
+     Returns all categories grouped by category group.  Amounts (budgeted, activity, balance, etc.) are
+    specific to the current budget month (UTC).
+
+    Args:
+        budget_id (str):
+        last_knowledge_of_server (Union[Unset, int]):
+
+    Raises:
+        errors.UnexpectedStatusError: 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[Union[CategoriesResponse, ErrorResponse]]
+    """
+
+    kwargs = _get_kwargs(
+        budget_id=budget_id,
+        last_knowledge_of_server=last_knowledge_of_server,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    budget_id: str,
+    *,
+    client: AuthenticatedClient | Client,
+    last_knowledge_of_server: Unset | int = UNSET,
+) -> CategoriesResponse | ErrorResponse | None:
+    """List categories
+
+     Returns all categories grouped by category group.  Amounts (budgeted, activity, balance, etc.) are
+    specific to the current budget month (UTC).
+
+    Args:
+        budget_id (str):
+        last_knowledge_of_server (Union[Unset, int]):
+
+    Raises:
+        errors.UnexpectedStatusError: 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:
+        Union[CategoriesResponse, ErrorResponse]
+    """
+
+    return (
+        await asyncio_detailed(
+            budget_id=budget_id,
+            client=client,
+            last_knowledge_of_server=last_knowledge_of_server,
+        )
+    ).parsed