Melhoria de importação de módulos

Author: samuel.coelho

README.MD

@@ -15,9 +15,12 @@ pip install santander-python-sdk
 
 ```python
 from decimal import Decimal
-from santander_sdk import SantanderApiClient, SantanderClientConfiguration
-from santander_sdk.pix import transfer_pix_payment, get_transfer
-
+from santander_sdk import (
+  SantanderApiClient,
+  SantanderClientConfiguration
+  SantanderBeneficiary,
+)
+from santander_sdk.pix import transfer_pix, get_transfer
 
 # Setup do client
 client = SantanderApiClient(SantanderClientConfiguration(
@@ -29,7 +32,7 @@ client = SantanderApiClient(SantanderClientConfiguration(
 ))
 
 # Exemplo 1 - PIX para uma chave (Telefone, email, chave aleatória, cpf ou cpnj)
-transfer = transfer_pix_payment(
+transfer = transfer_pix(
     client,
     pix_key="[email protected]",
     value=Decimal(0.99),
@@ -47,7 +50,7 @@ benefiary = SantanderBeneficiary(
     documentNumber="12345678909",
 )
 
-transfer = transfer_pix_payment(
+transfer = transfer_pix(
     client,
     benefiary,
     value=Decimal(0.99),

santander_sdk/__init__.py

@@ -1,6 +1,19 @@
 from santander_sdk.api_client.client import SantanderApiClient
-from santander_sdk.api_client.client_configuration import (
-    SantanderClientConfiguration,
+from santander_sdk.api_client.client_configuration import SantanderClientConfiguration
+from santander_sdk.api_client.helpers import (
+    get_pix_key_type,
+    document_type,
 )
 
-__all__ = ["SantanderApiClient", "SantanderClientConfiguration"]
+from santander_sdk.pix import transfer_pix, get_transfer
+from santander_sdk.types import SantanderBeneficiary
+
+__all__ = [
+    "SantanderApiClient",
+    "SantanderClientConfiguration",
+    "SantanderBeneficiary",
+    "get_pix_key_type",
+    "document_type",
+    "transfer_pix",
+    "get_transfer",
+]

santander_sdk/pix.py

@@ -34,7 +34,7 @@
 MAX_UPDATE_STATUS_ATTEMPTS_TO_CONFIRM = 120
 PIX_CONFIRM_INTERVAL_TIME = 2
 
-def transfer_pix_payment(
+def transfer_pix(
     client: SantanderApiClient,
     pix_key: str | SantanderBeneficiary,
     value: D,

tests/test_pix.py

@@ -15,7 +15,7 @@
     _request_confirm_pix_payment,
     _request_create_pix_payment,
     _request_pix_payment_status,
-    transfer_pix_payment,
+    transfer_pix,
 )
 from mock.santander_mocker import (
     santander_beneciary_john,
@@ -289,7 +289,7 @@ def test_transfer_pix_payment_success(self, mock_sleep):
         pix_key = "12345678909"
         value = D("100.00")
 
-        transfer_result = transfer_pix_payment(
+        transfer_result = transfer_pix(
             self.api_client,
             pix_key,
             value,
@@ -340,20 +340,20 @@ def test_transfer_pix_payment_invalid_value(self, mock_sleep):
         pix_key = "12345678909"
         description = "Pagamento Teste valor inválido"
 
-        transfer_result = transfer_pix_payment(
+        transfer_result = transfer_pix(
             self.api_client, pix_key, D("-21.55"), description
         )
         self.assertFalse(transfer_result["success"])
-        transfer_result = transfer_pix_payment(
+        transfer_result = transfer_pix(
             self.api_client, pix_key, D("0"), description
         )
         self.assertFalse(transfer_result["success"])
-        transfer_result = transfer_pix_payment(
+        transfer_result = transfer_pix(
             self.api_client, pix_key, D("0.00"), description
         )
         self.assertFalse(transfer_result["success"])
         self.assertIn("Valor inválido para transferência PIX", transfer_result["error"])
-        transfer_result = transfer_pix_payment(
+        transfer_result = transfer_pix(
             self.api_client, pix_key, D("21.23"), description
         )
         self.assertFalse(transfer_result["success"])
@@ -362,7 +362,7 @@ def test_transfer_pix_payment_no_pix_id(self):
         self.api_client.post.return_value = get_dict_payment_pix_response(
             "", D("100.00"), OrderStatus.PENDING_VALIDATION
         )
-        response = transfer_pix_payment(
+        response = transfer_pix(
             self.api_client, "12345678909", D("100.00"), "Pagamento Teste"
         )
         self.assertFalse(response["success"])
@@ -379,7 +379,7 @@ def test_transfer_pix_payment_rejected(self):
             pix_key, value, OrderStatus.REJECTED
         )
 
-        response = transfer_pix_payment(
+        response = transfer_pix(
             self.api_client, pix_key, value, "Pagamento Teste"
         )
         self.assertFalse(response["success"])

tests/test_pix_integration.py

@@ -5,7 +5,7 @@
 from santander_sdk.pix import (
     MAX_UPDATE_STATUS_ATTEMPTS,
     MAX_UPDATE_STATUS_ATTEMPTS_TO_CONFIRM,
-    transfer_pix_payment,
+    transfer_pix,
 )
 from mock.santander_mocker import (
     PIX_ENDPOINT_WITH_WORKSPACE,
@@ -44,7 +44,7 @@ def test_transfer_pix_payment_success(mock_api, api_client):
     mock_status = mock_pix_status_endpoint(
         mock_api, pix_id, value, OrderStatus.PAYED, pix_key, "CPF"
     )
-    transfer_result = transfer_pix_payment(
+    transfer_result = transfer_pix(
         api_client, pix_key, value, description, tags=["teste"]
     )
     assert transfer_result == {
@@ -106,7 +106,7 @@ def test_transfer_pix_payment_timeout_create(api_client: SantanderApiClient, moc
     mock_status = mock_pix_status_endpoint(
         mock_api, pix_id, value, OrderStatus.PENDING_VALIDATION, pix_key, "CPF"
     )
-    transfer_result = transfer_pix_payment(api_client, pix_key, value, description)
+    transfer_result = transfer_pix(api_client, pix_key, value, description)
 
     assert transfer_result == {
         "success": False,
@@ -135,7 +135,7 @@ def test_transfer_pix_payment_timeout_before_authorize(
         mock_api, pix_id, value, OrderStatus.PENDING_CONFIRMATION, pix_key, "CPF"
     )
 
-    transfer_result = transfer_pix_payment(api_client, pix_key, value, description)
+    transfer_result = transfer_pix(api_client, pix_key, value, description)
     assert transfer_result == {
         "success": True,
         "data": {
@@ -187,7 +187,7 @@ def test_transfer_pix_payment_rejected_on_create(
         mock_api, pix_id, value, OrderStatus.REJECTED, pix_key, "CPF"
     )
 
-    transfer_result = transfer_pix_payment(api_client, pix_key, value, description)
+    transfer_result = transfer_pix(api_client, pix_key, value, description)
     assert transfer_result == {
         "success": False,
         "error": "Rejeição de pagamento: Santander - Pagamento rejeitado pelo banco na etapa Criação do pagamento PIX - Motivo não retornado pelo Santander",
@@ -214,7 +214,7 @@ def test_transfer_pix_payment_rejected_on_confirm(
         mock_api, pix_id, value, OrderStatus.REJECTED, pix_key, "CPF"
     )
 
-    transfer_result = transfer_pix_payment(api_client, pix_key, value, description)
+    transfer_result = transfer_pix(api_client, pix_key, value, description)
     assert transfer_result == {
         "success": False,
         "error": "Rejeição de pagamento: Santander - Pagamento rejeitado pelo banco na etapa Confirmação do pagamento PIX - Motivo não retornado pelo Santander",
@@ -246,7 +246,7 @@ def test_transfer_pix_payment_with_beneficiary(
         mock_api, pix_id, value, OrderStatus.PAYED, santander_beneciary_john
     )
 
-    transfer_result = transfer_pix_payment(
+    transfer_result = transfer_pix(
         api_client, santander_beneciary_john, value, description
     )
     assert transfer_result == {
@@ -327,7 +327,7 @@ def test_transfer_pix_payment_lazy_status_update(
         ],
     )
 
-    transfer_result = transfer_pix_payment(api_client, pix_key, value, description)
+    transfer_result = transfer_pix(api_client, pix_key, value, description)
     assert transfer_result == {
         "success": True,
         "data": {