@whatsapi.sh/sdk 0.1.0

package/dist/generated/contract.d.ts

@@ -0,0 +1,318 @@
+/** Canonical error codes. The web client can switch on these / map them to i18n. */
+export type ErrorCode = "VALIDATION_ERROR" | "UNAUTHORIZED" | "INVALID_TOKEN" | "FORBIDDEN" | "NOT_FOUND" | "CONFLICT" | "PAYMENT_REQUIRED" | "RATE_LIMIT_EXCEEDED" | "QUOTA_EXCEEDED" | "NUMBER_NOT_CONNECTED" | "PAIRING_COOLDOWN" | "OTP_INVALID" | "GATEWAY_ERROR" | "GATEWAY_TIMEOUT" | "INTERNAL_ERROR" | "SERVICE_UNAVAILABLE";
+export type PlanId = "free" | "starter" | "pro" | "scale";
+/** A number's lifecycle: created (no session) → connected (session live) →
+ *  disconnected (dropped) / banned (restriction signal — see docs/QUIRKS.md). */
+export type NumberStatus = "pairing" | "connected" | "disconnected" | "banned";
+/** A WhatsApp number (a paired session), server-projected — never carries the
+ *  gateway instance id or token. */
+export interface NumberDto {
+    id: string;
+    name: string;
+    phone: string | null;
+    status: NumberStatus;
+    connectedAt: string | null;
+    historySync: boolean;
+    createdAt: string;
+}
+/** Answer to POST /numbers/:id/pair. `state` tells the client what to render:
+ *  "pairing" (show the QR/linking code, or poll again when both are absent —
+ *  wuzapi can take ~5s to mint a QR after connect), "connected" (already live). */
+export interface PairNumberDto {
+    mode: "qr" | "code";
+    state: "pairing" | "connected";
+    /** Base64 QR (mode qr, when ready). */
+    qrCode?: string;
+    /** XXXX-XXXX linking code (mode code). */
+    linkingCode?: string;
+    /** True when the QR is the cached one from an earlier generation. */
+    isCached: boolean;
+    /** Epoch ms of generation — the client resumes its countdown from this. */
+    generatedAt?: number;
+    /** Seconds until a NEW QR may be generated (0 when fresh). */
+    remainingCooldown: number;
+}
+/** POST /v1/numbers/{id}/unpair — the slot stays, the WhatsApp session is gone. */
+export interface UnpairedNumberDto {
+    id: string;
+    status: "disconnected";
+}
+/** DELETE /v1/numbers/{id} — the slot itself is gone, and the plan's seat is free. */
+export interface DeletedNumberDto {
+    id: string;
+    deleted: true;
+}
+/** A message WhatsApp accepted. `sent` is the only success state the send call
+ *  can report — delivered/read arrive later on the `message.status` webhook. */
+export interface MessageDto {
+    /** WhatsApp's message id — the same id the status webhooks carry. */
+    id: string;
+    /** E.164 recipient the message actually went to. */
+    to: string;
+    /** Id of the number that sent it (useful when the account has several). */
+    from: string;
+    status: "sent";
+    timestamp: string;
+    /** Messages left in this month's PLAN quota after this send — so a client can
+     *  show a meter without a second call. Hits 0 while sends keep working if the
+     *  account has credits: the two pools are reported separately on purpose. */
+    quotaRemaining: number;
+    /** Purchased messages left (packs never expire). Sends spill here once
+     *  `quotaRemaining` is 0, so a client that stops at `quotaRemaining === 0`
+     *  and ignores this one stops earlier than it had to. */
+    creditRemaining: number;
+}
+/** One recipient's outcome inside a batch. `skipped` is not a failure of its
+ *  own: something systemic (the session died, the meter refused) stopped the
+ *  run, and these are the recipients never attempted — send them again once the
+ *  reason on the batch is cleared. */
+export interface BatchResultDto {
+    to: string;
+    status: "sent" | "failed" | "skipped";
+    /** Present on `sent`. */
+    id?: string;
+    /** Present on `failed` and `skipped` — the same code the single-send
+     *  endpoint would have answered with. */
+    error?: {
+        code: ErrorCode;
+        message: string;
+    };
+}
+/** POST /v1/messages/batch. Always a 200 with per-recipient outcomes: a batch
+ *  where 24 of 25 landed is neither a success nor a failure, and collapsing it
+ *  into one status code would throw away the only part that matters. */
+export interface BatchMessageDto {
+    sent: number;
+    failed: number;
+    skipped: number;
+    /** Why the run stopped early, when it did. */
+    stoppedBecause?: {
+        code: ErrorCode;
+        message: string;
+    };
+    results: BatchResultDto[];
+    /** Messages left in this month's plan quota after the batch. */
+    quotaRemaining: number;
+    /** Purchased messages left after the batch — see `MessageDto.creditRemaining`. */
+    creditRemaining: number;
+}
+/** POST /v1/chats/{phone}/typing. Free, so there is no quota to report — it
+ *  echoes what it did, and `to` is the address the indicator went to. */
+export interface TypingDto {
+    to: string;
+    state: "composing" | "paused";
+}
+/** POST /v1/chats/{phone}/read — the ids that now carry blue ticks. */
+export interface MarkReadDto {
+    to: string;
+    messageIds: string[];
+}
+/** POST /v1/otp — the code is returned to the CALLER (that's the whole point of
+ *  the endpoint: send it and hand it back so the app can verify however it
+ *  likes). Only its hash is stored. */
+export interface OtpDto {
+    code: string;
+    expiresAt: string;
+    to: string;
+    /** The WhatsApp message that carried the code. */
+    messageId: string;
+}
+/** POST /v1/otp/check succeeds or throws OTP_INVALID — never `{ verified: false }`.
+ *  A verification primitive that answers 200 to a wrong code is one forgotten
+ *  `if` away from letting anyone in. */
+export interface OtpCheckDto {
+    verified: true;
+    to: string;
+}
+/** GET /v1/numbers/check/{phone} — is this phone on WhatsApp? */
+export interface NumberCheckDto {
+    /** E.164 of the variant WhatsApp actually matched: a Brazilian mobile may be
+     *  registered with or without the 9th digit, and we check both. */
+    e164: string;
+    hasWhatsApp: boolean;
+    /** The address to send to. Null when the number isn't on WhatsApp. */
+    jid: string | null;
+    avatarUrl: string | null;
+    /** False when WhatsApp couldn't be reached and `hasWhatsApp` is an optimistic
+     *  assumption — a check outage must never block sends to real recipients
+     *  (docs/QUIRKS.md — number-check fail-open). */
+    verified: boolean;
+}
+/** GET /v1/usage — this month's spend against the plan, plus the per-key split. */
+export interface UsageDto {
+    plan: PlanId;
+    /** "2026-08" (America/Sao_Paulo). */
+    month: string;
+    monthUsed: number;
+    monthLimit: number;
+    dayUsed: number;
+    dayLimit: number;
+    sendsPerMinute: number;
+    creditBalance: number;
+    /** When the monthly counter rolls over. */
+    resetAt: string;
+    /** Per-key breakdown, newest first. Revoked keys stay listed — their usage
+     *  still counts toward the account total, and a month's spend that vanished
+     *  when a key was rotated would look like a billing error. `revoked` is what
+     *  tells the two apart. */
+    keys: {
+        id: string;
+        name: string;
+        prefix: string;
+        used: number;
+        revoked: boolean;
+    }[];
+}
+/** Every event an endpoint can subscribe to.
+ *
+ *  Deliberately FIVE, normalized out of wuzapi's ~50 provider events: an
+ *  inbound message, a status change on one we sent, and the three moments a
+ *  number's session changes hands. Everything else (presence, chat presence,
+ *  history sync, group metadata) is either noise to an API customer or
+ *  privacy-sensitive, and is dropped at the ingestion boundary. */
+export declare const WEBHOOK_EVENT_TYPES: readonly ["message.created", "message.status", "number.connected", "number.disconnected", "number.logged_out"];
+export type WebhookEventType = (typeof WEBHOOK_EVENT_TYPES)[number];
+/** The synthetic event `POST /v1/webhooks/test` fires. Not subscribable — it is
+ *  always delivered, because its whole job is proving the wiring works. */
+export declare const WEBHOOK_TEST_EVENT = "ping";
+export declare const WEBHOOK_DELIVERY_STATUSES: readonly ["pending", "delivered", "failed"];
+export type WebhookDeliveryStatus = (typeof WEBHOOK_DELIVERY_STATUSES)[number];
+/** The body of every delivery. `id` is also the `x-whatsapi-delivery` header:
+ *  retries reuse it, so a receiver that has seen an id can safely drop the
+ *  repeat. */
+export interface WebhookEnvelope<T = unknown> {
+    id: string;
+    type: WebhookEventType | typeof WEBHOOK_TEST_EVENT;
+    /** ISO 8601, when we built the event — not when we sent it. */
+    timestamp: string;
+    data: T;
+}
+/** The sending/receiving number, on every event. Enough to route without a
+ *  lookup, never the gateway instance or token. */
+export interface WebhookNumberRef {
+    id: string;
+    name: string;
+    phone: string | null;
+}
+export type InboundMessageType = "text" | "image" | "video" | "audio" | "document" | "location" | "contact" | "sticker" | "reaction" | "poll" | "other";
+/** `message.created`. Media arrives as metadata only: the gateway runs with
+ *  `-skipmedia`, so the bytes stay on WhatsApp's servers until asked for. */
+export interface MessageCreatedEvent {
+    number: WebhookNumberRef;
+    message: {
+        id: string;
+        /** The conversation: a phone number for a 1:1 chat, a group JID for a group. */
+        chat: string;
+        /** Who wrote it — the same as `chat` outside groups. */
+        from: string;
+        /** True when the message was sent BY this number (from the linked phone,
+         *  or by an earlier API call) rather than to it. */
+        fromMe: boolean;
+        isGroup: boolean;
+        /** The sender's WhatsApp display name, when they publish one. */
+        pushName?: string;
+        timestamp: string;
+        type: InboundMessageType;
+        /** Text body, for text messages. */
+        text?: string;
+        /** Caption, for media that carries one. */
+        caption?: string;
+        media?: {
+            mimeType?: string;
+            fileName?: string;
+            /** Audio/video length in seconds. */
+            seconds?: number;
+            bytes?: number;
+            /** True for a voice note rather than an audio file. */
+            voice?: boolean;
+        };
+    };
+}
+/** `message.status`. WhatsApp acks in batches, so one event can settle several
+ *  message ids at once. */
+export interface MessageStatusEvent {
+    number: WebhookNumberRef;
+    /** Ids as returned by the send call. */
+    messageIds: string[];
+    /** The chat the acks came from. */
+    chat: string;
+    status: "delivered" | "read" | "played";
+    timestamp: string;
+}
+/** `number.connected` · `number.disconnected` · `number.logged_out`. */
+export interface NumberStatusEvent {
+    number: WebhookNumberRef;
+    /** Why the session ended, when the provider said — "server", "logged_out",
+     *  "connection_failure", "ban". Absent on connect. */
+    reason?: string;
+}
+/** `ping` — what the test-fire delivers. Not subscribable; see WEBHOOK_TEST_EVENT. */
+export interface PingEvent {
+    message: string;
+}
+/** Which payload rides with which event. The map is what makes `WebhookEvent`
+ *  below a discriminated union — narrow on `type` and `data` narrows with it —
+ *  and it is load-bearing on the producing side too: the emitter's input is
+ *  typed from it, so an event can never be published with the wrong shape. */
+export interface WebhookPayloads {
+    "message.created": MessageCreatedEvent;
+    "message.status": MessageStatusEvent;
+    "number.connected": NumberStatusEvent;
+    "number.disconnected": NumberStatusEvent;
+    "number.logged_out": NumberStatusEvent;
+    ping: PingEvent;
+}
+/** Every delivery, as the receiver sees it:
+ *
+ *      if (event.type === "message.created") event.data.message.text
+ */
+export type WebhookEvent = {
+    [K in keyof WebhookPayloads]: WebhookEnvelope<WebhookPayloads[K]> & {
+        type: K;
+    };
+}[keyof WebhookPayloads];
+export interface WebhookEndpointDto {
+    url: string;
+    events: WebhookEventType[];
+    enabled: boolean;
+    /** Set when WE turned the endpoint off: "failures" after a long run of dead
+     *  deliveries. null while it is healthy. */
+    disabledReason: string | null;
+    /** Failed deliveries in a row. Resets on the first success. */
+    consecutiveFailures: number;
+    createdAt: string;
+    updatedAt: string;
+}
+/** The answer to `PUT /v1/webhooks`. `secret` is present ONLY when one was just
+ *  minted (first registration, or `rotateSecret: true`) — it is never
+ *  retrievable afterwards, exactly like an API key. */
+export interface SavedWebhookDto {
+    secret: string | null;
+    record: WebhookEndpointDto;
+}
+export interface WebhookDeliveryDto {
+    /** Also the `x-whatsapi-delivery` header of the POST. */
+    id: string;
+    event: string;
+    status: WebhookDeliveryStatus;
+    attempts: number;
+    /** The HTTP status the endpoint answered, when it answered at all. */
+    responseStatus: number | null;
+    error: string | null;
+    createdAt: string;
+    deliveredAt: string | null;
+}
+/** The synchronous outcome of `POST /v1/webhooks/test`. */
+export interface WebhookTestResultDto {
+    ok: boolean;
+    status: number | null;
+    error: string | null;
+    /** The delivery it was recorded as — it shows up in the delivery list too. */
+    deliveryId: string;
+}
+/** DELETE /v1/webhooks. `false` when there was nothing registered to delete —
+ *  the end state is the same either way, so it is not an error. */
+export interface DeletedWebhookDto {
+    deleted: boolean;
+}
+//# sourceMappingURL=contract.d.ts.map

package/dist/generated/contract.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contract.d.ts","sourceRoot":"","sources":["../../src/generated/contract.ts"],"names":[],"mappings":"AAOA,oFAAoF;AACpF,MAAM,MAAM,SAAS,GACf,kBAAkB,GAClB,cAAc,GACd,eAAe,GACf,WAAW,GACX,WAAW,GACX,UAAU,GAIV,kBAAkB,GAGlB,qBAAqB,GACrB,gBAAgB,GAGhB,sBAAsB,GAItB,kBAAkB,GAClB,aAAa,GACb,eAAe,GAKf,iBAAiB,GACjB,gBAAgB,GAChB,qBAAqB,CAAC;AAG5B,MAAM,MAAM,MAAM,GAAG,MAAM,GAAG,SAAS,GAAG,KAAK,GAAG,OAAO,CAAC;AAG1D;iFACiF;AACjF,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,WAAW,GAAG,cAAc,GAAG,QAAQ,CAAC;AAE/E;oCACoC;AACpC,MAAM,WAAW,SAAS;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,MAAM,EAAE,YAAY,CAAC;IACrB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,WAAW,EAAE,OAAO,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;CACrB;AAED;;mFAEmF;AACnF,MAAM,WAAW,aAAa;IAC1B,IAAI,EAAE,IAAI,GAAG,MAAM,CAAC;IACpB,KAAK,EAAE,SAAS,GAAG,WAAW,CAAC;IAC/B,uCAAuC;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,0CAA0C;IAC1C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,qEAAqE;IACrE,QAAQ,EAAE,OAAO,CAAC;IAClB,2EAA2E;IAC3E,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,8DAA8D;IAC9D,iBAAiB,EAAE,MAAM,CAAC;CAC7B;AAED,mFAAmF;AACnF,MAAM,WAAW,iBAAiB;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,cAAc,CAAC;CAC1B;AAED,sFAAsF;AACtF,MAAM,WAAW,gBAAgB;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,IAAI,CAAC;CACjB;AAED;gFACgF;AAChF,MAAM,WAAW,UAAU;IACvB,qEAAqE;IACrE,EAAE,EAAE,MAAM,CAAC;IACX,oDAAoD;IACpD,EAAE,EAAE,MAAM,CAAC;IACX,2EAA2E;IAC3E,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB;;iFAE6E;IAC7E,cAAc,EAAE,MAAM,CAAC;IACvB;;6DAEyD;IACzD,eAAe,EAAE,MAAM,CAAC;CAC3B;AAED;;;sCAGsC;AACtC,MAAM,WAAW,cAAc;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAC;IACtC,yBAAyB;IACzB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ;6CACyC;IACzC,KAAK,CAAC,EAAE;QAAE,IAAI,EAAE,SAAS,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;CAChD;AAED;;wEAEwE;AACxE,MAAM,WAAW,eAAe;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,8CAA8C;IAC9C,cAAc,CAAC,EAAE;QAAE,IAAI,EAAE,SAAS,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IACtD,OAAO,EAAE,cAAc,EAAE,CAAC;IAC1B,gEAAgE;IAChE,cAAc,EAAE,MAAM,CAAC;IACvB,kFAAkF;IAClF,eAAe,EAAE,MAAM,CAAC;CAC3B;AAED;yEACyE;AACzE,MAAM,WAAW,SAAS;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,WAAW,GAAG,QAAQ,CAAC;CACjC;AAED,uEAAuE;AACvE,MAAM,WAAW,WAAW;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,EAAE,CAAC;CACxB;AAED;;uCAEuC;AACvC,MAAM,WAAW,MAAM;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,EAAE,EAAE,MAAM,CAAC;IACX,kDAAkD;IAClD,SAAS,EAAE,MAAM,CAAC;CACrB;AAED;;wCAEwC;AACxC,MAAM,WAAW,WAAW;IACxB,QAAQ,EAAE,IAAI,CAAC;IACf,EAAE,EAAE,MAAM,CAAC;CACd;AAED,iEAAiE;AACjE,MAAM,WAAW,cAAc;IAC3B;uEACmE;IACnE,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,OAAO,CAAC;IACrB,sEAAsE;IACtE,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB;;qDAEiD;IACjD,QAAQ,EAAE,OAAO,CAAC;CACrB;AAED,mFAAmF;AACnF,MAAM,WAAW,QAAQ;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,qCAAqC;IACrC,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;IACvB,aAAa,EAAE,MAAM,CAAC;IACtB,2CAA2C;IAC3C,OAAO,EAAE,MAAM,CAAC;IAChB;;;+BAG2B;IAC3B,IAAI,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,OAAO,CAAA;KAAE,EAAE,CAAC;CACxF;AAGD;;;;;;mEAMmE;AACnE,eAAO,MAAM,mBAAmB,gHActB,CAAC;AAEX,MAAM,MAAM,gBAAgB,GAAG,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEpE;2EAC2E;AAC3E,eAAO,MAAM,kBAAkB,SAAS,CAAC;AAEzC,eAAO,MAAM,yBAAyB,6CAA8C,CAAC;AAErF,MAAM,MAAM,qBAAqB,GAAG,CAAC,OAAO,yBAAyB,CAAC,CAAC,MAAM,CAAC,CAAC;AAE/E;;cAEc;AACd,MAAM,WAAW,eAAe,CAAC,CAAC,GAAG,OAAO;IACxC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,gBAAgB,GAAG,OAAO,kBAAkB,CAAC;IACnD,+DAA+D;IAC/D,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,CAAC,CAAC;CACX;AAED;mDACmD;AACnD,MAAM,WAAW,gBAAgB;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,MAAM,kBAAkB,GACxB,MAAM,GACN,OAAO,GACP,OAAO,GACP,OAAO,GACP,UAAU,GACV,UAAU,GACV,SAAS,GACT,SAAS,GACT,UAAU,GACV,MAAM,GACN,OAAO,CAAC;AAEd;6EAC6E;AAC7E,MAAM,WAAW,mBAAmB;IAChC,MAAM,EAAE,gBAAgB,CAAC;IACzB,OAAO,EAAE;QACL,EAAE,EAAE,MAAM,CAAC;QACX,gFAAgF;QAChF,IAAI,EAAE,MAAM,CAAC;QACb,wDAAwD;QACxD,IAAI,EAAE,MAAM,CAAC;QACb;4DACoD;QACpD,MAAM,EAAE,OAAO,CAAC;QAChB,OAAO,EAAE,OAAO,CAAC;QACjB,iEAAiE;QACjE,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,SAAS,EAAE,MAAM,CAAC;QAClB,IAAI,EAAE,kBAAkB,CAAC;QACzB,oCAAoC;QACpC,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,2CAA2C;QAC3C,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,KAAK,CAAC,EAAE;YACJ,QAAQ,CAAC,EAAE,MAAM,CAAC;YAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;YAClB,qCAAqC;YACrC,OAAO,CAAC,EAAE,MAAM,CAAC;YACjB,KAAK,CAAC,EAAE,MAAM,CAAC;YACf,uDAAuD;YACvD,KAAK,CAAC,EAAE,OAAO,CAAC;SACnB,CAAC;KACL,CAAC;CACL;AAED;2BAC2B;AAC3B,MAAM,WAAW,kBAAkB;IAC/B,MAAM,EAAE,gBAAgB,CAAC;IACzB,wCAAwC;IACxC,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,mCAAmC;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,WAAW,GAAG,MAAM,GAAG,QAAQ,CAAC;IACxC,SAAS,EAAE,MAAM,CAAC;CACrB;AAED,wEAAwE;AACxE,MAAM,WAAW,iBAAiB;IAC9B,MAAM,EAAE,gBAAgB,CAAC;IACzB;0DACsD;IACtD,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,sFAAsF;AACtF,MAAM,WAAW,SAAS;IACtB,OAAO,EAAE,MAAM,CAAC;CACnB;AAED;;;8EAG8E;AAC9E,MAAM,WAAW,eAAe;IAC5B,iBAAiB,EAAE,mBAAmB,CAAC;IACvC,gBAAgB,EAAE,kBAAkB,CAAC;IACrC,kBAAkB,EAAE,iBAAiB,CAAC;IACtC,qBAAqB,EAAE,iBAAiB,CAAC;IACzC,mBAAmB,EAAE,iBAAiB,CAAC;IACvC,IAAI,EAAE,SAAS,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG;KACtB,CAAC,IAAI,MAAM,eAAe,GAAG,eAAe,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,GAAG;QAAE,IAAI,EAAE,CAAC,CAAA;KAAE;CAClF,CAAC,MAAM,eAAe,CAAC,CAAC;AAEzB,MAAM,WAAW,kBAAkB;IAC/B,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,gBAAgB,EAAE,CAAC;IAC3B,OAAO,EAAE,OAAO,CAAC;IACjB;gDAC4C;IAC5C,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,+DAA+D;IAC/D,mBAAmB,EAAE,MAAM,CAAC;IAC5B,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACrB;AAED;;uDAEuD;AACvD,MAAM,WAAW,eAAe;IAC5B,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,MAAM,EAAE,kBAAkB,CAAC;CAC9B;AAED,MAAM,WAAW,kBAAkB;IAC/B,yDAAyD;IACzD,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,qBAAqB,CAAC;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,sEAAsE;IACtE,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED,2DAA2D;AAC3D,MAAM,WAAW,oBAAoB;IACjC,EAAE,EAAE,OAAO,CAAC;IACZ,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,8EAA8E;IAC9E,UAAU,EAAE,MAAM,CAAC;CACtB;AAED;mEACmE;AACnE,MAAM,WAAW,iBAAiB;IAC9B,OAAO,EAAE,OAAO,CAAC;CACpB"}

package/dist/generated/contract.js

@@ -0,0 +1,32 @@
+// GENERATED FILE — do not edit. Run `bun run sdk:gen`.
+// Source: packages/shared/src/http/index.ts, packages/shared/src/billing/catalog.ts, packages/shared/src/dto/index.ts, packages/shared/src/webhooks/index.ts
+//
+// The shapes the API speaks, lifted from the server's own contract.
+// ── from packages/shared/src/webhooks/index.ts ───────────────────────
+/** Every event an endpoint can subscribe to.
+ *
+ *  Deliberately FIVE, normalized out of wuzapi's ~50 provider events: an
+ *  inbound message, a status change on one we sent, and the three moments a
+ *  number's session changes hands. Everything else (presence, chat presence,
+ *  history sync, group metadata) is either noise to an API customer or
+ *  privacy-sensitive, and is dropped at the ingestion boundary. */
+export const WEBHOOK_EVENT_TYPES = [
+    /** Someone messaged one of your numbers. The payload carries the text (or
+     *  the media's metadata), never the media bytes. */
+    "message.created",
+    /** WhatsApp reported delivery/read/played for messages you sent. */
+    "message.status",
+    /** A number's WhatsApp session came up and can send again. */
+    "number.connected",
+    /** A number's session dropped and did not come back on its own — it needs
+     *  re-pairing. */
+    "number.disconnected",
+    /** WhatsApp logged the number out or restricted it. Sends will fail until
+     *  it is paired again; see the 24h restriction window in the docs. */
+    "number.logged_out",
+];
+/** The synthetic event `POST /v1/webhooks/test` fires. Not subscribable — it is
+ *  always delivered, because its whole job is proving the wiring works. */
+export const WEBHOOK_TEST_EVENT = "ping";
+export const WEBHOOK_DELIVERY_STATUSES = ["pending", "delivered", "failed"];
+//# sourceMappingURL=contract.js.map

package/dist/generated/contract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contract.js","sourceRoot":"","sources":["../../src/generated/contract.ts"],"names":[],"mappings":"AAAA,uDAAuD;AACvD,6JAA6J;AAC7J,EAAE;AACF,oEAAoE;AA4MpE,wEAAwE;AAExE;;;;;;mEAMmE;AACnE,MAAM,CAAC,MAAM,mBAAmB,GAAG;IAC/B;wDACoD;IACpD,iBAAiB;IACjB,oEAAoE;IACpE,gBAAgB;IAChB,8DAA8D;IAC9D,kBAAkB;IAClB;sBACkB;IAClB,qBAAqB;IACrB;0EACsE;IACtE,mBAAmB;CACb,CAAC;AAIX;2EAC2E;AAC3E,MAAM,CAAC,MAAM,kBAAkB,GAAG,MAAM,CAAC;AAEzC,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,SAAS,EAAE,WAAW,EAAE,QAAQ,CAAU,CAAC"}

package/dist/generated/operations.d.ts

@@ -0,0 +1,240 @@
+import type { RequestSpec } from "../client.ts";
+import type { BatchMessageDto, DeletedNumberDto, DeletedWebhookDto, MarkReadDto, MessageDto, NumberCheckDto, NumberDto, OtpCheckDto, OtpDto, PairNumberDto, SavedWebhookDto, TypingDto, UnpairedNumberDto, UsageDto, WebhookDeliveryDto, WebhookEndpointDto, WebhookTestResultDto } from "./contract.ts";
+import type { CheckNumberParams, CheckOtpParams, CreateNumberParams, DeleteNumberParams, ListWebhookDeliveriesParams, MarkReadParams, NumberStatusParams, PairNumberParams, SendBatchParams, SendContactParams, SendLocationParams, SendMediaParams, SendMessageParams, SendOtpParams, SetWebhookParams, TypingParams, UnpairNumberParams } from "./params.ts";
+/** The version this client reports in `x-whatsapi-client`. */
+export declare const SDK_VERSION = "0.1.0";
+/** The hosted API. */
+export declare const DEFAULT_BASE_URL = "https://api.whatsapi.sh/v1";
+export declare abstract class GeneratedOperations {
+    protected abstract request<T>(spec: RequestSpec, params?: object): Promise<T>;
+    /**
+     * Send a WhatsApp message
+     *
+     * Send a text message to a phone number over WhatsApp. Counts as one message against the
+     * account's monthly quota. The reply carries WhatsApp's message id — delivery and read
+     * receipts arrive later on the account's webhook, not here.
+     *
+     * `POST /messages`
+     */
+    sendMessage(params: SendMessageParams): Promise<MessageDto>;
+    /**
+     * Send a photo, video, voice note or file
+     *
+     * Send media over WhatsApp from a public URL or base64 data. `type` picks the bubble the
+     * recipient sees: `image` and `video` support a caption, `document` is a file attachment named
+     * by `fileName`, and `audio` becomes a voice note when the file is ogg/opus — any other audio
+     * format is sent as a playable attachment instead, because WhatsApp will not render a voice
+     * note that is not opus. Files are capped at 16MB, and `url` beats `base64` for anything
+     * sizeable. Counts as one message.
+     *
+     * `POST /messages/media`
+     */
+    sendMedia(params: SendMediaParams): Promise<MessageDto>;
+    /**
+     * Send one text to many recipients
+     *
+     * Send the same text to up to 25 recipients in one call — one message, and one message's worth
+     * of quota, per recipient. The answer reports each recipient separately: a batch where some
+     * land and some do not is the normal case, not an error. If something systemic stops the run
+     * (the number drops its session, the quota or rate limit refuses) the remaining recipients
+     * come back as `skipped` rather than being attempted, so they can be sent again once that is
+     * cleared. Sends inside a batch leave back-to-back, so keep lists small and space calls
+     * minutes apart — pacing keeps your number off WhatsApp's spam radar (see the avoiding-bans
+     * guide). Paid plans only.
+     *
+     * `POST /messages/batch`
+     */
+    sendBatch(params: SendBatchParams): Promise<BatchMessageDto>;
+    /**
+     * Send a location pin
+     *
+     * Send a map pin over WhatsApp. Counts as one message.
+     *
+     * `POST /messages/location`
+     */
+    sendLocation(params: SendLocationParams): Promise<MessageDto>;
+    /**
+     * Send a contact card
+     *
+     * Send a contact card (vCard) over WhatsApp, so the recipient can save the number with one
+     * tap. Counts as one message.
+     *
+     * `POST /messages/contact`
+     */
+    sendContact(params: SendContactParams): Promise<MessageDto>;
+    /**
+     * Send a verification code
+     *
+     * Generate a 6-digit code, send it over WhatsApp and return it. Returning the code is
+     * deliberate: verify it yourself, or hand it back to check_otp and keep nothing. Codes expire
+     * in 5 minutes by default and one number can only be sent a new code once a minute. Counts as
+     * one message.
+     *
+     * `POST /otp`
+     */
+    sendOtp(params: SendOtpParams): Promise<OtpDto>;
+    /**
+     * Check a verification code
+     *
+     * Verify a code sent with send_otp and consume it, so it can never be used twice. A wrong or
+     * expired code answers 400 OTP_INVALID — deliberately an error, not a `verified: false`, so a
+     * missing check at the caller can never read as success. Five wrong guesses kill the code.
+     * Free.
+     *
+     * `POST /otp/check`
+     */
+    checkOtp(params: CheckOtpParams): Promise<OtpCheckDto>;
+    /**
+     * List your WhatsApp numbers
+     *
+     * Every WhatsApp number on the account with its connection status. Start here when you do not
+     * know which number to send from, or to check whether one needs re-pairing. Free.
+     *
+     * `GET /numbers`
+     */
+    listNumbers(): Promise<NumberDto[]>;
+    /**
+     * Add a WhatsApp number
+     *
+     * Create a new WhatsApp number slot on the account and return it. This is step one of two: the
+     * slot starts `disconnected` and cannot send until pair_number links a real WhatsApp account
+     * to it. How many can exist at once is what the plan sells. Free.
+     *
+     * `POST /numbers`
+     */
+    createNumber(params: CreateNumberParams): Promise<NumberDto>;
+    /**
+     * Check whether a phone is on WhatsApp
+     *
+     * Ask WhatsApp whether a phone number has an account, and get its profile picture when it
+     * does. Brazilian mobiles are checked with and without the extra 9 and the answer reports the
+     * form that actually matched. If WhatsApp cannot be reached the answer assumes yes and sets
+     * `verified: false` — an outage must not block sends to real people. Free.
+     *
+     * `GET /numbers/check/:phone`
+     */
+    checkNumber(params: CheckNumberParams): Promise<NumberCheckDto>;
+    /**
+     * Get one number's status
+     *
+     * One number's current state: `connected` (ready to send), `pairing` (waiting for a scan),
+     * `disconnected` (session dropped — pair it again) or `banned` (WhatsApp restricted it; wait
+     * out the 24h window before reconnecting). Free.
+     *
+     * `GET /numbers/:id`
+     */
+    numberStatus(params: NumberStatusParams): Promise<NumberDto>;
+    /**
+     * Pair a number with WhatsApp
+     *
+     * Start (or resume) linking a WhatsApp account to one of your numbers. `qr` returns a QR code
+     * to scan from WhatsApp → Linked devices; `code` returns an 8-character linking code to type
+     * there instead, and needs the phone number being linked. A QR lives ~90 seconds and a new one
+     * can only be minted every few minutes, so call again to poll: `state: "pairing"` with no code
+     * yet simply means it is still being minted. Free.
+     *
+     * `POST /numbers/:id/pair`
+     */
+    pairNumber(params: PairNumberParams): Promise<PairNumberDto>;
+    /**
+     * Disconnect a number from WhatsApp
+     *
+     * Log the linked WhatsApp account out of this number, keeping the number itself. Use it to
+     * link a different phone: a connected number cannot be re-paired until it is unpaired. Free.
+     *
+     * `POST /numbers/:id/unpair`
+     */
+    unpairNumber(params: UnpairNumberParams): Promise<UnpairedNumberDto>;
+    /**
+     * Delete a number
+     *
+     * Remove a number from the account for good, logging its WhatsApp session out on the way. This
+     * frees a slot against the plan's limit. Messages already sent are unaffected, and the usage
+     * they cost stays on the bill. Free, and not reversible.
+     *
+     * `DELETE /numbers/:id`
+     */
+    deleteNumber(params: DeleteNumberParams): Promise<DeletedNumberDto>;
+    /**
+     * Show the typing indicator
+     *
+     * Show (or clear) the “typing…” indicator in a chat. Free — it is not a message. WhatsApp
+     * clears it on its own after a few seconds, so call it again for a long reply.
+     *
+     * `POST /chats/:phone/typing`
+     */
+    typing(params: TypingParams): Promise<TypingDto>;
+    /**
+     * Mark messages as read
+     *
+     * Put blue ticks on messages your number received in a chat. Free. Message ids come from the
+     * inbound webhook.
+     *
+     * `POST /chats/:phone/read`
+     */
+    markRead(params: MarkReadParams): Promise<MarkReadDto>;
+    /**
+     * Get your webhook endpoint
+     *
+     * The endpoint events are being POSTed to, which ones it is subscribed to, and whether it is
+     * still healthy. `null` when none is registered. `disabledReason: "failures"` means we stopped
+     * delivering after a long run of dead attempts — fix the endpoint and set it again (or fire a
+     * test) to switch it back on. Free.
+     *
+     * `GET /webhooks`
+     */
+    getWebhook(): Promise<WebhookEndpointDto | null>;
+    /**
+     * Register your webhook endpoint
+     *
+     * Point whatsapi.sh at an https URL and start receiving events there. The answer carries the
+     * signing secret ONCE, on first registration: keep it — every delivery is signed with it in
+     * the `x-whatsapi-signature` header (`t=<unix>,v1=<hmac-sha256 of "<t>.<body>">`), and that
+     * signature is how you know a request is really from us. Calling this again updates the URL or
+     * the subscription and keeps the same secret unless you ask to rotate it. Saving also
+     * re-enables an endpoint we had disabled. Free.
+     *
+     * `PUT /webhooks`
+     */
+    setWebhook(params: SetWebhookParams): Promise<SavedWebhookDto>;
+    /**
+     * Fire a test event at your endpoint
+     *
+     * Send a `ping` event to your registered endpoint right now and wait for the answer, so you
+     * can verify the URL and your signature check without waiting for a real message. The result
+     * is the actual outcome: `ok: false` carries the HTTP status your server answered, or why we
+     * could not reach it. A successful ping also revives an endpoint we had auto-disabled. Free.
+     *
+     * `POST /webhooks/test`
+     */
+    testWebhook(): Promise<WebhookTestResultDto>;
+    /**
+     * Recent webhook deliveries
+     *
+     * The last deliveries we attempted, newest first — what we sent, what your endpoint answered,
+     * and how many attempts it took. This is the answer to “the event never arrived”. Deliveries
+     * are kept for a week. Free.
+     *
+     * `GET /webhooks/deliveries`
+     */
+    listWebhookDeliveries(params?: ListWebhookDeliveriesParams): Promise<WebhookDeliveryDto[]>;
+    /**
+     * Remove your webhook endpoint
+     *
+     * Stop sending events and forget the endpoint, its secret and its delivery history.
+     * Registering again mints a new secret. Free.
+     *
+     * `DELETE /webhooks`
+     */
+    deleteWebhook(): Promise<DeletedWebhookDto>;
+    /**
+     * Check quota and usage
+     *
+     * Messages sent this month against the plan quota, today against the daily fair-use cap, the
+     * leftover credit balance, and the per-key breakdown. Read this before a bulk send. Free.
+     *
+     * `GET /usage`
+     */
+    getUsage(): Promise<UsageDto>;
+}
+//# sourceMappingURL=operations.d.ts.map

package/dist/generated/operations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"operations.d.ts","sourceRoot":"","sources":["../../src/generated/operations.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAChD,OAAO,KAAK,EACR,eAAe,EACf,gBAAgB,EAChB,iBAAiB,EACjB,WAAW,EACX,UAAU,EACV,cAAc,EACd,SAAS,EACT,WAAW,EACX,MAAM,EACN,aAAa,EACb,eAAe,EACf,SAAS,EACT,iBAAiB,EACjB,QAAQ,EACR,kBAAkB,EAClB,kBAAkB,EAClB,oBAAoB,EACvB,MAAM,eAAe,CAAC;AACvB,OAAO,KAAK,EACR,iBAAiB,EACjB,cAAc,EACd,kBAAkB,EAClB,kBAAkB,EAClB,2BAA2B,EAC3B,cAAc,EACd,kBAAkB,EAClB,gBAAgB,EAChB,eAAe,EACf,iBAAiB,EACjB,kBAAkB,EAClB,eAAe,EACf,iBAAiB,EACjB,aAAa,EACb,gBAAgB,EAChB,YAAY,EACZ,kBAAkB,EACrB,MAAM,aAAa,CAAC;AAErB,8DAA8D;AAC9D,eAAO,MAAM,WAAW,UAAU,CAAC;AAEnC,sBAAsB;AACtB,eAAO,MAAM,gBAAgB,+BAA+B,CAAC;AAE7D,8BAAsB,mBAAmB;IACrC,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAE7E;;;;;;;;OAQG;IACH,WAAW,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,UAAU,CAAC;IAI3D;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,UAAU,CAAC;IAIvD;;;;;;;;;;;;;OAaG;IACH,SAAS,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;IAI5D;;;;;;OAMG;IACH,YAAY,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,CAAC;IAI7D;;;;;;;OAOG;IACH,WAAW,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,UAAU,CAAC;IAI3D;;;;;;;;;OASG;IACH,OAAO,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC;IAI/C;;;;;;;;;OASG;IACH,QAAQ,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC;IAItD;;;;;;;OAOG;IACH,WAAW,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;IAInC;;;;;;;;OAQG;IACH,YAAY,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,SAAS,CAAC;IAI5D;;;;;;;;;OASG;IACH,WAAW,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,cAAc,CAAC;IAO/D;;;;;;;;OAQG;IACH,YAAY,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,SAAS,CAAC;IAO5D;;;;;;;;;;OAUG;IACH,UAAU,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,aAAa,CAAC;IAO5D;;;;;;;OAOG;IACH,YAAY,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAOpE;;;;;;;;OAQG;IACH,YAAY,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAOnE;;;;;;;OAOG;IACH,MAAM,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,SAAS,CAAC;IAOhD;;;;;;;OAOG;IACH,QAAQ,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC;IAOtD;;;;;;;;;OASG;IACH,UAAU,IAAI,OAAO,CAAC,kBAAkB,GAAG,IAAI,CAAC;IAIhD;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,eAAe,CAAC;IAI9D;;;;;;;;;OASG;IACH,WAAW,IAAI,OAAO,CAAC,oBAAoB,CAAC;IAI5C;;;;;;;;OAQG;IACH,qBAAqB,CAAC,MAAM,CAAC,EAAE,2BAA2B,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAI1F;;;;;;;OAOG;IACH,aAAa,IAAI,OAAO,CAAC,iBAAiB,CAAC;IAI3C;;;;;;;OAOG;IACH,QAAQ,IAAI,OAAO,CAAC,QAAQ,CAAC;CAGhC"}