fintoc 2.2.2__tar.gz → 2.4.0__tar.gz

{fintoc-2.2.2 → fintoc-2.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fintoc
-Version: 2.2.2
+Version: 2.4.0
 Summary: The official Python client for the Fintoc API.
 Home-page: https://fintoc.com/
 License: BSD-3-Clause
@@ -8,14 +8,13 @@ Author: Daniel Leal
 Author-email: daniel@fintoc.com
 Maintainer: Daniel Leal
 Maintainer-email: daniel@fintoc.com
-Requires-Python: >=3.6,<4.0
+Requires-Python: >=3.7,<4.0
 Classifier: License :: OSI Approved :: BSD License
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.6
 Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
 Requires-Dist: httpx (>=0.16,<1.0)
 Project-URL: Issue Tracker, https://github.com/fintoc-com/fintoc-python/issues
 Project-URL: Repository, https://github.com/fintoc-com/fintoc-python
@@ -47,14 +46,6 @@ Description-Content-Type: text/markdown
 </a>
 </p>
 
-## Why?
-
-You can think of [Fintoc API](https://fintoc.com/docs) as a piscola.
-And the key ingredient to a properly made piscola are the ice cubes.
-Sure, you can still have a [piscola without ice cubes](https://curl.haxx.se/).
-But hey… that’s not enjoyable -- why would you do that?
-Do yourself a favor: go grab some ice cubes by installing this refreshing library.
-
 ## Installation
 
 Install using pip!
@@ -346,17 +337,6 @@ for tax_return in link.tax_returns.all():
     print(tax_return.id)
 ```
 
-#### The `subscriptions` manager
-
-Available methods: `all`, `get`.
-
-Once you have a Link, you can use the `subscriptions` manager to get all the subscriptions associated to a link!
-
-```python
-for subscription in link.subscriptions.all():
-    print(subscription.id)
-```
-
 #### The `refresh_intents` manager
 
 Available methods: `all`, `get`, `create`.
@@ -415,6 +395,44 @@ for movement in account.movements.all():
     print(movement.id)
 ```
 
+#### The `subscription_intents` manager
+
+Available methods: `all`, `get`, `create`
+
+Subscription intents allow you to start a subscription using Fintoc!:
+
+```python
+subscription_intent = fintoc_client.subscription_intents.create()
+
+print(subscription_intent.id)            # si_BO381oEATXonG6bj
+print(subscription_intent.widget_token)  # si_BO381oEATXonG6bj_sec_a4xK32BanKWYn
+```
+
+#### The `subscriptions` manager
+
+Available methods: `all`, `get`
+
+You can check the status of the created subscription with the `subscriptions` manager
+
+```python
+subscription = fintoc_client.subscriptions.get('<subscription_id>')
+print(subscription.status)
+```
+
+#### The `charges` manager
+
+Available methods: `all`, `get`, `create`
+
+Once you have active subscriptions, you can use the `charges` manager to create charges to thosse subscriptions
+
+```python
+charge = fintoc_client.charges.create(
+    currency='CLP',
+    amount=1250,
+    subscription_id='<subscription_id>',
+)
+```
+
 ### Serialization
 
 Any resource of the SDK can be serialized! To get the serialized resource, just call the `serialize` method!

{fintoc-2.2.2 → fintoc-2.4.0}/README.md

@@ -24,14 +24,6 @@
 </a>
 </p>
 
-## Why?
-
-You can think of [Fintoc API](https://fintoc.com/docs) as a piscola.
-And the key ingredient to a properly made piscola are the ice cubes.
-Sure, you can still have a [piscola without ice cubes](https://curl.haxx.se/).
-But hey… that’s not enjoyable -- why would you do that?
-Do yourself a favor: go grab some ice cubes by installing this refreshing library.
-
 ## Installation
 
 Install using pip!
@@ -323,17 +315,6 @@ for tax_return in link.tax_returns.all():
     print(tax_return.id)
 ```
 
-#### The `subscriptions` manager
-
-Available methods: `all`, `get`.
-
-Once you have a Link, you can use the `subscriptions` manager to get all the subscriptions associated to a link!
-
-```python
-for subscription in link.subscriptions.all():
-    print(subscription.id)
-```
-
 #### The `refresh_intents` manager
 
 Available methods: `all`, `get`, `create`.
@@ -392,6 +373,44 @@ for movement in account.movements.all():
     print(movement.id)
 ```
 
+#### The `subscription_intents` manager
+
+Available methods: `all`, `get`, `create`
+
+Subscription intents allow you to start a subscription using Fintoc!:
+
+```python
+subscription_intent = fintoc_client.subscription_intents.create()
+
+print(subscription_intent.id)            # si_BO381oEATXonG6bj
+print(subscription_intent.widget_token)  # si_BO381oEATXonG6bj_sec_a4xK32BanKWYn
+```
+
+#### The `subscriptions` manager
+
+Available methods: `all`, `get`
+
+You can check the status of the created subscription with the `subscriptions` manager
+
+```python
+subscription = fintoc_client.subscriptions.get('<subscription_id>')
+print(subscription.status)
+```
+
+#### The `charges` manager
+
+Available methods: `all`, `get`, `create`
+
+Once you have active subscriptions, you can use the `charges` manager to create charges to thosse subscriptions
+
+```python
+charge = fintoc_client.charges.create(
+    currency='CLP',
+    amount=1250,
+    subscription_id='<subscription_id>',
+)
+```
+
 ### Serialization
 
 Any resource of the SDK can be serialized! To get the serialized resource, just call the `serialize` method!

{fintoc-2.2.2 → fintoc-2.4.0}/fintoc/client.py

@@ -10,15 +10,15 @@ from fintoc.paginator import paginate
 
 
 class Client:
-
     """Encapsulates the client behaviour and methods."""
 
-    def __init__(self, base_url, api_key, user_agent, params={}):
+    def __init__(self, base_url, api_key, api_version, user_agent, params={}):
         self.base_url = base_url
         self.api_key = api_key
         self.user_agent = user_agent
         self.params = params
         self.__client = None
+        self.api_version = api_version
 
     @property
     def _client(self):
@@ -33,7 +33,15 @@ class Client:
     @property
     def headers(self):
         """Return the appropriate headers for every request."""
-        return {"Authorization": self.api_key, "User-Agent": self.user_agent}
+        headers = {
+            "Authorization": self.api_key,
+            "User-Agent": self.user_agent,
+        }
+
+        if self.api_version is not None:
+            headers["Fintoc-Version"] = self.api_version
+
+        return headers
 
     def request(self, path, paginated=False, method="get", params=None, json=None):
         """
@@ -62,6 +70,7 @@ class Client:
         return Client(
             base_url=base_url or self.base_url,
             api_key=api_key or self.api_key,
+            api_version=self.api_version,
             user_agent=user_agent or self.user_agent,
             params={**self.params, **params} if params else self.params,
         )

{fintoc-2.2.2 → fintoc-2.4.0}/fintoc/core.py

@@ -4,22 +4,34 @@ Core module to house the Fintoc object of the Fintoc Python SDK.
 
 from fintoc.client import Client
 from fintoc.constants import API_BASE_URL, API_VERSION
-from fintoc.managers import LinksManager, PaymentIntentsManager, WebhookEndpointsManager
+from fintoc.managers import (
+    ChargesManager,
+    LinksManager,
+    PaymentIntentsManager,
+    SubscriptionIntentsManager,
+    SubscriptionsManager,
+    WebhookEndpointsManager,
+)
 from fintoc.version import __version__
 
 
 class Fintoc:
-
     """Encapsulates the core object's behaviour and methods."""
 
-    def __init__(self, api_key):
+    def __init__(self, api_key, api_version=None):
         self._client = Client(
             base_url=f"{API_BASE_URL}/{API_VERSION}",
             api_key=api_key,
+            api_version=api_version,
             user_agent=f"fintoc-python/{__version__}",
         )
+        self.charges = ChargesManager("/charges", self._client)
         self.links = LinksManager("/links", self._client)
         self.payment_intents = PaymentIntentsManager("/payment_intents", self._client)
+        self.subscriptions = SubscriptionsManager("/subscriptions", self._client)
+        self.subscription_intents = SubscriptionIntentsManager(
+            "/subscription_intents", self._client
+        )
         self.webhook_endpoints = WebhookEndpointsManager(
             "/webhook_endpoints", self._client
         )

{fintoc-2.2.2 → fintoc-2.4.0}/fintoc/managers/__init__.py

@@ -1,11 +1,13 @@
 """Init file for the managers module of the SDK."""
 
 from .accounts_manager import AccountsManager
+from .charges_manager import ChargesManager
 from .invoices_manager import InvoicesManager
 from .links_manager import LinksManager
 from .movements_manager import MovementsManager
 from .payment_intents_manager import PaymentIntentsManager
 from .refresh_intents_manager import RefreshIntentsManager
+from .subscription_intents_manager import SubscriptionIntentsManager
 from .subscriptions_manager import SubscriptionsManager
 from .tax_returns_manager import TaxRetunsManager
 from .webhook_endpoints_manager import WebhookEndpointsManager

fintoc-2.4.0/fintoc/managers/charges_manager.py

@@ -0,0 +1,11 @@
+"""Module to hold the charges manager."""
+
+from fintoc.mixins import ManagerMixin
+
+
+class ChargesManager(ManagerMixin):
+
+    """Represents a charges manager."""
+
+    resource = "charge"
+    methods = ["all", "get", "create"]

fintoc-2.4.0/fintoc/managers/subscription_intents_manager.py

@@ -0,0 +1,11 @@
+"""Module to hold the subscription_intents manager."""
+
+from fintoc.mixins import ManagerMixin
+
+
+class SubscriptionIntentsManager(ManagerMixin):
+
+    """Represents a subscription_intents manager."""
+
+    resource = "subscription_intent"
+    methods = ["all", "get", "create"]

{fintoc-2.2.2 → fintoc-2.4.0}/fintoc/resources/__init__.py

@@ -2,6 +2,7 @@
 
 from .account import Account
 from .balance import Balance
+from .charge import Charge
 from .generic_fintoc_resource import GenericFintocResource
 from .income import Income
 from .institution import Institution
@@ -15,6 +16,7 @@ from .payment_intent import PaymentIntent
 from .refresh_intent import RefreshIntent
 from .services_invoice import ServicesInvoice
 from .subscription import Subscription
+from .subscription_intent import SubscriptionIntent
 from .tax_return import TaxReturn
 from .taxpayer import Taxpayer
 from .tobacco_taxes import TobaccoTaxes

fintoc-2.4.0/fintoc/resources/charge.py

@@ -0,0 +1,7 @@
+"""Module to hold the Charge resource."""
+
+from fintoc.mixins import ResourceMixin
+
+
+class Charge(ResourceMixin):
+    """Represents a Fintoc Charge."""

fintoc-2.4.0/fintoc/resources/subscription_intent.py

@@ -0,0 +1,7 @@
+"""Module to hold the SubscriptionIntent resource."""
+
+from fintoc.mixins import ResourceMixin
+
+
+class SubscriptionIntent(ResourceMixin):
+    """Represents a Fintoc Subscription Intent."""

{fintoc-2.2.2 → fintoc-2.4.0}/fintoc/version.py

@@ -1,4 +1,4 @@
 """Module to hold the version utilities."""
 
-version_info = (2, 2, 2)
+version_info = (2, 4, 0)
 __version__ = ".".join([str(x) for x in version_info])

{fintoc-2.2.2 → fintoc-2.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "fintoc"
-version = "2.2.2"
+version = "2.4.0"
 description = "The official Python client for the Fintoc API."
 authors = ["Daniel Leal <daniel@fintoc.com>", "Nebil Kawas <nebil@uc.cl>"]
 maintainers = ["Daniel Leal <daniel@fintoc.com>"]
@@ -19,11 +19,11 @@ exclude = [
 ]
 
 [tool.poetry.dependencies]
-python = "^3.6"
+python = "^3.7"
 httpx = ">=0.16, < 1.0"
 
 [tool.poetry.dev-dependencies]
-black = "^20.8b1"
+black = "^22.10.0"
 flake8 = "^3.8.4"
 isort = "^5.6.4"
 pylint = "^2.6.0"

fintoc-2.4.0/setup.py

@@ -0,0 +1,30 @@
+# -*- coding: utf-8 -*-
+from setuptools import setup
+
+packages = \
+['fintoc', 'fintoc.managers', 'fintoc.mixins', 'fintoc.resources']
+
+package_data = \
+{'': ['*']}
+
+install_requires = \
+['httpx>=0.16,<1.0']
+
+setup_kwargs = {
+    'name': 'fintoc',
+    'version': '2.4.0',
+    'description': 'The official Python client for the Fintoc API.',
+    'long_description': '<h1 align="center">Fintoc meets Python 🐍</h1>\n\n<p align="center">\n    <em>\n        You have just found the Python-flavored client of <a href="https://fintoc.com/" target="_blank">Fintoc</a>.\n    </em>\n</p>\n\n<p align="center">\n<a href="https://pypi.org/project/fintoc" target="_blank">\n    <img src="https://img.shields.io/pypi/v/fintoc?label=version&logo=python&logoColor=%23fff&color=306998" alt="PyPI - Version">\n</a>\n\n<a href="https://github.com/fintoc-com/fintoc-python/actions?query=workflow%3Atests" target="_blank">\n    <img src="https://img.shields.io/github/workflow/status/fintoc-com/fintoc-python/tests?label=tests&logo=python&logoColor=%23fff" alt="Tests">\n</a>\n\n<a href="https://codecov.io/gh/fintoc-com/fintoc-python" target="_blank">\n    <img src="https://img.shields.io/codecov/c/gh/fintoc-com/fintoc-python?label=coverage&logo=codecov&logoColor=ffffff" alt="Coverage">\n</a>\n\n<a href="https://github.com/fintoc-com/fintoc-python/actions?query=workflow%3Alinters" target="_blank">\n    <img src="https://img.shields.io/github/workflow/status/fintoc-com/fintoc-python/linters?label=linters&logo=github" alt="Linters">\n</a>\n</p>\n\n## Installation\n\nInstall using pip!\n\n```sh\npip install fintoc\n```\n\n**Note:** This SDK requires [**Python 3.6+**](https://docs.python.org/3/whatsnew/3.6.html).\n\n## Usage\n\nThe idea behind this SDK is to stick to the API design as much as possible, so that it feels ridiculously natural to use even while only reading the raw API documentation.\n\n### Quickstart\n\nTo be able to use this SDK, you first need to have a [Fintoc](https://app.fintoc.com/login) account. You will need to get your secret API key from the dashboard to be able to use the SDK. Once you have your API key, all you need to do is initialize a `Fintoc` object with it and you\'re ready to start enjoying Fintoc!\n\n```python\nfrom fintoc import Fintoc\n\nfintoc_client = Fintoc("your_api_key")\n```\n\nNow you can start using the SDK!\n\n### Managers\n\nTo make the usage of the SDK feel natural, resources are managed by **managers** (_wow_). These **managers** correspond to objects with some methods that allow you to get the resources that you want. Each manager is _attached_ to another resource, following the API structure. For example, the `Fintoc` object has `links` and `webhook_endpoints` managers, while `Link` objects have an `accounts` manager (we will see more examples soon). Notice that **not every manager has all of the methods**, as they correspond to the API capabilities. The methods of the managers are the following (we will use the `webhook_endpoints` manager as an example):\n\n#### `all`\n\nYou can use the `all` method of the managers as follows:\n\n```python\nwebhook_endpoints = fintoc_client.webhook_endpoints.all()\n```\n\nThe `all` method of the managers returns **a generator** with all the instances of the resource. This method can also receive `kwargs`! The arguments that can be passed are the arguments that the API receives for that specific resource! For example, the `Movement` resource can be filtered using `since` and `until`, so if you wanted to get a range of `movements` from an `account`, all you need to do is to pass the parameters to the method!\n\n```python\nmovements = account.movements.all(since="2019-07-24", until="2021-05-12")\n```\n\nYou can also pass the `lazy=False` parameter to the method to force the SDK to return a list of all the instances of the resource instead of the generator. **Beware**: this could take **very long**, depending on the amount of instances that exist of said resource:\n\n```python\nwebhook_endpoints = fintoc_client.webhook_endpoints.all(lazy=False)\n\nisinstance(webhook_endpoints, list)  # True\n```\n\n#### `get`\n\nYou can use the `get` method of the managers as follows:\n\n```python\nwebhook_endpoint = fintoc_client.webhook_endpoints.get("we_8anqVLlBC8ROodem")\n```\n\nThe `get` method of the managers returns an existing instance of the resource using its identifier to find it.\n\n#### `create`\n\nYou can use the `create` method of the managers as follows:\n\n```python\nwebhook_endpoint = fintoc_client.webhook_endpoints.create(\n    url="https://webhook.site/58gfb429-c33c-20c7-584b-d5ew3y3202a0",\n    enabled_events=["link.credentials_changed"],\n    description="Fantasting webhook endpoint",\n)\n```\n\nThe `create` method of the managers creates and returns a new instance of the resource. The attributes of the created object are passed as `kwargs`, and correspond to the parameters specified by the API documentation for the creation of said resource.\n\n#### `update`\n\nYou can use the `update` method of the managers as follows:\n\n```python\nwebhook_endpoint = fintoc_client.webhook_endpoints.update(\n    "we_8anqVLlBC8ROodem",\n    enabled_events=["account.refresh_intent.succeeded"],\n    disabled=True,\n)\n```\n\nThe `update` method of the managers updates and returns an existing instance of the resource using its identifier to find it. The first parameter of the method corresponds to the identifier being used to find the existing instance of the resource. The attributes to be modified are passed as `kwargs`, and correspond to the parameters specified by the API documentation for the update action of said resource.\n\nNotice that using the manager to update an instance of a resource is equivalent (in terms of outcome) to calling the `update` directly on the object itself:\n\n\n```python\n# Using the manager\nwebhook_endpoint = fintoc_client.webhook_endpoints.update(\n    "we_8anqVLlBC8ROodem",\n    enabled_events=["account.refresh_intent.succeeded"],\n    disabled=True,\n)\n\n# Using the object\nwebhook_endpoint = fintoc_client.webhook_endpoints.get("we_8anqVLlBC8ROodem")\nwebhook_endpoint.update(\n    enabled_events=["account.refresh_intent.succeeded"],\n    disabled=True,\n)\n```\n\nWhen using the SDK, you will probably almost always want to use the object directly to update, just because it is way less verbose if you already have the object itself. Also, using the `update` method from the manager first needs to `get` the resource and then updates it, so it translates to 2 API calls. If you already have the object to update, using the `update` method directly from the object just updates it, so it translates to just 1 API call.\n\n#### `delete`\n\nYou can use the `delete` method of the managers as follows:\n\n```python\ndeleted_identifier = fintoc_client.webhook_endpoints.delete("we_8anqVLlBC8ROodem")\n```\n\nThe `delete` method of the managers deletes an existing instance of the resource using its identifier to find it and returns the identifier.\n\nNotice that using the manager to delete an instance of a resource is equivalent (in terms of outcome) to calling the `delete` directly on the object itself:\n\n\n```python\n# Using the manager\ndeleted_identifier = fintoc_client.webhook_endpoints.delete("we_8anqVLlBC8ROodem")\n\n# Using the object\nwebhook_endpoint = fintoc_client.webhook_endpoints.get("we_8anqVLlBC8ROodem")\ndeleted_identifier = webhook_endpoint.delete()\n```\n\nWhen using the SDK, you will probably almost always want to use the object directly to delete, just because it is way less verbose if you already have the object itself. Also, using the `delete` method from the manager first needs to `get` the resource and then deletes it, so it translates to 2 API calls. If you already have the object to delete, using the `delete` method directly from the object just deletes it, so it translates to just 1 API call.\n\n### The shape of the SDK\n\nFor complete information about the API, head to [the docs](https://fintoc.com/docs). You will notice that the shape of the SDK is very similar to the shape of the API. Let\'s start with the `Fintoc` object.\n\n#### The `Fintoc` object\n\nTo create a `Fintoc` object, instantiate it using your secret API key:\n\n```python\nfrom fintoc import Fintoc\n\nfintoc_client = Fintoc("your_api_key")\n```\n\nThis gives us access to a bunch of operations already. The object created using this _snippet_ contains three [managers](#managers): `links`, `payment_intents` and `webhook_endpoints`.\n\n#### The `webhook_endpoints` manager\n\nAvailable methods: `all`, `get`, `create`, `update`, `delete`.\n\nFrom the Fintoc client, you can manage your webhook endpoints swiftly! Start by creating a new Webhook Endpoint!\n\n```python\nwebhook_endpoint = fintoc_client.webhook_endpoints.create(\n    url="https://webhook.site/58gfb429-c33c-20c7-584b-d5ew3y3202a0",\n    enabled_events=["account.refresh_intent.succeeded"],\n    disabled=True,\n)\n\nprint(webhook_endpoint.id)  # we_8anqVLlBC8ROodem\n```\n\nYou can update this webhook endpoint any time you want! Just run the following command:\n\n```python\nwebhook_endpoint = fintoc_client.webhook_endpoints.update(\n    "we_8anqVLlBC8ROodem",\n    enabled_events=["link.credentials_changed"],\n    description="Fantasting webhook endpoint",\n)\n\nprint(webhook_endpoint.status)  # disabled\n```\n\nMaybe you no longer want this webhook endpoint. Let\'s delete it!\n\n```python\nfintoc_client.webhook_endpoints.delete("we_8anqVLlBC8ROodem")\n```\n\nNow, let\'s list every webhook endpoint we have:\n\n```python\nfor webhook_endpoint in fintoc_client.webhook_endpoints.all():\n    print(webhook_endpoint.id)\n```\n\nIf you see a webhook endpoint you want to use, just use the `get` method!\n\n```python\nwebhook_endpoint = fintoc_client.webhook_endpoints.get("we_8anqVLlBC8ROodem")\n\nprint(webhook_endpoint.id)  # we_8anqVLlBC8ROodem\n```\n\n#### The `payment_intents` manager\n\nAvailable methods: `all`, `get`, `create`.\n\nPayment intents allow you to start a payment using Fintoc! Start by creating a new payment intent:\n\n```python\npayment_intent = fintoc_client.payment_intents.create(\n    currency="CLP",\n    amount=5990,\n    recipient_account={\n        "holder_id": "111111111",\n        "number": "123123123",\n        "type": "checking_account",\n        "institution_id": "cl_banco_de_chile",\n    }\n)\n\nprint(payment_intent.id)            # pi_BO381oEATXonG6bj\nprint(payment_intent.widget_token)  # pi_BO381oEATXonG6bj_sec_a4xK32BanKWYn\n```\n\nNotice that the success of this payment intent will be notified through a Webhook. Now, let\'s list every payment intent we have:\n\n```python\nfor payment_intent in fintoc_client.payment_intents.all():\n    print(payment_intent.id)\n```\n\nIf you see a payment intent you want to use, just use the `get` method!\n\n```python\npayment_intent = fintoc_client.payment_intents.get("pi_BO381oEATXonG6bj")\n\nprint(payment_intent.id)      # pi_BO381oEATXonG6bj\nprint(payment_intent.status)  # succeeded\n```\n\n#### The `links` manager\n\nAvailable methods: `all`, `get`, `update`, `delete`.\n\nLinks are probably the most importat resource. Let\'s list them!\n\n```python\nprint(len(fintoc_client.links.all(lazy=False)))  # 3\n\nfor link in fintoc_client.links.all():\n    print(link.id)\n```\n\nLinks are a bit different than the rest of the resources, because their identifier is not really their `id`, but their `link_token`. This means that, in order to `get`, `update` or `delete` a link, you need to pass the `link_token`!\n\n```python\nlink = fintoc_client.links.get("link_Y75EXAKiIVj7w489_token_NCqjwRVoTX3cmnx8pnbpqd11")\n```\n\nNotice that the Link objects generated from the `all` method will won\'t be able to execute `update` or `delete` operations, while any Link object generated from `get` or `update` will have permission to `update` or `delete` (given that the link token is necessary to `get` or `update` in the first place).\n\nThe Link resource has a lot of **managers**!\n\n```python\ninvoices = link.invoices.all()  # Invoices\ntax_returns = link.tax_returns.all()  # Tax Returns\nsubscriptions = link.subscriptions.all()  # Subscriptions\nrefresh_intents = link.refresh_intents.all()  # Refresh Intents\naccounts = link.accounts.all()  # Accounts\n```\n\n#### The `invoices` manager\n\nAvailable methods: `all`.\n\nOnce you have a Link, you can use the `invoices` manager to get all the invoices associated to a link!\n\n```python\nfor invoice in link.invoices.all():\n    print(invoice.id)\n```\n\n#### The `tax_returns` manager\n\nAvailable methods: `all`, `get`.\n\nOnce you have a Link, you can use the `tax_returns` manager to get all the tax returns associated to a link!\n\n```python\nfor tax_return in link.tax_returns.all():\n    print(tax_return.id)\n```\n\n#### The `refresh_intents` manager\n\nAvailable methods: `all`, `get`, `create`.\n\nRefresh intents allow you to control how an account gets refreshed on Fintoc! Once you have a Link, you can use the `refresh_intents` manager to create a new refresh intent:\n\n```python\nrefresh_intent = link.refresh_intents.create()\n\nprint(refresh_intent.id)  # ri_5A94DVCJ7xNM3MEo\n```\n\nNotice that the success of this refresh intent will be notified through a Webhook. Now, let\'s list every refresh intent we have:\n\n```python\nfor refresh_intent in link.refresh_intents.all():\n    print(refresh_intent.id)\n```\n\nIf you see a refresh intent you want to use, just use the `get` method!\n\n```python\nrefresh_intent = link.refresh_intents.get("ri_5A94DVCJ7xNM3MEo")\n\nprint(refresh_intent.id)      # ri_5A94DVCJ7xNM3MEo\nprint(refresh_intent.status)  # succeeded\n```\n\n#### The `accounts` manager\n\nAvailable methods: `all`, `get`.\n\nOnce you have a Link, you can use the `accounts` manager to get all the accounts associated to a link!\n\n```python\nfor account in link.accounts.all():\n    print(account.id)\n```\n\nNotice that accounts also have a `movements` manager, to get all of the movements of an account:\n\n```python\naccount = link.accounts.all(lazy=False)[0]\n\nmovements = account.movements.all(lazy=False)\n```\n\n#### The `movements` manager\n\nAvailable methods: `all`, `get`.\n\nOnce you have an Account, you can use the `movements` manager to get all the movements associated to that account!\n\n```python\nfor movement in account.movements.all():\n    print(movement.id)\n```\n\n#### The `subscription_intents` manager\n\nAvailable methods: `all`, `get`, `create`\n\nSubscription intents allow you to start a subscription using Fintoc!:\n\n```python\nsubscription_intent = fintoc_client.subscription_intents.create()\n\nprint(subscription_intent.id)            # si_BO381oEATXonG6bj\nprint(subscription_intent.widget_token)  # si_BO381oEATXonG6bj_sec_a4xK32BanKWYn\n```\n\n#### The `subscriptions` manager\n\nAvailable methods: `all`, `get`\n\nYou can check the status of the created subscription with the `subscriptions` manager\n\n```python\nsubscription = fintoc_client.subscriptions.get(\'<subscription_id>\')\nprint(subscription.status)\n```\n\n#### The `charges` manager\n\nAvailable methods: `all`, `get`, `create`\n\nOnce you have active subscriptions, you can use the `charges` manager to create charges to thosse subscriptions\n\n```python\ncharge = fintoc_client.charges.create(\n    currency=\'CLP\',\n    amount=1250,\n    subscription_id=\'<subscription_id>\',\n)\n```\n\n### Serialization\n\nAny resource of the SDK can be serialized! To get the serialized resource, just call the `serialize` method!\n\n```python\naccount = link.accounts.all(lazy=False)[0]\n\nserialization = account.serialize()\n```\n\nThe serialization corresponds to a dictionary with only simple types, that can be JSON-serialized.\n\n## Acknowledgements\n\nThe first version of this SDK was originally designed and handcrafted by [**@nebil**](https://github.com/nebil),\n[ad](https://en.wikipedia.org/wiki/Ad_honorem) [piscolem](https://en.wiktionary.org/wiki/piscola).\nHe built it with the help of Gianni Roberto’s [Picchi 2](https://www.youtube.com/watch?v=WqjUlmkYr2g).\n',
+    'author': 'Daniel Leal',
+    'author_email': 'daniel@fintoc.com',
+    'maintainer': 'Daniel Leal',
+    'maintainer_email': 'daniel@fintoc.com',
+    'url': 'https://fintoc.com/',
+    'packages': packages,
+    'package_data': package_data,
+    'install_requires': install_requires,
+    'python_requires': '>=3.7,<4.0',
+}
+
+
+setup(**setup_kwargs)

fintoc-2.2.2/setup.py

@@ -1,30 +0,0 @@
-# -*- coding: utf-8 -*-
-from setuptools import setup
-
-packages = \
-['fintoc', 'fintoc.managers', 'fintoc.mixins', 'fintoc.resources']
-
-package_data = \
-{'': ['*']}
-
-install_requires = \
-['httpx>=0.16,<1.0']
-
-setup_kwargs = {
-    'name': 'fintoc',
-    'version': '2.2.2',
-    'description': 'The official Python client for the Fintoc API.',
-    'long_description': '<h1 align="center">Fintoc meets Python 🐍</h1>\n\n<p align="center">\n    <em>\n        You have just found the Python-flavored client of <a href="https://fintoc.com/" target="_blank">Fintoc</a>.\n    </em>\n</p>\n\n<p align="center">\n<a href="https://pypi.org/project/fintoc" target="_blank">\n    <img src="https://img.shields.io/pypi/v/fintoc?label=version&logo=python&logoColor=%23fff&color=306998" alt="PyPI - Version">\n</a>\n\n<a href="https://github.com/fintoc-com/fintoc-python/actions?query=workflow%3Atests" target="_blank">\n    <img src="https://img.shields.io/github/workflow/status/fintoc-com/fintoc-python/tests?label=tests&logo=python&logoColor=%23fff" alt="Tests">\n</a>\n\n<a href="https://codecov.io/gh/fintoc-com/fintoc-python" target="_blank">\n    <img src="https://img.shields.io/codecov/c/gh/fintoc-com/fintoc-python?label=coverage&logo=codecov&logoColor=ffffff" alt="Coverage">\n</a>\n\n<a href="https://github.com/fintoc-com/fintoc-python/actions?query=workflow%3Alinters" target="_blank">\n    <img src="https://img.shields.io/github/workflow/status/fintoc-com/fintoc-python/linters?label=linters&logo=github" alt="Linters">\n</a>\n</p>\n\n## Why?\n\nYou can think of [Fintoc API](https://fintoc.com/docs) as a piscola.\nAnd the key ingredient to a properly made piscola are the ice cubes.\nSure, you can still have a [piscola without ice cubes](https://curl.haxx.se/).\nBut hey… that’s not enjoyable -- why would you do that?\nDo yourself a favor: go grab some ice cubes by installing this refreshing library.\n\n## Installation\n\nInstall using pip!\n\n```sh\npip install fintoc\n```\n\n**Note:** This SDK requires [**Python 3.6+**](https://docs.python.org/3/whatsnew/3.6.html).\n\n## Usage\n\nThe idea behind this SDK is to stick to the API design as much as possible, so that it feels ridiculously natural to use even while only reading the raw API documentation.\n\n### Quickstart\n\nTo be able to use this SDK, you first need to have a [Fintoc](https://app.fintoc.com/login) account. You will need to get your secret API key from the dashboard to be able to use the SDK. Once you have your API key, all you need to do is initialize a `Fintoc` object with it and you\'re ready to start enjoying Fintoc!\n\n```python\nfrom fintoc import Fintoc\n\nfintoc_client = Fintoc("your_api_key")\n```\n\nNow you can start using the SDK!\n\n### Managers\n\nTo make the usage of the SDK feel natural, resources are managed by **managers** (_wow_). These **managers** correspond to objects with some methods that allow you to get the resources that you want. Each manager is _attached_ to another resource, following the API structure. For example, the `Fintoc` object has `links` and `webhook_endpoints` managers, while `Link` objects have an `accounts` manager (we will see more examples soon). Notice that **not every manager has all of the methods**, as they correspond to the API capabilities. The methods of the managers are the following (we will use the `webhook_endpoints` manager as an example):\n\n#### `all`\n\nYou can use the `all` method of the managers as follows:\n\n```python\nwebhook_endpoints = fintoc_client.webhook_endpoints.all()\n```\n\nThe `all` method of the managers returns **a generator** with all the instances of the resource. This method can also receive `kwargs`! The arguments that can be passed are the arguments that the API receives for that specific resource! For example, the `Movement` resource can be filtered using `since` and `until`, so if you wanted to get a range of `movements` from an `account`, all you need to do is to pass the parameters to the method!\n\n```python\nmovements = account.movements.all(since="2019-07-24", until="2021-05-12")\n```\n\nYou can also pass the `lazy=False` parameter to the method to force the SDK to return a list of all the instances of the resource instead of the generator. **Beware**: this could take **very long**, depending on the amount of instances that exist of said resource:\n\n```python\nwebhook_endpoints = fintoc_client.webhook_endpoints.all(lazy=False)\n\nisinstance(webhook_endpoints, list)  # True\n```\n\n#### `get`\n\nYou can use the `get` method of the managers as follows:\n\n```python\nwebhook_endpoint = fintoc_client.webhook_endpoints.get("we_8anqVLlBC8ROodem")\n```\n\nThe `get` method of the managers returns an existing instance of the resource using its identifier to find it.\n\n#### `create`\n\nYou can use the `create` method of the managers as follows:\n\n```python\nwebhook_endpoint = fintoc_client.webhook_endpoints.create(\n    url="https://webhook.site/58gfb429-c33c-20c7-584b-d5ew3y3202a0",\n    enabled_events=["link.credentials_changed"],\n    description="Fantasting webhook endpoint",\n)\n```\n\nThe `create` method of the managers creates and returns a new instance of the resource. The attributes of the created object are passed as `kwargs`, and correspond to the parameters specified by the API documentation for the creation of said resource.\n\n#### `update`\n\nYou can use the `update` method of the managers as follows:\n\n```python\nwebhook_endpoint = fintoc_client.webhook_endpoints.update(\n    "we_8anqVLlBC8ROodem",\n    enabled_events=["account.refresh_intent.succeeded"],\n    disabled=True,\n)\n```\n\nThe `update` method of the managers updates and returns an existing instance of the resource using its identifier to find it. The first parameter of the method corresponds to the identifier being used to find the existing instance of the resource. The attributes to be modified are passed as `kwargs`, and correspond to the parameters specified by the API documentation for the update action of said resource.\n\nNotice that using the manager to update an instance of a resource is equivalent (in terms of outcome) to calling the `update` directly on the object itself:\n\n\n```python\n# Using the manager\nwebhook_endpoint = fintoc_client.webhook_endpoints.update(\n    "we_8anqVLlBC8ROodem",\n    enabled_events=["account.refresh_intent.succeeded"],\n    disabled=True,\n)\n\n# Using the object\nwebhook_endpoint = fintoc_client.webhook_endpoints.get("we_8anqVLlBC8ROodem")\nwebhook_endpoint.update(\n    enabled_events=["account.refresh_intent.succeeded"],\n    disabled=True,\n)\n```\n\nWhen using the SDK, you will probably almost always want to use the object directly to update, just because it is way less verbose if you already have the object itself. Also, using the `update` method from the manager first needs to `get` the resource and then updates it, so it translates to 2 API calls. If you already have the object to update, using the `update` method directly from the object just updates it, so it translates to just 1 API call.\n\n#### `delete`\n\nYou can use the `delete` method of the managers as follows:\n\n```python\ndeleted_identifier = fintoc_client.webhook_endpoints.delete("we_8anqVLlBC8ROodem")\n```\n\nThe `delete` method of the managers deletes an existing instance of the resource using its identifier to find it and returns the identifier.\n\nNotice that using the manager to delete an instance of a resource is equivalent (in terms of outcome) to calling the `delete` directly on the object itself:\n\n\n```python\n# Using the manager\ndeleted_identifier = fintoc_client.webhook_endpoints.delete("we_8anqVLlBC8ROodem")\n\n# Using the object\nwebhook_endpoint = fintoc_client.webhook_endpoints.get("we_8anqVLlBC8ROodem")\ndeleted_identifier = webhook_endpoint.delete()\n```\n\nWhen using the SDK, you will probably almost always want to use the object directly to delete, just because it is way less verbose if you already have the object itself. Also, using the `delete` method from the manager first needs to `get` the resource and then deletes it, so it translates to 2 API calls. If you already have the object to delete, using the `delete` method directly from the object just deletes it, so it translates to just 1 API call.\n\n### The shape of the SDK\n\nFor complete information about the API, head to [the docs](https://fintoc.com/docs). You will notice that the shape of the SDK is very similar to the shape of the API. Let\'s start with the `Fintoc` object.\n\n#### The `Fintoc` object\n\nTo create a `Fintoc` object, instantiate it using your secret API key:\n\n```python\nfrom fintoc import Fintoc\n\nfintoc_client = Fintoc("your_api_key")\n```\n\nThis gives us access to a bunch of operations already. The object created using this _snippet_ contains three [managers](#managers): `links`, `payment_intents` and `webhook_endpoints`.\n\n#### The `webhook_endpoints` manager\n\nAvailable methods: `all`, `get`, `create`, `update`, `delete`.\n\nFrom the Fintoc client, you can manage your webhook endpoints swiftly! Start by creating a new Webhook Endpoint!\n\n```python\nwebhook_endpoint = fintoc_client.webhook_endpoints.create(\n    url="https://webhook.site/58gfb429-c33c-20c7-584b-d5ew3y3202a0",\n    enabled_events=["account.refresh_intent.succeeded"],\n    disabled=True,\n)\n\nprint(webhook_endpoint.id)  # we_8anqVLlBC8ROodem\n```\n\nYou can update this webhook endpoint any time you want! Just run the following command:\n\n```python\nwebhook_endpoint = fintoc_client.webhook_endpoints.update(\n    "we_8anqVLlBC8ROodem",\n    enabled_events=["link.credentials_changed"],\n    description="Fantasting webhook endpoint",\n)\n\nprint(webhook_endpoint.status)  # disabled\n```\n\nMaybe you no longer want this webhook endpoint. Let\'s delete it!\n\n```python\nfintoc_client.webhook_endpoints.delete("we_8anqVLlBC8ROodem")\n```\n\nNow, let\'s list every webhook endpoint we have:\n\n```python\nfor webhook_endpoint in fintoc_client.webhook_endpoints.all():\n    print(webhook_endpoint.id)\n```\n\nIf you see a webhook endpoint you want to use, just use the `get` method!\n\n```python\nwebhook_endpoint = fintoc_client.webhook_endpoints.get("we_8anqVLlBC8ROodem")\n\nprint(webhook_endpoint.id)  # we_8anqVLlBC8ROodem\n```\n\n#### The `payment_intents` manager\n\nAvailable methods: `all`, `get`, `create`.\n\nPayment intents allow you to start a payment using Fintoc! Start by creating a new payment intent:\n\n```python\npayment_intent = fintoc_client.payment_intents.create(\n    currency="CLP",\n    amount=5990,\n    recipient_account={\n        "holder_id": "111111111",\n        "number": "123123123",\n        "type": "checking_account",\n        "institution_id": "cl_banco_de_chile",\n    }\n)\n\nprint(payment_intent.id)            # pi_BO381oEATXonG6bj\nprint(payment_intent.widget_token)  # pi_BO381oEATXonG6bj_sec_a4xK32BanKWYn\n```\n\nNotice that the success of this payment intent will be notified through a Webhook. Now, let\'s list every payment intent we have:\n\n```python\nfor payment_intent in fintoc_client.payment_intents.all():\n    print(payment_intent.id)\n```\n\nIf you see a payment intent you want to use, just use the `get` method!\n\n```python\npayment_intent = fintoc_client.payment_intents.get("pi_BO381oEATXonG6bj")\n\nprint(payment_intent.id)      # pi_BO381oEATXonG6bj\nprint(payment_intent.status)  # succeeded\n```\n\n#### The `links` manager\n\nAvailable methods: `all`, `get`, `update`, `delete`.\n\nLinks are probably the most importat resource. Let\'s list them!\n\n```python\nprint(len(fintoc_client.links.all(lazy=False)))  # 3\n\nfor link in fintoc_client.links.all():\n    print(link.id)\n```\n\nLinks are a bit different than the rest of the resources, because their identifier is not really their `id`, but their `link_token`. This means that, in order to `get`, `update` or `delete` a link, you need to pass the `link_token`!\n\n```python\nlink = fintoc_client.links.get("link_Y75EXAKiIVj7w489_token_NCqjwRVoTX3cmnx8pnbpqd11")\n```\n\nNotice that the Link objects generated from the `all` method will won\'t be able to execute `update` or `delete` operations, while any Link object generated from `get` or `update` will have permission to `update` or `delete` (given that the link token is necessary to `get` or `update` in the first place).\n\nThe Link resource has a lot of **managers**!\n\n```python\ninvoices = link.invoices.all()  # Invoices\ntax_returns = link.tax_returns.all()  # Tax Returns\nsubscriptions = link.subscriptions.all()  # Subscriptions\nrefresh_intents = link.refresh_intents.all()  # Refresh Intents\naccounts = link.accounts.all()  # Accounts\n```\n\n#### The `invoices` manager\n\nAvailable methods: `all`.\n\nOnce you have a Link, you can use the `invoices` manager to get all the invoices associated to a link!\n\n```python\nfor invoice in link.invoices.all():\n    print(invoice.id)\n```\n\n#### The `tax_returns` manager\n\nAvailable methods: `all`, `get`.\n\nOnce you have a Link, you can use the `tax_returns` manager to get all the tax returns associated to a link!\n\n```python\nfor tax_return in link.tax_returns.all():\n    print(tax_return.id)\n```\n\n#### The `subscriptions` manager\n\nAvailable methods: `all`, `get`.\n\nOnce you have a Link, you can use the `subscriptions` manager to get all the subscriptions associated to a link!\n\n```python\nfor subscription in link.subscriptions.all():\n    print(subscription.id)\n```\n\n#### The `refresh_intents` manager\n\nAvailable methods: `all`, `get`, `create`.\n\nRefresh intents allow you to control how an account gets refreshed on Fintoc! Once you have a Link, you can use the `refresh_intents` manager to create a new refresh intent:\n\n```python\nrefresh_intent = link.refresh_intents.create()\n\nprint(refresh_intent.id)  # ri_5A94DVCJ7xNM3MEo\n```\n\nNotice that the success of this refresh intent will be notified through a Webhook. Now, let\'s list every refresh intent we have:\n\n```python\nfor refresh_intent in link.refresh_intents.all():\n    print(refresh_intent.id)\n```\n\nIf you see a refresh intent you want to use, just use the `get` method!\n\n```python\nrefresh_intent = link.refresh_intents.get("ri_5A94DVCJ7xNM3MEo")\n\nprint(refresh_intent.id)      # ri_5A94DVCJ7xNM3MEo\nprint(refresh_intent.status)  # succeeded\n```\n\n#### The `accounts` manager\n\nAvailable methods: `all`, `get`.\n\nOnce you have a Link, you can use the `accounts` manager to get all the accounts associated to a link!\n\n```python\nfor account in link.accounts.all():\n    print(account.id)\n```\n\nNotice that accounts also have a `movements` manager, to get all of the movements of an account:\n\n```python\naccount = link.accounts.all(lazy=False)[0]\n\nmovements = account.movements.all(lazy=False)\n```\n\n#### The `movements` manager\n\nAvailable methods: `all`, `get`.\n\nOnce you have an Account, you can use the `movements` manager to get all the movements associated to that account!\n\n```python\nfor movement in account.movements.all():\n    print(movement.id)\n```\n\n### Serialization\n\nAny resource of the SDK can be serialized! To get the serialized resource, just call the `serialize` method!\n\n```python\naccount = link.accounts.all(lazy=False)[0]\n\nserialization = account.serialize()\n```\n\nThe serialization corresponds to a dictionary with only simple types, that can be JSON-serialized.\n\n## Acknowledgements\n\nThe first version of this SDK was originally designed and handcrafted by [**@nebil**](https://github.com/nebil),\n[ad](https://en.wikipedia.org/wiki/Ad_honorem) [piscolem](https://en.wiktionary.org/wiki/piscola).\nHe built it with the help of Gianni Roberto’s [Picchi 2](https://www.youtube.com/watch?v=WqjUlmkYr2g).\n',
-    'author': 'Daniel Leal',
-    'author_email': 'daniel@fintoc.com',
-    'maintainer': 'Daniel Leal',
-    'maintainer_email': 'daniel@fintoc.com',
-    'url': 'https://fintoc.com/',
-    'packages': packages,
-    'package_data': package_data,
-    'install_requires': install_requires,
-    'python_requires': '>=3.6,<4.0',
-}
-
-
-setup(**setup_kwargs)