Merge pull request #114 from allanstone/send-email

felipao-mx · web-flow · commit 70ba906db0e9 · 2025-04-21T20:59:42.000-06:00
Add send-by-email method
diff --git a/facturapi/resources/invoices.py b/facturapi/resources/invoices.py
@@ -11,6 +11,7 @@ class to create the resource and a class to represent an
 from pydantic import BaseModel
 from pydantic.dataclasses import dataclass
 
+from ..http import client
 from ..types import InvoiceRelation, InvoiceUse, PaymentForm, PaymentMethod
 from ..types.general import (
     CustomerBasicInfo,
@@ -191,6 +192,38 @@ def cancel(cls, invoice_id: str, motive: str) -> 'Invoice':
         """
         return cast('Invoice', cls._delete(invoice_id, **dict(motive=motive)))
 
+    @classmethod
+    def send_by_email(
+        cls,
+        invoice_id: str,
+        recipients: Optional[Union[str, List[str]]] = None,
+    ) -> bool:
+        """Send an invoice by email.
+
+        Sends an email to the customer's email address with the XML and PDF
+        files attached.
+
+        Args:
+            invoice_id: The ID of the invoice to send.
+            recipients: The email addresses to send the invoice to.
+                   If not provided, the invoice will be sent to the customer's
+                   registered email.
+
+        Returns:
+            bool: True if the email was sent successfully, False otherwise.
+
+        Raises:
+            FacturapiResponseException: If the invoice_id is not found.
+            requests.RequestException: If the API request fails.
+        """
+
+        endpoint = f"{cls._resource}/{invoice_id}/email"
+        payload = {}
+        if recipients:
+            payload["email"] = recipients
+        response = client.post(endpoint, payload)
+        return response.get("ok", False)
+
     @property
     def customer(self) -> Customer:
         """Fetch and access Customer resource.
diff --git a/facturapi/version.py b/facturapi/version.py
@@ -1,2 +1,2 @@
-__version__ = '0.1.1'  # pragma: no cover
+__version__ = '0.2.0'  # pragma: no cover
 CLIENT_VERSION = __version__
diff --git a/tests/resources/cassettes/test_send_invoice_by_email_false.yaml b/tests/resources/cassettes/test_send_invoice_by_email_false.yaml
@@ -0,0 +1,70 @@
+interactions:
+  - request:
+      body: "{}"
+      headers:
+        Accept:
+          - "*/*"
+        Accept-Encoding:
+          - gzip, deflate
+        Authorization:
+          - DUMMY
+        Connection:
+          - keep-alive
+        Content-Length:
+          - "30"
+        Content-Type:
+          - application/json
+        User-Agent:
+          - facturapi-python/0.1.2.dev0
+      method: POST
+      uri: https://www.facturapi.io/v2/invoices/INVOICE01/email
+    response:
+      body:
+        string: '{"ok":false}'
+      headers:
+        Content-Length:
+          - "11"
+        access-control-allow-origin:
+          - "*"
+        content-security-policy:
+          - "default-src 'self';font-src https:;img-src data: https:;script-src 'unsafe-inline'
+            https:;style-src https: 'unsafe-inline';object-src 'none';connect-src
+            https:;frame-src self *.stripe.com *.facebook.com;upgrade-insecure-requests"
+        content-type:
+          - application/json; charset=utf-8
+        cross-origin-opener-policy:
+          - same-origin-allow-popups
+        cross-origin-resource-policy:
+          - same-site
+        date:
+          - Thu, 27 Mar 2025 19:45:43 GMT
+        etag:
+          - W/"b-Ai2R8hgEarLmHKwesT1qcY913ys"
+        origin-agent-cluster:
+          - ?1
+        referrer-policy:
+          - no-referrer
+        server:
+          - Google Frontend
+        strict-transport-security:
+          - max-age=15552000; includeSubDomains
+        x-cloud-trace-context:
+          - a37cf4f44f040b2436c140d1010f163d
+        x-content-type-options:
+          - nosniff
+        x-dns-prefetch-control:
+          - "off"
+        x-download-options:
+          - noopen
+        x-facturapi-log-id:
+          - 67e5aae72f593170271effbc
+        x-frame-options:
+          - SAMEORIGIN
+        x-permitted-cross-domain-policies:
+          - none
+        x-xss-protection:
+          - "0"
+      status:
+        code: 200
+        message: OK
+version: 1
diff --git a/tests/resources/cassettes/test_send_invoice_by_email_invoice_not_found.yaml b/tests/resources/cassettes/test_send_invoice_by_email_invoice_not_found.yaml
@@ -0,0 +1,77 @@
+interactions:
+- request:
+    body: '{}'
+    headers:
+      Accept:
+      - '*/*'
+      Accept-Encoding:
+      - gzip, deflate
+      Authorization:
+      - DUMMY
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '2'
+      Content-Type:
+      - application/json
+      User-Agent:
+      - facturapi-python/0.2.0
+    method: POST
+    uri: https://www.facturapi.io/v2/invoices/INVOICE_NOT_FOUND/email
+  response:
+    body:
+      string: '{"message":"Invoice with Id \"INVOICE_NOT_FOUND\" was not found or
+        you don''t have the right permissions","ok":false}'
+    headers:
+      Content-Length:
+      - '116'
+      access-control-allow-origin:
+      - '*'
+      content-security-policy:
+      - 'default-src ''self'' https://accounts.google.com/gsi/* https://*.stripe.com;font-src
+        https:;img-src data: https: https://*.stripe.com;script-src ''unsafe-inline''
+        https: https://accounts.google.com/gsi/client https://builder.io https://builder.io/*;style-src
+        https: ''unsafe-inline'' https://accounts.google.com/gsi/style;base-uri ''self'';object-src
+        ''none'';connect-src https: https://accounts.google.com/gsi/* https://*.stripe.com;frame-src
+        ''self'' *.stripe.com *.facebook.com https://accounts.google.com/ https://accounts.google.com/gsi/
+        https://accounts.google.com/gsi/* https://builder.io https://builder.io/*;frame-ancestors
+        ''self'' https://builder.io https://builder.io/*;upgrade-insecure-requests;form-action
+        ''self'';script-src-attr ''none'''
+      content-type:
+      - application/json; charset=utf-8
+      cross-origin-opener-policy:
+      - same-origin-allow-popups
+      cross-origin-resource-policy:
+      - same-site
+      date:
+      - Fri, 04 Apr 2025 02:59:28 GMT
+      etag:
+      - W/"74-9U2JIE0F589sz9k6Zf4ELoiLoa4"
+      origin-agent-cluster:
+      - ?1
+      referrer-policy:
+      - no-referrer
+      server:
+      - Google Frontend
+      strict-transport-security:
+      - max-age=15552000; includeSubDomains
+      x-cloud-trace-context:
+      - 34e5c1b94a06826421ee52ae05c02139/10885945258051611867;o=1
+      x-content-type-options:
+      - nosniff
+      x-dns-prefetch-control:
+      - 'off'
+      x-download-options:
+      - noopen
+      x-facturapi-log-id:
+      - 67ef4b105eb1f5f4a053ae9f
+      x-frame-options:
+      - SAMEORIGIN
+      x-permitted-cross-domain-policies:
+      - none
+      x-xss-protection:
+      - '0'
+    status:
+      code: 400
+      message: Bad Request
+version: 1
diff --git a/tests/resources/cassettes/test_send_invoice_by_email_with_email.yaml b/tests/resources/cassettes/test_send_invoice_by_email_with_email.yaml
@@ -0,0 +1,70 @@
+interactions:
+  - request:
+      body: '{"email": "frida_kahlo@test.com"}'
+      headers:
+        Accept:
+          - "*/*"
+        Accept-Encoding:
+          - gzip, deflate
+        Authorization:
+          - DUMMY
+        Connection:
+          - keep-alive
+        Content-Length:
+          - "30"
+        Content-Type:
+          - application/json
+        User-Agent:
+          - facturapi-python/0.1.2.dev0
+      method: POST
+      uri: https://www.facturapi.io/v2/invoices/67e59a55f4f823d3d978f3cb/email
+    response:
+      body:
+        string: '{"ok":true}'
+      headers:
+        Content-Length:
+          - "11"
+        access-control-allow-origin:
+          - "*"
+        content-security-policy:
+          - "default-src 'self';font-src https:;img-src data: https:;script-src 'unsafe-inline'
+            https:;style-src https: 'unsafe-inline';object-src 'none';connect-src
+            https:;frame-src self *.stripe.com *.facebook.com;upgrade-insecure-requests"
+        content-type:
+          - application/json; charset=utf-8
+        cross-origin-opener-policy:
+          - same-origin-allow-popups
+        cross-origin-resource-policy:
+          - same-site
+        date:
+          - Thu, 27 Mar 2025 19:45:43 GMT
+        etag:
+          - W/"b-Ai2R8hgEarLmHKwesT1qcY913ys"
+        origin-agent-cluster:
+          - ?1
+        referrer-policy:
+          - no-referrer
+        server:
+          - Google Frontend
+        strict-transport-security:
+          - max-age=15552000; includeSubDomains
+        x-cloud-trace-context:
+          - a37cf4f44f040b2436c140d1010f163d
+        x-content-type-options:
+          - nosniff
+        x-dns-prefetch-control:
+          - "off"
+        x-download-options:
+          - noopen
+        x-facturapi-log-id:
+          - 67e5aae72f593170271effbc
+        x-frame-options:
+          - SAMEORIGIN
+        x-permitted-cross-domain-policies:
+          - none
+        x-xss-protection:
+          - "0"
+      status:
+        code: 200
+        message: OK
+version: 1
diff --git a/tests/resources/cassettes/test_send_invoice_by_email_without_email.yaml b/tests/resources/cassettes/test_send_invoice_by_email_without_email.yaml
@@ -0,0 +1,70 @@
+interactions:
+  - request:
+      body: "{}"
+      headers:
+        Accept:
+          - "*/*"
+        Accept-Encoding:
+          - gzip, deflate
+        Authorization:
+          - DUMMY
+        Connection:
+          - keep-alive
+        Content-Length:
+          - "30"
+        Content-Type:
+          - application/json
+        User-Agent:
+          - facturapi-python/0.1.2.dev0
+      method: POST
+      uri: https://www.facturapi.io/v2/invoices/67e59a55f4f823d3d978f3cb/email
+    response:
+      body:
+        string: '{"ok":true}'
+      headers:
+        Content-Length:
+          - "11"
+        access-control-allow-origin:
+          - "*"
+        content-security-policy:
+          - "default-src 'self';font-src https:;img-src data: https:;script-src 'unsafe-inline'
+            https:;style-src https: 'unsafe-inline';object-src 'none';connect-src
+            https:;frame-src self *.stripe.com *.facebook.com;upgrade-insecure-requests"
+        content-type:
+          - application/json; charset=utf-8
+        cross-origin-opener-policy:
+          - same-origin-allow-popups
+        cross-origin-resource-policy:
+          - same-site
+        date:
+          - Thu, 27 Mar 2025 19:45:43 GMT
+        etag:
+          - W/"b-Ai2R8hgEarLmHKwesT1qcY913ys"
+        origin-agent-cluster:
+          - ?1
+        referrer-policy:
+          - no-referrer
+        server:
+          - Google Frontend
+        strict-transport-security:
+          - max-age=15552000; includeSubDomains
+        x-cloud-trace-context:
+          - a37cf4f44f040b2436c140d1010f163d
+        x-content-type-options:
+          - nosniff
+        x-dns-prefetch-control:
+          - "off"
+        x-download-options:
+          - noopen
+        x-facturapi-log-id:
+          - 67e5aae72f593170271effbc
+        x-frame-options:
+          - SAMEORIGIN
+        x-permitted-cross-domain-policies:
+          - none
+        x-xss-protection:
+          - "0"
+      status:
+        code: 200
+        message: OK
+version: 1
diff --git a/tests/resources/test_invoices.py b/tests/resources/test_invoices.py
@@ -4,7 +4,11 @@
 from facturapi.resources.customers import CustomerRequest
 from facturapi.resources.invoices import InvoiceRequest
 from facturapi.types import FileType, PaymentForm
-from facturapi.types.exc import MultipleResultsFound, NoResultFound
+from facturapi.types.exc import (
+    FacturapiResponseException,
+    MultipleResultsFound,
+    NoResultFound,
+)
 from facturapi.types.general import CustomerAddress, ItemPart
 
 
@@ -104,6 +108,40 @@ def test_cancel_invoice():
     assert invoice.cancellation_status == 'accepted'
 
 
+@pytest.mark.vcr
+def test_send_invoice_by_email_without_email():
+    invoice_id = "67e59a55f4f823d3d978f3cb"
+    email_sent = facturapi.Invoice.send_by_email(invoice_id=invoice_id)
+    assert email_sent
+
+
+@pytest.mark.vcr
+def test_send_invoice_by_email_with_email():
+    invoice_id = "67e59a55f4f823d3d978f3cb"
+    email = "frida_kahlo@test.com"
+    recipients = [email]
+    email_sent = facturapi.Invoice.send_by_email(
+        invoice_id=invoice_id, recipients=recipients
+    )
+    assert email_sent
+
+
+@pytest.mark.vcr
+def test_send_invoice_by_email_false():
+    invoice_id = "INVOICE01"
+    email_sent = facturapi.Invoice.send_by_email(invoice_id=invoice_id)
+    assert not email_sent
+
+
+@pytest.mark.vcr
+def test_send_invoice_by_email_invoice_not_found():
+    invoice_id = "INVOICE_NOT_FOUND"
+    with pytest.raises(FacturapiResponseException) as exc_info:
+        facturapi.Invoice.send_by_email(invoice_id=invoice_id)
+    exc_str = str(exc_info.value)
+    assert f'Invoice with Id "{invoice_id}" was not found' in exc_str
+
+
 @pytest.mark.vcr
 def test_download_invoice():
     invoice_id = 'INVOICE01'

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`		`-__version__ = '0.1.1' # pragma: no cover`
	`1`	`+__version__ = '0.2.0' # pragma: no cover`
`2`	`2`	`CLIENT_VERSION = __version__`