Thesmsworks SDK

The SMS Works API client, generated from the OpenAPI spec.

The SMS Works provides a low-cost, reliable SMS API for developers.

Learn more about The SMS Works API at thesmsworks.co.uk.

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

Learn more about Voxgig SDKs at voxgig.com/sdk.

TypeScript, Python, Golang, Ruby SDKs, and an interactive REPL — all generated from one OpenAPI spec by @voxgig/sdkgen.

Entities, not endpoints

This SDK exposes the API as a small set of semantic entities — Batch, BatchMessage, Credit, Flash, Message, OneTimePassword, Schedule, Swagger and Util — 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 (load, create, remove):

const client = new ThesmsworksSDK()
const batch = await client.Batch().load()

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

Offline unit testing

Every SDK ships a built-in test mode that swaps the HTTP transport for an in-memory mock, so your unit tests run fully offline — no server, no network, and no credentials:

TypeScript

const client = ThesmsworksSDK.test()
const batch = await client.Batch().load({ id: 'test01' })
// batch is a bare Batch populated with mock data
console.log(batch)

Python

client = ThesmsworksSDK.test()
batch = client.Batch().load({"id": "test01"})
print(batch)

Golang

client := sdk.Test()
result, err := client.Batch(nil).Load(
    map[string]any{"id": "test01"}, nil,
)

Ruby

# Seed fixture data so offline calls resolve without a live server.
client = ThesmsworksSDK.test({
  "entity" => { "batch" => { "test01" => { "id" => "test01" } } },
})
batch = client.Batch.load({ "id" => "test01" })

Packages

Quickstart

TypeScript

import { ThesmsworksSDK } from '@voxgig-sdk/thesmsworks'

const client = new ThesmsworksSDK({
  apikey: process.env.THESMSWORKS_APIKEY,
})


// Load a specific onetimepassword (returns a OneTimePassword)
const onetimepassword = await client.OneTimePassword().load({
  messageid: 'example_messageid',
})
console.log(onetimepassword)

See the TypeScript README for the full guide.

Surfaces

Entities

The API exposes 9 entities:

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

Quickstart in other languages

Python

import os
from thesmsworks_sdk import ThesmsworksSDK

client = ThesmsworksSDK({
    "apikey": os.environ.get("THESMSWORKS_APIKEY"),
})


# Load a specific batch (returns the record, raises on error)
batch = client.Batch().load({"id": "example_id"})
print(batch)

Golang

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

client := sdk.NewThesmsworksSDK(map[string]any{
    "apikey": os.Getenv("THESMSWORKS_APIKEY"),
})


// Load a specific onetimepassword
oneTimePassword, err := client.OneTimePassword(nil).Load(
    map[string]any{"messageid": "example_messageid"}, nil,
)
if err != nil {
    panic(err)
}
fmt.Println(oneTimePassword)

Ruby

require_relative "Thesmsworks_sdk"

client = ThesmsworksSDK.new({
  "apikey" => ENV["THESMSWORKS_APIKEY"],
})


# Load a specific batch (returns the bare record; raises on error)
batch = client.Batch.load({ "id" => "example_id" })
puts batch

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"},
})

Go:

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

Ruby:

result = 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

Pass custom features via the extend option at construction time.

Per-language documentation

• TypeScript
• Python
• Golang
• Ruby

Upstream API

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

• Upstream API: https://thesmsworks.co.uk/contact

Security

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

Generated from the The SMS Works API OpenAPI spec by @voxgig/sdkgen.