@neynar/nodejs-sdk 3.137.0 → 3.137.2

package/build/api/models/register-user-req-body.d.ts

@@ -11,52 +11,12 @@
  */
 import type { RegisterUserReqBodyMetadata } from './register-user-req-body-metadata';
 import type { RegisterUserReqBodySigner } from './register-user-req-body-signer';
-/**
- *
- * @export
- * @interface RegisterUserReqBody
- */
 export interface RegisterUserReqBody {
-    /**
-     *
-     * @type {RegisterUserReqBodySigner}
-     * @memberof RegisterUserReqBody
-     */
     'signer'?: RegisterUserReqBodySigner;
-    /**
-     *
-     * @type {string}
-     * @memberof RegisterUserReqBody
-     */
     'signature': string;
-    /**
-     *
-     * @type {number}
-     * @memberof RegisterUserReqBody
-     */
     'fid': number;
-    /**
-     *
-     * @type {string}
-     * @memberof RegisterUserReqBody
-     */
     'requested_user_custody_address': string;
-    /**
-     *
-     * @type {number}
-     * @memberof RegisterUserReqBody
-     */
     'deadline': number;
-    /**
-     *
-     * @type {string}
-     * @memberof RegisterUserReqBody
-     */
     'fname'?: string;
-    /**
-     *
-     * @type {RegisterUserReqBodyMetadata}
-     * @memberof RegisterUserReqBody
-     */
     'metadata'?: RegisterUserReqBodyMetadata;
 }

package/build/api/models/register-user-response-signers-inner.d.ts

@@ -10,52 +10,21 @@
  * Do not edit the class manually.
  */
 import type { SharedSignerPermission } from './shared-signer-permission';
-/**
- *
- * @export
- * @interface RegisterUserResponseSignersInner
- */
 export interface RegisterUserResponseSignersInner {
-    /**
-     *
-     * @type {string}
-     * @memberof RegisterUserResponseSignersInner
-     */
     'object'?: RegisterUserResponseSignersInnerObjectEnum;
     /**
      * Ed25519 public key
-     * @type {string}
-     * @memberof RegisterUserResponseSignersInner
      */
     'public_key': string;
-    /**
-     *
-     * @type {string}
-     * @memberof RegisterUserResponseSignersInner
-     */
     'status': RegisterUserResponseSignersInnerStatusEnum;
-    /**
-     *
-     * @type {string}
-     * @memberof RegisterUserResponseSignersInner
-     */
     'signer_approval_url'?: string;
     /**
      * The unique identifier of a farcaster user or app (unsigned integer)
-     * @type {number}
-     * @memberof RegisterUserResponseSignersInner
      */
     'fid'?: number;
-    /**
-     *
-     * @type {Array<SharedSignerPermission>}
-     * @memberof RegisterUserResponseSignersInner
-     */
     'permissions'?: Array<SharedSignerPermission>;
     /**
      * 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 RegisterUserResponseSignersInner
      */
     'uuid': string;
 }

package/build/api/models/register-user-response.d.ts

@@ -12,40 +12,10 @@
 import type { RegisterUserResponseSignersInner } from './register-user-response-signers-inner';
 import type { Signer } from './signer';
 import type { User } from './user';
-/**
- *
- * @export
- * @interface RegisterUserResponse
- */
 export interface RegisterUserResponse {
-    /**
-     *
-     * @type {boolean}
-     * @memberof RegisterUserResponse
-     */
     'success': boolean;
-    /**
-     *
-     * @type {string}
-     * @memberof RegisterUserResponse
-     */
     'message': string;
-    /**
-     *
-     * @type {Signer}
-     * @memberof RegisterUserResponse
-     */
     'signer'?: Signer;
-    /**
-     *
-     * @type {Array<RegisterUserResponseSignersInner>}
-     * @memberof RegisterUserResponse
-     */
     'signers': Array<RegisterUserResponseSignersInner>;
-    /**
-     *
-     * @type {User}
-     * @memberof RegisterUserResponse
-     */
     'user'?: User;
 }

package/build/api/models/relevant-followers-response.d.ts

@@ -11,22 +11,7 @@
  */
 import type { Follower } from './follower';
 import type { FollowerDehydrated } from './follower-dehydrated';
-/**
- *
- * @export
- * @interface RelevantFollowersResponse
- */
 export interface RelevantFollowersResponse {
-    /**
-     *
-     * @type {Array<Follower>}
-     * @memberof RelevantFollowersResponse
-     */
     'top_relevant_followers_hydrated': Array<Follower>;
-    /**
-     *
-     * @type {Array<FollowerDehydrated>}
-     * @memberof RelevantFollowersResponse
-     */
     'all_relevant_followers_dehydrated': Array<FollowerDehydrated>;
 }

package/build/api/models/relevant-fungible-owners-response.d.ts

@@ -11,22 +11,7 @@
  */
 import type { User } from './user';
 import type { UserDehydrated } from './user-dehydrated';
-/**
- *
- * @export
- * @interface RelevantFungibleOwnersResponse
- */
 export interface RelevantFungibleOwnersResponse {
-    /**
-     *
-     * @type {Array<User>}
-     * @memberof RelevantFungibleOwnersResponse
-     */
     'top_relevant_fungible_owners_hydrated': Array<User>;
-    /**
-     *
-     * @type {Array<UserDehydrated>}
-     * @memberof RelevantFungibleOwnersResponse
-     */
     'all_relevant_fungible_owners_dehydrated': Array<UserDehydrated>;
 }

package/build/api/models/remove-channel-member-req-body.d.ts

@@ -10,34 +10,18 @@
  * Do not edit the class manually.
  */
 import type { ChannelMemberRole } from './channel-member-role';
-/**
- *
- * @export
- * @interface RemoveChannelMemberReqBody
- */
 export interface RemoveChannelMemberReqBody {
     /**
      * 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 RemoveChannelMemberReqBody
      */
     'signer_uuid': string;
     /**
      * The unique identifier of a farcaster channel
-     * @type {string}
-     * @memberof RemoveChannelMemberReqBody
      */
     'channel_id': string;
     /**
      * The unique identifier of a farcaster user or app (unsigned integer)
-     * @type {number}
-     * @memberof RemoveChannelMemberReqBody
      */
     'fid': number;
-    /**
-     *
-     * @type {ChannelMemberRole}
-     * @memberof RemoveChannelMemberReqBody
-     */
     'role': ChannelMemberRole;
 }

package/build/api/models/remove-verification-req-body.d.ts

@@ -9,34 +9,15 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-/**
- *
- * @export
- * @interface RemoveVerificationReqBody
- */
 export interface RemoveVerificationReqBody {
     /**
      * 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 RemoveVerificationReqBody
      */
     'signer_uuid': string;
     /**
      * Ethereum address
-     * @type {string}
-     * @memberof RemoveVerificationReqBody
      */
     'address': string;
-    /**
-     *
-     * @type {string}
-     * @memberof RemoveVerificationReqBody
-     */
     'block_hash': string;
-    /**
-     *
-     * @type {string}
-     * @memberof RemoveVerificationReqBody
-     */
     'eth_signature': string;
 }

package/build/api/models/respond-channel-invite-req-body.d.ts

@@ -10,34 +10,18 @@
  * Do not edit the class manually.
  */
 import type { ChannelMemberRole } from './channel-member-role';
-/**
- *
- * @export
- * @interface RespondChannelInviteReqBody
- */
 export interface RespondChannelInviteReqBody {
     /**
      * 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 RespondChannelInviteReqBody
      */
     'signer_uuid': string;
     /**
      * The unique identifier of a farcaster channel
-     * @type {string}
-     * @memberof RespondChannelInviteReqBody
      */
     'channel_id': string;
-    /**
-     *
-     * @type {ChannelMemberRole}
-     * @memberof RespondChannelInviteReqBody
-     */
     'role': ChannelMemberRole;
     /**
      * Accept or reject the invite
-     * @type {boolean}
-     * @memberof RespondChannelInviteReqBody
      */
     'accept': boolean;
 }

package/build/api/models/send-frame-notifications-req-body-filters-near-location.d.ts

@@ -12,32 +12,13 @@
 import type { LocationAddress } from './location-address';
 /**
  * Only send notifications to users near a given location.
- * @export
- * @interface SendFrameNotificationsReqBodyFiltersNearLocation
  */
 export interface SendFrameNotificationsReqBodyFiltersNearLocation {
-    /**
-     *
-     * @type {number}
-     * @memberof SendFrameNotificationsReqBodyFiltersNearLocation
-     */
     'latitude': number;
-    /**
-     *
-     * @type {number}
-     * @memberof SendFrameNotificationsReqBodyFiltersNearLocation
-     */
     'longitude': number;
-    /**
-     *
-     * @type {LocationAddress}
-     * @memberof SendFrameNotificationsReqBodyFiltersNearLocation
-     */
     'address'?: LocationAddress;
     /**
      * The radius in meters for the location search. Any location within this radius will be returned.
-     * @type {number}
-     * @memberof SendFrameNotificationsReqBodyFiltersNearLocation
      */
     'radius'?: number;
 }

package/build/api/models/send-frame-notifications-req-body-filters.d.ts

@@ -12,32 +12,19 @@
 import type { SendFrameNotificationsReqBodyFiltersNearLocation } from './send-frame-notifications-req-body-filters-near-location';
 /**
  * Filters to apply to the target_fids set. All filters are additive, so only users matching all filters will be notified.
- * @export
- * @interface SendFrameNotificationsReqBodyFilters
  */
 export interface SendFrameNotificationsReqBodyFilters {
     /**
      * Only send notifications to users who are not in the given FIDs.
-     * @type {Array<number>}
-     * @memberof SendFrameNotificationsReqBodyFilters
      */
     'exclude_fids'?: Array<number>;
     /**
      * Only send notifications to users who follow the given FID.
-     * @type {number}
-     * @memberof SendFrameNotificationsReqBodyFilters
      */
     'following_fid'?: number;
     /**
      * Only send notifications to users with a score greater than or equal to this value.
-     * @type {number}
-     * @memberof SendFrameNotificationsReqBodyFilters
      */
     'minimum_user_score'?: number;
-    /**
-     *
-     * @type {SendFrameNotificationsReqBodyFiltersNearLocation}
-     * @memberof SendFrameNotificationsReqBodyFilters
-     */
     'near_location'?: SendFrameNotificationsReqBodyFiltersNearLocation;
 }

package/build/api/models/send-frame-notifications-req-body-notification.d.ts

@@ -9,34 +9,21 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-/**
- *
- * @export
- * @interface SendFrameNotificationsReqBodyNotification
- */
 export interface SendFrameNotificationsReqBodyNotification {
     /**
      * The title of the notification. Must be between 1 and 32 characters.
-     * @type {string}
-     * @memberof SendFrameNotificationsReqBodyNotification
      */
     'title': string;
     /**
      * The body of the notification. Must be between 1 and 128 characters.
-     * @type {string}
-     * @memberof SendFrameNotificationsReqBodyNotification
      */
     'body': string;
     /**
      * The target URL to open when the user clicks the notification. Must be a valid URL.
-     * @type {string}
-     * @memberof SendFrameNotificationsReqBodyNotification
      */
     'target_url': string;
     /**
      * An optional UUID for the notification, used as an idempotency key.
-     * @type {string}
-     * @memberof SendFrameNotificationsReqBodyNotification
      */
     'uuid'?: string;
 }

package/build/api/models/send-frame-notifications-req-body.d.ts

@@ -11,28 +11,11 @@
  */
 import type { SendFrameNotificationsReqBodyFilters } from './send-frame-notifications-req-body-filters';
 import type { SendFrameNotificationsReqBodyNotification } from './send-frame-notifications-req-body-notification';
-/**
- *
- * @export
- * @interface SendFrameNotificationsReqBody
- */
 export interface SendFrameNotificationsReqBody {
     /**
      * An array of target FIDs to whom the notifications should be sent. Each FID must be a positive integer. Pass an empty array to send notifications to all FIDs with notifications enabled for the mini app.
-     * @type {Array<number>}
-     * @memberof SendFrameNotificationsReqBody
      */
     'target_fids'?: Array<number>;
-    /**
-     *
-     * @type {SendFrameNotificationsReqBodyFilters}
-     * @memberof SendFrameNotificationsReqBody
-     */
     'filters'?: SendFrameNotificationsReqBodyFilters;
-    /**
-     *
-     * @type {SendFrameNotificationsReqBodyNotification}
-     * @memberof SendFrameNotificationsReqBody
-     */
     'notification': SendFrameNotificationsReqBodyNotification;
 }

package/build/api/models/send-frame-notifications-response.d.ts

@@ -9,40 +9,25 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-/**
- *
- * @export
- * @interface SendFrameNotificationsResponse
- */
 export interface SendFrameNotificationsResponse {
     /**
      * The unique identifier for the notification campaign.
-     * @type {string}
-     * @memberof SendFrameNotificationsResponse
      */
     'campaign_id': string;
     /**
      * The number of notifications successfully delivered.
-     * @type {number}
-     * @memberof SendFrameNotificationsResponse
      */
     'success_count': number | null;
     /**
      * The number of notifications that failed to deliver.
-     * @type {number}
-     * @memberof SendFrameNotificationsResponse
      */
     'failure_count': number | null;
     /**
      * The number of notifications not attempted (e.g., disabled tokens, invalid tokens).
-     * @type {number}
-     * @memberof SendFrameNotificationsResponse
      */
     'not_attempted_count': number | null;
     /**
      * List of FIDs that failed due to retryable errors (rate_limited, failed, http_error). Can be used to retry sending notifications to these users.
-     * @type {Array<number>}
-     * @memberof SendFrameNotificationsResponse
      */
     'retryable_fids'?: Array<number>;
 }

package/build/api/models/shared-signer-permission.d.ts

@@ -9,11 +9,6 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-/**
- *
- * @export
- * @enum {string}
- */
 export declare const SharedSignerPermission: {
     readonly WriteAll: "WRITE_ALL";
     readonly ReadOnly: "READ_ONLY";

package/build/api/models/shared-signer-permission.js

@@ -14,11 +14,6 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SharedSignerPermission = void 0;
-/**
- *
- * @export
- * @enum {string}
- */
 exports.SharedSignerPermission = {
     WriteAll: 'WRITE_ALL',
     ReadOnly: 'READ_ONLY',

package/build/api/models/signed-key-request-sponsor.d.ts

@@ -9,28 +9,17 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-/**
- *
- * @export
- * @interface SignedKeyRequestSponsor
- */
 export interface SignedKeyRequestSponsor {
     /**
      * The unique identifier of a farcaster user or app (unsigned integer)
-     * @type {number}
-     * @memberof SignedKeyRequestSponsor
      */
     'fid'?: number;
     /**
      * Signature generated by the fid of the sponsor and the signature generated from signKeyRequest for the app.
-     * @type {string}
-     * @memberof SignedKeyRequestSponsor
      */
     'signature'?: string;
     /**
      * Neynar will sponsor the signer if set to true. **Note: ** If sponsor.fid and sponsor.signature are provided along with sponsored_by_neynar set to true, the sponsor.fid and sponsor.signature will be ignored. Neynar will sponsor the signer on behalf of the user. The developer will get charged in credits.
-     * @type {boolean}
-     * @memberof SignedKeyRequestSponsor
      */
     'sponsored_by_neynar'?: boolean;
 }

package/build/api/models/signed-message-body-signed-message.d.ts

@@ -13,6 +13,5 @@ import type { EncodedJsonFarcasterSignature } from './encoded-json-farcaster-sig
 /**
  * @type SignedMessageBodySignedMessage
  * JFS-signed message containing the event payload. The message must be properly signed and contain valid event information.  Can be provided as a single string or json object.
- * @export
  */
 export type SignedMessageBodySignedMessage = EncodedJsonFarcasterSignature | string;

package/build/api/models/signed-message-body.d.ts

@@ -10,22 +10,10 @@
  * Do not edit the class manually.
  */
 import type { SignedMessageBodySignedMessage } from './signed-message-body-signed-message';
-/**
- *
- * @export
- * @interface SignedMessageBody
- */
 export interface SignedMessageBody {
-    /**
-     *
-     * @type {SignedMessageBodySignedMessage}
-     * @memberof SignedMessageBody
-     */
     'signed_message': SignedMessageBodySignedMessage;
     /**
      * Domain of the mini app
-     * @type {string}
-     * @memberof SignedMessageBody
      */
     'app_domain': string;
 }

package/build/api/models/signer-list-response.d.ts

@@ -10,16 +10,6 @@
  * Do not edit the class manually.
  */
 import type { Signer } from './signer';
-/**
- *
- * @export
- * @interface SignerListResponse
- */
 export interface SignerListResponse {
-    /**
-     *
-     * @type {Array<Signer>}
-     * @memberof SignerListResponse
-     */
     'signers': Array<Signer>;
 }

package/build/api/models/signer-uuid-body.d.ts

@@ -10,34 +10,18 @@
  * Do not edit the class manually.
  */
 import type { AppHostEventType } from './app-host-event-type';
-/**
- *
- * @export
- * @interface SignerUuidBody
- */
 export interface SignerUuidBody {
     /**
      * 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 SignerUuidBody
      */
     'signer_uuid': string;
     /**
      * Domain of the mini app
-     * @type {string}
-     * @memberof SignerUuidBody
      */
     'app_domain': string;
     /**
      * The unique identifier of a farcaster user or app (unsigned integer)
-     * @type {number}
-     * @memberof SignerUuidBody
      */
     'fid': number;
-    /**
-     *
-     * @type {AppHostEventType}
-     * @memberof SignerUuidBody
-     */
     'event': AppHostEventType;
 }

package/build/api/models/signer.d.ts

@@ -10,53 +10,22 @@
  * 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: {