pyznuny 0.0.7__tar.gz → 0.0.9__tar.gz

{pyznuny-0.0.7/src/pyznuny.egg-info → pyznuny-0.0.9}/PKG-INFO

@@ -1,11 +1,13 @@
 Metadata-Version: 2.4
 Name: pyznuny
-Version: 0.0.7
+Version: 0.0.9
 Summary: A Python client for interacting with the Znuny ticketing system API.
 Author-email: Junior Rosa <jr.dasrosas@gmail.com>, Pablo Gascon <pablogasconiel445@gmail.com>
+License-Expression: MIT
 Project-URL: Homepage, https://github.com/Junior-Rosa/py-znuny
 Project-URL: Repository, https://github.com/Junior-Rosa/py-znuny
 Project-URL: Issues, https://github.com/Junior-Rosa/py-znuny/issues
+Project-URL: Documentation, https://pyznuny.readthedocs.io/en/latest/
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
 Classifier: Operating System :: OS Independent
@@ -26,6 +28,9 @@ Dynamic: license-file
 
 # pyznuny
 
+[![PyPI version](https://img.shields.io/pypi/v/pyznuny)](https://pypi.org/project/pyznuny/)
+[![PyPI license](https://img.shields.io/pypi/l/pyznuny)](https://pypi.org/project/pyznuny/)
+
 A Python client for interacting with the Znuny ticketing system API.
 
 ## Features
@@ -46,6 +51,10 @@ Or with uv:
 uv add pyznuny
 ```
 
+## Documentation
+
+For a complete API Reference and guide on how to use pyznuny, please visit our [documentation](https://pyznuny.readthedocs.io/en/latest/).
+
 ## Quick start
 
 Create a client and authenticate using environment variables.

{pyznuny-0.0.7 → pyznuny-0.0.9}/README.md

@@ -1,5 +1,8 @@
 # pyznuny
 
+[![PyPI version](https://img.shields.io/pypi/v/pyznuny)](https://pypi.org/project/pyznuny/)
+[![PyPI license](https://img.shields.io/pypi/l/pyznuny)](https://pypi.org/project/pyznuny/)
+
 A Python client for interacting with the Znuny ticketing system API.
 
 ## Features
@@ -20,6 +23,10 @@ Or with uv:
 uv add pyznuny
 ```
 
+## Documentation
+
+For a complete API Reference and guide on how to use pyznuny, please visit our [documentation](https://pyznuny.readthedocs.io/en/latest/).
+
 ## Quick start
 
 Create a client and authenticate using environment variables.

{pyznuny-0.0.7 → pyznuny-0.0.9}/pyproject.toml

@@ -1,12 +1,13 @@
 [project]
 name = "pyznuny"
-version = "0.0.7"
+version = "0.0.9"
 description = "A Python client for interacting with the Znuny ticketing system API."
 authors = [
     { name = "Junior Rosa", email = "jr.dasrosas@gmail.com" },
     { name = "Pablo Gascon", email = "pablogasconiel445@gmail.com" }
 ]
 readme = "README.md"
+license = "MIT"
 requires-python = ">=3.10"
 dependencies = [
     "httpx>=0.28.1",
@@ -30,6 +31,7 @@ classifiers = [
 Homepage = "https://github.com/Junior-Rosa/py-znuny"
 Repository = "https://github.com/Junior-Rosa/py-znuny"
 Issues = "https://github.com/Junior-Rosa/py-znuny/issues"
+Documentation = "https://pyznuny.readthedocs.io/en/latest/"
 
 [dependency-groups]
 dev = [

{pyznuny-0.0.7 → pyznuny-0.0.9}/src/pyznuny/ticket/client.py

@@ -5,42 +5,16 @@ from typing import Any
 
 import httpx
 
-if __name__ == "__main__" and __package__ is None:
-    import os
-    import sys
-
-    sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), "../..")))
-    from pyznuny.ticket.endpoints import (
-        _DEFAULT_ENDPOINT_IDENTIFIERS,
-        _DEFAULT_ENDPOINTS,
-        Endpoint,
-        EndpointSetter,
-        EndpointsRegistry,
-    )
-    from pyznuny.ticket.exceptions import TicketClientError
-    from pyznuny.ticket.models import (
-        TicketCreateArticle,
-        TicketCreatePayload,
-        TicketCreateTicket,
-    )
-    from pyznuny.ticket.routes import SessionRoutes, TicketRoutes
-else:
-    from .endpoints import (
-        _DEFAULT_ENDPOINT_IDENTIFIERS,
-        _DEFAULT_ENDPOINTS,
-        Endpoint,
-        EndpointSetter,
-        EndpointsRegistry,
-    )
-    from .exceptions import TicketClientError
-    from .models import (
-        TicketCreateArticle,
-        TicketCreatePayload,
-        TicketCreateTicket,
-    )
-    from .routes import SessionRoutes, TicketRoutes
-
-
+from .endpoints import (
+    _DEFAULT_ENDPOINT_IDENTIFIERS,
+    _DEFAULT_ENDPOINTS,
+    Endpoint,
+    EndpointSetter,
+    EndpointsRegistry,
+)
+from .exceptions import TicketClientError
+from .models import HttpMethod
+from .routes import SessionRoutes, TicketRoutes
 
 
 class TicketClient:
@@ -94,14 +68,14 @@ class TicketClient:
     def endpoints(self) -> EndpointsRegistry:
         return self._endpoints
 
-    def register_endpoint(self, name: str, method: str, path: str) -> Endpoint:
+    def register_endpoint(self, name: str, method: HttpMethod, path: str) -> Endpoint:
         """
         Registers a custom endpoint for the Ticket API
 
         :param name: Name of the endpoint
         :type name: str
         :param method: HTTP method for the endpoint
-        :type method: str
+        :type method: HttpMethod
         :param path: Endpoint path
         :type path: str
         :return: Registered endpoint
@@ -147,13 +121,14 @@ class TicketClient:
         """
         response = self.session.create(username, password)
         self.session_id = response.json().get("SessionID")
+        return response
 
 
     def request(
         self,
         endpoint_name: str,
         *,
-        method: str | None = None,
+        method: HttpMethod | None = None,
         path: str | None = None,
         path_params: Mapping[str, Any] | None = None,
         **kwargs: Any,
@@ -164,7 +139,7 @@ class TicketClient:
         :param endpoint_name: Name of the endpoint
         :type endpoint_name: str
         :param method: HTTP method for the request, defaults to None
-        :type method: str | None
+        :type method: HttpMethod | None
         :param path: Custom endpoint path, defaults to None
         :type path: str | None
         :param path_params: Parameters for the endpoint path, defaults to None
@@ -218,65 +193,4 @@ class TicketClient:
             if not self._endpoints.has(name):
                 self._endpoints.register(
                     Endpoint(name=name, method=method, path=path)
-                )
-
-
-if __name__ == "__main__":
-    from dotenv import load_dotenv
-    load_dotenv()
-    import os
-    
-    class_payload_create = TicketCreatePayload(
-    Ticket=TicketCreateTicket(
-        Title="Erro no login",
-        Queue="ITS::Ops-TechOps::Sentinelops::Cops React - N1",
-        State="new",
-        Priority="3 normal",
-        CustomerUser="joel.junior@eitisolucoes.com.br",
-        Type="Monitoramento",
-    ),
-    Article=TicketCreateArticle(
-        Subject="Não consigo acessar",
-        Body="Detalhes do problema...",
-        ContentType="text/plain; charset=utf-8",
-        Charset="utf-8",
-        MimeType="text/plain",
-        SenderType="customer",
-        From_="joel.junior@eitisolucoes.com.br",
-    ),
-)
-
-    payload_create = {
-        "Ticket": {
-            "Title": "Erro no login",
-            "Queue": "ITS::Ops-TechOps::Sentinelops::Cops React - N1",
-            "State": "new",
-            "Priority": "3 normal",
-            "CustomerUser": "joel.junior@eitisolucoes.com.br",
-            "Type": "Monitoramento",
-        },
-        "Article": {
-            "Subject": "Não consigo acessar",
-            "Body": "Detalhes do problema...",
-            "ContentType": "text/plain; charset=utf-8",
-            "Charset": "utf-8",
-            "MimeType": "text/plain",
-            "SenderType": "customer",
-            "From": "joel.junior@eitisolucoes.com.br",
-        },
-    }
-    
-    payload_update = {
-        "Ticket": {
-            "State": "open",
-        }
-    }
-    
-    
-    client = TicketClient(base_url=os.getenv("HOST"), 
-                          username=os.getenv("USER_LOGIN"), password=os.getenv("PASS"))
-    
-    client.set_endpoint.ticket_get(endpoint="Tickets/{ticket_id}", 
-                                   identifier="ticket_id")
-    response = client.ticket.get(ticket_id=5853276)
-    print("GET Ticket Response:", response.json())
+                )

{pyznuny-0.0.7 → pyznuny-0.0.9}/src/pyznuny/ticket/endpoints.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING, Iterable, Mapping, MutableMapping
 
-from .models import Endpoint
+from .models import Endpoint, HttpMethod
 
 if TYPE_CHECKING:
     from pyznuny.ticket.client import TicketClient
@@ -31,15 +31,14 @@ class EndpointSetter:
     def __init__(self, client: "TicketClient") -> None:
         self._client = client
 
-    
-    def ticket_create(self, *, endpoint: str, method: str = "POST") -> Endpoint:
+    def ticket_create(self, *, endpoint: str, method: HttpMethod = "POST") -> Endpoint:
         """
         Sets a custom endpoint for creating tickets
 
         :param endpoint: Custom endpoint for creating tickets
         :type endpoint: str
         :param method: HTTP method for creating tickets, defaults to POST
-        :type method: str
+        :type method: HttpMethod
         :return: Endpoint object
         :rtype: Endpoint
         """
@@ -50,7 +49,7 @@ class EndpointSetter:
         *,
         endpoint: str,
         identifier: str = "ticket_id",
-        method: str = "GET",
+        method: HttpMethod = "GET",
     ) -> Endpoint:
         """
         Sets a custom endpoint for retrieving a ticket.
@@ -60,7 +59,7 @@ class EndpointSetter:
         :param identifier: Identifier for the ticket ID in the endpoint path
         :type identifier: str
         :param method: HTTP method for the endpoint, defaults to GET
-        :type method: str
+        :type method: HttpMethod
         :return: Registered endpoint
         :rtype: Endpoint
         """
@@ -77,7 +76,7 @@ class EndpointSetter:
         *,
         endpoint: str,
         identifier: str = "ticket_id",
-        method: str = "POST",
+        method: HttpMethod = "POST",
     ) -> Endpoint:
         """
         Sets a custom endpoint for updating a ticket.
@@ -87,7 +86,7 @@ class EndpointSetter:
         :param identifier: Identifier for the ticket ID in the endpoint path
         :type identifier: str
         :param method: HTTP method for the endpoint, defaults to POST
-        :type method: str
+        :type method: HttpMethod
         :return: Registered endpoint
         :rtype: Endpoint
         """
@@ -133,7 +132,7 @@ class EndpointsRegistry:
         self._endpoints[endpoint.name] = endpoint
         return endpoint
 
-    def configure(self, mapping: Mapping[str, tuple[str, str]]) -> None:
+    def configure(self, mapping: Mapping[str, tuple[HttpMethod, str]]) -> None:
         for name, (method, path) in mapping.items():
             self.register(Endpoint(name=name, method=method, path=path))
 
@@ -150,5 +149,5 @@ class EndpointsRegistry:
         endpoint = self.get(name)
         return endpoint.full_path(self._base_path)
 
-    def method_for(self, name: str) -> str:
+    def method_for(self, name: str) -> HttpMethod:
         return self.get(name).method

{pyznuny-0.0.7 → pyznuny-0.0.9}/src/pyznuny/ticket/exceptions.py

@@ -1,12 +1,9 @@
-
-
 from typing import Any, Mapping
 
 
 class TicketClientError(Exception):
     """
-    Docstring for TicketClientError
-    Represents an error returned by the TicketClient API.
+    Error returned by the TicketClient API.
     """
     def __init__(self, error: Mapping[str, Any] | str) -> None:
         

{pyznuny-0.0.7 → pyznuny-0.0.9}/src/pyznuny/ticket/models.py

@@ -1,18 +1,11 @@
 from __future__ import annotations
 
 from dataclasses import dataclass
-from typing import Any, Mapping
+from typing import Any, Literal, Mapping
 
-_VALID_METHODS = {
-    "GET",
-    "POST",
-    "PUT",
-    "PATCH",
-    "DELETE",
-    "HEAD",
-    "OPTIONS",
-}
+from pydantic import BaseModel
 
+HttpMethod = Literal["GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS"]
 
 def _clean_dict(data: Mapping[str, Any]) -> dict[str, Any]:
     return {key: value for key, value in data.items() if value is not None}
@@ -22,15 +15,6 @@ def _require_non_empty(value: str, field: str) -> None:
     if not value or not str(value).strip():
         raise ValueError(f"{field} is required.")
 
-
-def _normalize_method(method: str) -> str:
-    normalized = method.strip().upper()
-    if normalized not in _VALID_METHODS:
-        valid = ", ".join(sorted(_VALID_METHODS))
-        raise ValueError(f"Unsupported HTTP method: {method!r}. Use one of: {valid}")
-    return normalized
-
-
 def _normalize_path(path: str) -> str:
     normalized = "/" + path.lstrip("/")
     if normalized == "/":
@@ -45,24 +29,24 @@ def _join_base_path(base_path: str, endpoint_path: str) -> str:
         return "/" + tail
     return f"/{base}/{tail}"
 
-@dataclass(frozen=True, slots=True)
-class Endpoint:
+class Endpoint(BaseModel):
     """
     Object representing an API endpoint
 
     :arg name: Name of the endpoint
     :type name: str
     :arg method: HTTP method for the endpoint
-    :type method: str
+    :type method: HttpMethod
     :arg path: Endpoint path
     :type path: str
+    :raises pydantic.ValidationError: If http method is invalid
+    :raises ValueError: If endpoint path is empty
     """
     name: str
-    method: str
+    method: HttpMethod
     path: str
 
     def __post_init__(self) -> None:
-        object.__setattr__(self, "method", _normalize_method(self.method))
         object.__setattr__(self, "path", _normalize_path(self.path))
 
     def full_path(self, base_path: str = "") -> str:
@@ -80,6 +64,29 @@ class Endpoint:
 
 @dataclass(slots=True)
 class TicketCreateTicket:
+    """
+    Represents the metadata for a ticket
+
+    :param Title: Title of the ticket
+    :type Title: str
+    :param Queue: Queue of the ticket
+    :type Queue: str
+    :param State: State of the ticket
+    :type State: str
+    :param Priority: Priority of the ticket
+    :type Priority: str
+    :param CustomerUser: Customer user of the ticket
+    :type CustomerUser: str | None
+    :param Type: Type of the ticket
+    :type Type: str | None
+    :param Service: Service of the ticket
+    :type Service: str | None
+    :param SLA: SLA of the ticket
+    :type SLA: str | None
+    :param Owner: Owner of the ticket
+    :type Owner: str | None
+    :raises ValueError: If any required field is empty
+    """
     Title: str
     Queue: str
     State: str
@@ -117,6 +124,25 @@ class TicketCreateTicket:
 
 @dataclass(slots=True)
 class TicketCreateArticle:
+    """
+    Represents the article content for a ticket
+
+    :param Subject: Subject of the article
+    :type Subject: str
+    :param Body: Body of the article
+    :type Body: str
+    :param ContentType: Content type of the article
+    :type ContentType: str
+    :param Charset: Charset of the article, defaults to None
+    :type Charset: str | None
+    :param MimeType: MIME type of the article, defaults to None
+    :type MimeType: str | None
+    :param SenderType: Sender type of the article, defaults to None
+    :type SenderType: str | None
+    :param From_: From address of the article, defaults to None
+    :type From_: str | None
+    :raises ValueError: If any required field is empty
+    """
     Subject: str
     Body: str
     ContentType: str
@@ -147,6 +173,20 @@ class TicketCreateArticle:
 
 @dataclass(slots=True)
 class TicketCreatePayload:
+    """
+    Represents the payload for creating a ticket
+
+    :param Ticket: Ticket metadata
+    :type Ticket: TicketCreateTicket
+    :param Article: Article content
+    :type Article: TicketCreateArticle
+    :param DynamicField: Dynamic fields for the ticket, defaults to None
+    :type DynamicField: Mapping[str, Any] | None
+    :param Attachment: Attachments for the ticket, defaults to None
+    :type Attachment: list[Mapping[str, Any]] | None
+    :param TimeUnit: Time unit for the ticket, defaults to None
+    :type TimeUnit: int | None
+    """
     Ticket: TicketCreateTicket
     Article: TicketCreateArticle
     DynamicField: Mapping[str, Any] | None = None

{pyznuny-0.0.7 → pyznuny-0.0.9}/src/pyznuny/ticket/routes.py

@@ -4,13 +4,17 @@ from typing import TYPE_CHECKING, Any, Mapping
 
 import httpx
 
-from pyznuny.ticket.models import TicketCreatePayload
+from .models import TicketCreatePayload
 
 if TYPE_CHECKING:
-    from pyznuny.ticket.client import TicketClient
+    from .client import TicketClient
 
 
 class SessionRoutes:
+    """
+    Object representing the routes for creating a session with the Ticket API, this is
+    abstracted by the TicketClient
+    """
     def __init__(self, client: "TicketClient") -> None:
         self._client = client
 
@@ -32,6 +36,10 @@ class SessionRoutes:
 
 
 class TicketRoutes:
+    """
+    Object representing the routes for the Ticket API, this is abstracted
+    by the TicketClient
+    """
     def __init__(self, client: "TicketClient") -> None:
         self._client = client
 
@@ -40,7 +48,16 @@ class TicketRoutes:
         payload: TicketCreatePayload | Mapping[str, Any] | None = None,
         **payload_kwargs: Any,
     ) -> httpx.Response:
-        
+        """
+        Creates a new ticket
+
+        :param payload: Ticket creation payload
+        :type payload: TicketCreatePayload | Mapping[str, Any] | None
+        :param payload_kwargs: Additional keyword arguments for the payload
+        :type payload_kwargs: Any
+        :return: Response object
+        :rtype: httpx.Response
+        """
         if payload is None:
             payload_dict = dict(payload_kwargs)
             
@@ -56,6 +73,16 @@ class TicketRoutes:
     
 
     def update(self, ticket_id: str | int , **payload: dict) -> httpx.Response:
+        """
+        Updates an existing ticket
+
+        :param ticket_id: ID of the ticket to update
+        :type ticket_id: str | int
+        :param payload: Map of the fields to update
+        :type payload: dict
+        :return: Response object
+        :rtype: httpx.Response
+        """
         identifier = self._client.endpoint_identifier("ticket_update")
         
         payload.update({"SessionID": self._client.session_id})
@@ -68,6 +95,19 @@ class TicketRoutes:
     def get(self, ticket_id: str | int, 
             dynamic_fields:int=0,
             all_articles:int=0) -> httpx.Response:
+        """
+        Retrieves an existing ticket
+
+        :param ticket_id: ID of the ticket to retrieve
+        :type ticket_id: str | int
+        :param dynamic_fields: Number of dynamic fields to retrieve, defaults to 0
+        :type dynamic_fields: int
+        :param all_articles: Whether to retrieve all articles, 1 for true 0 for false,
+        defaults to 0
+        :type all_articles: int
+        :return: Response object
+        :rtype: httpx.Response
+        """
         identifier = self._client.endpoint_identifier("ticket_get")
         return self._client.request(
             "ticket_get",

{pyznuny-0.0.7 → pyznuny-0.0.9/src/pyznuny.egg-info}/PKG-INFO

@@ -1,11 +1,13 @@
 Metadata-Version: 2.4
 Name: pyznuny
-Version: 0.0.7
+Version: 0.0.9
 Summary: A Python client for interacting with the Znuny ticketing system API.
 Author-email: Junior Rosa <jr.dasrosas@gmail.com>, Pablo Gascon <pablogasconiel445@gmail.com>
+License-Expression: MIT
 Project-URL: Homepage, https://github.com/Junior-Rosa/py-znuny
 Project-URL: Repository, https://github.com/Junior-Rosa/py-znuny
 Project-URL: Issues, https://github.com/Junior-Rosa/py-znuny/issues
+Project-URL: Documentation, https://pyznuny.readthedocs.io/en/latest/
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
 Classifier: Operating System :: OS Independent
@@ -26,6 +28,9 @@ Dynamic: license-file
 
 # pyznuny
 
+[![PyPI version](https://img.shields.io/pypi/v/pyznuny)](https://pypi.org/project/pyznuny/)
+[![PyPI license](https://img.shields.io/pypi/l/pyznuny)](https://pypi.org/project/pyznuny/)
+
 A Python client for interacting with the Znuny ticketing system API.
 
 ## Features
@@ -46,6 +51,10 @@ Or with uv:
 uv add pyznuny
 ```
 
+## Documentation
+
+For a complete API Reference and guide on how to use pyznuny, please visit our [documentation](https://pyznuny.readthedocs.io/en/latest/).
+
 ## Quick start
 
 Create a client and authenticate using environment variables.