@neynar/nodejs-sdk 3.137.0 → 3.137.1

package/build/api/base.d.ts

@@ -12,42 +12,22 @@
 import type { Configuration } from './configuration';
 import type { AxiosInstance, RawAxiosRequestConfig } from 'axios';
 export declare const BASE_PATH: string;
-/**
- *
- * @export
- */
 export declare const COLLECTION_FORMATS: {
     csv: string;
     ssv: string;
     tsv: string;
     pipes: string;
 };
-/**
- *
- * @export
- * @interface RequestArgs
- */
 export interface RequestArgs {
     url: string;
     options: RawAxiosRequestConfig;
 }
-/**
- *
- * @export
- * @class BaseAPI
- */
 export declare class BaseAPI {
     protected basePath: string;
     protected axios: AxiosInstance;
     protected configuration: Configuration | undefined;
     constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
 }
-/**
- *
- * @export
- * @class RequiredError
- * @extends {Error}
- */
 export declare class RequiredError extends Error {
     field: string;
     constructor(field: string, msg?: string);
@@ -58,9 +38,5 @@ interface ServerMap {
         description: string;
     }[];
 }
-/**
- *
- * @export
- */
 export declare const operationServerMap: ServerMap;
 export {};

package/build/api/base.js

@@ -19,21 +19,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.operationServerMap = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = exports.BASE_PATH = void 0;
 const axios_1 = __importDefault(require("axios"));
 exports.BASE_PATH = "https://api.neynar.com".replace(/\/+$/, "");
-/**
- *
- * @export
- */
 exports.COLLECTION_FORMATS = {
     csv: ",",
     ssv: " ",
     tsv: "\t",
     pipes: "|",
 };
-/**
- *
- * @export
- * @class BaseAPI
- */
 class BaseAPI {
     constructor(configuration, basePath = exports.BASE_PATH, axios = axios_1.default) {
         var _a;
@@ -47,12 +38,6 @@ class BaseAPI {
 }
 exports.BaseAPI = BaseAPI;
 ;
-/**
- *
- * @export
- * @class RequiredError
- * @extends {Error}
- */
 class RequiredError extends Error {
     constructor(field, msg) {
         super(msg);
@@ -61,8 +46,4 @@ class RequiredError extends Error {
     }
 }
 exports.RequiredError = RequiredError;
-/**
- *
- * @export
- */
 exports.operationServerMap = {};

package/build/api/common.d.ts

@@ -12,54 +12,23 @@
 import type { Configuration } from "./configuration";
 import type { RequestArgs } from "./base";
 import type { AxiosInstance, AxiosResponse } from 'axios';
-/**
- *
- * @export
- */
 export declare const DUMMY_BASE_URL = "https://example.com";
 /**
  *
  * @throws {RequiredError}
- * @export
  */
 export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
-/**
- *
- * @export
- */
 export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
-/**
- *
- * @export
- */
 export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
-/**
- *
- * @export
- */
 export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
-/**
- *
- * @export
- */
 export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
-/**
- *
- * @export
- */
 export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
 /**
- *
- * @export
+ * JSON serialization helper function which replaces instances of unserializable types with serializable ones.
+ * This function will run for every key-value pair encountered by JSON.stringify while traversing an object.
+ * Converting a set to a string will return an empty object, so an intermediate conversion to an array is required.
  */
+export declare const replaceWithSerializableTypeIfNeeded: (key: string, value: any) => any;
 export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
-/**
- *
- * @export
- */
 export declare const toPathString: (url: URL) => string;
-/**
- *
- * @export
- */
-export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T, any, {}>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
+export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;

package/build/api/common.js

@@ -13,17 +13,12 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createRequestFunction = exports.toPathString = exports.serializeDataIfNeeded = exports.setSearchParams = exports.setOAuthToObject = exports.setBearerAuthToObject = exports.setBasicAuthToObject = exports.setApiKeyToObject = exports.assertParamExists = exports.DUMMY_BASE_URL = void 0;
+exports.createRequestFunction = exports.toPathString = exports.serializeDataIfNeeded = exports.replaceWithSerializableTypeIfNeeded = exports.setSearchParams = exports.setOAuthToObject = exports.setBearerAuthToObject = exports.setBasicAuthToObject = exports.setApiKeyToObject = exports.assertParamExists = exports.DUMMY_BASE_URL = void 0;
 const base_1 = require("./base");
-/**
- *
- * @export
- */
 exports.DUMMY_BASE_URL = 'https://example.com';
 /**
  *
  * @throws {RequiredError}
- * @export
  */
 const assertParamExists = function (functionName, paramName, paramValue) {
     if (paramValue === null || paramValue === undefined) {
@@ -31,10 +26,6 @@ const assertParamExists = function (functionName, paramName, paramValue) {
     }
 };
 exports.assertParamExists = assertParamExists;
-/**
- *
- * @export
- */
 const setApiKeyToObject = async function (object, keyParamName, configuration) {
     if (configuration && configuration.apiKey) {
         const localVarApiKeyValue = typeof configuration.apiKey === 'function'
@@ -44,20 +35,12 @@ const setApiKeyToObject = async function (object, keyParamName, configuration) {
     }
 };
 exports.setApiKeyToObject = setApiKeyToObject;
-/**
- *
- * @export
- */
 const setBasicAuthToObject = function (object, configuration) {
     if (configuration && (configuration.username || configuration.password)) {
         object["auth"] = { username: configuration.username, password: configuration.password };
     }
 };
 exports.setBasicAuthToObject = setBasicAuthToObject;
-/**
- *
- * @export
- */
 const setBearerAuthToObject = async function (object, configuration) {
     if (configuration && configuration.accessToken) {
         const accessToken = typeof configuration.accessToken === 'function'
@@ -67,10 +50,6 @@ const setBearerAuthToObject = async function (object, configuration) {
     }
 };
 exports.setBearerAuthToObject = setBearerAuthToObject;
-/**
- *
- * @export
- */
 const setOAuthToObject = async function (object, name, scopes, configuration) {
     if (configuration && configuration.accessToken) {
         const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
@@ -84,7 +63,7 @@ function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
     if (parameter == null)
         return;
     if (typeof parameter === "object") {
-        if (Array.isArray(parameter)) {
+        if (Array.isArray(parameter) || parameter instanceof Set) {
             parameter.forEach(item => setFlattenedQueryParams(urlSearchParams, item, key));
         }
         else {
@@ -100,10 +79,6 @@ function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
         }
     }
 }
-/**
- *
- * @export
- */
 const setSearchParams = function (url, ...objects) {
     const searchParams = new URLSearchParams(url.search);
     setFlattenedQueryParams(searchParams, objects);
@@ -111,31 +86,34 @@ const setSearchParams = function (url, ...objects) {
 };
 exports.setSearchParams = setSearchParams;
 /**
- *
- * @export
+ * JSON serialization helper function which replaces instances of unserializable types with serializable ones.
+ * This function will run for every key-value pair encountered by JSON.stringify while traversing an object.
+ * Converting a set to a string will return an empty object, so an intermediate conversion to an array is required.
  */
+// @ts-ignore
+const replaceWithSerializableTypeIfNeeded = function (key, value) {
+    if (value instanceof Set) {
+        return Array.from(value);
+    }
+    else {
+        return value;
+    }
+};
+exports.replaceWithSerializableTypeIfNeeded = replaceWithSerializableTypeIfNeeded;
 const serializeDataIfNeeded = function (value, requestOptions, configuration) {
     const nonString = typeof value !== 'string';
     const needsSerialization = nonString && configuration && configuration.isJsonMime
         ? configuration.isJsonMime(requestOptions.headers['Content-Type'])
         : nonString;
     return needsSerialization
-        ? JSON.stringify(value !== undefined ? value : {})
+        ? JSON.stringify(value !== undefined ? value : {}, exports.replaceWithSerializableTypeIfNeeded)
         : (value || "");
 };
 exports.serializeDataIfNeeded = serializeDataIfNeeded;
-/**
- *
- * @export
- */
 const toPathString = function (url) {
     return url.pathname + url.search + url.hash;
 };
 exports.toPathString = toPathString;
-/**
- *
- * @export
- */
 const createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
     return (axios = globalAxios, basePath = BASE_PATH) => {
         var _a;

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

@@ -11,46 +11,17 @@
  */
 import type { VerificationChainId } from './verification-chain-id';
 import type { VerificationType } from './verification-type';
-/**
- *
- * @export
- * @interface AddVerificationReqBody
- */
 export interface AddVerificationReqBody {
     /**
      * 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 AddVerificationReqBody
      */
     'signer_uuid': string;
     /**
      * Ethereum address
-     * @type {string}
-     * @memberof AddVerificationReqBody
      */
     'address': string;
-    /**
-     *
-     * @type {string}
-     * @memberof AddVerificationReqBody
-     */
     'block_hash': string;
-    /**
-     *
-     * @type {string}
-     * @memberof AddVerificationReqBody
-     */
     'eth_signature': string;
-    /**
-     *
-     * @type {VerificationType}
-     * @memberof AddVerificationReqBody
-     */
     'verification_type'?: VerificationType;
-    /**
-     *
-     * @type {VerificationChainId}
-     * @memberof AddVerificationReqBody
-     */
     'chain_id'?: VerificationChainId;
 }

package/build/api/models/address-balance-verified-address.d.ts

@@ -10,22 +10,10 @@
  * Do not edit the class manually.
  */
 import type { Network } from './network';
-/**
- *
- * @export
- * @interface AddressBalanceVerifiedAddress
- */
 export interface AddressBalanceVerifiedAddress {
     /**
      * The wallet address
-     * @type {string}
-     * @memberof AddressBalanceVerifiedAddress
      */
     'address': string;
-    /**
-     *
-     * @type {Network}
-     * @memberof AddressBalanceVerifiedAddress
-     */
     'network': Network;
 }

package/build/api/models/address-balance.d.ts

@@ -13,27 +13,10 @@ import type { AddressBalanceVerifiedAddress } from './address-balance-verified-a
 import type { TokenBalance } from './token-balance';
 /**
  * The token balances associated with a wallet address
- * @export
- * @interface AddressBalance
  */
 export interface AddressBalance {
-    /**
-     *
-     * @type {string}
-     * @memberof AddressBalance
-     */
     'object': AddressBalanceObjectEnum;
-    /**
-     *
-     * @type {AddressBalanceVerifiedAddress}
-     * @memberof AddressBalance
-     */
     'verified_address': AddressBalanceVerifiedAddress;
-    /**
-     *
-     * @type {Array<TokenBalance>}
-     * @memberof AddressBalance
-     */
     'token_balances': Array<TokenBalance>;
 }
 export declare const AddressBalanceObjectEnum: {

package/build/api/models/app-host-event-type.d.ts

@@ -11,8 +11,6 @@
  */
 /**
  * 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
- * @export
- * @enum {string}
  */
 export declare const AppHostEventType: {
     readonly FrameAdded: "frame_added";

package/build/api/models/app-host-event-type.js

@@ -16,8 +16,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AppHostEventType = void 0;
 /**
  * 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
- * @export
- * @enum {string}
  */
 exports.AppHostEventType = {
     FrameAdded: 'frame_added',

package/build/api/models/app-host-get-event-response-notification-details.d.ts

@@ -11,20 +11,14 @@
  */
 /**
  * Details for notification setup, only present when event is notifications_enabled
- * @export
- * @interface AppHostGetEventResponseNotificationDetails
  */
 export interface AppHostGetEventResponseNotificationDetails {
     /**
      * URL endpoint for sending notifications
-     * @type {string}
-     * @memberof AppHostGetEventResponseNotificationDetails
      */
     'url': string;
     /**
      * Token to use when sending notifications to this user
-     * @type {string}
-     * @memberof AppHostGetEventResponseNotificationDetails
      */
     'token': string;
 }

package/build/api/models/app-host-get-event-response.d.ts

@@ -10,22 +10,10 @@
  * Do not edit the class manually.
  */
 import type { AppHostGetEventResponseNotificationDetails } from './app-host-get-event-response-notification-details';
-/**
- *
- * @export
- * @interface AppHostGetEventResponse
- */
 export interface AppHostGetEventResponse {
     /**
      * Legacy event type corresponding to the requested event type: - 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
-     * @type {string}
-     * @memberof AppHostGetEventResponse
      */
     'event': string;
-    /**
-     *
-     * @type {AppHostGetEventResponseNotificationDetails}
-     * @memberof AppHostGetEventResponse
-     */
     'notificationDetails'?: AppHostGetEventResponseNotificationDetails;
 }

package/build/api/models/app-host-post-event-req-body.d.ts

@@ -14,6 +14,5 @@ import type { SignerUuidBody } from './signer-uuid-body';
 /**
  * @type AppHostPostEventReqBody
  * Request body for app host events. Can either provide a signed_message or a signer_uuid with event details.
- * @export
  */
 export type AppHostPostEventReqBody = SignedMessageBody | SignerUuidBody;

package/build/api/models/app-host-post-event-response.d.ts

@@ -9,22 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-/**
- *
- * @export
- * @interface AppHostPostEventResponse
- */
 export interface AppHostPostEventResponse {
-    /**
-     *
-     * @type {boolean}
-     * @memberof AppHostPostEventResponse
-     */
     'success': boolean;
-    /**
-     *
-     * @type {string}
-     * @memberof AppHostPostEventResponse
-     */
     'message'?: string;
 }

package/build/api/models/app-host-user-state-response-notifications-enabled-inner.d.ts

@@ -9,28 +9,17 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-/**
- *
- * @export
- * @interface AppHostUserStateResponseNotificationsEnabledInner
- */
 export interface AppHostUserStateResponseNotificationsEnabledInner {
     /**
      * Domain of the mini app
-     * @type {string}
-     * @memberof AppHostUserStateResponseNotificationsEnabledInner
      */
     'domain': string;
     /**
      * Status of notifications for this domain (usually \'valid\')
-     * @type {string}
-     * @memberof AppHostUserStateResponseNotificationsEnabledInner
      */
     'status': string;
     /**
      * When the notification preference was last updated
-     * @type {string}
-     * @memberof AppHostUserStateResponseNotificationsEnabledInner
      */
     'updated_at': string;
 }

package/build/api/models/app-host-user-state-response.d.ts

@@ -10,16 +10,9 @@
  * Do not edit the class manually.
  */
 import type { AppHostUserStateResponseNotificationsEnabledInner } from './app-host-user-state-response-notifications-enabled-inner';
-/**
- *
- * @export
- * @interface AppHostUserStateResponse
- */
 export interface AppHostUserStateResponse {
     /**
      * List of domains for which notifications are enabled for this user
-     * @type {Array<AppHostUserStateResponseNotificationsEnabledInner>}
-     * @memberof AppHostUserStateResponse
      */
     'notifications_enabled': Array<AppHostUserStateResponseNotificationsEnabledInner>;
 }

package/build/api/models/associate-deployment-request-account-association.d.ts

@@ -11,26 +11,18 @@
  */
 /**
  * Signed domain association linking this deployment to a Farcaster account
- * @export
- * @interface AssociateDeploymentRequestAccountAssociation
  */
 export interface AssociateDeploymentRequestAccountAssociation {
     /**
      * Base64URL encoded JFS header
-     * @type {string}
-     * @memberof AssociateDeploymentRequestAccountAssociation
      */
     'header': string;
     /**
      * Base64URL encoded JFS payload
-     * @type {string}
-     * @memberof AssociateDeploymentRequestAccountAssociation
      */
     'payload': string;
     /**
      * Base64URL encoded JFS signature
-     * @type {string}
-     * @memberof AssociateDeploymentRequestAccountAssociation
      */
     'signature': string;
 }

package/build/api/models/associate-deployment-request.d.ts

@@ -10,40 +10,22 @@
  * Do not edit the class manually.
  */
 import type { AssociateDeploymentRequestAccountAssociation } from './associate-deployment-request-account-association';
-/**
- *
- * @export
- * @interface AssociateDeploymentRequest
- */
 export interface AssociateDeploymentRequest {
     /**
      * Deployment ID (UUID). Required if name not provided.
-     * @type {string}
-     * @memberof AssociateDeploymentRequest
      */
     'deployment_id'?: string;
     /**
      * Farcaster ID of the user; if not provided, namespace must be provided
-     * @type {number}
-     * @memberof AssociateDeploymentRequest
      */
     'fid'?: number;
     /**
      * Kubernetes deployment name. Required if deployment_id not provided.
-     * @type {string}
-     * @memberof AssociateDeploymentRequest
      */
     'name'?: string;
     /**
      * Optional Kubernetes namespace. If not provided, will query for the active namespace for the given FID.
-     * @type {string}
-     * @memberof AssociateDeploymentRequest
      */
     'namespace'?: string;
-    /**
-     *
-     * @type {AssociateDeploymentRequestAccountAssociation}
-     * @memberof AssociateDeploymentRequest
-     */
     'account_association': AssociateDeploymentRequestAccountAssociation;
 }

package/build/api/models/associate-deployment200-response.d.ts

@@ -9,22 +9,10 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-/**
- *
- * @export
- * @interface AssociateDeployment200Response
- */
 export interface AssociateDeployment200Response {
-    /**
-     *
-     * @type {boolean}
-     * @memberof AssociateDeployment200Response
-     */
     'success': boolean;
     /**
      * Status message from the miniapp generator
-     * @type {string}
-     * @memberof AssociateDeployment200Response
      */
     'message': string;
 }

package/build/api/models/authorization-url-response.d.ts

@@ -9,16 +9,6 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-/**
- *
- * @export
- * @interface AuthorizationUrlResponse
- */
 export interface AuthorizationUrlResponse {
-    /**
-     *
-     * @type {string}
-     * @memberof AuthorizationUrlResponse
-     */
     'authorization_url': string;
 }

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

@@ -11,29 +11,9 @@
  */
 import type { AddressBalance } from './address-balance';
 import type { UserDehydrated } from './user-dehydrated';
-/**
- *
- * @export
- * @interface BalanceResponseUserBalance
- */
 export interface BalanceResponseUserBalance {
-    /**
-     *
-     * @type {string}
-     * @memberof BalanceResponseUserBalance
-     */
     'object': BalanceResponseUserBalanceObjectEnum;
-    /**
-     *
-     * @type {UserDehydrated}
-     * @memberof BalanceResponseUserBalance
-     */
     'user': UserDehydrated;
-    /**
-     *
-     * @type {Array<AddressBalance>}
-     * @memberof BalanceResponseUserBalance
-     */
     'address_balances': Array<AddressBalance>;
 }
 export declare const BalanceResponseUserBalanceObjectEnum: {

package/build/api/models/balance-response.d.ts

@@ -10,16 +10,6 @@
  * Do not edit the class manually.
  */
 import type { BalanceResponseUserBalance } from './balance-response-user-balance';
-/**
- *
- * @export
- * @interface BalanceResponse
- */
 export interface BalanceResponse {
-    /**
-     *
-     * @type {BalanceResponseUserBalance}
-     * @memberof BalanceResponse
-     */
     'user_balance'?: BalanceResponseUserBalance;
 }