lunchmoney-python 2.9.0__py3-none-any.whl

lunchmoney/exceptions.py

@@ -0,0 +1,217 @@
+# coding: utf-8
+
+"""
+    Lunch Money API - v2
+
+    Welcome to the Lunch Money v2 API.  A working version of this API is now available through these docs, or directly at:  `https://api.lunchmoney.dev/v2`  <span class=\"red-text\"><strong>This is in alpha launch of a major API update. It is still subject to change during this alpha review period and bugs may still exist. Users are strongly encouraged to use the mock service or to create a test budget with example data as the first step to interacting with the v2 API.</strong></span> See the [Getting Started Guide](https://alpha.lunchmoney.dev/v2/getting-started) for more information on using a test budget.<br<br>  If you are new to the v2 API, you may wish to review the [v2 API Overview of Changes](https://alpha.lunchmoney.dev/v2/changelog).  ### Static Mock Server  You may also use these docs to explore the API using a static mock server endpoint.<p> This enables users to become familiar with the API without having to create an access token, and eliminates the possibility of modifying real data. <p> To access this endpoint select the second endpoint in the the \"Server\" dropdown to the right. When selected you should see \"Static Mock v2 Lunch Money API Server\".<br> When using this server, set your Bearer token to any string with 11 or more characters.  ### Migrating from V1  The v2 API is NOT backwards compatible with the v1 API. Developers are encouraged to review the [Migration Guide](https://alpha.lunchmoney.dev/v2/migration-guide) to understand the changes and plan their migration.  ### Acknowledgments  If you have been providing feedback on the API during our iterative design process, **THANK YOU**. We are happy to provide the opportunity to finally interact with the working API that was built based on your feedback.  ### Useful links: - [Getting Started](https://alpha.lunchmoney.dev/v2/getting-started) - [v2 API Changelog](https://alpha.lunchmoney.dev/v2/changelog) - [Migration Guide](https://alpha.lunchmoney.dev/v2/migration-guide) - [Rate Limits](https://alpha.lunchmoney.dev/v2/rate-limits) - [Current v1 Lunch Money API Documentation](https://lunchmoney.dev) - [Awesome Lunch Money Projects](https://github.com/lunch-money/awesome-lunchmoney?tab=readme-ov-file)
+
+    The version of the OpenAPI document: 2.8.4
+    Contact: devsupport@lunchmoney.app
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+from typing import Any, Optional
+from typing_extensions import Self
+
+class OpenApiException(Exception):
+    """The base exception class for all OpenAPIExceptions"""
+
+
+class ApiTypeError(OpenApiException, TypeError):
+    def __init__(self, msg, path_to_item=None, valid_classes=None,
+                 key_type=None) -> None:
+        """ Raises an exception for TypeErrors
+
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (list): a list of keys an indices to get to the
+                                 current_item
+                                 None if unset
+            valid_classes (tuple): the primitive classes that current item
+                                   should be an instance of
+                                   None if unset
+            key_type (bool): False if our value is a value in a dict
+                             True if it is a key in a dict
+                             False if our item is an item in a list
+                             None if unset
+        """
+        self.path_to_item = path_to_item
+        self.valid_classes = valid_classes
+        self.key_type = key_type
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiTypeError, self).__init__(full_msg)
+
+
+class ApiValueError(OpenApiException, ValueError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (list) the path to the exception in the
+                received_data dict. None if unset
+        """
+
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiValueError, self).__init__(full_msg)
+
+
+class ApiAttributeError(OpenApiException, AttributeError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Raised when an attribute reference or assignment fails.
+
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (None/list) the path to the exception in the
+                received_data dict
+        """
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiAttributeError, self).__init__(full_msg)
+
+
+class ApiKeyError(OpenApiException, KeyError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (None/list) the path to the exception in the
+                received_data dict
+        """
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiKeyError, self).__init__(full_msg)
+
+
+class ApiException(OpenApiException):
+
+    def __init__(
+        self, 
+        status=None, 
+        reason=None, 
+        http_resp=None,
+        *,
+        body: Optional[str] = None,
+        data: Optional[Any] = None,
+    ) -> None:
+        self.status = status
+        self.reason = reason
+        self.body = body
+        self.data = data
+        self.headers = None
+
+        if http_resp:
+            if self.status is None:
+                self.status = http_resp.status
+            if self.reason is None:
+                self.reason = http_resp.reason
+            if self.body is None:
+                try:
+                    self.body = http_resp.data.decode('utf-8')
+                except Exception:
+                    pass
+            self.headers = http_resp.getheaders()
+
+    @classmethod
+    def from_response(
+        cls, 
+        *, 
+        http_resp, 
+        body: Optional[str], 
+        data: Optional[Any],
+    ) -> Self:
+        if http_resp.status == 400:
+            raise BadRequestException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 401:
+            raise UnauthorizedException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 403:
+            raise ForbiddenException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 404:
+            raise NotFoundException(http_resp=http_resp, body=body, data=data)
+
+        # Added new conditions for 409 and 422
+        if http_resp.status == 409:
+            raise ConflictException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 422:
+            raise UnprocessableEntityException(http_resp=http_resp, body=body, data=data)
+
+        if 500 <= http_resp.status <= 599:
+            raise ServiceException(http_resp=http_resp, body=body, data=data)
+        raise ApiException(http_resp=http_resp, body=body, data=data)
+
+    def __str__(self):
+        """Custom error messages for exception"""
+        error_message = "({0})\n"\
+                        "Reason: {1}\n".format(self.status, self.reason)
+        if self.headers:
+            error_message += "HTTP response headers: {0}\n".format(
+                self.headers)
+
+        if self.data or self.body:
+            error_message += "HTTP response body: {0}\n".format(self.data or self.body)
+
+        return error_message
+
+
+class BadRequestException(ApiException):
+    pass
+
+
+class NotFoundException(ApiException):
+    pass
+
+
+class UnauthorizedException(ApiException):
+    pass
+
+
+class ForbiddenException(ApiException):
+    pass
+
+
+class ServiceException(ApiException):
+    pass
+
+
+class ConflictException(ApiException):
+    """Exception for HTTP 409 Conflict."""
+    pass
+
+
+class UnprocessableEntityException(ApiException):
+    """Exception for HTTP 422 Unprocessable Entity."""
+    pass
+
+
+def render_path(path_to_item):
+    """Returns a string representation of a path"""
+    result = ""
+    for pth in path_to_item:
+        if isinstance(pth, int):
+            result += "[{0}]".format(pth)
+        else:
+            result += "['{0}']".format(pth)
+    return result

lunchmoney/models/__init__.py

@@ -0,0 +1,84 @@
+# coding: utf-8
+
+# flake8: noqa
+"""
+    Lunch Money API - v2
+
+    Welcome to the Lunch Money v2 API.  A working version of this API is now available through these docs, or directly at:  `https://api.lunchmoney.dev/v2`  <span class=\"red-text\"><strong>This is in alpha launch of a major API update. It is still subject to change during this alpha review period and bugs may still exist. Users are strongly encouraged to use the mock service or to create a test budget with example data as the first step to interacting with the v2 API.</strong></span> See the [Getting Started Guide](https://alpha.lunchmoney.dev/v2/getting-started) for more information on using a test budget.<br<br>  If you are new to the v2 API, you may wish to review the [v2 API Overview of Changes](https://alpha.lunchmoney.dev/v2/changelog).  ### Static Mock Server  You may also use these docs to explore the API using a static mock server endpoint.<p> This enables users to become familiar with the API without having to create an access token, and eliminates the possibility of modifying real data. <p> To access this endpoint select the second endpoint in the the \"Server\" dropdown to the right. When selected you should see \"Static Mock v2 Lunch Money API Server\".<br> When using this server, set your Bearer token to any string with 11 or more characters.  ### Migrating from V1  The v2 API is NOT backwards compatible with the v1 API. Developers are encouraged to review the [Migration Guide](https://alpha.lunchmoney.dev/v2/migration-guide) to understand the changes and plan their migration.  ### Acknowledgments  If you have been providing feedback on the API during our iterative design process, **THANK YOU**. We are happy to provide the opportunity to finally interact with the working API that was built based on your feedback.  ### Useful links: - [Getting Started](https://alpha.lunchmoney.dev/v2/getting-started) - [v2 API Changelog](https://alpha.lunchmoney.dev/v2/changelog) - [Migration Guide](https://alpha.lunchmoney.dev/v2/migration-guide) - [Rate Limits](https://alpha.lunchmoney.dev/v2/rate-limits) - [Current v1 Lunch Money API Documentation](https://lunchmoney.dev) - [Awesome Lunch Money Projects](https://github.com/lunch-money/awesome-lunchmoney?tab=readme-ov-file)
+
+    The version of the OpenAPI document: 2.8.4
+    Contact: devsupport@lunchmoney.app
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+# import models into model package
+from lunchmoney.models.account_type_enum import AccountTypeEnum
+from lunchmoney.models.aligned_category_totals_object import AlignedCategoryTotalsObject
+from lunchmoney.models.aligned_summary_category_object import AlignedSummaryCategoryObject
+from lunchmoney.models.aligned_summary_response_object import AlignedSummaryResponseObject
+from lunchmoney.models.category_object import CategoryObject
+from lunchmoney.models.child_category_object import ChildCategoryObject
+from lunchmoney.models.child_transaction_object import ChildTransactionObject
+from lunchmoney.models.create_category_request_object import CreateCategoryRequestObject
+from lunchmoney.models.create_category_request_object_children_inner import CreateCategoryRequestObjectChildrenInner
+from lunchmoney.models.create_manual_account_request_object import CreateManualAccountRequestObject
+from lunchmoney.models.create_manual_account_request_object_balance import CreateManualAccountRequestObjectBalance
+from lunchmoney.models.create_new_transactions_request import CreateNewTransactionsRequest
+from lunchmoney.models.create_tag_request_object import CreateTagRequestObject
+from lunchmoney.models.currency_enum import CurrencyEnum
+from lunchmoney.models.delete_category_response_with_dependencies import DeleteCategoryResponseWithDependencies
+from lunchmoney.models.delete_category_response_with_dependencies_dependents import DeleteCategoryResponseWithDependenciesDependents
+from lunchmoney.models.delete_tag_response_with_dependencies import DeleteTagResponseWithDependencies
+from lunchmoney.models.delete_tag_response_with_dependencies_dependents import DeleteTagResponseWithDependenciesDependents
+from lunchmoney.models.delete_transactions_request import DeleteTransactionsRequest
+from lunchmoney.models.error_response_object import ErrorResponseObject
+from lunchmoney.models.error_response_object_errors_inner import ErrorResponseObjectErrorsInner
+from lunchmoney.models.get_all_categories200_response import GetAllCategories200Response
+from lunchmoney.models.get_all_manual_accounts200_response import GetAllManualAccounts200Response
+from lunchmoney.models.get_all_plaid_accounts200_response import GetAllPlaidAccounts200Response
+from lunchmoney.models.get_all_recurring200_response import GetAllRecurring200Response
+from lunchmoney.models.get_all_tags200_response import GetAllTags200Response
+from lunchmoney.models.get_all_transactions200_response import GetAllTransactions200Response
+from lunchmoney.models.get_all_transactions_created_since_parameter import GetAllTransactionsCreatedSinceParameter
+from lunchmoney.models.get_budget_summary200_response import GetBudgetSummary200Response
+from lunchmoney.models.get_transaction_attachment_url200_response import GetTransactionAttachmentUrl200Response
+from lunchmoney.models.group_transactions_request import GroupTransactionsRequest
+from lunchmoney.models.insert_transaction_object import InsertTransactionObject
+from lunchmoney.models.insert_transaction_object_amount import InsertTransactionObjectAmount
+from lunchmoney.models.insert_transactions_response_object import InsertTransactionsResponseObject
+from lunchmoney.models.manual_account_object import ManualAccountObject
+from lunchmoney.models.non_aligned_category_totals_object import NonAlignedCategoryTotalsObject
+from lunchmoney.models.non_aligned_summary_category_object import NonAlignedSummaryCategoryObject
+from lunchmoney.models.non_aligned_summary_response_object import NonAlignedSummaryResponseObject
+from lunchmoney.models.plaid_account_object import PlaidAccountObject
+from lunchmoney.models.recurring_object import RecurringObject
+from lunchmoney.models.recurring_object_matches import RecurringObjectMatches
+from lunchmoney.models.recurring_object_matches_found_transactions_inner import RecurringObjectMatchesFoundTransactionsInner
+from lunchmoney.models.recurring_object_overrides import RecurringObjectOverrides
+from lunchmoney.models.recurring_object_transaction_criteria import RecurringObjectTransactionCriteria
+from lunchmoney.models.skipped_existing_external_id_object import SkippedExistingExternalIdObject
+from lunchmoney.models.split_transaction_object import SplitTransactionObject
+from lunchmoney.models.split_transaction_object_amount import SplitTransactionObjectAmount
+from lunchmoney.models.split_transaction_request import SplitTransactionRequest
+from lunchmoney.models.summary_category_occurrence_object import SummaryCategoryOccurrenceObject
+from lunchmoney.models.summary_recurring_transaction_object import SummaryRecurringTransactionObject
+from lunchmoney.models.summary_rollover_pool_adjustment_object import SummaryRolloverPoolAdjustmentObject
+from lunchmoney.models.summary_rollover_pool_object import SummaryRolloverPoolObject
+from lunchmoney.models.summary_totals_breakdown_object import SummaryTotalsBreakdownObject
+from lunchmoney.models.summary_totals_object import SummaryTotalsObject
+from lunchmoney.models.tag_object import TagObject
+from lunchmoney.models.transaction_attachment_object import TransactionAttachmentObject
+from lunchmoney.models.transaction_object import TransactionObject
+from lunchmoney.models.update_category_request_object import UpdateCategoryRequestObject
+from lunchmoney.models.update_manual_account_request_object import UpdateManualAccountRequestObject
+from lunchmoney.models.update_manual_account_request_object_balance import UpdateManualAccountRequestObjectBalance
+from lunchmoney.models.update_tag_request_object import UpdateTagRequestObject
+from lunchmoney.models.update_transaction_object import UpdateTransactionObject
+from lunchmoney.models.update_transaction_object_amount import UpdateTransactionObjectAmount
+from lunchmoney.models.update_transactions200_response import UpdateTransactions200Response
+from lunchmoney.models.update_transactions_request import UpdateTransactionsRequest
+from lunchmoney.models.update_transactions_request_transactions_inner import UpdateTransactionsRequestTransactionsInner
+from lunchmoney.models.user_object import UserObject
+

lunchmoney/models/account_type_enum.py

@@ -0,0 +1,46 @@
+# coding: utf-8
+
+"""
+    Lunch Money API - v2
+
+    Welcome to the Lunch Money v2 API.  A working version of this API is now available through these docs, or directly at:  `https://api.lunchmoney.dev/v2`  <span class=\"red-text\"><strong>This is in alpha launch of a major API update. It is still subject to change during this alpha review period and bugs may still exist. Users are strongly encouraged to use the mock service or to create a test budget with example data as the first step to interacting with the v2 API.</strong></span> See the [Getting Started Guide](https://alpha.lunchmoney.dev/v2/getting-started) for more information on using a test budget.<br<br>  If you are new to the v2 API, you may wish to review the [v2 API Overview of Changes](https://alpha.lunchmoney.dev/v2/changelog).  ### Static Mock Server  You may also use these docs to explore the API using a static mock server endpoint.<p> This enables users to become familiar with the API without having to create an access token, and eliminates the possibility of modifying real data. <p> To access this endpoint select the second endpoint in the the \"Server\" dropdown to the right. When selected you should see \"Static Mock v2 Lunch Money API Server\".<br> When using this server, set your Bearer token to any string with 11 or more characters.  ### Migrating from V1  The v2 API is NOT backwards compatible with the v1 API. Developers are encouraged to review the [Migration Guide](https://alpha.lunchmoney.dev/v2/migration-guide) to understand the changes and plan their migration.  ### Acknowledgments  If you have been providing feedback on the API during our iterative design process, **THANK YOU**. We are happy to provide the opportunity to finally interact with the working API that was built based on your feedback.  ### Useful links: - [Getting Started](https://alpha.lunchmoney.dev/v2/getting-started) - [v2 API Changelog](https://alpha.lunchmoney.dev/v2/changelog) - [Migration Guide](https://alpha.lunchmoney.dev/v2/migration-guide) - [Rate Limits](https://alpha.lunchmoney.dev/v2/rate-limits) - [Current v1 Lunch Money API Documentation](https://lunchmoney.dev) - [Awesome Lunch Money Projects](https://github.com/lunch-money/awesome-lunchmoney?tab=readme-ov-file)
+
+    The version of the OpenAPI document: 2.8.4
+    Contact: devsupport@lunchmoney.app
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class AccountTypeEnum(str, Enum):
+    """
+    AccountTypeEnum
+    """
+
+    """
+    allowed enum values
+    """
+    CASH = 'cash'
+    CREDIT = 'credit'
+    CRYPTOCURRENCY = 'cryptocurrency'
+    EMPLOYEE_COMPENSATION = 'employee compensation'
+    INVESTMENT = 'investment'
+    LOAN = 'loan'
+    OTHER_LIABILITY = 'other liability'
+    OTHER_ASSET = 'other asset'
+    REAL_ESTATE = 'real estate'
+    VEHICLE = 'vehicle'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of AccountTypeEnum from a JSON string"""
+        return cls(json.loads(json_str))
+
+

lunchmoney/models/aligned_category_totals_object.py

@@ -0,0 +1,108 @@
+# coding: utf-8
+
+"""
+    Lunch Money API - v2
+
+    Welcome to the Lunch Money v2 API.  A working version of this API is now available through these docs, or directly at:  `https://api.lunchmoney.dev/v2`  <span class=\"red-text\"><strong>This is in alpha launch of a major API update. It is still subject to change during this alpha review period and bugs may still exist. Users are strongly encouraged to use the mock service or to create a test budget with example data as the first step to interacting with the v2 API.</strong></span> See the [Getting Started Guide](https://alpha.lunchmoney.dev/v2/getting-started) for more information on using a test budget.<br<br>  If you are new to the v2 API, you may wish to review the [v2 API Overview of Changes](https://alpha.lunchmoney.dev/v2/changelog).  ### Static Mock Server  You may also use these docs to explore the API using a static mock server endpoint.<p> This enables users to become familiar with the API without having to create an access token, and eliminates the possibility of modifying real data. <p> To access this endpoint select the second endpoint in the the \"Server\" dropdown to the right. When selected you should see \"Static Mock v2 Lunch Money API Server\".<br> When using this server, set your Bearer token to any string with 11 or more characters.  ### Migrating from V1  The v2 API is NOT backwards compatible with the v1 API. Developers are encouraged to review the [Migration Guide](https://alpha.lunchmoney.dev/v2/migration-guide) to understand the changes and plan their migration.  ### Acknowledgments  If you have been providing feedback on the API during our iterative design process, **THANK YOU**. We are happy to provide the opportunity to finally interact with the working API that was built based on your feedback.  ### Useful links: - [Getting Started](https://alpha.lunchmoney.dev/v2/getting-started) - [v2 API Changelog](https://alpha.lunchmoney.dev/v2/changelog) - [Migration Guide](https://alpha.lunchmoney.dev/v2/migration-guide) - [Rate Limits](https://alpha.lunchmoney.dev/v2/rate-limits) - [Current v1 Lunch Money API Documentation](https://lunchmoney.dev) - [Awesome Lunch Money Projects](https://github.com/lunch-money/awesome-lunchmoney?tab=readme-ov-file)
+
+    The version of the OpenAPI document: 2.8.4
+    Contact: devsupport@lunchmoney.app
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AlignedCategoryTotalsObject(BaseModel):
+    """
+    Total activity for the given category within the given date range which is aligned with budget period setting.
+    """ # noqa: E501
+    other_activity: Union[StrictFloat, StrictInt] = Field(description="Total non recurring activity, in the user's default currency, for the category within the given date range.<br> The total activity for the category is the sum of this and the recurring_activity.")
+    recurring_activity: Union[StrictFloat, StrictInt] = Field(description="Total recurring activity, in the user's default currency, for the category within the given date range.<br> The total activity for the category is the sum of this and the other_activity.")
+    budgeted: Optional[Union[StrictFloat, StrictInt]] = Field(description="Total budgeted amount, in the user's default currency, for the category within the given date range or null if the category is not budgeted.")
+    available: Optional[Union[StrictFloat, StrictInt]] = Field(description="Total amount of funds available, in the user's default currency, for the category within the given date range.")
+    recurring_remaining: Union[StrictFloat, StrictInt] = Field(description="Total expected recurring activity, in the user's default currency, that has not yet occurred for the category within the given date range.")
+    recurring_expected: Union[StrictFloat, StrictInt] = Field(description="Total expected recurring activity for the category within the given date range.")
+    __properties: ClassVar[List[str]] = ["other_activity", "recurring_activity", "budgeted", "available", "recurring_remaining", "recurring_expected"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of AlignedCategoryTotalsObject from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # set to None if budgeted (nullable) is None
+        # and model_fields_set contains the field
+        if self.budgeted is None and "budgeted" in self.model_fields_set:
+            _dict['budgeted'] = None
+
+        # set to None if available (nullable) is None
+        # and model_fields_set contains the field
+        if self.available is None and "available" in self.model_fields_set:
+            _dict['available'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AlignedCategoryTotalsObject from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "other_activity": obj.get("other_activity"),
+            "recurring_activity": obj.get("recurring_activity"),
+            "budgeted": obj.get("budgeted"),
+            "available": obj.get("available"),
+            "recurring_remaining": obj.get("recurring_remaining"),
+            "recurring_expected": obj.get("recurring_expected")
+        })
+        return _obj
+
+

lunchmoney/models/aligned_summary_category_object.py

@@ -0,0 +1,110 @@
+# coding: utf-8
+
+"""
+    Lunch Money API - v2
+
+    Welcome to the Lunch Money v2 API.  A working version of this API is now available through these docs, or directly at:  `https://api.lunchmoney.dev/v2`  <span class=\"red-text\"><strong>This is in alpha launch of a major API update. It is still subject to change during this alpha review period and bugs may still exist. Users are strongly encouraged to use the mock service or to create a test budget with example data as the first step to interacting with the v2 API.</strong></span> See the [Getting Started Guide](https://alpha.lunchmoney.dev/v2/getting-started) for more information on using a test budget.<br<br>  If you are new to the v2 API, you may wish to review the [v2 API Overview of Changes](https://alpha.lunchmoney.dev/v2/changelog).  ### Static Mock Server  You may also use these docs to explore the API using a static mock server endpoint.<p> This enables users to become familiar with the API without having to create an access token, and eliminates the possibility of modifying real data. <p> To access this endpoint select the second endpoint in the the \"Server\" dropdown to the right. When selected you should see \"Static Mock v2 Lunch Money API Server\".<br> When using this server, set your Bearer token to any string with 11 or more characters.  ### Migrating from V1  The v2 API is NOT backwards compatible with the v1 API. Developers are encouraged to review the [Migration Guide](https://alpha.lunchmoney.dev/v2/migration-guide) to understand the changes and plan their migration.  ### Acknowledgments  If you have been providing feedback on the API during our iterative design process, **THANK YOU**. We are happy to provide the opportunity to finally interact with the working API that was built based on your feedback.  ### Useful links: - [Getting Started](https://alpha.lunchmoney.dev/v2/getting-started) - [v2 API Changelog](https://alpha.lunchmoney.dev/v2/changelog) - [Migration Guide](https://alpha.lunchmoney.dev/v2/migration-guide) - [Rate Limits](https://alpha.lunchmoney.dev/v2/rate-limits) - [Current v1 Lunch Money API Documentation](https://lunchmoney.dev) - [Awesome Lunch Money Projects](https://github.com/lunch-money/awesome-lunchmoney?tab=readme-ov-file)
+
+    The version of the OpenAPI document: 2.8.4
+    Contact: devsupport@lunchmoney.app
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional
+from lunchmoney.models.aligned_category_totals_object import AlignedCategoryTotalsObject
+from lunchmoney.models.summary_category_occurrence_object import SummaryCategoryOccurrenceObject
+from lunchmoney.models.summary_rollover_pool_object import SummaryRolloverPoolObject
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AlignedSummaryCategoryObject(BaseModel):
+    """
+    List of each category's budget configuration and activity for the given date range.
+    """ # noqa: E501
+    category_id: StrictInt = Field(description="ID of the category associated with the totals.")
+    totals: AlignedCategoryTotalsObject
+    occurrences: Optional[List[SummaryCategoryOccurrenceObject]] = None
+    rollover_pool: Optional[SummaryRolloverPoolObject] = None
+    __properties: ClassVar[List[str]] = ["category_id", "totals", "occurrences", "rollover_pool"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of AlignedSummaryCategoryObject from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of totals
+        if self.totals:
+            _dict['totals'] = self.totals.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in occurrences (list)
+        _items = []
+        if self.occurrences:
+            for _item_occurrences in self.occurrences:
+                if _item_occurrences:
+                    _items.append(_item_occurrences.to_dict())
+            _dict['occurrences'] = _items
+        # override the default output from pydantic by calling `to_dict()` of rollover_pool
+        if self.rollover_pool:
+            _dict['rollover_pool'] = self.rollover_pool.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AlignedSummaryCategoryObject from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "category_id": obj.get("category_id"),
+            "totals": AlignedCategoryTotalsObject.from_dict(obj["totals"]) if obj.get("totals") is not None else None,
+            "occurrences": [SummaryCategoryOccurrenceObject.from_dict(_item) for _item in obj["occurrences"]] if obj.get("occurrences") is not None else None,
+            "rollover_pool": SummaryRolloverPoolObject.from_dict(obj["rollover_pool"]) if obj.get("rollover_pool") is not None else None
+        })
+        return _obj
+
+