1from datetime import date
 2from typing import Dict, List, Optional, Union
 3
 4from belvo.enums import TaxReturnType
 5from belvo.resources.base import Resource
 6
 7
 8class TaxReturns(Resource):
 9    endpoint = "/api/tax-returns/"
10
11    def create(
12        self,
13        link: str,
14        year_from: str = None,
15        year_to: str = None,
16        *,
17        attach_pdf: bool = False,
18        save_data: bool = True,
19        raise_exception: bool = False,
20        type_: Optional[TaxReturnType] = None,
21        date_from: str = None,
22        date_to: str = None,
23        **kwargs: Dict,
24    ) -> Union[List[Dict], Dict]:
25        """Retrieve tax returns for a link
26
27        Retrieve yearly (annual) or monthly tax returns for a fiscal link.
28
29        Args:
30            link (str): The fiscal `link.id` you want specific tax return information for.
31            year_from (str, optional): The starting year you want to get tax returns for, in `YYYY` format. Defaults to None.
32            year_to (str, optional): The year you want to stop geting tax returns for, in `YYYY` format. Defaults to None.
33            attach_pdf (bool, optional): When this is set to `True`, you will receive the PDF as a binary string in the response.. Defaults to `False`.
34            save_data (bool, optional): Indicates whether or not to persist the data in Belvo. Defaults to `True`.
35            raise_exception (bool, optional): Indicates whether to raise an exception or return the API error. Defaults to `False`.
36            type_ (Optional[TaxReturnType], optional): The type of tax return to return. For yearly tax returns this must be set to `yearly`. For monthly tax returns, this field must be set to `monthly`. By default, Belvo returns the **yearly** (annual) tax returns.
37            date_from (str, optional): The starting date you want to get tax returns for, in `YYYY-MM-DD` format. The value of `date_from` cannot be greater than `date_to`. Defaults to None.
38            date_to (str, optional): The date you want to stop geting tax returns for, in `YYYY-MM-DD` format. The value of `date_to` cannot be greater than today's date (in other words, no future dates). Defaults to None.
39
40        Returns:
41            Dict: The details of the object. For more information on the response from the API, see our [Tax returns API documentation](https://developers.belvo.com/reference/retrievetaxreturns).
42        """
43
44        type_ = type_ if type_ else TaxReturnType.YEARLY
45
46        data = {"link": link, "attach_pdf": attach_pdf, "save_data": save_data, "type": type_.value}
47
48        if data["type"] == "yearly":
49            year_to = year_to or str(date.today().year)
50            data.update(year_to=year_to, year_from=year_from)
51        else:
52            data.update(date_to=date_to, date_from=date_from)
53
54        return self.session.post(
55            self.endpoint, data=data, raise_exception=raise_exception, **kwargs
56        )
57
58    def resume(
59        self,
60        session: str,
61        token: str,
62        *,
63        link: str = None,
64        raise_exception: bool = False,
65        **kwargs: Dict,
66    ) -> Dict:
67        raise NotImplementedError()