pyznuny 0.0.5__py3-none-any.whl → 0.0.6__py3-none-any.whl

pyznuny-0.0.6.dist-info/METADATA

@@ -0,0 +1,143 @@
+Metadata-Version: 2.4
+Name: pyznuny
+Version: 0.0.6
+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>
+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
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: pydantic>=2.12.5
+Dynamic: license-file
+
+# pyznuny
+
+A Python client for interacting with the Znuny ticketing system API.
+
+## Features
+
+- Simple, typed client built on httpx
+- Ticket create, update, and get routes
+- Easy custom endpoint configuration
+
+## Installation
+
+```console
+pip install pyznuny
+```
+
+Or with uv:
+
+```console
+uv add pyznuny
+```
+
+## Quick start
+
+Create a client and authenticate using environment variables.
+
+```python
+from pyznuny import TicketClient
+from dotenv import load_dotenv
+import os
+
+load_dotenv()
+
+client = TicketClient(
+    base_url=os.getenv("HOST"),
+    username=os.getenv("USER_LOGIN"),
+    password=os.getenv("PASSWORD"),
+)
+```
+
+Example `.env`:
+
+```ini
+HOST=https://your-znuny-instance.com
+USER_LOGIN=your-username
+PASSWORD=your-password
+```
+
+## Usage examples
+
+### Create a ticket
+
+```python
+from pyznuny.ticket.models import (
+    TicketCreateArticle,
+    TicketCreatePayload,
+    TicketCreateTicket,
+)
+
+payload = TicketCreatePayload(
+    Ticket=TicketCreateTicket(
+        Title="Ticket Title",
+        Queue="Ticket queue",
+        State="Ticket state",
+        Priority="Ticket priority",
+        CustomerUser="customer@example.com",
+    ),
+    Article=TicketCreateArticle(
+        Subject="Ticket subject",
+        Body="Ticket body...",
+        ContentType="text/plain; charset=utf-8",
+        From_="customer@example.com",
+    ),
+)
+
+response = client.ticket.create(payload=payload)
+print(response.json())
+```
+
+### Get a ticket by ID
+
+```python
+# default endpoint is GET /Ticket/{ticket_id}
+response = client.ticket.get(ticket_id=1234)
+print(response.json())
+```
+
+### Update a ticket
+
+```python
+response = client.ticket.update(
+    ticket_id=1234,
+    Ticket={"State": "open"},
+)
+print(response.json())
+```
+
+### Customize endpoints
+
+If your Znuny instance uses different paths, set them with the endpoint setter.
+
+```python
+# Example: custom ticket get endpoint and identifier
+client.set_endpoint.ticket_get(endpoint="Tickets/{id}", identifier="id")
+
+response = client.ticket.get(ticket_id=1234)
+```
+
+## Notes
+
+- When `username` and `password` are provided, the client logs in and stores
+  `session_id` automatically.
+- You can pass a pre-configured `httpx.Client` via `client=...` if needed.
+
+## License
+
+MIT

{pyznuny-0.0.5.dist-info → pyznuny-0.0.6.dist-info}/RECORD

@@ -5,7 +5,8 @@ pyznuny/ticket/endpoints.py,sha256=ArLl_BnUnZAQaWOA-T9EnTQHF1vl1XUG2kCgxlzr7vc,4
 pyznuny/ticket/exceptions.py,sha256=0pK5I0TjF_yR19eUWITGd0DryG1BrD_3ggA1YXbmPxI,563
 pyznuny/ticket/models.py,sha256=oLn3asm3cDvRvi4LfR5HOKPsyP7tG-y7d7stD-QnNjc,4691
 pyznuny/ticket/routes.py,sha256=54cr08Z2NM9JwWCkY47E1Kj94Uen9d1PJXrJ24mb2nM,2514
-pyznuny-0.0.5.dist-info/METADATA,sha256=BY475mSyPt3cmku59n9QoKI5eI42Oe6GkFa8-v6V37Q,1058
-pyznuny-0.0.5.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-pyznuny-0.0.5.dist-info/top_level.txt,sha256=ki9uLRbo2oQCeiEaaYUcnYMj1mD_dkIhQroMCdJJXmk,8
-pyznuny-0.0.5.dist-info/RECORD,,
+pyznuny-0.0.6.dist-info/licenses/LICENSE,sha256=u46khy_M-afxT4hYts7ZKb557BdvpkgoCnqTd0YCiE8,1068
+pyznuny-0.0.6.dist-info/METADATA,sha256=6LlJydC7RuHbJSs1EtfnVmtOYg-tSKGLnLQGo60sK0U,3313
+pyznuny-0.0.6.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+pyznuny-0.0.6.dist-info/top_level.txt,sha256=ki9uLRbo2oQCeiEaaYUcnYMj1mD_dkIhQroMCdJJXmk,8
+pyznuny-0.0.6.dist-info/RECORD,,

pyznuny-0.0.6.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Junior Rosa
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pyznuny-0.0.5.dist-info/METADATA

@@ -1,23 +0,0 @@
-Metadata-Version: 2.4
-Name: pyznuny
-Version: 0.0.5
-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>
-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
-Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Developers
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Typing :: Typed
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-Requires-Dist: httpx>=0.28.1
-Requires-Dist: pydantic>=2.12.5