@serviceos/sdk

TypeScript/Node.js SDK for ServiceOS API.

Installation

npm install @serviceos/sdk

Quick Start

import { ServiceOS } from "@serviceos/sdk";

const client = new ServiceOS({
  apiKey: "sk_...",
  orgId: "org_123",
  baseUrl: "https://helpdesk.ainative.studio",
});

// List open tickets
const tickets = await client.tickets.list({ status: "open" });

// Create a ticket
const ticket = await client.tickets.create({
  title: "Bug report",
  priority: "high",
});

// Update a ticket
await client.tickets.update(ticket.data.ticket_id, { status: "resolved" });

// Auto-paginate all tickets
for await (const ticket of client.tickets.listAll({ status: "open" })) {
  console.log(ticket.title);
}

// Teams, queues, webhooks, views
const teams = await client.teams.list();
const queues = await client.queues.list();

Debug Mode

const client = new ServiceOS({ ..., debug: true });

Error Handling

import { ServiceOS, AuthError, RateLimitError, NotFoundError } from "@serviceos/sdk";

try {
  await client.tickets.get("nonexistent");
} catch (err) {
  if (err instanceof NotFoundError) {
    console.log("Ticket not found");
  } else if (err instanceof RateLimitError) {
    console.log(`Retry after ${err.retryAfter}s`);
  }
}

Features

• Auto-retry on 429 (respects Retry-After header) and 5xx (exponential backoff)
• Async pagination iterator via listAll()
• Typed error classes with API error codes
• Debug mode for request logging