SDKs
TypeScript and Python: one method per operation, retries and idempotency done for you.
TypeScript
@lidmeo/sdk: Node 18 and later, Deno or Bun (it needs fetch and node:crypto), without any dependency.Python
lidmeo: Python 3.8 and later, the standard library only.Both SDKs are generated from the API's contract: every operation of the reference has its method there, with its parameters. They do for you what a good integration must do:
- authentication: the key in
LIDMEO_API_KEY, or passed to the client; - the version: every request carries the API version the SDK was generated with, so its types match the responses;
- idempotency: every write carries an
Idempotency-Key, the same on every new attempt; - the language of errors: the
languageoption ("fr"or"en") chooses the language ofdetail(Accept-Languageheader); without it, the API answers in French; - retries: network cut,
408,429(afterRetry-After) and5xxerrors, with the sameIdempotency-Key; on a write, also the transient409refusals (idempotency_key_in_use,send_in_progress,import_in_progress,test_reset_in_progress,delivery_in_progress); two retries by default, with a growing wait. Never a send that failed (502 send_failed) nor sends switched off by Lidmeo (503 sends_disabled): sending again stays your decision; - errors: a single class,
LidmeoError, with the problem's stablecode; - pagination: a walk through all the pages;
- webhooks: signature verification.
The TypeScript SDK is an ESM module: import everywhere; require works from Node 20.19 and 22.12. It runs neither in a browser nor on an edge runtime without Node compatibility.
For any other language, generate a client from the OpenAPI contract (https://developers.lidmeo.com/openapi.json).