palbase 0.0.0-stage → 0.2.0

package/types/internal/src/modules/notify.d.ts

@@ -0,0 +1,1450 @@
+import { type Reply, type Transport } from '../transport.js';
+/**
+ * What a push put on its way: a message per user it reaches, in the users' order, and the users whose preferences turned its category off. A push to a topic is one message, spread by the worker.
+ */
+export type ChannelQueued = {
+    message_ids: string[];
+    skipped_user_ids: string[];
+};
+/**
+ * Whether a channel can send now, and how.
+ */
+export type ChannelReadiness = {
+    because?: string;
+    channel: "email" | "sms" | "verify" | "whatsapp" | "push";
+    ok: boolean;
+    remedy?: string;
+    /**
+     * Whether its provider reports what became of what it sent: its credential holds what verifies the reports, or, for the shared sender, the platform reads the reports its account makes.
+     */
+    reports: boolean;
+    /**
+     * The project's own providers in failover order, or shared (the platform's sender, email only).
+     */
+    via: string[];
+};
+/**
+ * Each channel's readiness.
+ */
+export type Deliverability = {
+    channels: ChannelReadiness[];
+};
+/**
+ * A provider's report about a message.
+ */
+export type DeliveryEvent = {
+    /**
+     * The provider's own words: a bounce's reason, an error code.
+     */
+    detail?: string;
+    event: "sent" | "delivered" | "read" | "opened" | "clicked" | "bounced" | "complained" | "failed" | "undelivered" | "expired" | "rejected";
+    occurred_at: string;
+    provider: string;
+};
+/**
+ * A user's device — never its token.
+ */
+export type Device = {
+    app_version?: string;
+    created_at: string;
+    device_id: string;
+    id: string;
+    installation_id?: string;
+    last_used_at?: string;
+    locale?: string;
+    platform: "android" | "ios" | "ios_voip" | "web";
+    updated_at: string;
+    user_id: string;
+};
+/**
+ * A user's devices.
+ */
+export type DeviceList = {
+    devices: Device[];
+};
+/**
+ * A page of devices, the most recently registered first.
+ */
+export type DevicePage = {
+    devices: Device[];
+    next_cursor?: string;
+};
+/**
+ * A device's push token as the app's push SDK gave it: FCM's, APNs' (a PushKit VoIP token on ios_voip), or Expo's (ExponentPushToken[…]). A token another device held moves here.
+ */
+export type DeviceRegistration = {
+    app_version?: string | null;
+    /**
+     * The app's own stable name for the device.
+     */
+    device_id: string;
+    installation_id?: string | null;
+    /**
+     * The device's language: the push it gets is in it.
+     */
+    locale?: string | null;
+    platform: "android" | "ios" | "ios_voip" | "web";
+    token: string;
+};
+/**
+ * The project's devices, counted.
+ */
+export type DeviceStats = {
+    /**
+     * Every platform a device registers on, in the order the API names them; one with no device has a zero.
+     */
+    platforms: PlatformDevices[];
+    /**
+     * Every device registered.
+     */
+    total: number;
+    /**
+     * The users with at least one device.
+     */
+    users: number;
+};
+/**
+ * The send's own sender, over the project's settings (its own provider only).
+ */
+export type EmailFrom = {
+    email: string;
+    name?: string;
+};
+/**
+ * An email: a template with its variables — and, through the project's own provider, its own subject, html or text over the template's — or a subject with an html or text body (own provider only). Without a text part, the html's text is sent as one.
+ */
+export type EmailSend = {
+    /**
+     * The message's kind: transactional (the default) reaches every user; any other — marketing, news — only users who did not turn it off on this channel (preferences). 1 to 64 of a-z, 0-9, _ . -.
+     */
+    category?: string;
+    from?: EmailFrom;
+    html?: string;
+    locale?: string;
+    /**
+     * More locales the send would take, most wanted first, after locale (10 at most): each, then its language alone, then the project's default and English.
+     */
+    locales?: string[];
+    metadata?: Metadata;
+    /**
+     * high: tried again sooner when it could not leave (5 s, 15 s, 1 min instead of 10 s, 30 s, 2 min).
+     */
+    priority?: "high" | "normal";
+    /**
+     * Where replies go (own provider only).
+     */
+    reply_to?: string;
+    subject?: string;
+    /**
+     * A template's slug. Auth's (auth.*) are sent through the project's own provider: on the platform's shared sender they are auth's flows' alone (403 auth_template_reserved).
+     */
+    template?: string;
+    text?: string;
+    /**
+     * One email address.
+     */
+    to: string;
+    /**
+     * The user the message is for: their preferences hold, and deleting them deletes it.
+     */
+    user_id?: string;
+    variables?: {
+        [key: string]: unknown;
+    };
+};
+/**
+ * A template as it renders now.
+ */
+export type EmailTemplate = {
+    customized: boolean;
+    html_body: string;
+    locale: string;
+    slug: string;
+    subject: string;
+    text_body: string;
+    /**
+     * When the project last wrote its override; absent on the platform's default, which was never written.
+     */
+    updated_at?: string;
+    variables: string[];
+};
+/**
+ * Every template the project's email renders from, as a list shows it.
+ */
+export type EmailTemplateList = {
+    templates: EmailTemplateSummary[];
+};
+/**
+ * An email template in one locale, as a list shows it: its subject (998 bytes at most), never its body — a body is up to 256 KiB of HTML and as much text.
+ */
+export type EmailTemplateSummary = {
+    /**
+     * Whether the project overrides it.
+     */
+    customized: boolean;
+    locale: string;
+    slug: string;
+    subject: string;
+    /**
+     * When the project last wrote its override; absent on the platform's default, which was never written.
+     */
+    updated_at?: string;
+    variables: string[];
+};
+/**
+ * A template override.
+ */
+export type EmailTemplateWrite = {
+    html_body: string;
+    subject: string;
+    text_body: string;
+};
+export type ErrorResponse = {
+    /**
+     * Machine-readable error code (snake_case)
+     */
+    error: string;
+    /**
+     * Human-readable explanation
+     */
+    error_description: string;
+    /**
+     * Correlation ID
+     */
+    request_id: string;
+    /**
+     * Seconds to wait before retrying, when the refusal ends with time.
+     */
+    retry_after?: number;
+    /**
+     * HTTP status code
+     */
+    status: number;
+};
+/**
+ * A WhatsApp message a user sent the project's number.
+ */
+export type Inbound = {
+    id: string;
+    /**
+     * text, image, audio, location, … as Meta names it.
+     */
+    kind: string;
+    message: MetaMessage;
+    phone_number_id: string;
+    received_at: string;
+    sent_at: string;
+};
+/**
+ * A page of the WhatsApp messages users sent, newest first.
+ */
+export type InboundPage = {
+    messages: Inbound[];
+    next_cursor?: string;
+};
+/**
+ * A text per BCP 47 locale.
+ */
+export type LocaleTexts = {
+    [key: string]: string;
+};
+/**
+ * A text, or one per locale: each device gets the one in its language (its locale, that language, default_locale, the project's default, English), filled with variables (Handlebars, as a template) and cut to what a banner shows (65 characters for a title, 240 for a body).
+ */
+export type LocalizedText = PlainText | LocaleTexts;
+/**
+ * Meta's message object whole: its sender (from), its text or media.
+ */
+export type MetaMessage = {
+    [key: string]: unknown;
+};
+/**
+ * Meta's WhatsApp Business Account webhook call: statuses of the messages the project sent, messages users sent its number.
+ */
+export type MetaNotification = {
+    [key: string]: unknown;
+};
+/**
+ * The project's own data about the message (a JSON object, 4 KiB at most), kept with its report; null is none.
+ */
+export type Metadata = ({
+    [key: string]: unknown;
+}) | null;
+/**
+ * One day's count of one channel's messages in one status.
+ */
+export type MetricsDay = {
+    channel: string;
+    count: number;
+    day: string;
+    status: string;
+};
+/**
+ * The window counted, in whole UTC days: from, inclusive, to to, exclusive.
+ */
+export type MetricsRange = {
+    from: string;
+    to: string;
+};
+/**
+ * Status → how many messages.
+ */
+export type MetricsStatusCounts = {
+    [key: string]: number;
+};
+/**
+ * A window's counts of the project's messages, by the day they were created and their status now. A topic push is counted as its followers' pushes.
+ */
+export type MetricsSummary = {
+    range: MetricsRange;
+    series: MetricsDay[];
+    /**
+     * Channel → status → count.
+     */
+    totals: {
+        [key: string]: MetricsStatusCounts;
+    };
+};
+/**
+ * A message's delivery report.
+ */
+export type NotifyMessage = {
+    attempts: number;
+    /**
+     * The message's kind (transactional unless its send named another).
+     */
+    category: string;
+    channel: "email" | "sms" | "push" | "whatsapp";
+    created_at: string;
+    delivered_at?: string;
+    /**
+     * A push's report per device.
+     */
+    deliveries?: PushDelivery[];
+    error?: string;
+    /**
+     * What its provider reported after it left, oldest first.
+     */
+    events?: DeliveryEvent[];
+    id: string;
+    locale?: string;
+    metadata?: Metadata;
+    /**
+     * The topic push this is a follower's push of.
+     */
+    parent_id?: string;
+    priority: "high" | "normal";
+    provider?: string;
+    provider_message_id?: string;
+    /**
+     * The platform's shared sender or the project's own provider.
+     */
+    rail: "shared" | "own";
+    read_at?: string;
+    recipient_hint: string;
+    /**
+     * A topic push: how many followers it reached so far.
+     */
+    recipients?: number;
+    /**
+     * How many SMS segments a text took: what its provider bills.
+     */
+    segments?: number;
+    sent_at?: string;
+    status: "queued" | "sending" | "sent" | "failed" | "delivered" | "read" | "bounced" | "complained" | "undelivered" | "expired" | "rejected";
+    template?: string;
+    /**
+     * The user the message is for, when its send named one.
+     */
+    user_id?: string;
+};
+/**
+ * A page of messages, newest first.
+ */
+export type NotifyMessagePage = {
+    messages: NotifyMessage[];
+    /**
+     * The cursor of the next page; absent on the last page.
+     */
+    next_cursor?: string;
+};
+/**
+ * A project's provider — never its credentials.
+ */
+export type NotifyProvider = {
+    active: boolean;
+    channel: "email" | "sms" | "verify" | "whatsapp" | "push";
+    created_at: string;
+    /**
+     * Lower is tried first.
+     */
+    priority: number;
+    provider: string;
+    updated_at: string;
+};
+/**
+ * The project's providers.
+ */
+export type NotifyProviderList = {
+    providers: NotifyProvider[];
+};
+/**
+ * A provider's credentials and place in the failover order.
+ */
+export type NotifyProviderWrite = {
+    active?: boolean;
+    /**
+     * The provider's credentials, by channel. email — acs {connection_string, from_email}; ses {region, access_key_id, secret_access_key, from_domain}; sendgrid {api_key, from_domain, webhook_public_key: the signed Event Webhook's verification key, for delivery reports}; smtp {host, port, username, password, from_email, use_starttls}. sms — twilio {account_sid, auth_token or api_key_sid + api_key_secret, from_number or messaging_service_sid; with the auth token Twilio reports each text's delivery}; vonage {api_key, api_secret, from, signature_secret + signature_method (md5hash, md5, sha1, sha256, sha512) for its signed delivery receipts}; acs {connection_string, from_number}. verify — twilio_verify {account_sid, auth_token or api_key_sid + api_key_secret, service_sid}. whatsapp — meta {phone_number_id, access_token, api_version, app_secret + verify_token for its webhook}. push — fcm {the service account JSON}; apns {private_key, team_id, key_id, bundle_id, is_production}; expo {access_token}.
+     */
+    credentials: {
+        [key: string]: unknown;
+    };
+    priority?: number;
+};
+/**
+ * What a project's messages say about it, and where its texts may go.
+ */
+export type NotifySettings = {
+    default_locale: string;
+    /**
+     * Who email through the project's own provider is from.
+     */
+    from_email: string | null;
+    /**
+     * The sender's display name, through the project's own SMTP, SendGrid or SES provider. ACS shows the name its sender username is registered with on the domain.
+     */
+    from_name: string | null;
+    /**
+     * Refuse an email whose recipient's domain takes no mail (no MX record, a null one, or no address), before it is queued. Off unless set.
+     */
+    mx_check?: boolean;
+    /**
+     * Where replies go.
+     */
+    reply_to: string | null;
+    /**
+     * The E.164 calling codes the project's texts may not reach even when sms_countries would let them (+1876 within +1); null: none.
+     */
+    sms_blocked_countries: string[] | null;
+    /**
+     * The E.164 calling codes the project's texts may reach (+1, +44, +90); null: every country.
+     */
+    sms_countries: string[] | null;
+};
+/**
+ * One text, for every device.
+ */
+export type PlainText = string;
+/**
+ * One platform's devices.
+ */
+export type PlatformDevices = {
+    /**
+     * The devices registered on it.
+     */
+    devices: number;
+    platform: "android" | "ios" | "ios_voip" | "web";
+};
+/**
+ * A channel's categories: whether the user takes each.
+ */
+export type PreferenceChannel = {
+    [key: string]: boolean;
+};
+/**
+ * A user's preferences: channel (email, sms, whatsapp, push) → category → whether they take it. Every channel shows transactional (always on) and marketing; a category the user never set is on.
+ */
+export type Preferences = {
+    [key: string]: PreferenceChannel;
+};
+/**
+ * Key-value data for the app (4 KiB at most).
+ */
+export type PushData = {
+    [key: string]: string;
+};
+/**
+ * How a push went to one device: token_invalid when its provider says no app holds the token any more, and the device is forgotten.
+ */
+export type PushDelivery = {
+    at: string;
+    device_id: string;
+    error?: string;
+    platform: string;
+    provider: string;
+    provider_message_id?: string;
+    status: "sent" | "failed" | "token_invalid";
+};
+/**
+ * Who the push is for: users, or the followers of a topic.
+ */
+export type PushRecipients = {
+    /**
+     * A topic's name: the push reaches its followers, spread by the worker.
+     */
+    topic?: string;
+    user_ids?: string[];
+};
+/**
+ * A push to the project's users, one message each, to every device of theirs the push reaches — or to a topic's followers.
+ */
+export type PushSend = {
+    /**
+     * The app's localized placeholder banner key, shown until the extension rewrites it.
+     */
+    alert_loc_key?: string;
+    badge?: number;
+    body?: LocalizedText;
+    /**
+     * The message's kind: transactional (the default) reaches every user; any other — marketing, news — only users who did not turn it off on this channel (preferences). 1 to 64 of a-z, 0-9, _ . -.
+     */
+    category?: string;
+    collapse_key?: string;
+    content_available?: boolean;
+    data?: PushData;
+    /**
+     * A URL with a scheme (https://, myapp://); not javascript:.
+     */
+    deep_link?: string;
+    default_locale?: string;
+    /**
+     * An https URL.
+     */
+    image?: string;
+    metadata?: Metadata;
+    /**
+     * An alert the app's notification service extension rewrites before it shows (an end-to-end encrypted message's wake).
+     */
+    mutable_content?: boolean;
+    priority?: "high" | "normal";
+    /**
+     * voip: a PushKit call ring, to ios_voip devices only; none: every other device.
+     */
+    push_type?: "voip";
+    /**
+     * A background push the user does not see.
+     */
+    silent?: boolean;
+    sound?: string;
+    title?: LocalizedText;
+    to: PushRecipients;
+    /**
+     * Seconds, up to 28 days.
+     */
+    ttl?: number;
+    variables?: PushData;
+};
+/**
+ * A message accepted for sending — or skipped: its user turned its category off on this channel, and nothing was queued or counted.
+ */
+export type Queued = {
+    message_id?: string;
+    skipped?: boolean;
+};
+/**
+ * A text: a template with its variables, or a body.
+ */
+export type SMSSend = {
+    /**
+     * The text itself: 1,600 bytes and ten segments at most.
+     */
+    body?: string;
+    /**
+     * The message's kind: transactional (the default) reaches every user; any other — marketing, news — only users who did not turn it off on this channel (preferences). 1 to 64 of a-z, 0-9, _ . -.
+     */
+    category?: string;
+    locale?: string;
+    /**
+     * More locales the send would take, most wanted first, after locale (10 at most): each, then its language alone, then the project's default and English.
+     */
+    locales?: string[];
+    metadata?: Metadata;
+    /**
+     * high: tried again sooner when it could not leave (5 s, 15 s, 1 min instead of 10 s, 30 s, 2 min).
+     */
+    priority?: "high" | "normal";
+    template?: string;
+    /**
+     * One number in E.164 form (+14155551212).
+     */
+    to: string;
+    /**
+     * The user the message is for: their preferences hold, and deleting them deletes it.
+     */
+    user_id?: string;
+    variables?: {
+        [key: string]: unknown;
+    };
+};
+/**
+ * An SMS template as it renders now.
+ */
+export type SMSTemplate = {
+    body: string;
+    customized: boolean;
+    locale: string;
+    slug: string;
+    /**
+     * When the project last wrote its override; absent on the platform's default, which was never written.
+     */
+    updated_at?: string;
+    variables: string[];
+};
+/**
+ * Every template the project's texts render from, each whole.
+ */
+export type SMSTemplateList = {
+    templates: SMSTemplate[];
+};
+/**
+ * An SMS template override.
+ */
+export type SMSTemplateWrite = {
+    body: string;
+};
+/**
+ * One SendGrid event, as SendGrid sends it.
+ */
+export type SendGridEvent = {
+    [key: string]: unknown;
+};
+/**
+ * SendGrid's Event Webhook call: an array of events.
+ */
+export type SendGridEvents = SendGridEvent[];
+/**
+ * A text accepted for sending, and what its body takes on the wire — or skipped: its user turned its category off by SMS, and nothing was queued or counted.
+ */
+export type Texted = {
+    /**
+     * GSM-7 when every character is in its alphabet, else UCS-2 (fewer characters a segment).
+     */
+    encoding?: "gsm7" | "ucs2";
+    message_id?: string;
+    /**
+     * The SMS segments the text takes.
+     */
+    segments?: number;
+    skipped?: boolean;
+};
+/**
+ * A topic users follow.
+ */
+export type Topic = {
+    created_at: string;
+    id: string;
+    name: string;
+    /**
+     * Whether a user follows it from the app (POST /notify/topics/{name}/subscription). Otherwise only the project adds its followers — a team, its admins — and a user asking is refused (403 topic_closed). A user leaves any topic.
+     */
+    self_subscribe: boolean;
+    subscribers: number;
+};
+/**
+ * Opens a topic to users following it from the app, or closes it; who follows it stays.
+ */
+export type TopicChange = {
+    /**
+     * Whether a user follows it from the app (POST /notify/topics/{name}/subscription). Otherwise only the project adds its followers — a team, its admins — and a user asking is refused (403 topic_closed). A user leaves any topic.
+     */
+    self_subscribe: boolean;
+};
+/**
+ * A new topic: its name, and whether users follow it from the app (closed unless self_subscribe).
+ */
+export type TopicCreate = {
+    /**
+     * 1 to 128 of A-Z, a-z, 0-9, _ . : -
+     */
+    name: string;
+    /**
+     * Whether a user follows it from the app (POST /notify/topics/{name}/subscription). Otherwise only the project adds its followers — a team, its admins — and a user asking is refused (403 topic_closed). A user leaves any topic.
+     */
+    self_subscribe?: boolean;
+};
+/**
+ * A page of the project's topics, newest first.
+ */
+export type TopicPage = {
+    next_cursor?: string;
+    topics: Topic[];
+};
+/**
+ * Users to add to a topic.
+ */
+export type TopicSubscribers = {
+    user_ids: string[];
+};
+/**
+ * Twilio's status callback for a message, as Twilio sends it (a form).
+ */
+export type TwilioStatusCallback = {
+    [key: string]: unknown;
+};
+/**
+ * Whether the code is the one the service sent: false for a wrong code and for one that is over (expired, used, out of attempts).
+ */
+export type Verdict = {
+    approved: boolean;
+};
+/**
+ * A code to check against the one texted to the number.
+ */
+export type VerificationCheck = {
+    code: string;
+    to: string;
+};
+/**
+ * A number to text a one-time code to, through the project's verification service.
+ */
+export type VerificationStart = {
+    /**
+     * The text's language; empty: the service's own.
+     */
+    locale?: string;
+    /**
+     * One number in E.164 form.
+     */
+    to: string;
+    /**
+     * The user the code is for, kept with its report.
+     */
+    user_id?: string;
+};
+/**
+ * A code on its way: its report's id, and the verification service's own id and status for it.
+ */
+export type VerificationStarted = {
+    message_id?: string;
+    status?: string;
+    verification_sid?: string;
+};
+/**
+ * Vonage's delivery receipt, as the account sends it (a form or JSON; or a query on GET).
+ */
+export type VonageReceipt = {
+    [key: string]: unknown;
+};
+/**
+ * One of a Meta template's components, in Meta's own shape: a body's parameters, a button.
+ */
+export type WhatsAppComponent = {
+    [key: string]: unknown;
+};
+/**
+ * A WhatsApp message: exactly one of a text (Meta takes one inside a conversation the user opened in the last 24 hours), a template approved on the project's account, or one of its template slugs with the slug's variables.
+ */
+export type WhatsAppSend = {
+    body?: string;
+    /**
+     * The message's kind: transactional (the default) reaches every user; any other — marketing, news — only users who did not turn it off on this channel (preferences). 1 to 64 of a-z, 0-9, _ . -.
+     */
+    category?: string;
+    locale?: string;
+    /**
+     * More locales the send would take, most wanted first, after locale (10 at most): each, then its language alone, then the project's default and English.
+     */
+    locales?: string[];
+    metadata?: Metadata;
+    /**
+     * high: tried again sooner when it could not leave (5 s, 15 s, 1 min instead of 10 s, 30 s, 2 min).
+     */
+    priority?: "high" | "normal";
+    template?: WhatsAppTemplate;
+    template_slug?: string;
+    /**
+     * One number in E.164 form.
+     */
+    to: string;
+    /**
+     * The user the message is for: their preferences hold, and deleting them deletes it.
+     */
+    user_id?: string;
+    variables?: {
+        [key: string]: unknown;
+    };
+};
+/**
+ * A template approved on the project's Meta account: its name, language, and components in Meta's own shape.
+ */
+export type WhatsAppTemplate = {
+    /**
+     * Meta's components: body parameters, buttons.
+     */
+    components?: WhatsAppComponent[];
+    language: string;
+    name: string;
+};
+/**
+ * A project's slug in a locale, mapped to a template approved on its Meta account: the variables fill its body in order, and a code button copies the one variable of an authentication template.
+ */
+export type WhatsAppTemplateMap = {
+    code_button: boolean;
+    language: string;
+    locale: string;
+    name: string;
+    slug: string;
+    /**
+     * When the project last wrote the mapping.
+     */
+    updated_at: string;
+    variables: string[];
+};
+/**
+ * The project's WhatsApp template mappings.
+ */
+export type WhatsAppTemplateMapList = {
+    templates: WhatsAppTemplateMap[];
+};
+/**
+ * Maps a slug in a locale to a template approved on the project's Meta account.
+ */
+export type WhatsAppTemplateWrite = {
+    /**
+     * An authentication template's copy-code button: exactly one variable.
+     */
+    code_button?: boolean;
+    language: string;
+    name: string;
+    variables?: string[];
+};
+/** Palbase Notify */
+export declare function client(t: Transport): {
+    /**
+     * Get deliverability
+     *
+     * Whether each channel can send now, through what, why not and what to do, and whether its provider reports what became of what it sent.
+     */
+    getDeliverability(input?: {
+        signal?: AbortSignal;
+    }): Promise<Reply<200, Deliverability>>;
+    /**
+     * List devices
+     *
+     * The signed-in user's devices; with the project's secret key, every device of the project — one platform's (platform), one user's (user_id). Never a token.
+     */
+    listDevices(input?: {
+        query?: {
+            limit?: number; /** The next_cursor of the previous page. Opaque; omit it for the first page. */
+            cursor?: string; /** Only this platform's devices. */
+            platform?: "android" | "ios" | "ios_voip" | "web"; /** Only this user's devices (the secret key's filter; a user sees their own). */
+            user_id?: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, DevicePage>>;
+    /**
+     * Register a device
+     *
+     * Records the signed-in user's device, or its new token. A token another device held moves here: one token reaches one user. The device is the session's it is registered in: when that session ends — the user signs out, ends it from another device, an admin revokes it — the device is forgotten and no push of theirs reaches it; registered again in another session, it is that one's. A registration in a session that has ended is refused (401 session_ended).
+     */
+    registerDevice(input: {
+        headers?: {
+            "Idempotency-Key"?: string;
+        };
+        body: DeviceRegistration; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, Device>>;
+    /**
+     * Read the device stats
+     *
+     * The project's devices, counted: how many are registered, of how many users (a user with at least one device), and how many on each platform — every platform listed, one with no device as a zero. A device its user forgot, or whose token a provider called dead, is in no count.
+     */
+    getDeviceStats(input?: {
+        signal?: AbortSignal;
+    }): Promise<Reply<200, DeviceStats>>;
+    /**
+     * Forget a device
+     *
+     * Forgets the signed-in user's device by the app's own id for it — every token it registered (an iPhone's alert and VoIP tokens) — on sign-out: no push reaches it. A session ended without this call — from another device, by an admin, its refresh token revoked — forgets the devices registered in it all the same.
+     */
+    deleteMyDevice(input: {
+        path: {
+            device_id: string;
+        };
+        headers?: {
+            "Idempotency-Key"?: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<204, undefined>>;
+    /**
+     * Send an email
+     *
+     * Queues an email through the project's own provider: a template with its variables — the platform's, as the project overrode them, or one it made — or a message composed whole. The platform's shared sender, which a project with no email provider of its own has, sends none of them for the project's key: auth's templates (auth.*) leave it from auth's own flows alone — a sign-up's confirmation, a password reset, a sign-in link — with auth's link, to the address the flow is for, and a key's send of one is refused with 403 `auth_template_reserved`; anything else is refused with 403 `own_provider_required`. Palbase's own project, Studio's, sends its notices and its organizations' invitations to Studio's developers through the shared sender with its key.
+     */
+    sendEmail(input: {
+        headers?: {
+            "Idempotency-Key"?: string;
+        };
+        body: EmailSend; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<202, Queued>>;
+    /**
+     * List the project's messages
+     *
+     * The project's messages, newest first: their delivery reports, never what they said; one channel's, status's, user's, category's or topic push's, created in a window.
+     */
+    listNotifyMessages(input?: {
+        query?: {
+            limit?: number; /** The next_cursor of the previous page. Opaque; omit it for the first page. */
+            cursor?: string; /** Only this channel's messages. */
+            channel?: "email" | "sms" | "whatsapp" | "push"; /** Only messages in this status. */
+            status?: "queued" | "sending" | "sent" | "failed" | "delivered" | "read" | "bounced" | "complained" | "undelivered" | "expired" | "rejected"; /** Only messages for this user. */
+            user_id?: string; /** Only this category's messages. */
+            category?: string; /** Only the followers' pushes of this topic push. */
+            parent_id?: string; /** Only messages created at or after this time (RFC 3339). */
+            created_after?: string; /** Only messages created before this time (RFC 3339). */
+            created_before?: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, NotifyMessagePage>>;
+    /**
+     * Read a message's report
+     *
+     * A message's delivery report.
+     */
+    getNotifyMessage(input: {
+        path: {
+            id: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, NotifyMessage>>;
+    /**
+     * Get the metrics summary
+     *
+     * The project's messages counted per channel, status and day, over a window of up to 92 days (the last 7 by default), counted in whole UTC days: from is taken back to its day's start, to on to the next day's. Reports are kept 30 days; past them a day's counts are kept.
+     */
+    getMetricsSummary(input?: {
+        query?: {
+            from?: string; /** The window's end (RFC 3339), now by default. */
+            to?: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, MetricsSummary>>;
+    /**
+     * Get my preferences
+     *
+     * The signed-in user's preferences: which categories they take on which channel.
+     */
+    getMyPreferences(input?: {
+        signal?: AbortSignal;
+    }): Promise<Reply<200, Preferences>>;
+    /**
+     * Set my preferences
+     *
+     * Sets some of the signed-in user's preferences ({channel: {category: on}}) and answers all of them. Transactional is not theirs to turn off and is left as it is; a write sets 100 at most, and a user keeps 50 categories.
+     */
+    setMyPreferences(input: {
+        headers?: {
+            "Idempotency-Key"?: string;
+        };
+        body: Preferences; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, Preferences>>;
+    /**
+     * List the project's providers
+     *
+     * The project's own providers, by channel and failover order — never their credentials.
+     */
+    listNotifyProviders(input?: {
+        signal?: AbortSignal;
+    }): Promise<Reply<200, NotifyProviderList>>;
+    /**
+     * Bring a provider
+     *
+     * Stores the project's own provider for a channel — its credentials sealed with the project's key, checked as the sender will use them. A project with an active email provider sends its email through it instead of the platform's shared sender. Texts go through the project's own SMS providers only, and its one-time codes through them or through its own verification service (Twilio Verify).
+     */
+    putNotifyProvider(input: {
+        path: {
+            channel: "email" | "sms" | "verify" | "whatsapp" | "push"; /** The provider: for email acs, ses, sendgrid or smtp; for sms twilio, vonage or acs; for verify twilio_verify; for whatsapp meta; for push fcm, apns or expo. */
+            provider: "acs" | "ses" | "sendgrid" | "smtp" | "twilio" | "vonage" | "twilio_verify" | "meta" | "fcm" | "apns" | "expo";
+        };
+        headers?: {
+            "Idempotency-Key"?: string;
+        };
+        body: NotifyProviderWrite; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, NotifyProvider>>;
+    /**
+     * Remove a provider
+     *
+     * Forgets the provider and its credentials.
+     */
+    deleteNotifyProvider(input: {
+        path: {
+            channel: "email" | "sms" | "verify" | "whatsapp" | "push"; /** The provider: for email acs, ses, sendgrid or smtp; for sms twilio, vonage or acs; for verify twilio_verify; for whatsapp meta; for push fcm, apns or expo. */
+            provider: "acs" | "ses" | "sendgrid" | "smtp" | "twilio" | "vonage" | "twilio_verify" | "meta" | "fcm" | "apns" | "expo";
+        };
+        headers?: {
+            "Idempotency-Key"?: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<204, undefined>>;
+    /**
+     * Push to users
+     *
+     * Queues one push per user — each whose preferences take its category — delivered to each of their devices through the project's own FCM, APNs or Expo account: an Expo token through Expo, a VoIP token through APNs, an iOS token through APNs if the project has it (else FCM), Android and web through FCM. To a topic, it is one message the worker spreads to the followers. A dead token is forgotten. A quota that refuses past its limit stops pushes until the next month.
+     */
+    sendPush(input: {
+        headers?: {
+            "Idempotency-Key"?: string;
+        };
+        body: PushSend; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<202, ChannelQueued>>;
+    /**
+     * Read the project's message settings
+     *
+     * The locale a template falls back to, and who an email through the project's own provider is from, with their revision in the ETag header. A save sends that ETag back in If-Match.
+     */
+    getNotifySettings(input?: {
+        signal?: AbortSignal;
+    }): Promise<Reply<200, NotifySettings>>;
+    /**
+     * Write the project's message settings
+     *
+     * Sets the default locale, the from address and name, and the reply-to address used with the project's own provider. Requires If-Match with the ETag of the settings the change was made against: without it 428 settings_revision_required, with a revision that is no longer current 412 settings_revision_conflict (read again and review before saving). Answers the saved settings and their new ETag.
+     */
+    putNotifySettings(input: {
+        headers: {
+            "If-Match": string; /** Makes the write safe to send again (at most 255 characters). A retry with the same key and the same request gets the first answer back, marked `Idempotent-Replayed: true`, and changes nothing; the same key with a different request is refused with 422, and while the first request still runs a retry gets 409 with Retry-After. Answers are kept for 24 hours. */
+            "Idempotency-Key"?: string;
+        };
+        body: NotifySettings; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, NotifySettings>>;
+    /**
+     * Send a text
+     *
+     * Queues a text through the project's own SMS providers, in failover order: a template with its variables, or a body. A number gets one text a minute and ten a day; a project that texts more distinct numbers at once than its users would ask for is paused for a few minutes; a quota that refuses past its limit stops its texts until the next month.
+     */
+    sendSms(input: {
+        headers?: {
+            "Idempotency-Key"?: string;
+        };
+        body: SMSSend; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<202, Texted>>;
+    /**
+     * List the email templates
+     *
+     * Every template the project's email renders from — the platform's defaults and the project's overrides — with the subject and variables each uses and when the project last wrote it. Never a body: read the template for that. On the platform's shared sender, auth's templates (auth.*) go out in Palbase's words; the project's edits of them are used with its own email provider.
+     */
+    listEmailTemplates(input?: {
+        signal?: AbortSignal;
+    }): Promise<Reply<200, EmailTemplateList>>;
+    /**
+     * Read an email template
+     *
+     * The template as it renders now in this locale: the project's override, or the platform's default. On the platform's shared sender, auth's templates (auth.*) go out in Palbase's words; the project's edits of them are used with its own email provider.
+     */
+    getEmailTemplate(input: {
+        path: {
+            slug: string; /** A BCP 47 locale, e.g. en or tr. */
+            locale: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, EmailTemplate>>;
+    /**
+     * Override an email template
+     *
+     * Overrides the template in this locale. It is Handlebars ({{name}}, {{#if}} {{#unless}} {{#each}} {{#with}}, lookup, equal): {{name}} in an HTML body is escaped, {{{name}}} is not; a subject, a text body and an SMS are text; an override of a platform template uses only the variables its sender passes. On the platform's shared sender, auth's templates (auth.*) go out in Palbase's words; the project's edits of them are used with its own email provider.
+     */
+    putEmailTemplate(input: {
+        path: {
+            slug: string; /** A BCP 47 locale, e.g. en or tr. */
+            locale: string;
+        };
+        headers?: {
+            "Idempotency-Key"?: string;
+        };
+        body: EmailTemplateWrite; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, EmailTemplate>>;
+    /**
+     * Remove an override
+     *
+     * Removes the project's override; the platform's default renders again.
+     */
+    deleteEmailTemplate(input: {
+        path: {
+            slug: string; /** A BCP 47 locale, e.g. en or tr. */
+            locale: string;
+        };
+        headers?: {
+            "Idempotency-Key"?: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<204, undefined>>;
+    /**
+     * List the SMS templates
+     *
+     * Every template the project's texts render from — the platform's defaults and the project's overrides — each whole (a body is 1600 bytes at most), with the variables it uses and when the project last wrote it.
+     */
+    listSmsTemplates(input?: {
+        signal?: AbortSignal;
+    }): Promise<Reply<200, SMSTemplateList>>;
+    /**
+     * Read an SMS template
+     *
+     * The template as it renders now in this locale: the project's override, or the platform's default.
+     */
+    getSmsTemplate(input: {
+        path: {
+            slug: string; /** A BCP 47 locale, e.g. en or tr. */
+            locale: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, SMSTemplate>>;
+    /**
+     * Override an SMS template
+     *
+     * Overrides the SMS template in this locale. It is Handlebars ({{name}}, {{#if}} {{#unless}} {{#each}} {{#with}}, lookup, equal): {{name}} in an HTML body is escaped, {{{name}}} is not; a subject, a text body and an SMS are text; an override of a platform template uses only the variables its sender passes.
+     */
+    putSmsTemplate(input: {
+        path: {
+            slug: string; /** A BCP 47 locale, e.g. en or tr. */
+            locale: string;
+        };
+        headers?: {
+            "Idempotency-Key"?: string;
+        };
+        body: SMSTemplateWrite; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, SMSTemplate>>;
+    /**
+     * Remove an SMS override
+     *
+     * Removes the project's override; the platform's default renders again.
+     */
+    deleteSmsTemplate(input: {
+        path: {
+            slug: string; /** A BCP 47 locale, e.g. en or tr. */
+            locale: string;
+        };
+        headers?: {
+            "Idempotency-Key"?: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<204, undefined>>;
+    /**
+     * List the WhatsApp template mappings
+     *
+     * The project's slugs mapped to templates approved on its Meta account.
+     */
+    listWhatsAppTemplates(input?: {
+        signal?: AbortSignal;
+    }): Promise<Reply<200, WhatsAppTemplateMapList>>;
+    /**
+     * Read a WhatsApp template mapping
+     *
+     * The template this slug maps to in this locale.
+     */
+    getWhatsAppTemplate(input: {
+        path: {
+            slug: string; /** A BCP 47 locale, e.g. en or tr. */
+            locale: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, WhatsAppTemplateMap>>;
+    /**
+     * Map a slug to a WhatsApp template
+     *
+     * Maps the slug in this locale to a template approved on the project's Meta account.
+     */
+    putWhatsAppTemplate(input: {
+        path: {
+            slug: string; /** A BCP 47 locale, e.g. en or tr. */
+            locale: string;
+        };
+        headers?: {
+            "Idempotency-Key"?: string;
+        };
+        body: WhatsAppTemplateWrite; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, WhatsAppTemplateMap>>;
+    /**
+     * Remove a WhatsApp template mapping
+     *
+     * Removes the mapping.
+     */
+    deleteWhatsAppTemplate(input: {
+        path: {
+            slug: string; /** A BCP 47 locale, e.g. en or tr. */
+            locale: string;
+        };
+        headers?: {
+            "Idempotency-Key"?: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<204, undefined>>;
+    /**
+     * List topics
+     *
+     * A page of the project's topics, newest first, with how many users follow each.
+     */
+    listTopics(input?: {
+        query?: {
+            limit?: number; /** The next_cursor of the previous page. Opaque; omit it for the first page. */
+            cursor?: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, TopicPage>>;
+    /**
+     * Create a topic
+     *
+     * Makes a topic users can follow; a push to it reaches its followers.
+     */
+    createTopic(input: {
+        headers?: {
+            "Idempotency-Key"?: string;
+        };
+        body: TopicCreate; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<201, Topic>>;
+    /**
+     * Delete a topic
+     *
+     * Deletes a topic and who follows it; a push to it under way reaches no one more.
+     */
+    deleteTopic(input: {
+        path: {
+            name: string;
+        };
+        headers?: {
+            "Idempotency-Key"?: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<204, undefined>>;
+    /**
+     * Open or close a topic
+     *
+     * Opens a topic to users following it from the app (self_subscribe), or closes it; who follows it stays.
+     */
+    changeTopic(input: {
+        path: {
+            name: string;
+        };
+        headers?: {
+            "Idempotency-Key"?: string;
+        };
+        body: TopicChange; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, Topic>>;
+    /**
+     * Add followers
+     *
+     * Adds users to a topic (a user already on it stays).
+     */
+    addTopicSubscribers(input: {
+        path: {
+            name: string;
+        };
+        headers?: {
+            "Idempotency-Key"?: string;
+        };
+        body: TopicSubscribers; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<204, undefined>>;
+    /**
+     * Remove a follower
+     *
+     * Takes a user off a topic.
+     */
+    removeTopicSubscriber(input: {
+        path: {
+            name: string; /** The user's id. */
+            user_id: string;
+        };
+        headers?: {
+            "Idempotency-Key"?: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<204, undefined>>;
+    /**
+     * Follow a topic
+     *
+     * The signed-in user follows a topic. A user follows only a topic the project opened to them (self_subscribe).
+     */
+    followTopic(input: {
+        path: {
+            name: string;
+        };
+        headers?: {
+            "Idempotency-Key"?: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<204, undefined>>;
+    /**
+     * Unfollow a topic
+     *
+     * The signed-in user stops following a topic.
+     */
+    unfollowTopic(input: {
+        path: {
+            name: string;
+        };
+        headers?: {
+            "Idempotency-Key"?: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<204, undefined>>;
+    /**
+     * List a user's devices
+     *
+     * A user's devices, for the project's backend.
+     */
+    listUserDevices(input: {
+        path: {
+            user_id: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, DeviceList>>;
+    /**
+     * Get a user's preferences
+     *
+     * A user's preferences, for the project's backend or support desk.
+     */
+    getUserPreferences(input: {
+        path: {
+            user_id: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, Preferences>>;
+    /**
+     * Set a user's preferences
+     *
+     * Sets some of a user's preferences for them, and answers all of them.
+     */
+    setUserPreferences(input: {
+        path: {
+            user_id: string;
+        };
+        headers?: {
+            "Idempotency-Key"?: string;
+        };
+        body: Preferences; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, Preferences>>;
+    /**
+     * Text a one-time code
+     *
+     * Has the project's own verification service (Twilio Verify) generate a one-time code and text it, from senders it has approved in each country. It is a text like any other: the number guard, the project's countries and its quota apply, and it is reported. 502 when the service fails.
+     */
+    startVerification(input: {
+        headers?: {
+            "Idempotency-Key"?: string;
+        };
+        body: VerificationStart; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<202, VerificationStarted>>;
+    /**
+     * Check a one-time code
+     *
+     * Asks the project's verification service whether the code is the one it texted to the number.
+     */
+    checkVerification(input: {
+        headers?: {
+            "Idempotency-Key"?: string;
+        };
+        body: VerificationCheck; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, Verdict>>;
+    /**
+     * SendGrid events
+     *
+     * Where the project's SendGrid account reports what became of its emails (Event Webhook, signed): delivered, bounced, dropped, spam report, open, click. Verified with the project's own SendGrid credential's webhook_public_key; a call it did not sign is refused (401). A call sent again is kept once, and a message only moves forward.
+     */
+    receiveSendGridEvents(input: {
+        body: SendGridEvents; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<204, undefined>>;
+    /**
+     * Twilio status callback
+     *
+     * Where the project's Twilio account reports what became of a text: the address notify gives with each text when the credential holds the auth token. Verified with the project's own auth token (X-Twilio-Signature); a call it did not sign is refused (401). A call sent again is kept once, and a message only moves forward.
+     */
+    receiveTwilioStatus(input: {
+        body: TwilioStatusCallback; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<204, undefined>>;
+    /**
+     * Vonage receipt (query)
+     *
+     * Vonage's delivery receipt as a query. Verified with the project's own signature secret (sig); a call it did not sign is refused (401). A call sent again is kept once, and a message only moves forward.
+     */
+    receiveVonageReceiptQuery(input?: {
+        query?: {
+            messageId?: string; /** delivered, expired, failed, rejected, accepted, buffered or unknown. */
+            status?: string; /** Vonage's error code. */
+            "err-code"?: string; /** The recipient's number. */
+            msisdn?: string; /** The sender. */
+            to?: string; /** The recipient's network. */
+            "network-code"?: string; /** What the text cost. */
+            price?: string; /** When the network reported it. */
+            scts?: string; /** When Vonage received the report. */
+            "message-timestamp"?: string; /** The send's reference. */
+            "client-ref"?: string; /** The account's key. */
+            "api-key"?: string; /** When Vonage signed the receipt (Unix seconds); a receipt older than 5 minutes is refused. */
+            timestamp?: string; /** Vonage's nonce. */
+            nonce?: string; /** The receipt's signature, with the project's signature secret. */
+            sig?: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<204, undefined>>;
+    /**
+     * Vonage receipt
+     *
+     * Where the project's Vonage account reports what became of a text: the address notify gives with each text when the credential holds the signature secret. Verified with the project's own signature secret (sig); a call it did not sign is refused (401). A call sent again is kept once, and a message only moves forward.
+     */
+    receiveVonageReceipt(input: {
+        body: VonageReceipt; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<204, undefined>>;
+    /**
+     * Meta subscription check
+     *
+     * Meta's check when the project subscribes its app's webhook to this address: hub.mode=subscribe and the verify_token the project's Meta credential names; the hub.challenge is echoed.
+     */
+    subscribeMetaWebhook(input: {
+        query: {
+            "hub.mode": "subscribe"; /** The verify token the project set on its Meta credential (verify_token). */
+            "hub.verify_token": string; /** Echoed back when the token is the project's. */
+            "hub.challenge": string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, Response>>;
+    /**
+     * Meta notification
+     *
+     * Where the project's Meta app reports the statuses of its WhatsApp messages (sent, delivered, read, failed) and the messages users send its number, which are kept sealed and announced (notification.received). Verified with the project's own app_secret (X-Hub-Signature-256); a call it did not sign is refused (401). A call sent again is kept once, and a message only moves forward.
+     */
+    receiveMetaNotification(input: {
+        body: MetaNotification; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<204, undefined>>;
+    /**
+     * Send a WhatsApp message
+     *
+     * Queues a WhatsApp message through the project's own WhatsApp Business account (Meta). A quota that refuses past its limit stops them until the next month.
+     */
+    sendWhatsApp(input: {
+        headers?: {
+            "Idempotency-Key"?: string;
+        };
+        body: WhatsAppSend; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<202, Queued>>;
+    /**
+     * List inbound WhatsApp messages
+     *
+     * A page of the WhatsApp messages users sent the project's number, newest first, each Meta's message whole. Kept 30 days.
+     */
+    listWhatsAppInbound(input?: {
+        query?: {
+            limit?: number; /** The next_cursor of the previous page. Opaque; omit it for the first page. */
+            cursor?: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, InboundPage>>;
+};
+export type Client = ReturnType<typeof client>;