@neynar/nodejs-sdk
Version:
SDK to interact with Neynar APIs (https://docs.neynar.com/reference/quickstart)
42 lines (41 loc) • 1.86 kB
TypeScript
/**
* Neynar API
* The Neynar API allows you to interact with the Farcaster protocol among other things. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
*
* The version of the OpenAPI document: 3.175.0
* Contact: team@neynar.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import type { SignedMessageBodySignedMessage } from './signed-message-body-signed-message';
/**
* Request body for app host events. Can either provide a signed_message or a signer_uuid with event details.
*/
export interface AppHostPostEventReqBody {
/**
* Domain of the mini app
*/
'app_domain': string;
'signed_message': SignedMessageBodySignedMessage;
/**
* Types of events that can occur between a user and an app host: - frame_added: User adds a mini app to their account - frame_removed: User removes a mini app from their account - notifications_enabled: User enables notifications for a mini app - notifications_disabled: User disables notifications for a mini app
*/
'event': AppHostPostEventReqBodyEventEnum;
/**
* The unique identifier of a farcaster user or app (unsigned integer)
*/
'fid': number;
/**
* UUID of the signer. `signer_uuid` is paired with API key, can\'t use a `uuid` made with a different API key.
*/
'signer_uuid': string;
}
export declare const AppHostPostEventReqBodyEventEnum: {
readonly FrameAdded: "frame_added";
readonly FrameRemoved: "frame_removed";
readonly NotificationsEnabled: "notifications_enabled";
readonly NotificationsDisabled: "notifications_disabled";
};
export type AppHostPostEventReqBodyEventEnum = typeof AppHostPostEventReqBodyEventEnum[keyof typeof AppHostPostEventReqBodyEventEnum];