Dedline SDK

Dedline SDK

Dedline API client, generated from the OpenAPI spec.

This is an unofficial SDK for the Dedline public API, generated by Voxgig with @voxgig/sdkgen. It is not affiliated with, endorsed by, or sponsored by the upstream API provider.

TypeScript, Python, PHP, Golang, Ruby, Lua SDKs, a CLI, an interactive REPL, and an MCP server for AI agents — all generated from one OpenAPI spec by @voxgig/sdkgen.

Entities, not endpoints

This SDK exposes the API as a small set of semantic entities — Deadline, RegistrationFeature, Stat and State — that you call directly, instead of assembling URL paths and query strings. Entities are Capitalised to mark them as the primary surface, each with the operations they support (list, load):

const client = new DedlineSDK()
const items = await client.Deadline().list()

Thinking in entities keeps the mental model small — for people and AI agents alike — rather than reasoning about raw HTTP routes and query parameters.

Packages

LanguagePackageInstall
TypeScript@voxgig-sdk/dedlinepublish pending — install from git tag
Pythonvoxgig-sdk-dedlinepublish pending — install from git tag
PHPvoxgig-sdk/dedlinepublish pending — install from git tag
Golanggithub.com/voxgig-sdk/dedline-sdk/gogo get github.com/voxgig-sdk/dedline-sdk/go@latest
Rubyvoxgig-sdk-dedlinepublish pending — install from git tag
Luavoxgig-sdk-dedlinepublish pending — install from git tag

Quickstart

TypeScript

import { DedlineSDK } from '@voxgig-sdk/dedline'

const client = new DedlineSDK()

// List all deadlines (returns Deadline[])
const deadlines = await client.Deadline().list()
for (const deadline of deadlines) {
  console.log(deadline)
}

See the TypeScript README for the full guide.

Surfaces

SurfacePath
SDK (TypeScript, Python, PHP, Golang, Ruby, Lua)ts/ py/ php/ go/ rb/ lua/
CLIgo-cli/
MCP servergo-mcp/

Use it from an AI agent (MCP)

The generated MCP server exposes every operation in this SDK as an MCP tool that Claude, Cursor or Cline can call directly. Build and register it:

cd go-mcp && go build -o dedline-mcp .

Then add it to your agent’s MCP config (Claude Desktop, Cursor, etc.):

{
  "mcpServers": {
    "dedline": {
      "command": "/abs/path/to/dedline-mcp"
    }
  }
}

Entities

The API exposes 4 entities:

EntityDescriptionAPI path
DeadlineThe Deadline entity (list)./upcoming.json
RegistrationFeatureThe RegistrationFeature entity (list)./lastMinuteAccepted.json
StatThe Stat entity (load)./stats.json
StateThe State entity (list, load)./states.json

The operations available across these entities are load, list — see each entity’s own list above for exactly which it supports.

Quickstart in other languages

Python

from dedline_sdk import DedlineSDK

client = DedlineSDK()

# List all deadlines (returns a list, raises on error)
deadlines = client.Deadline().list()
for deadline in deadlines:
    print(deadline)

PHP

<?php
require_once 'dedline_sdk.php';

$client = new DedlineSDK();

// List all deadlines (returns an array; throws on error)
$deadlines = $client->Deadline()->list();
print_r($deadlines);

Golang

import sdk "github.com/voxgig-sdk/dedline-sdk/go"

client := sdk.New()

// List all deadlines
deadlines, err := client.Deadline(nil).List(nil, nil)
fmt.Println(deadlines)

Ruby

require_relative "Dedline_sdk"

client = DedlineSDK.new

# List all deadlines (returns an Array; raises on error)
deadlines = client.Deadline.list
puts deadlines

Lua

local sdk = require("dedline_sdk")

local client = sdk.new()

-- List all deadlines
local deadlines, err = client:Deadline():list()
print(deadlines)

Unit testing in offline mode

Every SDK ships a test mode that swaps the HTTP transport for an in-memory mock, so unit tests run offline.

TypeScript

const client = DedlineSDK.test()
const deadline = await client.Deadline().list()
// deadline is a bare Deadline populated with mock data
console.log(deadline)

Python

client = DedlineSDK.test()
deadline = client.Deadline().list()
print(deadline)

PHP

// Seed fixture data so offline calls resolve without a live server.
$client = DedlineSDK::test([
    "entity" => ["deadline" => ["test01" => []]],
]);
$deadline = $client->Deadline()->list();

Golang

client := sdk.Test()
result, err := client.Deadline(nil).List(
    nil, nil,
)

Ruby

# Seed fixture data so offline calls resolve without a live server.
client = DedlineSDK.test({
  "entity" => { "deadline" => { "test01" => {} } },
})
deadline = client.Deadline.list()

Lua

local client = sdk.test()
local result, err = client:Deadline():list()

Direct and prepare

For endpoints the entity model doesn’t cover, use the low-level methods:

  • direct(fetchargs) — build and send an HTTP request in one step.
  • prepare(fetchargs) — build the request without sending it.

Both accept a map with path, method, params, query, headers, and body. See the How-to guides below.

How-to guides

Make a direct API call

When the entity interface does not cover an endpoint, use direct:

TypeScript:

const result = await client.direct({
  path: '/api/resource/{id}',
  method: 'GET',
  params: { id: 'example' },
})
if (result instanceof Error) {
  throw result
}
console.log(result.data)

Python:

result = client.direct({
    "path": "/api/resource/{id}",
    "method": "GET",
    "params": {"id": "example"},
})

PHP:

$result = $client->direct([
    "path" => "/api/resource/{id}",
    "method" => "GET",
    "params" => ["id" => "example"],
]);

Go:

result, err := client.Direct(map[string]any{
    "path":   "/api/resource/{id}",
    "method": "GET",
    "params": map[string]any{"id": "example"},
})

Ruby:

result = client.direct({
  "path" => "/api/resource/{id}",
  "method" => "GET",
  "params" => { "id" => "example" },
})

Lua:

local result, err = client:direct({
  path = "/api/resource/{id}",
  method = "GET",
  params = { id = "example" },
})

Advanced

Everyday use only needs the sections above. This explains the internals behind every call — relevant when writing custom features.

Every SDK call runs the same five-stage pipeline:

  1. Point — resolve the API endpoint from the operation definition.
  2. Spec — build the HTTP specification (URL, method, headers, body).
  3. Request — send the HTTP request.
  4. Response — receive and parse the response.
  5. Result — extract the result data for the caller.

A feature hook fires at each stage (e.g. PrePoint, PreSpec, PreRequest), so features can inspect or modify the pipeline without forking the SDK.

Features

FeaturePurpose
TestFeatureIn-memory mock transport for testing without a live server

Pass custom features via the extend option at construction time.

Per-language documentation

Upstream API

This SDK is generated from the upstream OpenAPI specification. It is an unofficial client and is not affiliated with the API provider.

Security

Please report security issues to security@voxgig.com. See SECURITY.md. Do not open public issues for suspected vulnerabilities.


Generated from the Dedline API OpenAPI spec by @voxgig/sdkgen.

Get the Voxgig dispatch

Short notes on building SDKs, CLIs, REPLs, and MCPs for API-first teams, plus the occasional Fireside episode pick.

By signing up you agree to our Terms and Conditions.