Approval

Approvals: the calls NoClick holds for your account's owner's yes, read and answered from your own code.

When an agent, a connected app, a key used through MCP or an app's own code makes a purchase, a deletion that can't be undone, a call your policy holds or one that raises a spending limit, NoClick holds the exact call and sends your account's owner a link to approve it. Your code may answer it too, with one of your account's secret keys that names the approvals:answer scope (a key with every scope, *, holds it only when it's named too):

for approval in noclick.Approval.list(status="pending"):
    if approval.price and approval.price["amount_usd"] <= 20:
        approval.approve(note="Under $20: fine.")

A key never answers a call made with it (by its own code, through MCP, or by an agent or app acting as it), never approves one whose terms a person accepts (it may decline it), and approves only what it could make itself: the scopes the call needs (never a call only the owner and their NoClick assistant make), and a price that fits the key's own monthly cap beside what it spent and approved this month (what it approves also counts against what it may still spend itself). NoClick then runs an approved call itself, once, exactly as it was held, with no scope the answering key lacks. While your account holds a key that would approve it, a call whose link reaches no person is still held, with an empty sent_to, for your code (or the owner, signed in) to answer.

class Approval

A call held for your account's owner's yes, as they see it on its page.

Attributes
idstring
statusApprovalStatus

Where it stands (used: approved, and run).

actionstring | null

What the call does, in a person's words.

priceJsonObject | null

A purchase's price (amount_usd, recurrence, terms, renewal); null for anything else.

reasonstring | null

Why it waits for a person.

operationstring

The API operation it calls, by name (phone_numbers_create).

methodstring | null
pathstring | null
argumentsJsonObject

Its arguments as the page shows them, secrets masked.

connectionJsonObject

Who made it: kind (assistant, agent, connected_app or key) and name.

userIdstring | null

The user it acts for (null for your account).

operationIdstring

The held call's operation: Operation.fromId(...).wait() gives what it returned once approved, or throws once declined or expired.

impactJsonObject | null

What a deletion takes with it; null for anything else.

consentJsonObject[]

Terms a person accepts by approving it (each terms, title, url): only the owner approves such a call.

sentTostring[]

Where NoClick sent the owner its link: whatsapp, imessage, email, or web (a card in the chat); empty when it reached nobody and waits for your code.

createdAtDate | null
expiresAtDate | null

When it lapses unanswered (a day after it was held).

decidedAtDate | null
decidedBy"owner" | "code" | null

Who decided: owner (signed in, or from NoClick's link) or code; null while pending.

decidedByKey{ key_id: string; key_name: string | null } | null

The key whose code decided (key_id, key_name); null otherwise.

notestring | null

What whoever decided wrote with it.

Types
type ApprovalStatus = "pending" | "approved" | "declined" | "expired" | "used" | "canceled";

type JsonObject = { [key: string]: unknown };

fromIdstatic

static fromId(
  approvalId: string,
  options?: Pick<CallOptions, "client">,
): Approval

A lazy reference to an approval by its id (an ApprovalRequired's approvalId).

Parameters
approvalIdstringrequired
options.clientNoClick

The client to send with; defaults to the module client built from NOCLICK_API_KEY.

Returns

The approval; it loads the first time it's used.

liststatic

static list(options?: ApprovalListOptions): Promise<Approval[]>

Calls held for your account's owner's yes, newest first: the first 20, or the first limit (at most 100). Acting for a user, that user's alone.

Parameters
options.statusApprovalStatus

One status; omitted, every one.

options.limitnumber

The first this many (20 unless you say, at most 100).

options.userUserOption

undefined = the ambient user (asUser), null = the account itself.

(defaults to the current user)
options.clientNoClick

The client to send with; defaults to the module client built from NOCLICK_API_KEY.

options.userFilterUserFilter

Which users the read covers (user_id query), instead of acting as one (user).

Returns

Each approval as its page shows it.

Types
type ApprovalStatus = "pending" | "approved" | "declined" | "expired" | "used" | "canceled";

/**
 * Which users a read covers: `ALL_USERS`, `NO_USER`, a `User` or your id for one. Sent as the
 * `user_id` query parameter, never as the `NoClick-User` header, so it filters without acting as the user.
 */
type UserFilter = typeof ALL_USERS | typeof NO_USER | UserRef;

/** A `User` or your own id for the user. */
type UserRef = string | UserLike;

/** Anything that can name a user lazily (a `User`). */
interface UserLike {
  _userId(): Promise<string>;
}

/** `undefined` = the ambient user (from `asUser`), `null` = the account itself. */
type UserOption = UserRef | null | undefined;

approve

approve(options?: { note?: string }): Promise<this>

Approve it from your own code, with one of your account's secret keys that names the approvals:answer scope; NoClick then runs the call itself, once, exactly as it was held. Throws PermissionDenied for the key the call was made with, a call whose terms a person accepts, one needing a scope the key lacks or only the owner makes, a key acting for a user, and a key without the scope; SpendCapExceeded when its price, beside what the key spent and approved this month, is past the key's own monthly cap.

Parameters
options.notestring
Returns

This approval, answered: status is approved, then used once the call ran; decided_by is code.

decline

decline(options?: { note?: string }): Promise<this>

Decline it from your own code, as approve answers it: the call never runs, and whoever made it is told why, with your note. A call whose terms a person accepts may be declined from code too.

Parameters
options.notestring
Returns

This approval, answered: status is declined.