@vorluno/niiko-sdk

The TypeScript client for the niiko actions API. One typed method per action, three outcomes, zero dependencies.

A client that knows the actions it was written for is stale the day a new one opens. This one is generated from the niiko action manifest, in the same run as the Python client and the reference (plan 88185e0c8c12), so an action that opens on the server appears here as a typed method at once — and nothing in this repository is edited by hand.

Install

npm install @vorluno/niiko-sdk

Zero runtime dependencies. A client that drags an HTTP library along forces whoever installs it to resolve a version conflict just to send a POST.

Use

import { Niiko } from "@vorluno/niiko-sdk";

const niiko = new Niiko({ apiKey: process.env.NIIKO_API_KEY! });

// The second argument is the idempotency key: keep it if you retry.
const r = await niiko.createLead({
  submissionId: "01890a5d-ac96-774b-bcce-b302099a8057",
  source: "web_form",
}, crypto.randomUUID());

if (r.status === "done") console.log(r.output);
else if (r.status === "refused") console.error(r.reason, r.detail?.message);
else console.log("waiting for a human signature", r.proposalId);

Three outcomes, not two

| status | Meaning | |---|---| | done | Done. Carries the output. | | pending_approval | Waits for a human signature and may complete hours later. A webhook tells you when it resolves. | | refused | Not done, and reason says why. detail.message, when present, says what to do. |

A two-outcome contract forces the third one to disguise itself as another, and the disguised one is always the one that takes longest to understand. Branch once on status; a refusal is a state, not an exception.

[!NOTE] Send an idempotency key with every request. A timeout retry with the same key does not execute again: it answers refused with reason: "duplicate" and what happened the first time. Without one, a retry is a new request. The protection lasts 24 hours.

[!IMPORTANT] Each action needs two permissions: a key with that action's scope, and the workspace owner having switched it on (Administration → Permissions). Holding the key is not enough — they are two decisions made by different people.

The actions today (13)

| Action | Method | What it does | |---|---|---| | miira.lead_create | createLead | Creates a new lead in the workspace CRM from its contact details. If a matching one already exists it is not duplicated: the reply is ambiguous with the candidates. | | crm.call_logged | loggedCall | Logs what was discussed in a call on a client's record, naming the client; optionally creates the follow-up with its date. Reads nothing and calls no one. | | crm.owner_assigned | assignedOwner | Changes who owns a client, naming the client and the team member (by name or email). If either is ambiguous it refuses with the list. | | crm.stage_moved | movedStage | Moves a client's open deal to another pipeline stage, naming the client and the stage. Creates no deals: with no open deal it refuses, and with several it refuses with the list. | | kiipu.invoice_proposed | proposedInvoice | Prepares an invoice as a DRAFT for a client named by name, with its lines and taxes. Does NOT issue it, does NOT number it and does NOT count as debt: a person reviews and issues it in Kiipu. Does not create the client if it does not exist. | | crm.task_created | createdTask | Creates a reminder (a task with date and time) on a client named by name. Does not log a call: that is crm.call_logged. Does not create the client if it does not exist. | | crm.deal_created | createdDeal | Opens a new deal in the pipeline for a client named by name, with a title, an optional value in USD, an optional stage (by name; without it, the first one) and an optional owner. Does not check for other open deals: it returns how many remain so a duplicate is visible. Does not win or lose it: that is crm.stage_moved. | | crm.note_added | addedNote | Saves a note on a client's record, naming the client: something to know next time, with no call and no date. For a call use crm.call_logged; for a dated reminder, crm.task_created. | | crm.contact_added | addedContact | Adds a person (name, and optionally email, phone and role) to a client's record, naming the client. Does not make them the primary contact and does not create the client. If someone with that email or phone already existed, the reply says so but does not block it. | | miira.broadcast_quoted | quotedBroadcast | Quotes sending the SAME WhatsApp message to several clients named by name (up to 50). Sends NOTHING: per client, it says whether the text goes as-is (24-hour window open, free), whether an approved template is needed and what it costs, or why that client cannot be messaged. Returns a signed quote valid for 15 minutes; to send, call miira.broadcast_sent with it. Show the quote to the person first. | | miira.broadcast_sent | sentBroadcast | Sends the WhatsApp broadcast quoted by miira.broadcast_quoted, exactly to whom and how the quote said. If anything changed (window, consent, rate) it refuses with a new quote to confirm again. Costs money when templates are involved: do not call it without the person having seen the cost. | | kiipu.draft_voided | voidedDraft | Voids a DRAFT invoice (one created with kiipu.invoice_proposed and not yet issued), by its id or by the client's name when it is their only draft. Does not void issued invoices: that is for a person in Kiipu. | | kiipu.payment_reported | reportedPayment | Leaves in the Kiipu approval queue the notice that a client (by name) paid a given amount of an open invoice. Does NOT apply the payment and touches no balances: a person checks it against the bank and applies it. If the client has several open invoices the number must be given. |

What this client does not do

| Not included | Why | |---|---| | Validate your input | It could — the schema is published — and that would be worse: a client that validates can disagree with the server, and the likely direction of the error is the dangerous one (approving what the server will reject). The server validates, and its refusal travels with a name. What this client gives you is the shape, in your editor, before sending anything. | | Read anything | This API exposes verbs, not rows. There is nothing to list or paginate. | | Retry on its own | A retry is a decision about your idempotency key. The client keeps it explicit. |

Support

| | | |---|---| | Versioning | Semantic. Every visible change is in the changelog of the API reference. | | Regeneration | This repository is generated from the niiko action manifest. When an action opens or a contract changes, a new version is published — nothing here is edited by hand. | | Issues | vorluno/niiko-sdk-typescript/issues — a fault of the API itself starts at developers.niiko.org. | | Security | [email protected] — first response within 48 hours, patch or plan within 7 days. |

Related

• niiko (Python) — the Python client, same plan.
• niiko-cli — the same actions from the terminal, with the outcome in the exit code.
• n8n-nodes-niiko — the same actions as an n8n node.
• niiko-mcp-server — the same actions as MCP tools, for Claude and other AI clients.
• developers.niiko.org — the API reference this is generated alongside.

Built and maintained by Vorluno, a software studio in Panama, and generated from niiko's production action manifest — the same one the server enforces. Apache 2.0.