Merge pull request #20 from LeandroDeJesus-S/feature/improve-models

Feature/improve models

Author: JoaquimCassano

README-pt.md

@@ -45,7 +45,7 @@ Para usar o SDK, importe-o e inicialize o cliente com sua chave de API:
 ```python
 import abacatepay
 
-client = abacatepay.AbacatePay(api_key="<your-api-key>")
+client = abacatepay.AbacatePay("<your-api-key>")
 ```
 
 ---
@@ -57,22 +57,28 @@ client = abacatepay.AbacatePay(api_key="<your-api-key>")
 ```python
 from abacatepay.products import Product
 
-client = abacatepay.AbacatePay(api_key="<your-api-key>")
-
 products = [
     Product(
-        externalId="123",
+        external_id="123",
         name="Test Product",
         quantity=1,
         price=5000,
         description="Example product"
-    )
+    ),
+    # ou como um dicionário
+    {
+        'external_id': "321",
+        'name': "Product as dict",
+        'quantity': 1,
+        'price': 10_00,
+        'description': "Example using dict"
+    }
 ]
 
 billing = client.billing.create(
     products=products,
-    returnURL="https://yourwebsite.com/return",
-    completionUrl="https://yourwebsite.com/complete"
+    return_url="https://yourwebsite.com/return",
+    completion_url="https://yourwebsite.com/complete"
 )
 
 print(billing.data.url)
@@ -84,20 +90,23 @@ print(billing.data.url)
 billings = client.billing.list()
 for billing in billings:
     print(billing.id, billing.status)
+
+print(len(billings))
 ```
 
 ### Gerenciamento de clientes
 
 ```python
-from abacatepay.customers import Customer
+from abacatepay.customers import CustomerMetadata
 
-customer = Customer(
+customer = CustomerMetadata(  # Também pode ser apenas um dicionário
     email="customer@example.com",
     name="Customer Name",
-    cellphone="+1234567890"
+    cellphone="(12) 3456-7890",
+    tax_id="123-456-789-10"
 )
 
-created_customer = client.customers.create(customer=customer)
+created_customer = client.customers.create(customer)
 print(created_customer.id)
 ```
 

README.md

@@ -46,7 +46,7 @@ To use the SDK, import it and initialize the client with your API key:
 ```python
 import abacatepay
 
-client = abacatepay.AbacatePay(api_key="<your-api-key>")
+client = abacatepay.AbacatePay("<your-api-key>")
 ```
 
 ---
@@ -58,22 +58,29 @@ client = abacatepay.AbacatePay(api_key="<your-api-key>")
 ```python
 from abacatepay.products import Product
 
-client = abacatepay.AbacatePay(api_key="<your-api-key>")
 
 products = [
     Product(
-        externalId="123",
+        external_id="123",
         name="Test Product",
         quantity=1,
-        price=5000,
+        price=50_00,
         description="Example product"
-    )
+    ),
+    # or as dict
+    {
+        'external_id': "321",
+        'name': "Product as dict",
+        'quantity': 1,
+        'price': 10_00,
+        'description': "Example using dict"
+    }
 ]
 
 billing = client.billing.create(
     products=products,
-    returnURL="https://yourwebsite.com/return",
-    completionUrl="https://yourwebsite.com/complete"
+    return_url="https://yourwebsite.com/return",
+    completion_url="https://yourwebsite.com/complete"
 )
 
 print(billing.data.url)
@@ -85,20 +92,23 @@ print(billing.data.url)
 billings = client.billing.list()
 for billing in billings:
     print(billing.id, billing.status)
+
+print(len(billings))
 ```
 
 ### Customer Management
 
 ```python
-from abacatepay.customers import Customer
+from abacatepay.customers import CustomerMetadata
 
-customer = Customer(
+customer = CustomerMetadata(  # Its can also be only a dict
     email="customer@example.com",
     name="Customer Name",
-    cellphone="+1234567890"
+    cellphone="(12) 3456-7890",
+    tax_id="123-456-789-10"
 )
 
-created_customer = client.customers.create(customer=customer)
+created_customer = client.customers.create(customer)
 print(created_customer.id)
 ```
 

abacatepay/billings/__init__.py

@@ -1,4 +1,15 @@
 from .client import BillingClient
-from .models import BillingResponse
+from .models import (
+    Billing,
+    BillingList,
+    BillingIn,
+    BillingMetadata,
+)
 
-__all__ = ["BillingClient", "BillingResponse"]
+__all__ = [
+    "BillingClient",
+    "Billing",
+    "BillingList",
+    "BillingIn",
+    "BillingMetadata",
+]

abacatepay/billings/client.py

@@ -1,71 +1,51 @@
-from ..constants import (
-    BASE_URL,
-    BILLING_KINDS,
-    BILLING_METHODS,
-)
-from ..products import Product
-from .models import (
-    BillingResponse,
-    Customer,
-)
-from ..base.client import BaseClient
 from logging import getLogger
+from typing import Optional
+from ..base.client import BaseClient
+from ..constants import BASE_URL
+from .models import Billing, BillingIn, BillingList
+from ..utils.helpers import prepare_data
 
 logger = getLogger(__name__)
 
 
 class BillingClient(BaseClient):
-    def create(
-        self,
-        products: list[Product],
-        returnURL: str,
-        completionUrl: str,
-        methods: list[BILLING_METHODS] = ["PIX"],
-        frequency: BILLING_KINDS = "ONE_TIME",
-        customerId: str | None = None,
-        customer: Customer | None = None
-    ) -> BillingResponse:
-
-
+    def create(self, data: Optional[BillingIn | dict] = None, **kwargs) -> Billing:
         """
         Create a new billing.
 
         Args:
-            products: List of products to be billed.
-            returnURL: The URL the user will be redirected to after the billing is completed.
-            completionUrl: The URL the API will make a POST request after the billing is completed.
-            methods: The payment methods to be accepted. Defaults to ["PIX"].
-            frequency: The frequency of the billing. Defaults to "ONE_TIME".
-            customerId: The ID of the customer. If provided, the customer information won't be required.
-            customer: The customer information. If customerId is provided, this parameter is ignored.
+            data (BillingIn): an instance of `abacatepay.billings.models.BillingIn` a dict \
+            or the named params following the model schema.
+        
+        Keyword args:
+            products (List[Product]): List of products to be billed.
+            returnURL (str): The URL the user will be redirected to after the billing is completed.
+            completionUrl (str): The URL the API will make a POST request after the billing is completed.
+            methods (List[BILLING_METHODS]): The payment methods to be accepted. Defaults to ["PIX"].
+            frequency (BILLING_KINDS): The frequency of the billing. Defaults to "ONE_TIME".
+            customerId (str): The ID of the customer. If provided, the customer information won't be required.
+            customer (CustomerMetadata): The customer information. If customerId is provided, this parameter is ignored.
 
         Returns:
-            BillingResponse: The response with the billing data.
+            Billing: The response with the billing data.
         """
+        json_data = prepare_data(data or kwargs, BillingIn)
+        logger.debug('creating billing: %s', json_data)
+
         response = self._request(
             f"{BASE_URL}/billing/create",
             method="POST",
-            json={
-                "products": [product.model_dump() for product in products],
-                "returnUrl": returnURL,
-                "completionUrl": completionUrl,
-                "methods": methods,
-                "frequency": frequency,
-                "customerId": customerId,
-                **({"customer": customer.model_dump()} if customer is not None else {}),
-            }
+            json=json_data,
         )
+        return Billing(**response.json()["data"])
 
-        billing_data = BillingResponse(data=response.json()["data"])
-        return billing_data
-
-    def list(self) -> list[BillingResponse]:
+    def list(self) -> BillingList:
         """
         List all bills.
 
         Returns:
-            list[BillingResponse]: A list of billing responses.
+            BillingList: A list of billing objects.
         """
         logger.debug(f"Listing bills with URL: {BASE_URL}/billing/list")
         response = self._request(f"{BASE_URL}/billing/list", method="GET")
-        return [BillingResponse(data=bill) for bill in response.json()["data"]]
+        return BillingList.model_validate({'data': response.json()["data"]})