Migration to v2 factutrapi (#100)

* migration complete

* linterD

* upgrade python

* python 3.9

* 3.10

* 3.8

* 1

* upgrade pydantic

* bump request

* much better

* enum plus

* fixed

* upgrade version

* bump cv

Author: alexviquez

.github/workflows/test.yml

@@ -20,7 +20,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.6, 3.7, 3.8]
+        python-version: [3.7, 3.8, 3.9, '3.10']
     steps:
     - uses: actions/checkout@v2
     - name: Set up Python ${{ matrix.python-version }}

Makefile

@@ -1,6 +1,6 @@
 SHELL := bash
 PATH := ./venv/bin:${PATH}
-PYTHON = python3.8
+PYTHON = python3.9
 PROJECT = facturapi
 isort = isort $(PROJECT) tests setup.py examples
 black = black -S -l 79 --target-version py38 $(PROJECT) tests setup.py examples

facturapi/http/client.py

@@ -8,7 +8,7 @@
 from ..types.exc import FacturapiResponseException
 from ..version import CLIENT_VERSION
 
-API_HOST = 'www.facturapi.io/v1'
+API_HOST = 'www.facturapi.io/v2'
 
 
 class Client:

facturapi/resources/base.py

@@ -188,20 +188,26 @@ class Deletable(Resource):
 
     """
 
+    _query_params: ClassVar = BaseQuery
+
     @classmethod
-    def _delete(cls, id: str) -> Resource:
+    def _delete(cls, id: str, **query_params) -> Resource:
         """Delete an specific resource.
 
         Performs a DELETE request on the ID.
 
         Args:
             id: The ID of the resource to delete.
+            query_params: Send aditional information over uri
 
         Returns:
             Resource: The deleted resource.
 
         """
-        response = client.delete(f'/{cls._resource}/{id}')
+        q = cls._query_params(**query_params)
+        response = client.delete(
+            f'/{cls._resource}/{id}?{urlencode(q.dict())}'
+        )
         return cls._from_dict(response)
 
 

facturapi/resources/customers.py

@@ -7,6 +7,7 @@
 import datetime as dt
 from typing import ClassVar, Optional, cast
 
+from cuenca_validations.types import SATRegimeCode
 from pydantic import BaseModel
 from pydantic.dataclasses import dataclass
 
@@ -22,6 +23,7 @@ class CustomerRequest(BaseModel):
     Attributes:
         legal_name (str): Full name of the customer.
         tax_id (str): RFC of the customer.
+        tax_system: SATRegimeCode regime code from SAT
         email (str): Email of the customer.
         phone (str): Phone of the customer. Optional.
         address (CustomerAddress): Address object of the customer. Optional.
@@ -30,9 +32,10 @@ class CustomerRequest(BaseModel):
 
     legal_name: str
     tax_id: str
+    tax_system: SATRegimeCode
     email: str
     phone: Optional[str]
-    address: Optional[CustomerAddress]
+    address: CustomerAddress
 
 
 class CustomerUpdateRequest(BaseModel):
@@ -43,6 +46,7 @@ class CustomerUpdateRequest(BaseModel):
     Attributes:
         legal_name (str): Full name of the customer. Optional.
         tax_id (str): RFC of the customer. Optional.
+        tax_system: SATRegimeCode regime code from SAT
         email (str): Email of the customer. Optional.
         phone (str): Phone of the customer. Optional.
         address (CustomerAddress): Address object of the customer. Optional.
@@ -51,6 +55,7 @@ class CustomerUpdateRequest(BaseModel):
 
     legal_name: Optional[str]
     tax_id: Optional[str]
+    tax_system: Optional[SATRegimeCode]
     email: Optional[str]
     phone: Optional[str]
     address: Optional[CustomerAddress]
@@ -72,8 +77,8 @@ class Customer(Creatable, Queryable, Retrievable, Updatable):
         tax_id (str): RFC of the customer.
         email (str): Email of the customer.
         address (CustomerAddress): Address data of the model. Optional.
+        tax_system (SATRegimeCode): Enum from catalogue of SAT
         phone (str): Phone of the customer. Defaults to `None`.
-
     """
 
     _resource: ClassVar = 'customers'
@@ -83,7 +88,8 @@ class Customer(Creatable, Queryable, Retrievable, Updatable):
     legal_name: str
     tax_id: str
     email: str
-    address: Optional[CustomerAddress]
+    address: CustomerAddress
+    tax_system: Optional[SATRegimeCode] = None
     phone: Optional[str] = None
 
     @classmethod

facturapi/resources/invoices.py

@@ -18,6 +18,7 @@ class to create the resource and a class to represent an
     Namespace,
     ProductBasicInfo,
 )
+from ..types.queries import InvoiceQuery
 from .base import Creatable, Deletable, Downloadable, Queryable, Retrievable
 from .customers import Customer, CustomerRequest
 from .resources import retrieve_property
@@ -49,7 +50,7 @@ class InvoiceItem(BaseModel):
     product: Union[
         str, ProductBasicInfo, Dict
     ]  # TO DO: Change Dict for ProductRequest
-    custom_keys: Optional[List[str]]
+    customs_keys: Optional[List[str]]
     complement: Optional[str]
     parts: Optional[List[ItemPart]]
     property_tax_account: Optional[str]
@@ -142,6 +143,7 @@ class Invoice(Creatable, Deletable, Downloadable, Queryable, Retrievable):
 
     _resource: ClassVar = 'invoices'
     _relations: ClassVar = ['customer']
+    _query_params = InvoiceQuery
 
     created_at: dt.datetime
     livemode: bool
@@ -175,7 +177,7 @@ def create(cls, data: InvoiceRequest) -> 'Invoice':
         return cast('Invoice', cls._create(**cleaned_data))
 
     @classmethod
-    def cancel(cls, invoice_id: str) -> 'Invoice':
+    def cancel(cls, invoice_id: str, motive: str) -> 'Invoice':
         """Cancel an invoice.
 
         Calls a DELETE request on invoice resource.
@@ -187,7 +189,7 @@ def cancel(cls, invoice_id: str) -> 'Invoice':
             Invoice: The cancelled invoice resource.
 
         """
-        return cast('Invoice', cls._delete(invoice_id))
+        return cast('Invoice', cls._delete(invoice_id, **dict(motive=motive)))
 
     @property
     def customer(self) -> Customer:

facturapi/types/enums.py

@@ -57,7 +57,9 @@ class InvoiceUse(str, Enum):
     gastos_transportacion_escolar = 'D08'
     cuentas_ahorro_pensiones = 'D09'
     servicios_educativos = 'D10'
-    por_definir = 'P01'
+    sin_efectos_fiscales = 'S01'
+    pagos = 'CP01'
+    nomina = 'CN01'
 
 
 class PaymentForm(str, Enum):

facturapi/types/queries.py

@@ -71,3 +71,7 @@ def dict(self, *args, **kwargs) -> Dict[str, Any]:
         kwargs.setdefault('exclude_unset', True)
         d = super().dict(*args, **kwargs)
         return d
+
+
+class InvoiceQuery(BaseQuery):
+    motive: Optional[str]

facturapi/version.py

@@ -1,2 +1,2 @@
-__version__ = '0.0.2'  # pragma: no cover
+__version__ = '0.0.3'  # pragma: no cover
 CLIENT_VERSION = __version__

requirements-test.txt

@@ -1,7 +1,7 @@
 pytest==6.2.*
 pytest-cov==3.0.*
 pytest-vcr==1.0.*
-black==21.9b0
+black==22.3.0
 isort==5.7.*
 flake8==3.8.*
 mypy==0.812