Metadata-Version: 2.4
Name: duplo-ai-helpdesk-sdk
Version: 0.1.1
Summary: Python client for the DuploCloud AI HelpDesk API
Author-email: DuploCloud <infra+sdk@duplocloud.net>
License: MIT
Project-URL: Repository, https://github.com/duplocloud/ai-helpdesk-client-python
Keywords: OpenAPI,OpenAPI-Generator,DuploCloud,AI HelpDesk
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: urllib3<3.0.0,>=2.1.0
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2
Requires-Dist: typing-extensions>=4.7.1
Dynamic: license-file

# duplo-ai-helpdesk-sdk

Typed Python models for the **DuploCloud AI HelpDesk API** — workspaces, agents,
and tickets. The models are [pydantic v2](https://docs.pydantic.dev), so every
request and response shape comes with validation, IDE autocomplete, and type
checking. A generated HTTP client is included too, if you want one.

## Install

```sh
pip install duplo-ai-helpdesk-sdk
```

Requires Python 3.9+.

## Usage

Validate an API payload into a typed model:

```python
from duplo_ai_helpdesk_sdk.models.workspace import Workspace

ws = Workspace.model_validate(payload)   # payload: a dict from the API
print(ws.name)
```

Build a body and serialize it back to a dict for a request:

```python
ws = Workspace(name="support-bot")
body = ws.model_dump(by_alias=True, exclude_none=True)
```

The package also ships generated transport classes (`ApiClient`, `Configuration`,
and the `*Api` classes) for a ready-made HTTP client. Per-model and per-endpoint
reference lives under [`docs/`](https://github.com/duplocloud/ai-helpdesk-client-python/tree/main/docs).

> **Using duploctl?** duploctl talks to the API with its own HTTP client and uses
> these models only for request/response validation — you don't need the transport
> classes for that.

## Versioning

Independent SemVer — the SDK's version is its own, not the backend's: **major** on a
breaking model change, **minor** on additive surface, **patch** for
generation/packaging-only updates.

## Links

- Source & issues: <https://github.com/duplocloud/ai-helpdesk-client-python>
- Releasing, regeneration, and provenance: [CONTRIBUTING.md](https://github.com/duplocloud/ai-helpdesk-client-python/blob/main/CONTRIBUTING.md)

---

Generated from the AI HelpDesk OpenAPI document with
[OpenAPI Generator](https://openapi-generator.tech).
