lunchmoney-python 2.9.0__py3-none-any.whl

lunchmoney/models/non_aligned_summary_response_object.py

@@ -0,0 +1,104 @@
+# 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, StrictBool
+from typing import Any, ClassVar, Dict, List, Optional
+from lunchmoney.models.non_aligned_summary_category_object import NonAlignedSummaryCategoryObject
+from lunchmoney.models.summary_totals_object import SummaryTotalsObject
+from typing import Optional, Set
+from typing_extensions import Self
+
+class NonAlignedSummaryResponseObject(BaseModel):
+    """
+    NonAlignedSummaryResponseObject
+    """ # noqa: E501
+    totals: Optional[SummaryTotalsObject] = None
+    aligned: StrictBool = Field(description="`true` if start_date and end_date are aligned with budget period setting")
+    categories: List[NonAlignedSummaryCategoryObject]
+    __properties: ClassVar[List[str]] = ["totals", "aligned", "categories"]
+
+    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 NonAlignedSummaryResponseObject 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 categories (list)
+        _items = []
+        if self.categories:
+            for _item_categories in self.categories:
+                if _item_categories:
+                    _items.append(_item_categories.to_dict())
+            _dict['categories'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of NonAlignedSummaryResponseObject from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "totals": SummaryTotalsObject.from_dict(obj["totals"]) if obj.get("totals") is not None else None,
+            "aligned": obj.get("aligned"),
+            "categories": [NonAlignedSummaryCategoryObject.from_dict(_item) for _item in obj["categories"]] if obj.get("categories") is not None else None
+        })
+        return _obj
+
+

lunchmoney/models/plaid_account_object.py

@@ -0,0 +1,168 @@
+# 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 datetime import date, datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PlaidAccountObject(BaseModel):
+    """
+    An object containing information about an account synced via Plaid
+    """ # noqa: E501
+    id: StrictInt = Field(description="The unique identifier of this account")
+    date_linked: date = Field(description="Date account was first linked in ISO 8601 format")
+    name: StrictStr = Field(description="Name of the account. This field is set by Plaid and cannot be altered.")
+    display_name: Optional[StrictStr] = Field(description="Optional display name for the account set by the user. If not set, it will return a concatenated string of institution and account name.")
+    type: StrictStr = Field(description="Primary type of the account, such as `credit`, `depository`, etc. This field is set by Plaid and cannot be altered.")
+    subtype: StrictStr = Field(description="Optional account subtype. This field is set by Plaid and cannot be altered.")
+    mask: StrictStr = Field(description="Mask (last 3 to 4 digits of account) of account. This field is set by Plaid and cannot be altered.")
+    institution_name: StrictStr = Field(description="Name of institution holding the account. This field is set by Plaid and cannot be altered.")
+    status: StrictStr = Field(description="Denotes the current status of the account within Lunch Money. Must be one of<br> - `active`: Account is active and in good state<br> - `inactive`: Account marked inactive from user. Transaction imports and balance updates will not occur for this account.<br> - `relink`: Account needs to be relinked with Plaid.<br> - `syncing`: Account is awaiting first import of transactions. <br> - `not found`: Account cannot be found with Plaid<br> - `not supported`: Account is not supported with Plaid<br> - `error`: Account is in error with Plaid.<br>")
+    allow_transaction_modifications: StrictBool = Field(description="If `false`, transactions imported for this synced account can have their properties (such as amount and account) be modified by the user. This option is managed in the web app.")
+    limit: Optional[Union[StrictFloat, StrictInt]] = Field(description="Optional credit limit of the account. This field is set by Plaid and cannot be altered")
+    balance: StrictStr = Field(description="Current balance of the account in numeric format to 4 decimal places. This field is set by Plaid and cannot be altered.")
+    currency: Annotated[str, Field(min_length=3, strict=True, max_length=3)] = Field(description="Three-letter lowercase currency code of the account balance")
+    to_base: Union[StrictFloat, StrictInt] = Field(description="The account balance converted to the user's primary currency")
+    balance_last_update: Optional[datetime] = Field(description="Date balance was last updated in ISO 8601 extended format. This field is set by Plaid and cannot be altered.")
+    import_start_date: Optional[date] = Field(description="Date of earliest date allowed for importing transactions. Transactions earlier than this date are not imported.")
+    last_import: Optional[datetime] = Field(description="Timestamp in ISO 8601 extended format of the last time Lunch Money imported new data from Plaid for this account.")
+    last_fetch: Optional[datetime] = Field(description="Timestamp in ISO 8601 extended format of the last successful request from Lunch Money for updated data or timestamps from Plaid in ISO 8601 extended format (not necessarily date of last successful import)")
+    plaid_last_successful_update: Optional[datetime] = Field(description="Timestamp in ISO 8601 extended format of the last time Plaid successfully connected with institution for new transaction updates, regardless of whether any new data was available in the update.")
+    __properties: ClassVar[List[str]] = ["id", "date_linked", "name", "display_name", "type", "subtype", "mask", "institution_name", "status", "allow_transaction_modifications", "limit", "balance", "currency", "to_base", "balance_last_update", "import_start_date", "last_import", "last_fetch", "plaid_last_successful_update"]
+
+    @field_validator('status')
+    def status_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['active', 'inactive', 'relink', 'syncing', 'not found', 'not supported', 'error']):
+            raise ValueError("must be one of enum values ('active', 'inactive', 'relink', 'syncing', 'not found', 'not supported', 'error')")
+        return value
+
+    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 PlaidAccountObject 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 display_name (nullable) is None
+        # and model_fields_set contains the field
+        if self.display_name is None and "display_name" in self.model_fields_set:
+            _dict['display_name'] = None
+
+        # set to None if limit (nullable) is None
+        # and model_fields_set contains the field
+        if self.limit is None and "limit" in self.model_fields_set:
+            _dict['limit'] = None
+
+        # set to None if balance_last_update (nullable) is None
+        # and model_fields_set contains the field
+        if self.balance_last_update is None and "balance_last_update" in self.model_fields_set:
+            _dict['balance_last_update'] = None
+
+        # set to None if import_start_date (nullable) is None
+        # and model_fields_set contains the field
+        if self.import_start_date is None and "import_start_date" in self.model_fields_set:
+            _dict['import_start_date'] = None
+
+        # set to None if last_import (nullable) is None
+        # and model_fields_set contains the field
+        if self.last_import is None and "last_import" in self.model_fields_set:
+            _dict['last_import'] = None
+
+        # set to None if last_fetch (nullable) is None
+        # and model_fields_set contains the field
+        if self.last_fetch is None and "last_fetch" in self.model_fields_set:
+            _dict['last_fetch'] = None
+
+        # set to None if plaid_last_successful_update (nullable) is None
+        # and model_fields_set contains the field
+        if self.plaid_last_successful_update is None and "plaid_last_successful_update" in self.model_fields_set:
+            _dict['plaid_last_successful_update'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PlaidAccountObject from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "date_linked": obj.get("date_linked"),
+            "name": obj.get("name"),
+            "display_name": obj.get("display_name"),
+            "type": obj.get("type"),
+            "subtype": obj.get("subtype"),
+            "mask": obj.get("mask"),
+            "institution_name": obj.get("institution_name"),
+            "status": obj.get("status"),
+            "allow_transaction_modifications": obj.get("allow_transaction_modifications"),
+            "limit": obj.get("limit"),
+            "balance": obj.get("balance"),
+            "currency": obj.get("currency"),
+            "to_base": obj.get("to_base"),
+            "balance_last_update": obj.get("balance_last_update"),
+            "import_start_date": obj.get("import_start_date"),
+            "last_import": obj.get("last_import"),
+            "last_fetch": obj.get("last_fetch"),
+            "plaid_last_successful_update": obj.get("plaid_last_successful_update")
+        })
+        return _obj
+
+

lunchmoney/models/recurring_object.py

@@ -0,0 +1,143 @@
+# 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 datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from lunchmoney.models.recurring_object_matches import RecurringObjectMatches
+from lunchmoney.models.recurring_object_overrides import RecurringObjectOverrides
+from lunchmoney.models.recurring_object_transaction_criteria import RecurringObjectTransactionCriteria
+from typing import Optional, Set
+from typing_extensions import Self
+
+class RecurringObject(BaseModel):
+    """
+    RecurringObject
+    """ # noqa: E501
+    id: StrictInt = Field(description="The unique identifier of this recurring item")
+    description: Optional[StrictStr] = Field(description="An optional description of this recurring item.")
+    status: StrictStr = Field(description="The status of this recurring item. `suggested` recurring items are generated by Lunch Money, but only `reviewed` recurring items will be applied to matching transactions.")
+    transaction_criteria: RecurringObjectTransactionCriteria
+    overrides: RecurringObjectOverrides
+    matches: Optional[RecurringObjectMatches]
+    created_by: StrictInt = Field(description="The ID of the user who created the recurring item.")
+    created_at: datetime = Field(description="Date/time the recurring item was created in ISO 8601 extended format.")
+    updated_at: datetime = Field(description="Date/time the recurring item was updated in ISO 8601 extended format.")
+    source: StrictStr = Field(description="This can be one of four values: - `manual`: User created this recurring item manually from the Recurring Items page - `transaction`: User created this by converting a transaction from the Transactions page - `system`: Recurring item was created by the system on transaction import - `null`: Some older recurring items may not have a source. ")
+    __properties: ClassVar[List[str]] = ["id", "description", "status", "transaction_criteria", "overrides", "matches", "created_by", "created_at", "updated_at", "source"]
+
+    @field_validator('status')
+    def status_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['suggested', 'reviewed']):
+            raise ValueError("must be one of enum values ('suggested', 'reviewed')")
+        return value
+
+    @field_validator('source')
+    def source_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['manual', 'transaction', 'system']):
+            raise ValueError("must be one of enum values ('manual', 'transaction', 'system')")
+        return value
+
+    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 RecurringObject 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 transaction_criteria
+        if self.transaction_criteria:
+            _dict['transaction_criteria'] = self.transaction_criteria.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of overrides
+        if self.overrides:
+            _dict['overrides'] = self.overrides.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of matches
+        if self.matches:
+            _dict['matches'] = self.matches.to_dict()
+        # set to None if description (nullable) is None
+        # and model_fields_set contains the field
+        if self.description is None and "description" in self.model_fields_set:
+            _dict['description'] = None
+
+        # set to None if matches (nullable) is None
+        # and model_fields_set contains the field
+        if self.matches is None and "matches" in self.model_fields_set:
+            _dict['matches'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of RecurringObject from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "description": obj.get("description"),
+            "status": obj.get("status"),
+            "transaction_criteria": RecurringObjectTransactionCriteria.from_dict(obj["transaction_criteria"]) if obj.get("transaction_criteria") is not None else None,
+            "overrides": RecurringObjectOverrides.from_dict(obj["overrides"]) if obj.get("overrides") is not None else None,
+            "matches": RecurringObjectMatches.from_dict(obj["matches"]) if obj.get("matches") is not None else None,
+            "created_by": obj.get("created_by"),
+            "created_at": obj.get("created_at"),
+            "updated_at": obj.get("updated_at"),
+            "source": obj.get("source")
+        })
+        return _obj
+
+

lunchmoney/models/recurring_object_matches.py

@@ -0,0 +1,105 @@
+# 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 datetime import date
+from pydantic import BaseModel, ConfigDict, Field
+from typing import Any, ClassVar, Dict, List, Optional
+from lunchmoney.models.recurring_object_matches_found_transactions_inner import RecurringObjectMatchesFoundTransactionsInner
+from typing import Optional, Set
+from typing_extensions import Self
+
+class RecurringObjectMatches(BaseModel):
+    """
+    Details on expected, found and missing transactions for the specified range. This will be `null` for recurring items with a `status` of `suggested`.
+    """ # noqa: E501
+    request_start_date: Optional[date] = Field(default=None, description="The beginning of the date range that this request used to find matching transactions.")
+    request_end_date: Optional[date] = Field(default=None, description="The beginning of the date range that this request used to find matching transactions.")
+    expected_occurrence_dates: Optional[List[date]] = Field(default=None, description="A list of dates within the specified range where a recurring transactions is expected.")
+    found_transactions: Optional[List[RecurringObjectMatchesFoundTransactionsInner]] = Field(default=None, description="A list with the dates and IDs of matching transactions.")
+    missing_transaction_dates: Optional[List[date]] = Field(default=None, description="A list of dates within the range of where a recurring transaction was expected but none was found.")
+    __properties: ClassVar[List[str]] = ["request_start_date", "request_end_date", "expected_occurrence_dates", "found_transactions", "missing_transaction_dates"]
+
+    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 RecurringObjectMatches 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 each item in found_transactions (list)
+        _items = []
+        if self.found_transactions:
+            for _item_found_transactions in self.found_transactions:
+                if _item_found_transactions:
+                    _items.append(_item_found_transactions.to_dict())
+            _dict['found_transactions'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of RecurringObjectMatches from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "request_start_date": obj.get("request_start_date"),
+            "request_end_date": obj.get("request_end_date"),
+            "expected_occurrence_dates": obj.get("expected_occurrence_dates"),
+            "found_transactions": [RecurringObjectMatchesFoundTransactionsInner.from_dict(_item) for _item in obj["found_transactions"]] if obj.get("found_transactions") is not None else None,
+            "missing_transaction_dates": obj.get("missing_transaction_dates")
+        })
+        return _obj
+
+

lunchmoney/models/recurring_object_matches_found_transactions_inner.py

@@ -0,0 +1,91 @@
+# 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 datetime import date
+from pydantic import BaseModel, ConfigDict, Field, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class RecurringObjectMatchesFoundTransactionsInner(BaseModel):
+    """
+    RecurringObjectMatchesFoundTransactionsInner
+    """ # noqa: E501
+    var_date: Optional[date] = Field(default=None, description="The date for a matching transaction within the specified range.", alias="date")
+    transaction_id: Optional[StrictInt] = Field(default=None, description="The ID of a matching transaction within the specified range.")
+    __properties: ClassVar[List[str]] = ["date", "transaction_id"]
+
+    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 RecurringObjectMatchesFoundTransactionsInner 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,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of RecurringObjectMatchesFoundTransactionsInner from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "date": obj.get("date"),
+            "transaction_id": obj.get("transaction_id")
+        })
+        return _obj
+
+