Migration to v2 factutrapi

.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

@@ -10,6 +10,7 @@
 from pydantic import BaseModel
 from pydantic.dataclasses import dataclass
 
+from ..types.enums import TaxSystemType
 from ..types.general import CustomerAddress
 from .base import Creatable, Queryable, Retrievable, Updatable
 
@@ -30,9 +31,10 @@ class CustomerRequest(BaseModel):
 
     legal_name: str
     tax_id: str
+    tax_system: TaxSystemType
     email: str
     phone: Optional[str]
-    address: Optional[CustomerAddress]
+    address: CustomerAddress
 
 
 class CustomerUpdateRequest(BaseModel):
@@ -51,6 +53,7 @@ class CustomerUpdateRequest(BaseModel):
 
     legal_name: Optional[str]
     tax_id: Optional[str]
+    tax_system: Optional[TaxSystemType]
     email: Optional[str]
     phone: Optional[str]
     address: Optional[CustomerAddress]
@@ -72,8 +75,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 (TaxSystemType): Enum from catalogue of SAT
         phone (str): Phone of the customer. Defaults to `None`.
-
     """
 
     _resource: ClassVar = 'customers'
@@ -83,7 +86,8 @@ class Customer(Creatable, Queryable, Retrievable, Updatable):
     legal_name: str
     tax_id: str
     email: str
-    address: Optional[CustomerAddress]
+    address: CustomerAddress
+    tax_system: Optional[TaxSystemType] = 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

@@ -92,3 +92,32 @@ class PaymentMethod(str, Enum):
 
     contado = 'PUE'
     parcialidades = 'PPD'
+
+
+class TaxSystemType(str, Enum):
+    """Regimen fiscal from SAT catalogue."""
+
+    GRL_PM = "601"  # General de Ley Personas Morales
+    PM_FN = "603"  # Personas Morales con Fines no Lucrativos
+    SAL_IS = "605"  # Sueldos y Salarios e Ingresos Asimilados a Salarios
+    ARR = "606"  # Arrendamiento
+    DEM_ING = "608"  # Demás ingresos
+    CONS = "609"  # Consolidación
+    RES_EXT = "610"  # Residentes en el Extranjero sin Establecimiento Permanente en México # noqa: E501
+    DIV = "611"  # Ingresos por Dividendos (socios y accionistas)
+    PF_AEP = "612"  # Personas Físicas con Actividades Empresariales y Profesionales # noqa: E501
+    INT = "614"  # Ingresos por intereses
+    SIN_OBL = "616"  # Sin obligaciones fiscales
+    SCP_DIF = "620"  # Sociedades Cooperativas de Producción que optan por diferir sus ingresos # noqa: E501
+    INC_FISC = "621"  # Incorporación Fiscal
+    AGRO_GAN_SILV_PES = "622"  # Actividades Agrícolas, Ganaderas, Silvícolas y Pesqueras # noqa: E501
+
+    OP_GRUPO_SOC = "623"  # Opcional para Grupos de Sociedades
+    COOR = "624"  # Coordinados
+    HID = "628"  # Hidrocarburos
+    ENAJ_ADQ = "607"  # Régimen de Enajenación o Adquisición de Bienes
+    PREF_EM_MULT = "629"  # De los Regímenes Fiscales Preferentes y de las Empresas Multinacionales # noqa: E501
+    ENAJ_ACC_BOL = "630"  # Enajenación de acciones en bolsa de valores
+    ING_PREM = "615"  # Régimen de los ingresos por obtención de premios
+    AE_PLAT_TEC = "625"  # Régimen de las Actividades Empresariales con ingresos a través de Plataformas Tecnológicas # noqa: E501
+    RS_CONF = "626"  # Régimen Simplificado de Confianza

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.dev1'  # 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

tests/http/cassettes/test_invalid_auth.yaml

@@ -15,7 +15,7 @@ interactions:
       User-Agent:
       - facturapi-python/0.0.1
     method: GET
-    uri: https://www.facturapi.io/v1/invoices
+    uri: https://www.facturapi.io/v2/invoices
   response:
     body:
       string: '{"message":"Not authenticated","ok":false}'