add related documents

Author: felipao-mx

.github/workflows/test.yml

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

facturapi/resources/invoices.py

@@ -17,6 +17,7 @@ class to create the resource and a class to represent an
     ItemPart,
     Namespace,
     ProductBasicInfo,
+    RelatedDocument,
 )
 from ..types.queries import InvoiceQuery
 from .base import Creatable, Deletable, Downloadable, Queryable, Retrievable
@@ -101,8 +102,7 @@ class InvoiceRequest(BaseModel):
     exchange: Optional[float] = 1.0
     conditions: Optional[str]
     foreign_trade: Optional[Dict]
-    related: Optional[List[str]]
-    relation: Optional[InvoiceRelation]
+    related_documents: Optional[List[RelatedDocument]]
     pdf_custom_section: Optional[str]
     addenda: Optional[str]
     namespaces: Optional[Namespace]
@@ -182,7 +182,9 @@ def create(cls, data: InvoiceRequest) -> 'Invoice':
         return cast('Invoice', cls._create(**cleaned_data))
 
     @classmethod
-    def cancel(cls, invoice_id: str, motive: str, substitution: Optional[str] = None) -> 'Invoice':
+    def cancel(
+        cls, invoice_id: str, motive: str, substitution: Optional[str] = None
+    ) -> 'Invoice':
         """Cancel an invoice.
 
         Calls a DELETE request on invoice resource.

facturapi/types/exc.py

@@ -2,7 +2,8 @@
 from typing import Any, Dict
 
 
-class FacturapiException(Exception): ...
+class FacturapiException(Exception):
+    ...
 
 
 class NoResultFound(FacturapiException):

facturapi/types/general.py

@@ -2,6 +2,7 @@
 
 from pydantic import BaseModel
 
+from ..types.enums import InvoiceRelation
 from .validators import sanitize_dict
 
 
@@ -71,3 +72,8 @@ class SanitizedDict(dict):
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         sanitize_dict(self)
+
+
+class RelatedDocument(BaseModel):
+    relationship: InvoiceRelation
+    documents: List[str] = []

facturapi/version.py

@@ -1,2 +1,2 @@
-__version__ = '0.1.2.dev2'  # pragma: no cover
+__version__ = '0.1.2.dev3'  # pragma: no cover
 CLIENT_VERSION = __version__