@neynar/nodejs-sdk
Version:
SDK to interact with Neynar APIs (https://docs.neynar.com/reference/quickstart)
73 lines (72 loc) • 1.95 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.115.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 { SharedSignerPermission } from './shared-signer-permission';
/**
*
* @export
* @interface Signer
*/
export interface Signer {
/**
*
* @type {string}
* @memberof Signer
*/
'object'?: SignerObjectEnum;
/**
* UUID of the signer. `signer_uuid` is paired with API key, can\'t use a `uuid` made with a different API key.
* @type {string}
* @memberof Signer
*/
'signer_uuid': string;
/**
* Ed25519 public key
* @type {string}
* @memberof Signer
*/
'public_key': string;
/**
*
* @type {string}
* @memberof Signer
*/
'status': SignerStatusEnum;
/**
*
* @type {string}
* @memberof Signer
*/
'signer_approval_url'?: string;
/**
* The unique identifier of a farcaster user or app (unsigned integer)
* @type {number}
* @memberof Signer
*/
'fid'?: number;
/**
*
* @type {Array<SharedSignerPermission>}
* @memberof Signer
*/
'permissions'?: Array<SharedSignerPermission>;
}
export declare const SignerObjectEnum: {
readonly Signer: "signer";
};
export type SignerObjectEnum = typeof SignerObjectEnum[keyof typeof SignerObjectEnum];
export declare const SignerStatusEnum: {
readonly Generated: "generated";
readonly PendingApproval: "pending_approval";
readonly Approved: "approved";
readonly Revoked: "revoked";
};
export type SignerStatusEnum = typeof SignerStatusEnum[keyof typeof SignerStatusEnum];