Merge pull request #4 from jssuzanne/endpoint_exports

Endpoint exports

Author: olance

.gitignore

@@ -20,6 +20,7 @@ parts/
 sdist/
 var/
 wheels/
+pip-wheel-metadata/
 *.egg-info/
 .installed.cfg
 *.egg

alma/client.py

@@ -65,3 +65,7 @@ def merchants(self) -> endpoints.Merchants:
     @property
     def orders(self) -> endpoints.Orders:
         return self._endpoint("Orders")
+
+    @property
+    def exports(self) -> endpoints.Exports:
+        return self._endpoint("Exports")

alma/endpoints/__init__.py

@@ -3,4 +3,5 @@
 from .base import Base
 from .merchants import Merchants
 from .orders import Orders
-from .payments import Payments
+from .exports import Exports
+from .payments import Payments

alma/endpoints/exports.py

@@ -0,0 +1,48 @@
+from functools import partial
+from datetime import datetime
+from io import BytesIO
+
+from . import Base
+from ..entities import Export, ExportType, ExportFormat
+from ..paginated_results import PaginatedResults
+
+
+class Exports(Base):
+    EXPORTS_PATH = "/v1/data-exports"
+
+    def create(self, export_type: ExportType, payout_id: str = None,
+               start: datetime = None, end: datetime = None):
+        """ Create a new export"""
+        data = {"type": export_type.value}
+        if payout_id:
+            data['payout'] = payout_id
+
+        if start:
+            data['start'] = int(start.timestamp())
+
+        if end:
+            data['end'] = int(end.timestamp())
+
+        response = self.request(self.EXPORTS_PATH).set_body(data).post()
+        return Export(response.json)
+
+    def get_file(self, export_id: str, export_format: ExportFormat = None):
+        request = self.request(f"{self.EXPORTS_PATH}/{export_id}")
+        if export_format:
+            request.set_query_params({"format": export_format.value})
+
+        response = request.get()
+        return BytesIO(response.resp.content)
+
+    def fetch_all(self, limit: int = 5, **filters):
+        args = {"limit": limit, **filters}
+        response = self.request(self.EXPORTS_PATH).set_query_params(args).get()
+        next_page = partial(self.fetch_all, limit=limit, **filters)
+        return PaginatedResults(response.json, Export, next_page)
+
+    def fetch(self, export_id: str = None, limit: int = 5, **filters):
+        if export_id is None:
+            return self.fetch_all(limit=limit, **filters)
+        else:
+            response = self.request(f"{self.EXPORTS_PATH}/{export_id}").get()
+            return Export(response.json)

alma/entities/__init__.py

@@ -7,3 +7,4 @@
 from .order import Order
 from .payment import Payment, PaymentFraudType, PaymentState
 from .refund import Refund
+from .export import Export, ExportType, ExportFormat

alma/entities/export.py

@@ -0,0 +1,19 @@
+from enum import Enum
+
+from . import Base
+
+
+class ExportType(Enum):
+    PAYMENTS = "payments"
+    ACCOUNTING = "accounting"
+    ACCOUNTING_FOR_PAYOUT = "accounting_for_payout"
+
+
+class ExportFormat(Enum):
+    CSV = "csv"
+    PDF = "pdf"
+    XLSX = "xlsx"
+
+
+class Export(Base):
+    pass