@dialgem/sdk 0.1.0-beta.0

package/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+## 0.1.0-beta.0 (unreleased)
+
+The first release.
+
+- `Dialgem` client authenticated with an organization API key (`X-API-Key`).
+- Resources:
+  - `agents`, with its `functions`, `knowledge` and `mcpServers` sub-resources
+  - `calls`: `list`, `retrieve`, `createPhoneCall`, `register`
+  - `phoneNumbers`, `voices`, `flowTemplates`, `promptTemplates`
+- Webhooks: `Dialgem.webhooks.verify` and `constructEvent` check HMAC-SHA256 signatures and return typed events.
+- Typed errors carrying `errCode`, `requestId` and `issues`.
+- Retries with backoff on GET, PATCH and DELETE, honoring `Retry-After`. POST is never retried by default.
+- `calls.list()` pagination: `await` it for one page, or iterate with `for await` across all pages.
+- Request-body types generated from the agent service's OpenAPI schema.

package/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.

package/README.md

@@ -0,0 +1,257 @@
+# @dialgem/sdk
+
+The official TypeScript SDK for the [Dialgem](https://dialgem.com) voice AI API. Use it from your backend to create voice agents, put them on phone numbers, place and register calls, pull transcripts, and verify webhooks.
+
+- Written in TypeScript. Request bodies are typed from the API's own schema, including the full conversation-flow node union.
+- Zero runtime dependencies. Ships ESM and CommonJS builds.
+- Node.js 20+. It also runs on Bun, Deno and serverless runtimes that provide `fetch` and Web Crypto.
+- Server-side only. Your API key grants full access to your organization.
+
+## Install
+
+```sh
+npm install @dialgem/sdk
+# or
+pnpm add @dialgem/sdk
+# or
+yarn add @dialgem/sdk
+```
+
+## Quickstart
+
+Create an organization API key (`zk_…`) in the Dialgem dashboard and keep it in your server's environment.
+
+```ts
+import { Dialgem } from "@dialgem/sdk"
+
+const dialgem = new Dialgem() // reads DIALGEM_API_KEY
+
+const agent = await 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 | |
+|---|---|---|
+| `apiKey` | `process.env.DIALGEM_API_KEY` | Organization API key. |
+| `baseURL` | `process.env.DIALGEM_BASE_URL`, then `https://api.dialgem.com` | Point at a self-hosted or local stack. |
+| `timeout` | `60000` | Milliseconds per attempt. |
+| `maxRetries` | `2` | See [Retries](#retries). |
+| `fetch` | global `fetch` | Custom implementation (proxy agent, instrumentation). |
+| `defaultHeaders` | `{}` | Sent with every request. |
+
+Every method also takes an optional last argument, `{ timeout, maxRetries, signal, headers }`, which overrides these options for that one request.
+
+Field names are the API's own snake_case, sent exactly as written.
+
+## Recipes
+
+Complete, typechecked versions of each recipe ship with the package, in `node_modules/@dialgem/sdk/examples/`.
+
+### 1. Provision an agent on a phone number
+
+```ts
+const agent = await dialgem.agents.create({ name: "Front desk", system_prompt: "…" })
+const number = await dialgem.phoneNumbers.create({ phone_number: "+14155550100" })
+
+await dialgem.phoneNumbers.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:
+
+```ts
+await dialgem.agents.functions.create(agent.id, {
+  name: "lookup_order",
+  url: "https://example.com/api/orders/lookup",
+  parameters: { type: "object", properties: { order_id: { type: "string" } } },
+})
+await dialgem.agents.knowledge.create(agent.id, { filename: "faq.txt", content: faqText })
+```
+
+To start from a built-in template, fetch it and pass its fields to `agents.create`:
+
+```ts
+const tpl = await dialgem.promptTemplates.retrieve("dental_front_desk")
+await dialgem.agents.create({
+  name: tpl.name,
+  system_prompt: tpl.system_prompt,
+  first_message: tpl.first_message,
+  default_dynamic_variables: { ...tpl.default_dynamic_variables, business_name: "Acme Dental" },
+})
+```
+
+### 2. Place an outbound call
+
+```ts
+const { call_id } = await dialgem.calls.createPhoneCall({
+  from_: "+14155550100", // a number on your organization (`from_` is the wire name)
+  to: "+14155550199",
+  agent_id: agent.id,
+  dialgem_llm_dynamic_variables: { customer_name: "Sam" },
+})
+```
+
+### 3. Bring your own Twilio number
+
+Point your Twilio number's Voice webhook at your backend. Register the call there, then return TwiML that connects Twilio's media stream to Dialgem:
+
+```ts
+app.post("/twilio/voice", express.urlencoded({ extended: false }), async (req, res) => {
+  const { stream_url } = await dialgem.calls.register({
+    agent_id: AGENT_ID,
+    call_sid: req.body.CallSid,
+    from_number: req.body.From,
+    to_number: req.body.To,
+  })
+  // stream_url contains `&`: escape it for XML.
+  res.type("text/xml").send(`<Response><Connect><Stream url="${escapeXml(stream_url)}"/></Connect></Response>`)
+})
+```
+
+Your Twilio credentials are never shared with Dialgem. `stream_url` is signed and expires after `expires_in` seconds.
+
+### 4. Verify webhooks
+
+Set `webhook_url`, `webhook_events` and `webhook_signing_secret` on the agent. Dialgem then POSTs `call_started`, `call_ended` and `call_analyzed` events, each signed with HMAC-SHA256 in the `x-dialgem-signature` header.
+
+> **Verify the raw body.** The signature covers the exact bytes Dialgem sent. A body that was parsed and re-serialized, for example by `express.json()`, will never verify, even when the JSON is identical.
+
+**Express**
+
+```ts
+import { Dialgem, WebhookVerificationError } from "@dialgem/sdk"
+
+app.post("/webhooks/dialgem", express.raw({ type: "application/json" }), async (req, res) => {
+  try {
+    const event = await Dialgem.webhooks.constructEvent(req.body, req.header("x-dialgem-signature"), SECRET)
+    if (event.event === "call_analyzed") await crm.update(event.call_id, event.analysis.variables)
+    res.sendStatus(204)
+  } catch (err) {
+    if (err instanceof WebhookVerificationError) return res.status(400).send(err.message)
+    throw err
+  }
+})
+```
+
+**Next.js route handler**
+
+```ts
+export async function POST(request: Request) {
+  const event = await Dialgem.webhooks.constructEvent(
+    await request.text(),
+    request.headers.get("x-dialgem-signature"),
+    process.env.DIALGEM_WEBHOOK_SECRET!,
+  )
+  // …
+  return new Response(null, { status: 204 })
+}
+```
+
+**Fastify**: register a buffer parser for `application/json` on the webhook route. See `examples/webhook-fastify.ts`.
+
+`event` is a discriminated union, so `switch (event.event)` narrows the payload type. A failed delivery is retried once, so make your handler idempotent on `(event, call_id)`. Respond within 10 seconds and queue any slow work. `webhooks.verify(body, signature, secret)` returns a boolean if you prefer to handle rejection yourself.
+
+### 5. Export calls and transcripts
+
+`calls.list()` returns one page when you `await` it. Iterate over it with `for await` to walk every page:
+
+```ts
+const cutoff = "2026-09-01T00:00:00"
+for await (const call of dialgem.calls.list({ page_size: 50 })) {
+  if (call.started_at < cutoff) break // newest first: the rest are older
+  console.log(call.id, call.duration_s, call.analysis?.call_successful, call.transcript)
+}
+
+const page = await dialgem.calls.list({ page_size: 50 })
+page.data // Call[]
+page.total // number
+if (page.hasNextPage()) await page.getNextPage()
+```
+
+Pages are offset-based and ordered newest first. A call that starts mid-export shifts later pages by one, so de-duplicate on `id` if exactness matters.
+
+## Errors
+
+Every error extends `DialgemError`. When the API returns an HTTP error, the SDK throws an `APIError` subclass chosen by status code:
+
+| Status | Class |
+|---|---|
+| 400 | `BadRequestError` |
+| 401 | `AuthenticationError` |
+| 403 | `PermissionDeniedError` |
+| 404 | `NotFoundError` |
+| 409 | `ConflictError` |
+| 422 | `UnprocessableEntityError` |
+| 429 | `RateLimitError` |
+| ≥500 | `InternalServerError` |
+| no response | `APIConnectionError` / `APIConnectionTimeoutError` |
+| your `signal` aborted | `APIUserAbortError` |
+
+```ts
+try {
+  await dialgem.agents.update(id, { flow_config })
+} catch (err) {
+  if (err instanceof UnprocessableEntityError && err.errCode === "flow_invalid") {
+    for (const issue of err.issues) console.log(issue.node_id, issue.message)
+  } else if (err instanceof APIError) {
+    console.error(err.status, err.errCode, err.message, err.requestId)
+  }
+}
+```
+
+Use `errCode` (for example `flow_invalid` or `flow_not_runnable`) to tell errors with the same status apart. Include `requestId` when you contact support.
+
+## Retries
+
+The SDK retries GET, PATCH and DELETE requests up to `maxRetries` times on 408, 429, 5xx and connection failures. It backs off exponentially with jitter and honors `Retry-After`.
+
+**POST requests are not retried by default.** Most POSTs create something: after an ambiguous failure, a retried `createPhoneCall` would dial the same person twice. To retry a specific POST anyway, opt in on that request: `dialgem.agents.create(body, { maxRetries: 2 })`.
+
+The SDK never follows redirects. The API does not issue them, and following one would send your API key to wherever the redirect points. A 3xx response throws an `APIError`.
+
+## Coverage
+
+| Resource | Methods |
+|---|---|
+| `agents` | `create`, `retrieve`, `list`, `update`, `delete` |
+| `agents.functions` | `list`, `create`, `update`, `delete`, `reorder` |
+| `agents.knowledge` | `list`, `create`, `delete` |
+| `agents.mcpServers` | `list`, `create`, `update`, `delete`, `test` |
+| `calls` | `list`, `retrieve`, `createPhoneCall`, `register` |
+| `phoneNumbers` | `create`, `list`, `update`, `assign`, `delete` |
+| `voices` | `list` |
+| `flowTemplates`, `promptTemplates` | `list`, `retrieve` |
+| `webhooks` | `verify`, `constructEvent` |
+
+In-browser web calls are not part of this package.
+
+## Development
+
+Requires Node 22.13+ and pnpm 11.
+
+```sh
+pnpm install
+pnpm typecheck && pnpm test          # unit tests with a fake fetch, plus the OpenAPI contract test
+pnpm build && pnpm smoke && pnpm lint:package
+
+# After an API change: refresh the filtered OpenAPI snapshot, then regenerate request types.
+pnpm sync:openapi --from https://api.dialgem.com/openapi.json
+pnpm gen:types
+
+# Against a running API, with an organization key:
+DIALGEM_API_KEY=zk_… DIALGEM_BASE_URL=http://localhost:8002 pnpm test:live
+```
+
+Request-body types are generated from `openapi/openapi.json`. Response types in `src/types/` are written by hand, so a change to a response shape needs a matching edit there.
+
+To release, bump `version` in `package.json` and `src/version.ts`, add a CHANGELOG entry, merge to `main`, and push a matching tag (`git tag v0.1.0 && git push origin v0.1.0`). A version with a hyphen (`0.2.0-beta.1`) publishes to the `next` dist-tag.
+
+## License
+
+Apache-2.0