1import os
  2
  3from . import resources
  4from .enums import Environment
  5from .exceptions import BelvoAPIException
  6from .http import APISession
  7
  8
  9class Client:
 10    def __init__(self, secret_key_id: str, secret_key_password: str, url: str = None) -> None:
 11        """# Connect to the Belvo API
 12
 13        In order to use Belvo API, you will have to login into a new session by using
 14        a _secret key_.
 15
 16        Secret keys are generated from the Belvo API dashboard. For more information, please visit
 17        [our Developers portal](https://developers.belvo.com/docs/get-your-belvo-api-keys)
 18
 19        ### Method
 20
 21        ```python
 22        def __init__(secret_key_id: str, secret_key_password: str, url: str = None) -> None:
 23            ...
 24        ```
 25
 26        You **must** provide your `secret_key_id` and `secret_key_password`.
 27
 28        The `url` tells the client to which Belvo API host should attempt to connect,
 29        this allows you to switch from a sandbox to a production environment.
 30
 31        You can also set which Belvo API host to use, by setting the `BELVO_API_URL`
 32        environment variable.
 33
 34        When creating a new instance of `Client`, it will automatically perform a login
 35        and create a `JWTSession` (if the credentials are valid).
 36
 37
 38        ### Example
 39        ```python
 40        # Creating a client instance to connect to Belvo API
 41        from belvo.client import Client
 42
 43        my_client = Client(
 44            "your-secret-key-id",
 45            "your-secret-key-password",
 46            "https://api.belvo.com"
 47        )
 48
 49
 50        # Creating a client that takes url from the environment.
 51        # We assume that you have set BELVO_API_URL before
 52        # (e.g. export BELVO_API_URL=https://sandbox.belvo.com
 53        my_client = Client(
 54            "your-secret-key-id",
 55            "your-secret-key-password"
 56        )
 57        ```
 58
 59        ## Nested resources
 60
 61        All resources in the Belvo API are nested attributes in your client instance,
 62        these resources are available **only** if you provide valid credentials.
 63
 64        Args:
 65            secret_key_id (str): Your Belvo secret ID.
 66            secret_key_password (str): Your Belvo secret password.
 67            url (str, optional): The URL of the environment you want to connect to.
 68
 69        Raises:
 70            BelvoAPIException
 71        """
 72        if url is None:
 73            url = os.getenv("BELVO_API_URL")
 74
 75        url = Environment.get_url(url)
 76        if not url:
 77            raise BelvoAPIException("You need to provide a URL or a valid environment.")
 78
 79        self.session = APISession(url)
 80
 81        if not self.session.login(secret_key_id, secret_key_password):
 82            raise BelvoAPIException("Login failed.")
 83
 84        self._links = resources.Links(self.session)
 85        self._accounts = resources.Accounts(self.session)
 86        self._transactions = resources.Transactions(self.session)
 87        self._balances = resources.Balances(self.session)
 88        self._institutions = resources.Institutions(self.session)
 89        self._incomes = resources.Incomes(self.session)
 90        self._owners = resources.Owners(self.session)
 91        self._invoices = resources.Invoices(self.session)
 92        self._recurring_expenses = resources.RecurringExpenses(self.session)
 93        self._risk_insights = resources.RiskInsights(self.session)
 94        self._tax_returns = resources.TaxReturns(self.session)
 95        self._tax_declarations = resources.TaxDeclarations(self.session)
 96        self._tax_status = resources.TaxStatus(self.session)
 97        self._tax_compliance_status = resources.TaxComplianceStatus(self.session)
 98        self._tax_retentions = resources.TaxRetentions(self.session)
 99        self._statements = resources.Statements(self.session)
100        self._widget_token = resources.WidgetToken(self.session)
101        self._investments_portfolios = resources.InvestmentsPortfolios(self.session)
102        self._employment_records = resources.EmploymentRecords(self.session)
103
104    @property
105    def Links(self):
106        return self._links
107
108    @property
109    def Accounts(self):
110        return self._accounts
111
112    @property
113    def Transactions(self):
114        return self._transactions
115
116    @property
117    def Balances(self):
118        return self._balances
119
120    @property
121    def Institutions(self):
122        return self._institutions
123
124    @property
125    def Incomes(self):
126        return self._incomes
127
128    @property
129    def Owners(self):
130        return self._owners
131
132    @property
133    def Invoices(self):
134        return self._invoices
135
136    @property
137    def RecurringExpenses(self):
138        return self._recurring_expenses
139
140    @property
141    def RiskInsights(self):
142        return self._risk_insights
143
144    @property
145    def TaxReturns(self):
146        return self._tax_returns
147
148    @property
149    def TaxDeclarations(self):
150        return self._tax_declarations
151
152    @property
153    def TaxComplianceStatus(self):
154        return self._tax_compliance_status
155
156    @property
157    def TaxStatus(self):
158        return self._tax_status
159
160    @property
161    def TaxRetentions(self):
162        return self._tax_retentions
163
164    @property
165    def Statements(self):
166        return self._statements
167
168    @property
169    def WidgetToken(self):
170        return self._widget_token
171
172    @property
173    def InvestmentsPortfolios(self):
174        return self._investments_portfolios
175
176    @property
177    def EmploymentRecords(self):
178        return self._employment_records