SDK overview
Lockally publishes official clients for ten language ecosystems. They are generated from one OpenAPI specification, so every client exposes the same operations and the same models, and a new endpoint appears everywhere at once.
That is the strength and the limitation, and this page is about both.
What is published
| Language | Package | Registry |
|---|---|---|
| TypeScript, JavaScript, Node | lockally |
npm |
| Python | lockally |
PyPI |
| Go | github.com/lockallyinc/lockally-go |
Go modules |
| Ruby | lockally |
RubyGems |
| PHP | lockally/sdk |
Packagist |
| Java | com.lockally:lockally-sdk |
Maven Central |
| C# | Lockally.SDK |
NuGet |
| Rust | lockally |
crates.io |
| Android | com.lockally:lockally-android |
Maven Central |
| Flutter, Dart | lockally |
pub.dev |
| iOS, Swift | Lockally |
CocoaPods |
There is no separate Node SDK. JavaScript, TypeScript and Node all use
lockally from npm; the package ships both CommonJS and ESM builds.
See Installation for the command and first call in each.
They are generated, and that shapes everything
A generated client is a faithful, mechanical translation of the API. It gives you typed models, every endpoint, and correctness that never drifts from the spec.
What it does not give you is judgement. openapi-generator produces no retry logic, no rate-limit backoff, no pagination helper and no webhook signature verification, because none of those can be derived from a specification.
This is worth stating rather than discovering: a caller who assumes an official
SDK handles 429 will build something that drops mail under load.
Method names come from the spec
Where an operation has an operationId, the method is named from it:
sendEmail, listDomains. Where it does not, the generator derives a name
from the route, which is why you will meet v1SendPost alongside sendEmail
in the same client.
That inconsistency is real and it is ours, not a quirk of your language’s
client. Roughly 80 of the operations have no operationId. Naming improves as
the spec gains them, and such a change is breaking for SDK callers even when
the HTTP API is untouched: see Versioning.
Versions
Every core client releases in lockstep on one version number, currently 0.3.3. A single number across ten ecosystems is deliberate: it means “generated from the same spec”, so you can reason about two services in different languages without a compatibility matrix.
Mobile and frontend helper packages version independently:
@lockally/react-native and @lockally/ui-core are on their own 0.1.x.
When not to use an SDK
The API is plain JSON over HTTPS and nothing about it needs a client library. If you send one kind of message from one service, a direct HTTP call is less code than a dependency, and you will not be exposed to an SDK release that renames your methods.
Reach for a client when you want typed models, when you call many endpoints, or when your language makes raw HTTP tedious.