lunchmoney-python 2.9.0__py3-none-any.whl

lunchmoney/api/summary_api.py

@@ -0,0 +1,434 @@
+# 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
+
+import warnings
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+
+from datetime import date
+from pydantic import Field, StrictBool
+from typing import Optional
+from typing_extensions import Annotated
+from lunchmoney.models.get_budget_summary200_response import GetBudgetSummary200Response
+
+from lunchmoney.api_client import ApiClient, RequestSerialized
+from lunchmoney.api_response import ApiResponse
+from lunchmoney.rest import RESTResponseType
+
+
+class SummaryApi:
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    def __init__(self, api_client=None) -> None:
+        if api_client is None:
+            api_client = ApiClient.get_default()
+        self.api_client = api_client
+
+
+    @validate_call
+    def get_budget_summary(
+        self,
+        start_date: Annotated[date, Field(description="Start of date range in ISO 8601 date format (YYYY-MM-DD).")],
+        end_date: Annotated[date, Field(description="End of date range in ISO 8601 date format (YYYY-MM-DD).")],
+        include_exclude_from_budgets: Annotated[Optional[StrictBool], Field(description="Enable to include categories that have the 'Exclude from Budgets' flag set in the returned `categories` array.")] = None,
+        include_occurrences: Annotated[Optional[StrictBool], Field(description="Enable to include an `occurrences` array for each category in an aligned response. Each array will include an object for each budget period that falls within the specified date range which includes details on the activity for the budget period.")] = None,
+        include_past_budget_dates: Annotated[Optional[StrictBool], Field(description="Enable to include the three budget occurrences prior to the start date in the `occurrences` array for each category in an aligned response. This property is ignored if `include_occurrences` is not also set to `true`.")] = None,
+        include_totals: Annotated[Optional[StrictBool], Field(description="Enable to include a top-level `totals` section that summarizes the inflow and outflow across all transactions for the specified date range.")] = None,
+        include_rollover_pool: Annotated[Optional[StrictBool], Field(description="Enable to include a `rollover_pool` section that summarizes the current rollover pool balance and all previous adjustments.")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> GetBudgetSummary200Response:
+        """Get summary
+
+        Returns a summary of the budget activity for the specified date range.
+
+        :param start_date: Start of date range in ISO 8601 date format (YYYY-MM-DD). (required)
+        :type start_date: date
+        :param end_date: End of date range in ISO 8601 date format (YYYY-MM-DD). (required)
+        :type end_date: date
+        :param include_exclude_from_budgets: Enable to include categories that have the 'Exclude from Budgets' flag set in the returned `categories` array.
+        :type include_exclude_from_budgets: bool
+        :param include_occurrences: Enable to include an `occurrences` array for each category in an aligned response. Each array will include an object for each budget period that falls within the specified date range which includes details on the activity for the budget period.
+        :type include_occurrences: bool
+        :param include_past_budget_dates: Enable to include the three budget occurrences prior to the start date in the `occurrences` array for each category in an aligned response. This property is ignored if `include_occurrences` is not also set to `true`.
+        :type include_past_budget_dates: bool
+        :param include_totals: Enable to include a top-level `totals` section that summarizes the inflow and outflow across all transactions for the specified date range.
+        :type include_totals: bool
+        :param include_rollover_pool: Enable to include a `rollover_pool` section that summarizes the current rollover pool balance and all previous adjustments.
+        :type include_rollover_pool: bool
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_budget_summary_serialize(
+            start_date=start_date,
+            end_date=end_date,
+            include_exclude_from_budgets=include_exclude_from_budgets,
+            include_occurrences=include_occurrences,
+            include_past_budget_dates=include_past_budget_dates,
+            include_totals=include_totals,
+            include_rollover_pool=include_rollover_pool,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "GetBudgetSummary200Response",
+            '401': "ErrorResponseObject",
+            '429': "ErrorResponseObject",
+            '500': "ErrorResponseObject",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def get_budget_summary_with_http_info(
+        self,
+        start_date: Annotated[date, Field(description="Start of date range in ISO 8601 date format (YYYY-MM-DD).")],
+        end_date: Annotated[date, Field(description="End of date range in ISO 8601 date format (YYYY-MM-DD).")],
+        include_exclude_from_budgets: Annotated[Optional[StrictBool], Field(description="Enable to include categories that have the 'Exclude from Budgets' flag set in the returned `categories` array.")] = None,
+        include_occurrences: Annotated[Optional[StrictBool], Field(description="Enable to include an `occurrences` array for each category in an aligned response. Each array will include an object for each budget period that falls within the specified date range which includes details on the activity for the budget period.")] = None,
+        include_past_budget_dates: Annotated[Optional[StrictBool], Field(description="Enable to include the three budget occurrences prior to the start date in the `occurrences` array for each category in an aligned response. This property is ignored if `include_occurrences` is not also set to `true`.")] = None,
+        include_totals: Annotated[Optional[StrictBool], Field(description="Enable to include a top-level `totals` section that summarizes the inflow and outflow across all transactions for the specified date range.")] = None,
+        include_rollover_pool: Annotated[Optional[StrictBool], Field(description="Enable to include a `rollover_pool` section that summarizes the current rollover pool balance and all previous adjustments.")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[GetBudgetSummary200Response]:
+        """Get summary
+
+        Returns a summary of the budget activity for the specified date range.
+
+        :param start_date: Start of date range in ISO 8601 date format (YYYY-MM-DD). (required)
+        :type start_date: date
+        :param end_date: End of date range in ISO 8601 date format (YYYY-MM-DD). (required)
+        :type end_date: date
+        :param include_exclude_from_budgets: Enable to include categories that have the 'Exclude from Budgets' flag set in the returned `categories` array.
+        :type include_exclude_from_budgets: bool
+        :param include_occurrences: Enable to include an `occurrences` array for each category in an aligned response. Each array will include an object for each budget period that falls within the specified date range which includes details on the activity for the budget period.
+        :type include_occurrences: bool
+        :param include_past_budget_dates: Enable to include the three budget occurrences prior to the start date in the `occurrences` array for each category in an aligned response. This property is ignored if `include_occurrences` is not also set to `true`.
+        :type include_past_budget_dates: bool
+        :param include_totals: Enable to include a top-level `totals` section that summarizes the inflow and outflow across all transactions for the specified date range.
+        :type include_totals: bool
+        :param include_rollover_pool: Enable to include a `rollover_pool` section that summarizes the current rollover pool balance and all previous adjustments.
+        :type include_rollover_pool: bool
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_budget_summary_serialize(
+            start_date=start_date,
+            end_date=end_date,
+            include_exclude_from_budgets=include_exclude_from_budgets,
+            include_occurrences=include_occurrences,
+            include_past_budget_dates=include_past_budget_dates,
+            include_totals=include_totals,
+            include_rollover_pool=include_rollover_pool,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "GetBudgetSummary200Response",
+            '401': "ErrorResponseObject",
+            '429': "ErrorResponseObject",
+            '500': "ErrorResponseObject",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def get_budget_summary_without_preload_content(
+        self,
+        start_date: Annotated[date, Field(description="Start of date range in ISO 8601 date format (YYYY-MM-DD).")],
+        end_date: Annotated[date, Field(description="End of date range in ISO 8601 date format (YYYY-MM-DD).")],
+        include_exclude_from_budgets: Annotated[Optional[StrictBool], Field(description="Enable to include categories that have the 'Exclude from Budgets' flag set in the returned `categories` array.")] = None,
+        include_occurrences: Annotated[Optional[StrictBool], Field(description="Enable to include an `occurrences` array for each category in an aligned response. Each array will include an object for each budget period that falls within the specified date range which includes details on the activity for the budget period.")] = None,
+        include_past_budget_dates: Annotated[Optional[StrictBool], Field(description="Enable to include the three budget occurrences prior to the start date in the `occurrences` array for each category in an aligned response. This property is ignored if `include_occurrences` is not also set to `true`.")] = None,
+        include_totals: Annotated[Optional[StrictBool], Field(description="Enable to include a top-level `totals` section that summarizes the inflow and outflow across all transactions for the specified date range.")] = None,
+        include_rollover_pool: Annotated[Optional[StrictBool], Field(description="Enable to include a `rollover_pool` section that summarizes the current rollover pool balance and all previous adjustments.")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Get summary
+
+        Returns a summary of the budget activity for the specified date range.
+
+        :param start_date: Start of date range in ISO 8601 date format (YYYY-MM-DD). (required)
+        :type start_date: date
+        :param end_date: End of date range in ISO 8601 date format (YYYY-MM-DD). (required)
+        :type end_date: date
+        :param include_exclude_from_budgets: Enable to include categories that have the 'Exclude from Budgets' flag set in the returned `categories` array.
+        :type include_exclude_from_budgets: bool
+        :param include_occurrences: Enable to include an `occurrences` array for each category in an aligned response. Each array will include an object for each budget period that falls within the specified date range which includes details on the activity for the budget period.
+        :type include_occurrences: bool
+        :param include_past_budget_dates: Enable to include the three budget occurrences prior to the start date in the `occurrences` array for each category in an aligned response. This property is ignored if `include_occurrences` is not also set to `true`.
+        :type include_past_budget_dates: bool
+        :param include_totals: Enable to include a top-level `totals` section that summarizes the inflow and outflow across all transactions for the specified date range.
+        :type include_totals: bool
+        :param include_rollover_pool: Enable to include a `rollover_pool` section that summarizes the current rollover pool balance and all previous adjustments.
+        :type include_rollover_pool: bool
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_budget_summary_serialize(
+            start_date=start_date,
+            end_date=end_date,
+            include_exclude_from_budgets=include_exclude_from_budgets,
+            include_occurrences=include_occurrences,
+            include_past_budget_dates=include_past_budget_dates,
+            include_totals=include_totals,
+            include_rollover_pool=include_rollover_pool,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "GetBudgetSummary200Response",
+            '401': "ErrorResponseObject",
+            '429': "ErrorResponseObject",
+            '500': "ErrorResponseObject",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _get_budget_summary_serialize(
+        self,
+        start_date,
+        end_date,
+        include_exclude_from_budgets,
+        include_occurrences,
+        include_past_budget_dates,
+        include_totals,
+        include_rollover_pool,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        if start_date is not None:
+            if isinstance(start_date, date):
+                _query_params.append(
+                    (
+                        'start_date',
+                        start_date.strftime(
+                            self.api_client.configuration.date_format
+                        )
+                    )
+                )
+            else:
+                _query_params.append(('start_date', start_date))
+            
+        if end_date is not None:
+            if isinstance(end_date, date):
+                _query_params.append(
+                    (
+                        'end_date',
+                        end_date.strftime(
+                            self.api_client.configuration.date_format
+                        )
+                    )
+                )
+            else:
+                _query_params.append(('end_date', end_date))
+            
+        if include_exclude_from_budgets is not None:
+            
+            _query_params.append(('include_exclude_from_budgets', include_exclude_from_budgets))
+            
+        if include_occurrences is not None:
+            
+            _query_params.append(('include_occurrences', include_occurrences))
+            
+        if include_past_budget_dates is not None:
+            
+            _query_params.append(('include_past_budget_dates', include_past_budget_dates))
+            
+        if include_totals is not None:
+            
+            _query_params.append(('include_totals', include_totals))
+            
+        if include_rollover_pool is not None:
+            
+            _query_params.append(('include_rollover_pool', include_rollover_pool))
+            
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json'
+                ]
+            )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'cookieAuth', 
+            'bearerSecurity'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/summary',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+