version 4.0.149

Author: mendozagit

examples.py

@@ -17,6 +17,46 @@ def main ():
     client = FiscalApiClient(settings=settings)
 
 
+    # listar api-keys
+    # api_response = client.api_keys.get_list(1, 10)
+    # print(api_response)
+    
+    
+    # Obtener api-key por id
+    # api_response = client.api_keys.get_by_id("78145e7d-40d3-4540-b1f8-262adff398a2")
+    # print(api_response)
+    
+    
+    # crear api-key
+    
+    # api_key: ApiKey = ApiKey(
+    #     person_id="7c1d2a85-ae39-44dd-b9f1-54f02b204165",
+    #     description="Api Key de prueba para python"
+    # )
+    # api_response = client.api_keys.create(api_key)
+    # print(api_response)
+    
+    
+    # actualizar api-key
+    # api_key: ApiKey = ApiKey(
+    #     id="78145e7d-40d3-4540-b1f8-262adff398a2",
+    #     description="Revocando por no pagar",
+    #     apiKeyStatus=0
+    # )
+    # api_response = client.api_keys.update(api_key)
+    # print(api_response)
+    
+    
+    # eliminar api-key
+    # api_response = client.api_keys.delete("78145e7d-40d3-4540-b1f8-262adff398a2")
+    # print(api_response)
+    
+    
+    
+    
+    
+    
+    
     # listar productos
     #api_response = client.products.get_list(1, 10)
 

fiscalapi/__init__.py

@@ -35,14 +35,16 @@
     SendInvoiceRequest,
     InvoiceStatusRequest,
     InvoiceStatusResponse,
+    ApiKey,
 )
 
 # Re-exportar servicios
 from .services.catalog_service import CatalogService
 from .services.invoice_service import InvoiceService
 from .services.people_service import PeopleService
 from .services.product_service import ProductService
-from .services.tax_file_servive import TaxFileService   # Asegúrate de que coincida con tu nombre real (tax_file_service o tax_file_servive)
+from .services.tax_file_servive import TaxFileService 
+from .services.api_key_service import ApiKeyService
 
 # Re-exportar la clase FiscalApiClient
 # (asumiendo que la definición está en fiscalapi/services/fiscalapi_client.py)
@@ -79,6 +81,7 @@
     "SendInvoiceRequest",
     "InvoiceStatusRequest",
     "InvoiceStatusResponse",
+    "ApiKey",
 
 
     # Servicios
@@ -87,6 +90,7 @@
     "PeopleService",
     "ProductService",
     "TaxFileService",
+    "ApiKeyService"
 
     # Cliente principal
     "FiscalApiClient",

fiscalapi/models/fiscalapi_models.py

@@ -347,4 +347,22 @@ class InvoiceStatusResponse(BaseDto):
 
     model_config = {
         "populate_by_name": True
-    }
+    }
+    
+
+
+class ApiKey(BaseDto):
+    """Modelo de clave de autenticación en fiscalapi."""
+    
+    id: Optional[str] = Field(default=None, alias="id", description="El identificador único de la API key.")
+    environment: Optional[str] = Field(default=None, alias="environment", description="El entorno al que pertenece la API key.")
+    api_key_value: Optional[str] = Field(default=None, alias="apiKeyValue", description="El API key. Este valor es el que se utiliza para autenticar las solicitudes.")
+    person_id: Optional[str] = Field(default=None, alias="personId", description="El identificador único de la persona a la que pertenece la API key.")
+    tenant_id: Optional[str] = Field(default=None, alias="tenantId", description="El identificador único del tenant al que pertenece la API key.")
+    api_key_status: Optional[int] = Field(default=None, alias="apiKeyStatus", description="El estado de la API key. 0=Revocada, 1=Activa")
+    description: Optional[str] = Field(default=None, alias="description", description="Nombre o description de la API key.")
+    
+    model_config = ConfigDict(
+        populate_by_name=True,
+        json_encoders={Decimal: str}
+    )

fiscalapi/services/api_key_service.py

@@ -0,0 +1,31 @@
+from fiscalapi.models.common_models import ApiResponse, PagedList
+from fiscalapi.models.fiscalapi_models import ApiKey
+from fiscalapi.services.base_service import BaseService
+
+
+class ApiKeyService(BaseService):
+    
+    # get paged list of api keys
+    def get_list(self, page_number: int, page_size: int) -> ApiResponse[PagedList[ApiKey]]:
+        endpoint = f"apikeys?pageNumber={page_number}&pageSize={page_size}"
+        return self.send_request("GET", endpoint, PagedList[ApiKey])
+    
+    # get apikey by id
+    def get_by_id(self, id: str) -> ApiResponse[ApiKey]:
+        endpoint = f"apikeys/{id}"
+        return self.send_request("GET", endpoint, ApiKey)
+    
+    # create apikey
+    def create(self, model: ApiKey) -> ApiResponse[ApiKey]:
+        endpoint = "apikeys"
+        return self.send_request("POST", endpoint, ApiKey, payload=model)
+    
+    # update apikey
+    def update(self, model: ApiKey) -> ApiResponse[ApiKey]:
+        endpoint = f"apikeys/{model.id}"
+        return self.send_request("PUT", endpoint, ApiKey, payload=model)
+    
+    # delete apikey by id
+    def delete(self, id: str) -> ApiResponse[bool]:
+        endpoint = f"apikeys/{id}"
+        return self.send_request("DELETE", endpoint, bool)

fiscalapi/services/fiscalapi_client.py

@@ -4,6 +4,7 @@
 from fiscalapi.services.people_service import PeopleService
 from fiscalapi.services.product_service import ProductService
 from fiscalapi.services.tax_file_servive import TaxFileService
+from fiscalapi.services.api_key_service import ApiKeyService
 
 
 
@@ -15,4 +16,5 @@ def __init__(self, settings: FiscalApiSettings):
         self.tax_files = TaxFileService(settings)
         self.catalogs = CatalogService(settings)
         self.invoices = InvoiceService(settings)
+        self.api_keys = ApiKeyService(settings)
         self.settings = settings

fiscalapi/services/people_service.py

@@ -11,7 +11,7 @@ def get_list(self, page_number: int, page_size: int) -> ApiResponse[PagedList[Pe
         return self.send_request("GET", endpoint, PagedList[Person])
 
     # get person by id
-    def get_by_id(self, person_id: int) -> ApiResponse[Person]:
+    def get_by_id(self, person_id: str) -> ApiResponse[Person]:
         endpoint = f"people/{person_id}"
         return self.send_request("GET", endpoint, Person)
 

fiscalapi/services/product_service.py

@@ -11,7 +11,7 @@ def get_list(self, page_number: int, page_size: int) -> ApiResponse[PagedList[Pr
         return self.send_request("GET", endpoint, PagedList[Product])
 
     # get product by id
-    def get_by_id(self, product_id: int) -> ApiResponse[Product]:
+    def get_by_id(self, product_id: str) -> ApiResponse[Product]:
         endpoint = f"products/{product_id}"
         return self.send_request("GET", endpoint, Product)
 

fiscalapi/services/tax_file_servive.py

@@ -10,7 +10,7 @@ def get_list(self, page_number: int, page_size: int) -> ApiResponse[PagedList[Ta
             return self.send_request("GET", endpoint, PagedList[TaxFile])
 
         # get tax file by id
-        def get_by_id(self, tax_file_id: int) -> ApiResponse[TaxFile]:
+        def get_by_id(self, tax_file_id: str) -> ApiResponse[TaxFile]:
             endpoint = f"tax-files/{tax_file_id}"
             return self.send_request("GET", endpoint, TaxFile)
 
@@ -28,14 +28,14 @@ def delete(self, tax_file_id: str) -> ApiResponse[bool]:
 
          # get default tax files for a given person)
          # obtiene el último par de certificados válidos y vigente de una persona. Es decir sus certificados por defecto.
-        def get_default_values(self, person_id: int) -> ApiResponse[list[TaxFile]]:
+        def get_default_values(self, person_id: str) -> ApiResponse[list[TaxFile]]:
             endpoint = f"tax-files/{person_id}/default-values"
             return self.send_request("GET", endpoint, list[TaxFile])
 
 
         # get default references for a given person
         # obtiene el último par de ids de certificados válidos y vigente de una persona. Es decir sus certificados por defecto (solo los ids)
-        def get_default_references(self, person_id: int) -> ApiResponse[list[TaxFile]]:
+        def get_default_references(self, person_id: str) -> ApiResponse[list[TaxFile]]:
             endpoint = f"tax-files/{person_id}/default-references"
             return self.send_request("GET", endpoint, list[TaxFile])
 

setup.py

@@ -2,7 +2,7 @@
 import os
 from setuptools import setup, find_packages
 
-VERSION = "4.0.144"
+VERSION = "4.0.145"
 # Descripción breve basada en el .csproj
 DESCRIPTION = "Genera facturas CFDI válidas ante el SAT consumiendo el API de https://www.fiscalapi.com"