Client SDK

npm install @zendfi/appkit

import { init, ZendError } from "@zendfi/appkit";

const zend = init();

pay(p: {
  to: `@${string}`;
  note?: string;
  reference?: string;
  interactionId?: string;
  splits?: { to: "app" | `@${string}`; percent?: number; amount?: number }[];
} & ({ amount: number } | { price: { ngn: number } })): Promise<{ paymentId: string; status: string }>

request(p: {
  amount?: number;
  price?: { ngn: number };
  note?: string;
  maxPayments?: number;
  reference?: string;
}): Promise<{ id: string; url: string }>

createLink(p: { uses?: number; note?: string; reference?: string }
  & ({ amount: number } | { price: { ngn: number } })): Promise<{ id: string; status: string }>

allowance.request(p?: { perPayment?: { ngn: number }; perDay?: { ngn: number } }): Promise<Allowance | null>
allowance.get(): Promise<Allowance | null>

prize.create(p: {
  joinInSecs: number; resolveInSecs: number; maxPlayers: number;
  disputeSecs?: number; reference?: string; interactionId?: string;
} & ({ amount: number } | { price: { ngn: number } })): Promise<Prize>
prize.join(id: string): Promise<Prize>
prize.cancel(id: string): Promise<Prize>
prize.get(id: string): Promise<Prize>

interaction.create(p: {
  type: string;
  participants?: string[];      // @username, zu_..., or a pick token
  data?: Record<string, unknown>;
  visibility?: "participants" | "friends" | "public";
  expiresInSecs?: number;
  reuseOpen?: boolean;
}): Promise<Interaction>

interaction.get(id: string): Promise<Interaction>

interaction.update(id: string, p: {
  state: string;
  data?: Record<string, unknown>;
  idempotencyKey: string;
  expectedVersion?: number;
}): Promise<Interaction>

postCard(p: {
  interactionId: string;
  template: "result" | "invite" | "status";
  placement: "chat" | "feed";
  idempotencyKey: string;
  slots: {
    title: string;
    subtitle?: string;
    emoji?: string;
    media?: string;
    check?: boolean;
    buttons?: (
      | { label: string; action: "open_sheet"; path: string }
      | { label: string; action: "start_interaction"; type: string }
      | { label: string; action: "open_url"; url: string }
    )[];
  };
}): Promise<unknown>

live.join(interactionId: string): Promise<LiveRoom>

interface LiveRoom {
  send(data: unknown): Promise<void>;
  on(event: "message", fn: (m: { from: string; data: unknown; at: string }) => void): () => void;
  on(event: "presence", fn: (members: LiveMember[]) => void): () => void;
  on(event: "closed", fn: (reason: string) => void): () => void;
  on(event: "status", fn: (status: "connected" | "reconnecting" | "disconnected") => void): () => void;
  leave(): Promise<void>;
}

people.pick(p?: { max?: number; title?: string }): Promise<PickedPerson[]>

random(p: { interactionId: string; label: string } & (
  | { kind: "int"; n: number }
  | { kind: "shuffle"; n: number }
  | { kind: "pick"; n: number; k: number }
)): Promise<RandomResult>

attest(p: { label: string; dataHash: string; interactionId?: string }): Promise<AttestReceipt>

report(p: {
  reason: "scam" | "unfair_result" | "offensive" | "broken" | "other";
  detail?: string;
  interactionId?: string;
  prizeId?: string;
}): Promise<void>

close(result?: unknown): Promise<void>