dialgem 0.1.0b1__tar.gz

dialgem-0.1.0b1/.gitignore

@@ -0,0 +1,11 @@
+.venv/
+__pycache__/
+*.pyc
+dist/
+build/
+*.egg-info/
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+.env
+.env.*

dialgem-0.1.0b1/CHANGELOG.md

@@ -0,0 +1,24 @@
+# Changelog
+
+## 0.1.0b1 (unreleased)
+
+First release. Sync and asyncio clients covering the customer API: agents (functions, knowledge, MCP
+servers, versions), calls, web calls, phone numbers, voices, templates, contacts and lists, simulations and
+sessions; plus webhook signature verification. Campaigns, webhook endpoint management, usage, billing,
+analytics, and contact erasure / do-not-call are deliberately not in the SDK (see `docs/api-surface.md`).
+
+`chats` (create, list, retrieve, update, delete, send_message, end, rerun_analysis), `calls.rerun_analysis`, `contacts.retrieve_by_phone` and `api_key.retrieve` need the matching routes in the service.
+
+``sessions.say(session_id, text=..., interrupt=...)`` and ``sessions.release(session_id)`` make the agent speak a line on a live call, and hand a taken-over call back. Off unless the deployment enables live control (``live_control_disabled``). Listening in and taking over run over a WebSocket this SDK does not wrap. ``sessions.update`` now reaches a call on any service instance.
+
+`sessions.update(session_id, system_prompt=..., dynamic_variables=...)` changes a live call's prompt and/or variables from the agent's next turn. ``session_id`` is the session's id or the call's ``call_id``. Only that call changes and it is not saved.
+
+`llms` (create, list, retrieve, update, delete) saves a prompt and model once; attach it with ``llm_id`` on ``agents.create`` / ``agents.update``. Attaching copies the values; later edits or deletion do not change the agent, and ``llm_id`` cannot be sent with the fields it carries.
+
+`agents.mcp_servers.list_tools(agent_id, server_id)` returns the server's tools with descriptions and argument schemas, from a live connection; it stores nothing.
+
+`flows` (create, list, retrieve, update, delete) saves a conversation flow once; attach it with ``flow_id`` on ``agents.create`` / ``agents.update``. Attaching copies the flow, so later edits or deletion do not change the agent.
+
+Chats are billed per agent reply (a spent balance is a 402 `insufficient_credit`) and `Chat.chat_cost` shows the spend (`None` for a team-member session). `chat_started`, `chat_ended` and `chat_analyzed` webhook events parse to `ChatStartedEvent`, `ChatEndedEvent` and `ChatAnalyzedEvent` (they carry `chat_id` and `chat`, not `call_id`).
+
+Mirrors the surface and the safety rules of `@dialgem/sdk` 0.1.0-beta.1 (see `docs/api-surface.md`).

dialgem-0.1.0b1/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

dialgem-0.1.0b1/PKG-INFO

@@ -0,0 +1,281 @@
+Metadata-Version: 2.5
+Name: dialgem
+Version: 0.1.0b1
+Summary: Official Python SDK for the Dialgem voice AI API: agents, calls, phone numbers and webhook verification from your backend.
+Project-URL: Homepage, https://github.com/DialgemAI/dialgem-sdk-python
+Project-URL: Issues, https://github.com/DialgemAI/dialgem-sdk-python/issues
+Author: Dialgem
+License: Apache-2.0
+License-File: LICENSE
+Keywords: dialgem,sdk,telephony,voice-agent,voice-ai
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+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
+Requires-Dist: httpx<1,>=0.27
+Requires-Dist: pydantic<3,>=2.6
+Requires-Dist: typing-extensions>=4.7
+Provides-Extra: dev
+Requires-Dist: build; extra == 'dev'
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: respx>=0.21; extra == 'dev'
+Requires-Dist: ruff>=0.5; extra == 'dev'
+Requires-Dist: twine; extra == 'dev'
+Description-Content-Type: text/markdown
+
+<div align="center">
+
+# dialgem
+
+**The official Python SDK for the [Dialgem](https://dialgem.com) voice AI API.**
+
+Build voice agents, put them on phone numbers, place calls, steer them live, and read transcripts, all from your backend.
+
+[![PyPI](https://img.shields.io/pypi/v/dialgem?color=3775A9&logo=pypi&logoColor=white)](https://pypi.org/project/dialgem/)
+[![Python](https://img.shields.io/pypi/pyversions/dialgem?logo=python&logoColor=white)](https://pypi.org/project/dialgem/)
+[![CI](https://img.shields.io/github/actions/workflow/status/DialgemAI/dialgem-sdk-python/ci.yml?branch=main&label=CI&logo=github)](https://github.com/DialgemAI/dialgem-sdk-python/actions/workflows/ci.yml)
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue)](LICENSE)
+[![Typed](https://img.shields.io/badge/typing-typed-2a6db2)](https://peps.python.org/pep-0561/)
+[![Stars](https://img.shields.io/github/stars/DialgemAI/dialgem-sdk-python?style=flat&logo=github)](https://github.com/DialgemAI/dialgem-sdk-python/stargazers)
+
+[Website](https://dialgem.com) · [Issues](https://github.com/DialgemAI/dialgem-sdk-python/issues) · [Changelog](CHANGELOG.md) · [API surface](docs/api-surface.md)
+
+</div>
+
+---
+
+```python
+from dialgem import Dialgem
+
+dialgem = Dialgem()  # reads DIALGEM_API_KEY
+
+agent = dialgem.agents.create(name="Front desk", system_prompt="You answer for Acme Dental.")
+call = dialgem.calls.create_phone_call(to="+14155550123", from_="+14155550100", agent_id=agent.id)
+```
+
+## Why this SDK
+
+- **Sync and async, one surface.** `Dialgem` and `AsyncDialgem` expose the same methods.
+- **Typed end to end.** Request bodies are `TypedDict`s generated from the API schema; responses are pydantic v2 models, so your editor and `mypy` know every field.
+- **Safe by default.** `POST` is never retried (a retry could ring someone twice), `GET`/`PUT`/`PATCH`/`DELETE` retry with backoff and `Retry-After`, and an API change never crashes your integration: unknown or mismatched fields come back as-is with one warning.
+- **Everything a backend needs.** Agents (with tools, knowledge and MCP servers), phone numbers, calls and chats, saved flows and LLMs, contacts, simulations, web calls, live call control, and webhook signature verification.
+- **Small.** Python 3.10+, three dependencies: `httpx`, `pydantic`, `typing_extensions`.
+- **Server-side only.** An organization API key grants full access to your organization. To let a visitor talk to an agent from a web page, see [Web calls](#web-calls).
+
+## Contents
+
+[Install](#install) · [Quickstart](#quickstart) · [Async](#async) · [Recipes](#recipes) · [Live call control](#live-call-control) · [Errors](#errors) · [Retries](#retries) · [Responses](#responses) · [Development](#development) · [License](#license)
+
+> Which routes this SDK can and cannot reach, and why: [docs/api-surface.md](docs/api-surface.md).
+
+## Install
+
+```sh
+pip install dialgem
+```
+
+## Quickstart
+
+Create an organization API key (`zk_…`) in the Dialgem dashboard and keep it in your server's environment.
+
+```python
+from dialgem import Dialgem
+
+dialgem = Dialgem()  # reads DIALGEM_API_KEY
+
+agent = dialgem.agents.create(
+    name="Front desk",
+    system_prompt="You are the front desk for {{business_name}}.",
+    first_message="Thanks for calling, how can I help?",
+    default_dynamic_variables={"business_name": "Acme Dental"},
+)
+```
+
+| Option | Default | |
+|---|---|---|
+| `api_key` | `$DIALGEM_API_KEY` | Organization API key. |
+| `timeout` | `60` | Seconds per attempt. |
+| `max_retries` | `2` | See [Retries](#retries). |
+| `default_headers` | `{}` | Sent with every request. |
+| `http_client` | a new `httpx.Client` | Your own client (proxy, mTLS, instrumentation). You close it. |
+
+Every method also takes `request_options={"timeout": 10, "max_retries": 0, "headers": {...}}` for that one request.
+
+Field names are the API's own snake_case, passed as keyword arguments and sent exactly as written.
+
+## Async
+
+```python
+import asyncio
+from dialgem import AsyncDialgem
+
+async def main():
+    async with AsyncDialgem() as dialgem:
+        agent = await dialgem.agents.create(name="Front desk")
+        async for call in dialgem.calls.list(limit=50):   # walks every page
+            print(call.id, call.call_status)
+
+asyncio.run(main())
+```
+
+## Recipes
+
+### Provision an agent on a phone number
+
+```python
+agent = dialgem.agents.create(name="Front desk", system_prompt="…")
+number = dialgem.phone_numbers.create(phone_number="+14155550100")
+
+dialgem.phone_numbers.update(
+    number.id,
+    inbound_agent_id=agent.id,
+    set_inbound_agent=True,  # inbound_agent_id is ignored without this
+)
+```
+
+Agents also have tools, knowledge and MCP servers:
+
+```python
+dialgem.agents.functions.create(
+    agent.id,
+    name="lookup_order",
+    url="https://example.com/api/orders/lookup",
+    parameters={"type": "object", "properties": {"order_id": {"type": "string"}}},
+)
+dialgem.agents.knowledge.create(agent.id, filename="faq.txt", content=faq_text)
+```
+
+### Place an outbound call
+
+```python
+call = dialgem.calls.create_phone_call(
+    to="+14155550123",
+    from_="+14155550100",          # `from_`: the wire name; must be a number on your organization
+    agent_id=agent.id,
+    metadata={"order": "A-1042"},
+    dialgem_llm_dynamic_variables={"customer_name": "Ada"},
+)
+```
+
+`create_phone_call` is a POST and is **not retried**. A retry after an ambiguous 502 could ring the person twice.
+
+### List calls
+
+```python
+for call in dialgem.calls.list(agent_id=agent.id, start_after=1730000000000, limit=50):
+    print(call.id, call.transcript_text)
+
+page = dialgem.calls.list(limit=50)        # or one page at a time
+page.data, page.has_next_page(), page.get_next_page()
+```
+
+### Web calls
+
+Your **server** mints a one-use token; the page connects with `@dialgem/client` using that token alone, so your API key never reaches the browser.
+
+```python
+# once: allow the page's origin
+dialgem.web_calls.update_settings(allowed_origins=["https://app.example.com"])
+
+# per visitor, from your own endpoint
+web_call = dialgem.web_calls.create(agent_id="AGENT_ID", metadata={"visitor": "v_123"})
+return {"access_token": web_call.access_token}   # 60 seconds, single use
+```
+
+### Verify webhooks
+
+Verify against the **raw request body** exactly as received. A body parsed and re-serialized no longer matches.
+
+```python
+from dialgem import webhooks, WebhookVerificationError
+
+# FastAPI
+@app.post("/dialgem")
+async def hook(request: Request):
+    body = await request.body()
+    try:
+        event = webhooks.construct_event(body, request.headers.get("x-dialgem-signature"), SECRET)
+    except WebhookVerificationError:
+        return Response(status_code=400)
+    if event.event == "call_ended":
+        print(event.call.id, event.call.duration_ms)
+    return Response(status_code=204)
+```
+
+`construct_function_call` does the same for the requests Dialgem sends to your agent's custom functions. Signatures carry a timestamp and are rejected after five minutes (`tolerance_ms=`).
+
+## Live call control
+
+Steer a call while it is happening. `session_id` is the session's id from `sessions.list()` or the call's own `call_id`, and the call can be on any service instance.
+
+```python
+# Change this call's prompt or variables from the agent's next turn (not saved, only this call).
+dialgem.sessions.update(call.id, dynamic_variables={"plan": "pro"})
+
+# Make the agent say a line in its own voice; interrupt=True cuts in now.
+dialgem.sessions.say(call.id, text="One moment while I check that.")
+
+# Give a taken-over call back to the agent.
+dialgem.sessions.release(call.id)
+```
+
+`say` and `release` are **off unless your deployment enables live control** (`PermissionDeniedError` with `err_code == "live_control_disabled"`), and are for owners, admins and API keys only. Listening in and taking a call over run over a WebSocket (`/v1/agent/sessions/{id}/live`), which this SDK does not wrap.
+
+## Errors
+
+```python
+from dialgem import NotFoundError, APIError, APIConnectionError
+
+try:
+    dialgem.agents.retrieve("nope")
+except NotFoundError as e:
+    print(e.status, e.err_code, e.request_id)   # quote request_id to support
+except APIError as e:
+    print(e.status, e.issues)                   # e.g. 422 validation issues
+except APIConnectionError:
+    ...                                         # no response (APITimeoutError is a subclass)
+```
+
+`400 BadRequestError`, `401 AuthenticationError`, `403 PermissionDeniedError`, `404 NotFoundError`, `409 ConflictError`, `422 UnprocessableEntityError`, `429 RateLimitError`, `5xx InternalServerError`. All derive from `APIError` → `DialgemError`.
+
+## Retries
+
+GET, PUT, PATCH and DELETE retry up to `max_retries` times on 408, 429, 5xx and connection errors, with exponential backoff and jitter, honouring `Retry-After` / `Retry-After-Ms` (capped at 60 s). **POST is never retried** unless you pass `request_options={"max_retries": n}`. 409 is never retried. File uploads are never retried.
+
+## Responses
+
+Responses are pydantic models. Unknown fields are kept (as attributes and in `model.model_extra`), and `model.to_dict()` returns the JSON as the API sent it. If the API returns something that does not fit the SDK's model (a field changed type or went missing), the SDK returns it **unvalidated** and issues one `UserWarning` per model instead of raising, so an API change never takes your integration down. Upgrade the SDK when you see it.
+
+## Development
+
+```sh
+python -m venv .venv && source .venv/bin/activate    # Windows: .venv\Scripts\activate
+pip install -e ".[dev]"
+pytest
+mypy src && ruff check .
+python scripts/unasync.py       # regenerate src/dialgem/aresources from src/dialgem/resources
+python scripts/gen_params.py    # regenerate request types from openapi/openapi.json
+python scripts/mutate.py        # mutation spot-check of the safety rules
+```
+
+`src/dialgem/aresources/` and `src/dialgem/types/params.py` are generated; edit the sync resources and the OpenAPI snapshot, never the generated files. CI fails if they are stale.
+
+## License
+
+Apache-2.0
+
+---
+
+<div align="center">
+
+If this SDK saves you time, a ⭐ on [GitHub](https://github.com/DialgemAI/dialgem-sdk-python) helps other developers find it.
+
+</div>