tap-belvo 0.3.5__py3-none-any.whl

tap_belvo/streams/__init__.py

@@ -0,0 +1,44 @@
+"""Stream classes for tap-belvo."""
+
+from __future__ import annotations
+
+from tap_belvo.streams.banking import (
+    Accounts,
+    Balances,
+    InvestmentPortfolios,
+    InvestmentTransactions,
+    Owners,
+    ReceivableTransactions,
+    Transactions,
+)
+from tap_belvo.streams.core import Institutions, Links
+from tap_belvo.streams.enrichment import Incomes, RecurringExpenses, RiskInsights
+from tap_belvo.streams.fiscal import (
+    Invoices,
+    TaxComplianceStatuses,
+    TaxDeclarations,
+    TaxRetentions,
+    TaxReturns,
+    TaxStatuses,
+)
+
+__all__ = [
+    "Accounts",
+    "Balances",
+    "Incomes",
+    "Institutions",
+    "InvestmentPortfolios",
+    "InvestmentTransactions",
+    "Invoices",
+    "Links",
+    "Owners",
+    "ReceivableTransactions",
+    "RecurringExpenses",
+    "RiskInsights",
+    "TaxComplianceStatuses",
+    "TaxDeclarations",
+    "TaxRetentions",
+    "TaxReturns",
+    "TaxStatuses",
+    "Transactions",
+]

tap_belvo/streams/banking.py

@@ -0,0 +1,103 @@
+"""Stream type classes for tap-belvo."""
+
+from __future__ import annotations
+
+import sys
+from typing import TYPE_CHECKING, Any
+
+from tap_belvo.client import BelvoStream
+from tap_belvo.streams.core import Links
+
+if sys.version_info >= (3, 12):
+    from typing import override
+else:
+    from typing_extensions import override
+
+if TYPE_CHECKING:
+    from urllib.parse import ParseResult
+
+    from singer_sdk.helpers.types import Context
+
+
+class Accounts(BelvoStream):
+    """Accounts stream."""
+
+    name = "banking_accounts"
+    path = "/api/accounts"
+    primary_keys = ("id",)
+    replication_key = "created_at"
+    openapi_ref = "Account"
+
+
+class Transactions(BelvoStream):
+    """Transactions stream."""
+
+    name = "banking_transactions"
+    path = "/api/transactions"
+    primary_keys = ("id",)
+    replication_key = "created_at"
+    openapi_ref = "Account"
+    parent_stream_type = Links
+
+    @override
+    def get_url_params(
+        self,
+        context: Context | None,
+        next_page_token: ParseResult | None,
+    ) -> dict[str, Any]:
+        params = super().get_url_params(context, next_page_token)
+
+        if context is not None:
+            params["link"] = context["link_id"]
+
+        return params
+
+
+class Balances(BelvoStream):
+    """DEPRECATED. Balances stream."""
+
+    name = "banking_balances"
+    path = "/api/balances"
+    primary_keys = ("id",)
+    replication_key = "value_date"
+    openapi_ref = "Balance"
+
+
+class Owners(BelvoStream):
+    """Owners stream."""
+
+    name = "banking_owners"
+    path = "/api/owners"
+    primary_keys = ("id",)
+    replication_key = "created_at"
+    openapi_ref = "Owner"
+
+
+class InvestmentPortfolios(BelvoStream):
+    """Portfolios stream."""
+
+    name = "investment_portfolios"
+    path = "/investments/portfolios"
+    primary_keys = ("id",)
+    replication_key = None
+    openapi_ref = "InvestmentsPortfolio"
+
+
+class InvestmentTransactions(BelvoStream):
+    """Investment transactions stream."""
+
+    name = "investment_transactions"
+    path = "/investments/transactions"
+    primary_keys = ("id",)
+    replication_key = "created_at"
+    openapi_ref = "InvestmentsInstrumentTransaction"
+
+
+class ReceivableTransactions(BelvoStream):
+    """Receivable transactions stream."""
+
+    name = "receivable_transactions"
+    path = "/receivables/transactions"
+    primary_keys = ("id",)
+    replication_key = "created_at"
+    openapi_ref = "ReceivablesTransaction"

tap_belvo/streams/core.py

@@ -0,0 +1,54 @@
+"""Stream type classes for tap-belvo."""
+
+from __future__ import annotations
+
+import sys
+from typing import TYPE_CHECKING, Any
+
+from tap_belvo.client import BelvoStream
+
+if sys.version_info >= (3, 12):
+    from typing import override
+else:
+    from typing_extensions import override
+
+if TYPE_CHECKING:
+    from singer_sdk.helpers.types import Context
+
+
+class Links(BelvoStream):
+    """Links stream."""
+
+    name = "links"
+    path = "/api/links"
+    primary_keys = ("id",)
+    replication_key = "created_at"
+    openapi_ref = "Link"
+
+    @override
+    def get_child_context(
+        self,
+        record: dict[str, Any],
+        context: Context | None,
+    ) -> dict[Any, Any]:
+        return {"link_id": record["id"]}
+
+
+class Institutions(BelvoStream):
+    """Institutions stream."""
+
+    name = "institutions"
+    path = "/api/institutions"
+    primary_keys = ("id",)
+    replication_key = None
+    openapi_ref = "InstitutionPublicApi"
+
+
+class Consents(BelvoStream):
+    """Consents stream."""
+
+    name = "consents"
+    path = "/api/consents"
+    primary_keys = ("id",)
+    replication_key = None
+    openapi_ref = "Consents"

tap_belvo/streams/enrichment.py

@@ -0,0 +1,34 @@
+"""Stream type classes for tap-belvo."""
+
+from __future__ import annotations
+
+from tap_belvo.client import BelvoStream
+
+
+class Incomes(BelvoStream):
+    """Incomes stream."""
+
+    name = "enrichment_incomes"
+    path = "/api/incomes"
+    primary_keys = ("id",)
+    openapi_ref = "Income"
+
+
+class RecurringExpenses(BelvoStream):
+    """RecurringExpenses stream."""
+
+    name = "enrichment_recurring_expenses"
+    path = "/api/recurring-expenses"
+    primary_keys = ("id",)
+    replication_key = None
+    openapi_ref = "RecurringExpenses"
+
+
+class RiskInsights(BelvoStream):
+    """RiskInsights stream."""
+
+    name = "enrichment_risk_insights"
+    path = "/api/risk-insights"
+    primary_keys = ("id",)
+    replication_key = None
+    openapi_ref = "RiskInsights"

tap_belvo/streams/fiscal.py

@@ -0,0 +1,66 @@
+"""Fiscal stream type classes for tap-belvo."""
+
+from __future__ import annotations
+
+from tap_belvo.client import BelvoStream
+
+
+class Invoices(BelvoStream):
+    """Invoices stream."""
+
+    name = "fiscal_invoices"
+    path = "/api/invoices"
+    primary_keys = ("id",)
+    replication_key = "created_at"
+    openapi_ref = "InvoiceWithIdSat"
+
+
+class TaxComplianceStatuses(BelvoStream):
+    """Tax Compliance Statuses stream."""
+
+    name = "fiscal_tax_compliance_statuses"
+    path = "/api/tax-compliance-status"
+    primary_keys = ("id",)
+    replication_key = "created_at"
+    openapi_ref = "TaxComplianceStatus"
+
+
+# NOTE: This is stream is in beta and its schema is not yet documented.
+class TaxDeclarations(BelvoStream):
+    """Tax Declarations stream."""
+
+    name = "fiscal_tax_declarations"
+    path = "/api/tax-declarations"
+    primary_keys = ("id",)
+    replication_key = "created_at"
+    openapi_ref = "TaxDeclaration"
+
+
+class TaxRetentions(BelvoStream):
+    """Tax Retentions stream."""
+
+    name = "fiscal_tax_retentions"
+    path = "/api/tax-retentions"
+    primary_keys = ("id",)
+    replication_key = "created_at"
+    openapi_ref = "TaxRetentions"
+
+
+class TaxReturns(BelvoStream):
+    """Tax Returns stream."""
+
+    name = "fiscal_tax_returns"
+    path = "/api/tax-returns"
+    primary_keys = ("id",)
+    replication_key = "created_at"
+    openapi_ref = "TaxReturn"
+
+
+class TaxStatuses(BelvoStream):
+    """Tax Statuses stream."""
+
+    name = "fiscal_tax_statuses"
+    path = "/api/tax-status"
+    primary_keys = ("id",)
+    replication_key = "created_at"
+    openapi_ref = "TaxStatusSat"

tap_belvo/tap.py

@@ -0,0 +1,74 @@
+"""Belvo tap class."""
+
+from __future__ import annotations
+
+import sys
+
+import singer_sdk
+from singer_sdk import typing as th
+
+from tap_belvo.streams import banking, core, enrichment, fiscal
+
+if sys.version_info >= (3, 12):
+    from typing import override
+else:
+    from typing_extensions import override
+
+
+class TapBelvo(singer_sdk.Tap):
+    """Singer tap for Belvo."""
+
+    name = "tap-belvo"
+
+    config_jsonschema = th.PropertiesList(
+        th.Property(
+            "secret_id",
+            th.StringType,
+            description="Belvo API secret ID.",
+            required=True,
+            secret=True,
+        ),
+        th.Property(
+            "password",
+            th.StringType,
+            description="Belvo API password.",
+            required=True,
+            secret=True,
+        ),
+        th.Property(
+            "start_date",
+            th.DateTimeType,
+            description="Earliest datetime to get data from",
+        ),
+        th.Property(
+            "base_url",
+            th.StringType,
+            description="Base URL for the Belvo API",
+            default="https://development.belvo.com",
+        ),
+    ).to_dict()
+
+    @override
+    def discover_streams(self) -> list[singer_sdk.Stream]:
+        # TODO(edgarrmondragon): Add tax declarations and tax returns
+        # https://github.com/reservoir-data/tap-belvo/issues/76
+        return [
+            core.Links(self),
+            core.Institutions(self),
+            # TODO(edgarrmondragon): The `document_number` field seems to be incorrectly
+            # marked as required?
+            # https://developers.belvo.com/apis/belvoopenapispec/consents/listconsents
+            # core.Consents(self),  # noqa: ERA001
+            banking.Accounts(self),
+            banking.Transactions(self),
+            banking.Owners(self),
+            # banking.InvestmentPortfolios(self),  # noqa: ERA001
+            # banking.ReceivableTransactions(self),  # noqa: ERA001
+            enrichment.Incomes(self),
+            enrichment.RecurringExpenses(self),
+            enrichment.RiskInsights(self),
+            fiscal.Invoices(self),
+            fiscal.TaxComplianceStatuses(self),
+            fiscal.TaxRetentions(self),
+            fiscal.TaxStatuses(self),
+        ]

tap_belvo-0.3.5.dist-info/METADATA

@@ -0,0 +1,110 @@
+Metadata-Version: 2.4
+Name: tap-belvo
+Version: 0.3.5
+Summary: Singer tap for Belvo, built with the Meltano SDK for Singer Taps.
+Project-URL: Documentation, https://github.com/reservoir-data/tap-belvo#readme
+Project-URL: Homepage, https://github.com/reservoir-data/tap-belvo
+Project-URL: Source, https://github.com/reservoir-data/tap-belvo
+Author-email: Edgar Ramírez-Mondragón <edgarrm358@gmail.com>
+Maintainer-email: Edgar Ramírez-Mondragón <edgarrm358@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: Belvo,ELT,singer.io
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.11
+Requires-Dist: requests-cache==1.*
+Requires-Dist: requests~=2.32.3
+Requires-Dist: singer-sdk~=0.53.2
+Requires-Dist: typing-extensions>=4.15; python_full_version < '3.12'
+Description-Content-Type: text/markdown
+
+# tap-belvo
+
+Singer tap for Belvo.
+
+Built with the [Meltano Singer SDK](https://sdk.meltano.com).
+
+## Capabilities
+
+* `catalog`
+* `state`
+* `discover`
+* `about`
+* `stream-maps`
+* `schema-flattening`
+
+## Settings
+
+| Setting             | Required | Default | Description |
+|:--------------------|:--------:|:-------:|:------------|
+| secret_id           | True     | None    | Belvo API secret ID. |
+| password            | True     | None    | Belvo API password. |
+| start_date          | False    | None    | Earliest datetime to get data from |
+| base_url            | False    | https://development.belvo.com | Base URL for the Belvo API |
+| stream_maps         | False    | None    | Config object for stream maps capability. For more information check out [Stream Maps](https://sdk.meltano.com/en/latest/stream_maps.html). |
+| stream_map_config   | False    | None    | User-defined config values to be used within map expressions. |
+| flattening_enabled  | False    | None    | 'True' to enable schema flattening and automatically expand nested properties. |
+| flattening_max_depth| False    | None    | The max depth to flatten schemas. |
+
+A full list of supported settings and capabilities is available by running: `tap-belvo --about`
+
+### Source Authentication and Authorization
+
+See https://developers.belvo.com/reference/authentication-1.
+
+## Usage
+
+You can easily run `tap-belvo` by itself or in a pipeline using [Meltano](https://meltano.com/).
+
+### Executing the Tap Directly
+
+```bash
+tap-belvo --version
+tap-belvo --help
+tap-belvo --config CONFIG --discover > ./catalog.json
+```
+
+## Developer Resources
+
+### Initialize your Development Environment
+
+```bash
+uv tool install --with tox-uv tox
+```
+
+### Create and Run Tests
+
+Run all tests:
+
+```bash
+tox run-parallel
+```
+
+### Testing with [Meltano](https://www.meltano.com)
+
+_**Note:** This tap will work in any Singer environment and does not require Meltano.
+Examples here are for convenience and to streamline end-to-end orchestration scenarios._
+
+Your project comes with a custom `meltano.yml` project file already created. Go ahead and [install Meltano](https://docs.meltano.com/getting-started/installation/) if you haven't already.
+
+1. Install all plugins
+
+   ```bash
+   meltano install
+   ```
+
+1. Check that the extractor is working properly
+
+   ```bash
+   meltano invoke tap-belvo --version
+   ```
+
+1. Execute an ELT pipeline
+
+   ```bash
+   meltano run tap-belvo target-jsonl
+   ```

tap_belvo-0.3.5.dist-info/RECORD

@@ -0,0 +1,15 @@
+tap_belvo/__init__.py,sha256=iyiBrJmF2aO9lg9B8vvrJlfGSSg0I2JooKI4TOFqbtY,80
+tap_belvo/__main__.py,sha256=J5_xhlTVBRRUlQ62HlFpgvpDXaeYZqEpb1-eEO0rSJg,110
+tap_belvo/client.py,sha256=9umJFleWiXI2zsWa51bLwl2dAeW7Aax8Ks0FfINHgNA,3663
+tap_belvo/openapi.json,sha256=s5by63pAwVcpKzl4Ym04KWUek9CAbDG8IZ-wYazZ87E,1617968
+tap_belvo/tap.py,sha256=U8RZsAC8gSxAOrjSBgmB7k3ntmVslxXksfmEwdlv4QE,2257
+tap_belvo/streams/__init__.py,sha256=pbZNHP8IAnavfiIpY2vNZevOyieVmjwmjrsNEYEIY1M,935
+tap_belvo/streams/banking.py,sha256=8IYbtUwDoUSjOxFbkEFSDC8QK9urLJyU0JvOJkNjIww,2421
+tap_belvo/streams/core.py,sha256=Kr991miUOD3kNu2eh4GGjBBHHrdRTPDD2FGa3swIhYg,1131
+tap_belvo/streams/enrichment.py,sha256=oiyXvkSK2XRcGjcpfbeTW454eyNGhO-eejdEnuHOFYg,761
+tap_belvo/streams/fiscal.py,sha256=P1kM1TN-Im1XCiTipG-OiKTfbgy0uoW_sg_-D7EnJQo,1603
+tap_belvo-0.3.5.dist-info/METADATA,sha256=j5n32ydIDD8TvRyf3GkJn0tTjGLaF6fmcT9-NVvLpzc,3501
+tap_belvo-0.3.5.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+tap_belvo-0.3.5.dist-info/entry_points.txt,sha256=mbs2jnK3SrSgW3kjbO1jMZdQkSAKw-JO8SscyYtN_Pg,57
+tap_belvo-0.3.5.dist-info/licenses/LICENSE,sha256=hYHcZxy5jb9T_KQO1dQVotQfhWsU2XBotWBg6FIgklM,1068
+tap_belvo-0.3.5.dist-info/RECORD,,

tap_belvo-0.3.5.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

tap_belvo-0.3.5.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+tap-belvo = tap_belvo.tap:TapBelvo.cli

tap_belvo-0.3.5.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Edgar R. M.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.