Metadata-Version: 2.1
Name: cuenca
Version: 0.0.2.dev0
Summary: Cuenca API Client
Home-page: https://github.com/cuenca-mx/cuenca-python
Author: Cuenca
Author-email: dev@cuenca.com
License: UNKNOWN
Description: # Cuenca – Python client library
        
        ## Transfers
        
        ### Create transfer
        
        ```python
        import cuenca
        
        cuenca.configure(sandbox=True)  # if using sandbox
        
        transfer = cuenca.Transfer.create(
            recipient_name='Benito Juárez',
            account_number='646180157042875763',
            amount=12345,  # Mx$123.45
            descriptor='sending money',  # As it'll appear for the customer
            idempotency_key='unique string',
        )
        
        # To get updated status (estado)
        transfer.refresh()
        ```
        
        
        ### Retrieve by `id`
        
        ```python
        import cuenca
        
        transfer = cuenca.Transfer.retrieve('tr_123')
        ```
        
        ### Query by `idempotency_key`, `account_number` and `status`
        
        Results are always returned in descending order of `created_at`
        
        The methods that can be used:
        - `one()` - returns a single result. Raises `NoResultFound` if there are no
        results and `MultipleResultsFound` if there are more than one
        - `first()` - returns the first result or `None` if there aren't any
        - `all()` - returns a generator of all matching results. Pagination is handled
        automatically as you iterate over the response
        - `count()` - returns an integer with the count of the matching results
        
        ```python
        import cuenca
        from cuenca.types import Status
        
        # find the unique transfer using the idempotency key
        transfer = cuenca.Transfer.one(idempotency_key='unique string')
        
        # returns a generator of all succeeded transfers to the specific account
        transfers = cuenca.Transfer.all(
            account_number='646180157000000004',
            status=Status.succeeded
        )
        
        # the total number of succeeded transfers
        count = cuenca.Transfer.count(status=Status.succeeded)
        ```
        
        ## Api Keys
        
        ### Roll the `ApiKey`
        
        ```python
        import cuenca
        
        # create new key and deactive old key in 60 mins
        old_key, new_key = cuenca.ApiKey.roll(60)
        ```
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: test
