@neynar/nodejs-sdk 2.42.3 → 2.43.0

package/build/clients/NeynarAPIClient.d.ts

@@ -2,7 +2,7 @@ import { Logger } from "../common/logger";
 import { AxiosError, AxiosInstance } from "axios";
 import type { SetRequired } from "type-fest";
 import { Configuration } from './configuration';
-import type { AuthorizationUrlResponse, AuthorizationUrlResponseType, BalanceResponse, BanListResponse, BanResponse, BlockListResponse, BulkCastsResponse, BulkFollowResponse, BulkUserAddressType, BulkUsersByAddressResponse, BulkUsersResponse, CastComposerActionsListResponse, CastComposerType, CastConversationSortType, CastEmbedCrawlResponse, CastParamType, CastResponse, CastsMetricsResponse, CastsResponse, CastsSearchResponse, ChannelListResponse, ChannelMemberInviteListResponse, ChannelMemberListResponse, ChannelMemberRole, ChannelResponse, ChannelResponseBulk, ChannelSearchResponse, ChannelType, Conversation, ConversationSummary, DeleteFrameResponse, DeployFungibleFactoryEnum, DeployFungibleMetadataNsfwEnum, DeployFungibleNetworkEnum, DeployFungibleResponse, DeveloperManagedSigner, EmbedType, ErrorRes, FarcasterActionReqBodyAction, FeedResponse, FeedTrendingProvider, FeedType, FetchBulkCastsSortTypeEnum, FetchCastMetricsIntervalEnum, FetchFrameCatalogCategoriesEnum, FetchFrameMetaTagsFromUrl200Response, FetchRelevantFrames200Response, FetchRepliesAndRecastsForUserFilterEnum, FetchTrendingChannelsTimeWindowEnum, FetchTrendingFeedTimeWindowEnum, FetchUserInteractions200Response, FilterType, FnameAvailabilityResponse, FollowSortType, FollowersResponse, ForYouProvider, Frame, FrameAction, FrameCatalogResponse, FrameNotificationTokens, FramePayTransactionRequestBody, FrameSignaturePacket, FrameType, FrameValidateAnalyticsResponse, FrameValidateListResponse, LookupCastConversationFoldEnum, MiniAppTimeWindow, MuteListResponse, MuteResponse, Network, NeynarFrame, NeynarFramePage, NonceResponse, NotificationType, NotificationsResponse, OperationResponse, PostCastReqBodyEmbeds, PostCastResponse, ReactionReqBodyTarget, ReactionType, ReactionsCastResponse, ReactionsResponse, ReactionsType, RegisterUserOnChainReqBodyPreRegistrationCallsInner, RegisterUserOnChainReqBodyRegistration, RegisterUserOnChainReqBodySignersInner, RegisterUserOnChainResponse, RegisterUserReqBodyMetadata, RegisterUserResponse, RelevantFollowersResponse, RelevantFungibleOwnersResponse, SearchCastsModeEnum, SearchSortType, SendFrameNotificationsReqBodyFilters, SendFrameNotificationsReqBodyNotification, SendFrameNotificationsResponse, SignedKeyRequestSponsor, Signer, SignerListResponse, StorageAllocationsResponse, StorageUsageResponse, SubscribedToResponse, SubscribersResponse, SubscriptionCheckResponse, SubscriptionProvider, SubscriptionProviders, SubscriptionsResponse, TransactionFrameResponse, TrendingChannelResponse, UpdateUserReqBodyLocation, UpdateUserReqBodyVerifiedAccounts, UserFIDResponse, UserPowerLiteResponse, UserResponse, UserSearchResponse, UsersActiveChannelsResponse, UsersResponse, ValidateFrameActionResponse, ValidateFrameAggregateWindow, ValidateFrameAnalyticsType, VerificationChainId, VerificationType, WebhookListResponse, WebhookPatchReqBodyActiveEnum, WebhookResponse, WebhookSubscriptionFilters } from '../api';
+import type { AuthorizationUrlResponse, AuthorizationUrlResponseType, BalanceResponse, BanListResponse, BanResponse, BlockListResponse, BulkCastsResponse, BulkFollowResponse, BulkUserAddressType, BulkUsersByAddressResponse, BulkUsersResponse, CastComposerActionsListResponse, CastComposerType, CastConversationSortType, CastEmbedCrawlResponse, CastParamType, CastResponse, CastsMetricsResponse, CastsResponse, CastsSearchResponse, ChannelListResponse, ChannelMemberInviteListResponse, ChannelMemberListResponse, ChannelMemberRole, ChannelResponse, ChannelResponseBulk, ChannelSearchResponse, ChannelType, Conversation, ConversationSummary, DeleteFrameResponse, DeployFungibleFactoryEnum, DeployFungibleMetadataNsfwEnum, DeployFungibleNetworkEnum, DeployFungibleResponse, DeveloperManagedSigner, EmbedType, ErrorRes, FarcasterActionReqBodyAction, FeedResponse, FeedTrendingProvider, FeedType, FetchBulkCastsSortTypeEnum, FetchCastMetricsIntervalEnum, FetchFrameCatalogCategoriesEnum, FetchFrameMetaTagsFromUrl200Response, FetchRelevantFrames200Response, FetchRepliesAndRecastsForUserFilterEnum, FetchTrendingChannelsTimeWindowEnum, FetchTrendingFeedTimeWindowEnum, FetchUserInteractions200Response, FilterType, FnameAvailabilityResponse, FollowSortType, FollowersResponse, ForYouProvider, Frame, FrameAction, FrameCatalogResponse, FrameNotificationTokens, FramePayTransactionRequestBody, FrameSignaturePacket, FrameType, FrameValidateAnalyticsResponse, FrameValidateListResponse, LookupCastConversationFoldEnum, MiniAppTimeWindow, MuteListResponse, MuteResponse, Network, NeynarFrame, NeynarFramePage, NonceResponse, NotificationType, NotificationsResponse, OperationResponse, PostCastReqBodyEmbeds, PostCastResponse, ReactionReqBodyTarget, ReactionType, ReactionsCastResponse, ReactionsResponse, ReactionsType, RegisterUserOnChainReqBodyPreRegistrationCallsInner, RegisterUserOnChainReqBodyRegistration, RegisterUserOnChainReqBodySignersInner, RegisterUserOnChainResponse, RegisterUserReqBodyMetadata, RegisterUserResponse, RelevantFollowersResponse, RelevantFungibleOwnersResponse, SearchCastsModeEnum, SearchSortType, SendFrameNotificationsReqBodyFilters, SendFrameNotificationsReqBodyNotification, SendFrameNotificationsResponse, SignedKeyRequestSponsor, Signer, SignerListResponse, StorageAllocationsResponse, StorageUsageResponse, SubscribedToResponse, SubscribersResponse, SubscriptionCheckResponse, SubscriptionProvider, SubscriptionProviders, SubscriptionsResponse, TransactionFrameResponse, TransactionSendFungiblesRequest, TransactionSendFungiblesResponse, TrendingChannelResponse, UpdateUserReqBodyLocation, UpdateUserReqBodyVerifiedAccounts, UserFIDResponse, UserPowerLiteResponse, UserResponse, UserSearchResponse, UsersActiveChannelsResponse, UsersResponse, ValidateFrameActionResponse, ValidateFrameAggregateWindow, ValidateFrameAnalyticsType, VerificationChainId, VerificationType, WebhookListResponse, WebhookPatchReqBodyActiveEnum, WebhookResponse, WebhookSubscriptionFilters } from '../api';
 export interface NeynarAPIClientOptions {
     logger?: Logger;
     axiosInstance?: AxiosInstance;
@@ -2393,13 +2393,14 @@ export declare class NeynarAPIClient {
         cursor?: string;
     }): Promise<NotificationsResponse>;
     /**
-     * Mark notifications as seen
+     * Mark notifications as seen. You can choose one of two authorization methods, either:   1. Provide a valid signer_uuid in the request body (Most common)   2. Provide a valid, signed \"Bearer\" token in the request\'s `Authorization` header similar to the      approach described [here](https://docs.farcaster.xyz/reference/warpcast/api#authentication)
      *
      * @summary Mark as seen
      *
      * @param {object} params
-     * @param {string} params.signerUuid  - The UUID of the signer. Signer should have atleast one write permission
+     * @param {string} params.signerUuid [optional]  - The UUID of a signer with at least one write permission.  Required unless a valid Authorization Bearer token is provided in the header.
      * @param {NotificationType} params.type [optional]
+     * @param {string} params.authorization [optional]  - Optional Bearer token for certain endpoints. The token format is described [here](https://docs.farcaster.xyz/reference/warpcast/api#authentication).
      *
      * @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
      *
@@ -2408,8 +2409,9 @@ export declare class NeynarAPIClient {
      * // Fill in the appropriate values
      * const signerUuid =
      * const type =
+     * const authorization =
      *
-     * client.markNotificationsAsSeen({signerUuid, type}).then(response => {
+     * client.markNotificationsAsSeen({signerUuid, type, authorization}).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -2417,8 +2419,9 @@ export declare class NeynarAPIClient {
      *
      */
     markNotificationsAsSeen(params: {
-        signerUuid: string;
+        signerUuid?: string;
         type?: NotificationType;
+        authorization?: string;
     }): Promise<OperationResponse>;
     /**
      * Creates a new token. This is an allowlisted API, reach out if you want access.
@@ -2574,6 +2577,34 @@ export declare class NeynarAPIClient {
         preRegistrationCalls?: Array<RegisterUserOnChainReqBodyPreRegistrationCallsInner>;
         idem?: string;
     }): Promise<RegisterUserOnChainResponse>;
+    /**
+     * Send fungibles in bulk to several farcaster users. A funded wallet is to required use this API. React out to us on the Neynar channel on farcaster to get your wallet address.
+     *
+     * @summary Send fungibles
+     *
+     * @param {object} params
+     * @param {string} params.xWalletId  - Wallet ID to use for transactions
+     * @param {TransactionSendFungiblesRequest} params.transactionSendFungiblesRequest
+     *
+     * @returns {Promise<TransactionSendFungiblesResponse>} A promise that resolves to a `TransactionSendFungiblesResponse` object.
+     *
+     * @example
+     *
+     * // Fill in the appropriate values
+     * const xWalletId =
+     * const transactionSendFungiblesRequest =
+     *
+     * client.sendFungiblesToUsers({ xWalletId, transactionSendFungiblesRequest }).then(response => {
+     *   console.log('response:', response);
+     * });
+     *
+     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/send-fungibles-to-users)
+     *
+     */
+    sendFungiblesToUsers(params: {
+        xWalletId: string;
+        transactionSendFungiblesRequest: TransactionSendFungiblesRequest;
+    }): Promise<TransactionSendFungiblesResponse>;
     /**
      * Delete a reaction (like or recast) to a cast \\ (In order to delete a reaction `signer_uuid` must be approved)
      *

package/build/clients/NeynarAPIClient.js

@@ -2684,13 +2684,14 @@ const client = new NeynarAPIClient(config);\n`);
         return response.data;
     }
     /**
-     * Mark notifications as seen
+     * Mark notifications as seen. You can choose one of two authorization methods, either:   1. Provide a valid signer_uuid in the request body (Most common)   2. Provide a valid, signed \"Bearer\" token in the request\'s `Authorization` header similar to the      approach described [here](https://docs.farcaster.xyz/reference/warpcast/api#authentication)
      *
      * @summary Mark as seen
      *
      * @param {object} params
-     * @param {string} params.signerUuid  - The UUID of the signer. Signer should have atleast one write permission
+     * @param {string} params.signerUuid [optional]  - The UUID of a signer with at least one write permission.  Required unless a valid Authorization Bearer token is provided in the header.
      * @param {NotificationType} params.type [optional]
+     * @param {string} params.authorization [optional]  - Optional Bearer token for certain endpoints. The token format is described [here](https://docs.farcaster.xyz/reference/warpcast/api#authentication).
      *
      * @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
      *
@@ -2699,8 +2700,9 @@ const client = new NeynarAPIClient(config);\n`);
      * // Fill in the appropriate values
      * const signerUuid =
      * const type =
+     * const authorization =
      *
-     * client.markNotificationsAsSeen({signerUuid, type}).then(response => {
+     * client.markNotificationsAsSeen({signerUuid, type, authorization}).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -2863,6 +2865,36 @@ const client = new NeynarAPIClient(config);\n`);
         const response = await this.apis.onchainApi.registerAccountOnchain(adjustedParams);
         return response.data;
     }
+    /**
+     * Send fungibles in bulk to several farcaster users. A funded wallet is to required use this API. React out to us on the Neynar channel on farcaster to get your wallet address.
+     *
+     * @summary Send fungibles
+     *
+     * @param {object} params
+     * @param {string} params.xWalletId  - Wallet ID to use for transactions
+     * @param {TransactionSendFungiblesRequest} params.transactionSendFungiblesRequest
+     *
+     * @returns {Promise<TransactionSendFungiblesResponse>} A promise that resolves to a `TransactionSendFungiblesResponse` object.
+     *
+     * @example
+     *
+     * // Fill in the appropriate values
+     * const xWalletId =
+     * const transactionSendFungiblesRequest =
+     *
+     * client.sendFungiblesToUsers({ xWalletId, transactionSendFungiblesRequest }).then(response => {
+     *   console.log('response:', response);
+     * });
+     *
+     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/send-fungibles-to-users)
+     *
+     */
+    async sendFungiblesToUsers(params) {
+        const adjustedParams = {};
+        Object.assign(adjustedParams, params);
+        const response = await this.apis.onchainApi.sendFungiblesToUsers(adjustedParams);
+        return response.data;
+    }
     /**
      * Delete a reaction (like or recast) to a cast \\ (In order to delete a reaction `signer_uuid` must be approved)
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@neynar/nodejs-sdk",
-  "version": "2.42.3",
+  "version": "2.43.0",
   "description": "SDK to interact with Neynar APIs (https://docs.neynar.com/reference/quickstart)",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",