@neynar/nodejs-sdk 2.44.0 → 3.18.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/api/api.d.ts +5 -3
- package/build/api/api.js +5 -3
- package/build/api/apis/action-api.d.ts +8 -8
- package/build/api/apis/action-api.js +8 -8
- package/build/api/apis/agents-api.d.ts +56 -25
- package/build/api/apis/agents-api.js +53 -26
- package/build/api/apis/app-host-api.d.ts +317 -0
- package/build/api/apis/app-host-api.js +337 -0
- package/build/api/apis/auth-address-api.d.ts +205 -0
- package/build/api/apis/auth-address-api.js +230 -0
- package/build/api/apis/ban-api.d.ts +16 -16
- package/build/api/apis/ban-api.js +13 -13
- package/build/api/apis/block-api.d.ts +16 -16
- package/build/api/apis/block-api.js +13 -13
- package/build/api/apis/cast-api.d.ts +282 -113
- package/build/api/apis/cast-api.js +231 -76
- package/build/api/apis/channel-api.d.ts +57 -42
- package/build/api/apis/channel-api.js +53 -39
- package/build/api/apis/feed-api.d.ts +225 -181
- package/build/api/apis/feed-api.js +160 -112
- package/build/api/apis/fname-api.d.ts +3 -3
- package/build/api/apis/fname-api.js +4 -4
- package/build/api/apis/follows-api.d.ts +72 -57
- package/build/api/apis/follows-api.js +51 -37
- package/build/api/apis/frame-api.d.ts +232 -58
- package/build/api/apis/frame-api.js +208 -48
- package/build/api/apis/login-api.d.ts +3 -3
- package/build/api/apis/login-api.js +4 -4
- package/build/api/apis/metrics-api.d.ts +22 -20
- package/build/api/apis/metrics-api.js +16 -14
- package/build/api/apis/mute-api.d.ts +16 -16
- package/build/api/apis/mute-api.js +13 -13
- package/build/api/apis/notifications-api.d.ts +43 -32
- package/build/api/apis/notifications-api.js +58 -41
- package/build/api/apis/onchain-api.d.ts +260 -40
- package/build/api/apis/onchain-api.js +249 -34
- package/build/api/apis/reaction-api.d.ts +46 -29
- package/build/api/apis/reaction-api.js +39 -23
- package/build/api/apis/signer-api.d.ts +30 -24
- package/build/api/apis/signer-api.js +30 -24
- package/build/api/apis/storage-api.d.ts +9 -9
- package/build/api/apis/storage-api.js +10 -10
- package/build/api/apis/subscribers-api.d.ts +55 -35
- package/build/api/apis/subscribers-api.js +39 -20
- package/build/api/apis/user-api.d.ts +223 -305
- package/build/api/apis/user-api.js +192 -274
- package/build/api/apis/webhook-api.d.ts +3 -3
- package/build/api/apis/webhook-api.js +9 -9
- package/build/api/base.d.ts +3 -3
- package/build/api/base.js +4 -4
- package/build/api/common.d.ts +3 -3
- package/build/api/common.js +3 -3
- package/build/api/configuration.d.ts +3 -3
- package/build/api/configuration.js +3 -3
- package/build/api/index.d.ts +3 -3
- package/build/api/index.js +3 -3
- package/build/api/models/add-verification-req-body.d.ts +3 -3
- package/build/api/models/add-verification-req-body.js +3 -3
- package/build/api/models/address-balance-verified-address.d.ts +3 -3
- package/build/api/models/address-balance-verified-address.js +3 -3
- package/build/api/models/address-balance.d.ts +3 -3
- package/build/api/models/address-balance.js +3 -3
- package/build/api/models/app-host-event-type.d.ts +23 -0
- package/build/api/models/app-host-event-type.js +27 -0
- package/build/api/models/app-host-get-event-response-notification-details.d.ts +30 -0
- package/build/api/models/{cast-with-interactions-and-conversations-ref-all-of.js → app-host-get-event-response-notification-details.js} +3 -3
- package/build/api/models/app-host-get-event-response.d.ts +31 -0
- package/build/api/models/{cast-with-interactions-and-conversations-ref.js → app-host-get-event-response.js} +3 -3
- package/build/api/models/app-host-post-event-req-body-one-of-signed-message-one-of.d.ts +36 -0
- package/build/api/models/{cast-with-interactions-all-of.js → app-host-post-event-req-body-one-of-signed-message-one-of.js} +3 -3
- package/build/api/models/app-host-post-event-req-body-one-of-signed-message.d.ts +18 -0
- package/build/api/models/{cast-with-interactions-and-conversations-all-of.js → app-host-post-event-req-body-one-of-signed-message.js} +3 -3
- package/build/api/models/app-host-post-event-req-body-one-of.d.ts +31 -0
- package/build/api/models/app-host-post-event-req-body-one-of.js +15 -0
- package/build/api/models/app-host-post-event-req-body-one-of1.d.ts +43 -0
- package/build/api/models/app-host-post-event-req-body-one-of1.js +15 -0
- package/build/api/models/app-host-post-event-req-body.d.ts +19 -0
- package/build/api/models/app-host-post-event-req-body.js +15 -0
- package/build/api/models/app-host-post-event-response.d.ts +30 -0
- package/build/api/models/app-host-post-event-response.js +15 -0
- package/build/api/models/app-host-user-state-response-notifications-enabled-inner.d.ts +36 -0
- package/build/api/models/app-host-user-state-response-notifications-enabled-inner.js +15 -0
- package/build/api/models/app-host-user-state-response.d.ts +25 -0
- package/build/api/models/app-host-user-state-response.js +15 -0
- package/build/api/models/authorization-url-response.d.ts +3 -3
- package/build/api/models/authorization-url-response.js +3 -3
- package/build/api/models/balance-response-user-balance.d.ts +3 -3
- package/build/api/models/balance-response-user-balance.js +3 -3
- package/build/api/models/balance-response.d.ts +3 -3
- package/build/api/models/balance-response.js +3 -3
- package/build/api/models/ban-list-response.d.ts +3 -3
- package/build/api/models/ban-list-response.js +3 -3
- package/build/api/models/ban-record.d.ts +3 -3
- package/build/api/models/ban-record.js +3 -3
- package/build/api/models/ban-req-body.d.ts +3 -3
- package/build/api/models/ban-req-body.js +3 -3
- package/build/api/models/ban-response.d.ts +3 -3
- package/build/api/models/ban-response.js +3 -3
- package/build/api/models/best-friends-response-users-inner.d.ts +36 -0
- package/build/api/models/best-friends-response-users-inner.js +15 -0
- package/build/api/models/best-friends-response.d.ts +32 -0
- package/build/api/models/best-friends-response.js +15 -0
- package/build/api/models/block-list-response.d.ts +3 -3
- package/build/api/models/block-list-response.js +3 -3
- package/build/api/models/block-record.d.ts +3 -3
- package/build/api/models/block-record.js +3 -3
- package/build/api/models/block-req-body.d.ts +4 -4
- package/build/api/models/block-req-body.js +3 -3
- package/build/api/models/bulk-casts-response.d.ts +6 -6
- package/build/api/models/bulk-casts-response.js +3 -3
- package/build/api/models/bulk-follow-response.d.ts +3 -3
- package/build/api/models/bulk-follow-response.js +3 -3
- package/build/api/models/bulk-users-by-address-response.d.ts +3 -3
- package/build/api/models/bulk-users-by-address-response.js +3 -3
- package/build/api/models/bulk-users-response.d.ts +3 -3
- package/build/api/models/bulk-users-response.js +3 -3
- package/build/api/models/buy-storage-req-body.d.ts +3 -3
- package/build/api/models/buy-storage-req-body.js +3 -3
- package/build/api/models/cast-and-conversations-ref.d.ts +179 -0
- package/build/api/models/cast-and-conversations-ref.js +19 -0
- package/build/api/models/cast-and-conversations.d.ts +180 -0
- package/build/api/models/cast-and-conversations.js +19 -0
- package/build/api/models/cast-composer-actions-list-response-actions-inner-action.d.ts +3 -3
- package/build/api/models/cast-composer-actions-list-response-actions-inner-action.js +3 -3
- package/build/api/models/cast-composer-actions-list-response-actions-inner.d.ts +3 -3
- package/build/api/models/cast-composer-actions-list-response-actions-inner.js +3 -3
- package/build/api/models/cast-composer-actions-list-response.d.ts +3 -3
- package/build/api/models/cast-composer-actions-list-response.js +3 -3
- package/build/api/models/cast-dehydrated.d.ts +3 -3
- package/build/api/models/cast-dehydrated.js +3 -3
- package/build/api/models/cast-embed-crawl-response.d.ts +3 -3
- package/build/api/models/cast-embed-crawl-response.js +3 -3
- package/build/api/models/cast-embedded-parent-author.d.ts +4 -4
- package/build/api/models/cast-embedded-parent-author.js +3 -3
- package/build/api/models/cast-embedded.d.ts +3 -10
- package/build/api/models/cast-embedded.js +3 -3
- package/build/api/models/cast-id.d.ts +4 -4
- package/build/api/models/cast-id.js +3 -3
- package/build/api/models/cast-notification-type.d.ts +3 -3
- package/build/api/models/cast-notification-type.js +3 -3
- package/build/api/models/{cast-with-interactions-reactions.d.ts → cast-reactions.d.ts} +9 -9
- package/build/api/models/cast-reactions.js +15 -0
- package/build/api/models/cast-replies.d.ts +24 -0
- package/build/api/models/cast-replies.js +15 -0
- package/build/api/models/cast-response.d.ts +6 -6
- package/build/api/models/cast-response.js +3 -3
- package/build/api/models/cast-viewer-context.d.ts +3 -3
- package/build/api/models/cast-viewer-context.js +3 -3
- package/build/api/models/cast.d.ts +77 -3
- package/build/api/models/cast.js +3 -3
- package/build/api/models/casts-metrics-response.d.ts +3 -3
- package/build/api/models/casts-metrics-response.js +3 -3
- package/build/api/models/casts-metrics.d.ts +3 -3
- package/build/api/models/casts-metrics.js +3 -3
- package/build/api/models/casts-response-result.d.ts +6 -6
- package/build/api/models/casts-response-result.js +3 -3
- package/build/api/models/casts-response.d.ts +3 -3
- package/build/api/models/casts-response.js +3 -3
- package/build/api/models/casts-search-response.d.ts +6 -6
- package/build/api/models/casts-search-response.js +3 -3
- package/build/api/models/channel-activity.d.ts +3 -3
- package/build/api/models/channel-activity.js +3 -3
- package/build/api/models/channel-dehydrated.d.ts +3 -3
- package/build/api/models/channel-dehydrated.js +3 -3
- package/build/api/models/channel-external-link.d.ts +3 -3
- package/build/api/models/channel-external-link.js +3 -3
- package/build/api/models/channel-follow-req-body.d.ts +3 -3
- package/build/api/models/channel-follow-req-body.js +3 -3
- package/build/api/models/channel-list-response.d.ts +3 -3
- package/build/api/models/channel-list-response.js +3 -3
- package/build/api/models/channel-member-channel.d.ts +3 -3
- package/build/api/models/channel-member-channel.js +3 -3
- package/build/api/models/channel-member-invite-list-response.d.ts +3 -3
- package/build/api/models/channel-member-invite-list-response.js +3 -3
- package/build/api/models/channel-member-invite.d.ts +3 -3
- package/build/api/models/channel-member-invite.js +3 -3
- package/build/api/models/channel-member-list-response.d.ts +3 -3
- package/build/api/models/channel-member-list-response.js +3 -3
- package/build/api/models/channel-member-role.d.ts +4 -3
- package/build/api/models/channel-member-role.js +5 -4
- package/build/api/models/channel-member-user.d.ts +3 -3
- package/build/api/models/channel-member-user.js +3 -3
- package/build/api/models/channel-member.d.ts +3 -3
- package/build/api/models/channel-member.js +3 -3
- package/build/api/models/channel-or-channel-dehydrated.d.ts +3 -3
- package/build/api/models/channel-or-channel-dehydrated.js +3 -3
- package/build/api/models/channel-response-bulk.d.ts +3 -3
- package/build/api/models/channel-response-bulk.js +3 -3
- package/build/api/models/channel-response.d.ts +3 -3
- package/build/api/models/channel-response.js +3 -3
- package/build/api/models/channel-search-response.d.ts +3 -3
- package/build/api/models/channel-search-response.js +3 -3
- package/build/api/models/channel-user-context.d.ts +3 -3
- package/build/api/models/channel-user-context.js +3 -3
- package/build/api/models/channel.d.ts +18 -18
- package/build/api/models/channel.js +3 -3
- package/build/api/models/conflict-error-res.d.ts +3 -3
- package/build/api/models/conflict-error-res.js +3 -3
- package/build/api/models/conversation-conversation.d.ts +9 -9
- package/build/api/models/conversation-conversation.js +3 -3
- package/build/api/models/conversation-summary-summary.d.ts +3 -3
- package/build/api/models/conversation-summary-summary.js +3 -3
- package/build/api/models/conversation-summary.d.ts +3 -3
- package/build/api/models/conversation-summary.js +3 -3
- package/build/api/models/conversation.d.ts +3 -3
- package/build/api/models/conversation.js +3 -3
- package/build/api/models/delete-cast-req-body.d.ts +4 -4
- package/build/api/models/delete-cast-req-body.js +3 -3
- package/build/api/models/delete-frame-req-body.d.ts +3 -3
- package/build/api/models/delete-frame-req-body.js +3 -3
- package/build/api/models/delete-frame-response.d.ts +3 -3
- package/build/api/models/delete-frame-response.js +3 -3
- package/build/api/models/deploy-fungible-response-contract-fungible.d.ts +3 -3
- package/build/api/models/deploy-fungible-response-contract-fungible.js +3 -3
- package/build/api/models/deploy-fungible-response-contract.d.ts +3 -3
- package/build/api/models/deploy-fungible-response-contract.js +3 -3
- package/build/api/models/deploy-fungible-response.d.ts +3 -3
- package/build/api/models/deploy-fungible-response.js +3 -3
- package/build/api/models/developer-managed-signer.d.ts +4 -4
- package/build/api/models/developer-managed-signer.js +3 -3
- package/build/api/models/embed-cast-deep.d.ts +3 -3
- package/build/api/models/embed-cast-deep.js +3 -3
- package/build/api/models/embed-cast.d.ts +3 -3
- package/build/api/models/embed-cast.js +3 -3
- package/build/api/models/embed-deep.d.ts +3 -3
- package/build/api/models/embed-deep.js +3 -3
- package/build/api/models/embed-url-metadata-image.d.ts +3 -3
- package/build/api/models/embed-url-metadata-image.js +3 -3
- package/build/api/models/embed-url-metadata-video-stream-inner.d.ts +3 -3
- package/build/api/models/embed-url-metadata-video-stream-inner.js +3 -3
- package/build/api/models/embed-url-metadata-video.d.ts +3 -3
- package/build/api/models/embed-url-metadata-video.js +3 -3
- package/build/api/models/embed-url-metadata.d.ts +3 -3
- package/build/api/models/embed-url-metadata.js +3 -3
- package/build/api/models/embed-url.d.ts +3 -3
- package/build/api/models/embed-url.js +3 -3
- package/build/api/models/embed.d.ts +3 -3
- package/build/api/models/embed.js +3 -3
- package/build/api/models/error-res.d.ts +3 -3
- package/build/api/models/error-res.js +3 -3
- package/build/api/models/farcaster-action-req-body-action.d.ts +3 -3
- package/build/api/models/farcaster-action-req-body-action.js +3 -3
- package/build/api/models/farcaster-action-req-body.d.ts +3 -3
- package/build/api/models/farcaster-action-req-body.js +3 -3
- package/build/api/models/farcaster-manifest-frame.d.ts +3 -3
- package/build/api/models/farcaster-manifest-frame.js +3 -3
- package/build/api/models/farcaster-manifest.d.ts +6 -6
- package/build/api/models/farcaster-manifest.js +3 -3
- package/build/api/models/feed-response.d.ts +6 -6
- package/build/api/models/feed-response.js +3 -3
- package/build/api/models/fetch-cast-quotes-identifier-parameter.d.ts +16 -0
- package/build/api/models/fetch-cast-quotes-identifier-parameter.js +15 -0
- package/build/api/models/fetch-cast-quotes200-response.d.ts +32 -0
- package/build/api/models/fetch-cast-quotes200-response.js +15 -0
- package/build/api/models/fetch-feed-for-you400-response.d.ts +3 -3
- package/build/api/models/fetch-feed-for-you400-response.js +3 -3
- package/build/api/models/fetch-frame-meta-tags-from-url200-response.d.ts +3 -3
- package/build/api/models/fetch-frame-meta-tags-from-url200-response.js +3 -3
- package/build/api/models/fetch-relevant-frames200-response-relevant-frames-inner.d.ts +3 -3
- package/build/api/models/fetch-relevant-frames200-response-relevant-frames-inner.js +3 -3
- package/build/api/models/fetch-relevant-frames200-response.d.ts +3 -3
- package/build/api/models/fetch-relevant-frames200-response.js +3 -3
- package/build/api/models/fetch-user-interactions200-response.d.ts +3 -3
- package/build/api/models/fetch-user-interactions200-response.js +3 -3
- package/build/api/models/fname-availability-response.d.ts +3 -3
- package/build/api/models/fname-availability-response.js +3 -3
- package/build/api/models/follow-req-body.d.ts +3 -3
- package/build/api/models/follow-req-body.js +3 -3
- package/build/api/models/follow-response.d.ts +4 -4
- package/build/api/models/follow-response.js +3 -3
- package/build/api/models/follower-dehydrated.d.ts +3 -3
- package/build/api/models/follower-dehydrated.js +3 -3
- package/build/api/models/follower.d.ts +3 -3
- package/build/api/models/follower.js +3 -3
- package/build/api/models/followers-response.d.ts +3 -3
- package/build/api/models/followers-response.js +3 -3
- package/build/api/models/frame-action-button.d.ts +3 -3
- package/build/api/models/frame-action-button.js +3 -3
- package/build/api/models/frame-action-req-body.d.ts +4 -4
- package/build/api/models/frame-action-req-body.js +3 -3
- package/build/api/models/frame-action.d.ts +3 -3
- package/build/api/models/frame-action.js +3 -3
- package/build/api/models/frame-button-action-type.d.ts +3 -3
- package/build/api/models/frame-button-action-type.js +3 -3
- package/build/api/models/frame-catalog-response.d.ts +3 -3
- package/build/api/models/frame-catalog-response.js +3 -3
- package/build/api/models/frame-developer-managed-action-req-body.d.ts +4 -4
- package/build/api/models/frame-developer-managed-action-req-body.js +3 -3
- package/build/api/models/frame-input.d.ts +3 -3
- package/build/api/models/frame-input.js +3 -3
- package/build/api/models/frame-notification-tokens-notification-tokens-inner.d.ts +4 -4
- package/build/api/models/frame-notification-tokens-notification-tokens-inner.js +3 -3
- package/build/api/models/frame-notification-tokens.d.ts +3 -3
- package/build/api/models/frame-notification-tokens.js +3 -3
- package/build/api/models/{transaction-frame-pay-all-of-transaction.d.ts → frame-pay-transaction-req-body-transaction.d.ts} +6 -6
- package/build/api/models/frame-pay-transaction-req-body-transaction.js +15 -0
- package/build/api/models/{frame-pay-transaction-request-body.d.ts → frame-pay-transaction-req-body.d.ts} +11 -11
- package/build/api/models/frame-pay-transaction-req-body.js +15 -0
- package/build/api/models/frame-signature-packet-trusted-data.d.ts +3 -3
- package/build/api/models/frame-signature-packet-trusted-data.js +3 -3
- package/build/api/models/frame-signature-packet-untrusted-data.d.ts +4 -4
- package/build/api/models/frame-signature-packet-untrusted-data.js +3 -3
- package/build/api/models/frame-signature-packet.d.ts +3 -3
- package/build/api/models/frame-signature-packet.js +3 -3
- package/build/api/models/frame-state.d.ts +3 -3
- package/build/api/models/frame-state.js +3 -3
- package/build/api/models/frame-transaction.d.ts +3 -3
- package/build/api/models/frame-transaction.js +3 -3
- package/build/api/models/{frame-v1-all-of-input.d.ts → frame-v1-input.d.ts} +6 -6
- package/build/api/models/frame-v1-input.js +15 -0
- package/build/api/models/{frame-v1-all-of-state.d.ts → frame-v1-state.d.ts} +6 -6
- package/build/api/models/frame-v1-state.js +15 -0
- package/build/api/models/frame-v1.d.ts +63 -7
- package/build/api/models/frame-v1.js +3 -3
- package/build/api/models/{frame-v2-all-of-metadata.d.ts → frame-v2-metadata.d.ts} +6 -6
- package/build/api/models/frame-v2-metadata.js +15 -0
- package/build/api/models/frame-v2-with-full-author.d.ts +51 -7
- package/build/api/models/frame-v2-with-full-author.js +3 -3
- package/build/api/models/frame-v2.d.ts +51 -7
- package/build/api/models/frame-v2.js +3 -3
- package/build/api/models/frame-validate-analytics-input-text-input-texts-inner.d.ts +4 -4
- package/build/api/models/frame-validate-analytics-input-text-input-texts-inner.js +3 -3
- package/build/api/models/frame-validate-analytics-input-text.d.ts +3 -3
- package/build/api/models/frame-validate-analytics-input-text.js +3 -3
- package/build/api/models/frame-validate-analytics-interactions-per-cast-interactions-per-cast-inner.d.ts +3 -3
- package/build/api/models/frame-validate-analytics-interactions-per-cast-interactions-per-cast-inner.js +3 -3
- package/build/api/models/frame-validate-analytics-interactions-per-cast.d.ts +3 -3
- package/build/api/models/frame-validate-analytics-interactions-per-cast.js +3 -3
- package/build/api/models/frame-validate-analytics-interactors-interactors-inner.d.ts +4 -4
- package/build/api/models/frame-validate-analytics-interactors-interactors-inner.js +3 -3
- package/build/api/models/frame-validate-analytics-interactors.d.ts +3 -3
- package/build/api/models/frame-validate-analytics-interactors.js +3 -3
- package/build/api/models/frame-validate-analytics-response.d.ts +3 -3
- package/build/api/models/frame-validate-analytics-response.js +3 -3
- package/build/api/models/frame-validate-analytics-total-interactors.d.ts +3 -3
- package/build/api/models/frame-validate-analytics-total-interactors.js +3 -3
- package/build/api/models/frame-validate-list-response.d.ts +3 -3
- package/build/api/models/frame-validate-list-response.js +3 -3
- package/build/api/models/frame.d.ts +3 -3
- package/build/api/models/frame.js +3 -3
- package/build/api/models/get-notification-campaign-stats200-response-notification-campaigns-inner-stats.d.ts +72 -0
- package/build/api/models/get-notification-campaign-stats200-response-notification-campaigns-inner-stats.js +15 -0
- package/build/api/models/get-notification-campaign-stats200-response-notification-campaigns-inner.d.ts +49 -0
- package/build/api/models/get-notification-campaign-stats200-response-notification-campaigns-inner.js +15 -0
- package/build/api/models/get-notification-campaign-stats200-response.d.ts +32 -0
- package/build/api/models/get-notification-campaign-stats200-response.js +15 -0
- package/build/api/models/{html-metadata-all-of-oembed.d.ts → html-metadata-oembed.d.ts} +5 -5
- package/build/api/models/html-metadata-oembed.js +15 -0
- package/build/api/models/html-metadata.d.ts +310 -7
- package/build/api/models/html-metadata.js +3 -3
- package/build/api/models/image-object.d.ts +3 -3
- package/build/api/models/image-object.js +3 -3
- package/build/api/models/index.d.ts +42 -56
- package/build/api/models/index.js +42 -56
- package/build/api/models/invite-channel-member-req-body.d.ts +4 -4
- package/build/api/models/invite-channel-member-req-body.js +3 -3
- package/build/api/models/location-address.d.ts +3 -3
- package/build/api/models/location-address.js +3 -3
- package/build/api/models/location.d.ts +9 -9
- package/build/api/models/location.js +3 -3
- package/build/api/models/mark-notifications-as-seen-req-body.d.ts +3 -3
- package/build/api/models/mark-notifications-as-seen-req-body.js +3 -3
- package/build/api/models/mint-nft-request-recipients-inner.d.ts +36 -0
- package/build/api/models/mint-nft-request-recipients-inner.js +15 -0
- package/build/api/models/mint-nft-request.d.ts +49 -0
- package/build/api/models/{transaction-send-fungibles-request.js → mint-nft-request.js} +5 -5
- package/build/api/models/mint-nft200-response-transactions-inner-receipt.d.ts +36 -0
- package/build/api/models/mint-nft200-response-transactions-inner-receipt.js +15 -0
- package/build/api/models/mint-nft200-response-transactions-inner-recipient.d.ts +36 -0
- package/build/api/models/mint-nft200-response-transactions-inner-recipient.js +15 -0
- package/build/api/models/mint-nft200-response-transactions-inner.d.ts +38 -0
- package/build/api/models/mint-nft200-response-transactions-inner.js +15 -0
- package/build/api/models/mint-nft200-response.d.ts +25 -0
- package/build/api/models/mint-nft200-response.js +15 -0
- package/build/api/models/mute-list-response.d.ts +3 -3
- package/build/api/models/mute-list-response.js +3 -3
- package/build/api/models/mute-record.d.ts +3 -3
- package/build/api/models/mute-record.js +3 -3
- package/build/api/models/mute-req-body.d.ts +5 -5
- package/build/api/models/mute-req-body.js +3 -3
- package/build/api/models/mute-response.d.ts +3 -3
- package/build/api/models/mute-response.js +3 -3
- package/build/api/models/network.d.ts +3 -3
- package/build/api/models/network.js +3 -3
- package/build/api/models/next-cursor.d.ts +3 -3
- package/build/api/models/next-cursor.js +3 -3
- package/build/api/models/neynar-frame-creation-req-body.d.ts +3 -3
- package/build/api/models/neynar-frame-creation-req-body.js +3 -3
- package/build/api/models/neynar-frame-page.d.ts +4 -4
- package/build/api/models/neynar-frame-page.js +3 -3
- package/build/api/models/neynar-frame-update-req-body.d.ts +3 -3
- package/build/api/models/neynar-frame-update-req-body.js +3 -3
- package/build/api/models/neynar-frame.d.ts +3 -3
- package/build/api/models/neynar-frame.js +3 -3
- package/build/api/models/neynar-next-frame-page-mint-url.d.ts +3 -3
- package/build/api/models/neynar-next-frame-page-mint-url.js +3 -3
- package/build/api/models/neynar-next-frame-page-redirect.d.ts +3 -3
- package/build/api/models/neynar-next-frame-page-redirect.js +3 -3
- package/build/api/models/neynar-next-frame-page.d.ts +3 -3
- package/build/api/models/neynar-next-frame-page.js +3 -3
- package/build/api/models/neynar-page-button-next-page.d.ts +3 -3
- package/build/api/models/neynar-page-button-next-page.js +3 -3
- package/build/api/models/neynar-page-button.d.ts +3 -3
- package/build/api/models/neynar-page-button.js +3 -3
- package/build/api/models/neynar-page-image.d.ts +3 -3
- package/build/api/models/neynar-page-image.js +3 -3
- package/build/api/models/neynar-page-input-text.d.ts +4 -4
- package/build/api/models/neynar-page-input-text.js +3 -3
- package/build/api/models/neynar-page-input.d.ts +3 -3
- package/build/api/models/neynar-page-input.js +3 -3
- package/build/api/models/nonce-response.d.ts +3 -3
- package/build/api/models/nonce-response.js +3 -3
- package/build/api/models/notification-delivery.d.ts +10 -4
- package/build/api/models/notification-delivery.js +3 -3
- package/build/api/models/notification-type.d.ts +4 -4
- package/build/api/models/notification-type.js +4 -4
- package/build/api/models/notification.d.ts +6 -6
- package/build/api/models/notification.js +3 -3
- package/build/api/models/notifications-response.d.ts +3 -3
- package/build/api/models/notifications-response.js +3 -3
- package/build/api/models/oembed-link-data.d.ts +77 -7
- package/build/api/models/oembed-link-data.js +7 -3
- package/build/api/models/oembed-photo-data.d.ts +95 -7
- package/build/api/models/oembed-photo-data.js +7 -3
- package/build/api/models/oembed-rich-data.d.ts +95 -7
- package/build/api/models/oembed-rich-data.js +7 -3
- package/build/api/models/oembed-video-data.d.ts +95 -7
- package/build/api/models/oembed-video-data.js +7 -3
- package/build/api/models/operation-response.d.ts +3 -3
- package/build/api/models/operation-response.js +3 -3
- package/build/api/models/post-cast-req-body-embeds-cast-id-properties.d.ts +4 -4
- package/build/api/models/post-cast-req-body-embeds-cast-id-properties.js +3 -3
- package/build/api/models/post-cast-req-body-embeds-one-of.d.ts +3 -3
- package/build/api/models/post-cast-req-body-embeds-one-of.js +3 -3
- package/build/api/models/post-cast-req-body-embeds-one-of1.d.ts +3 -3
- package/build/api/models/post-cast-req-body-embeds-one-of1.js +3 -3
- package/build/api/models/post-cast-req-body-embeds-one-of2.d.ts +3 -3
- package/build/api/models/post-cast-req-body-embeds-one-of2.js +3 -3
- package/build/api/models/post-cast-req-body-embeds.d.ts +3 -3
- package/build/api/models/post-cast-req-body-embeds.js +3 -3
- package/build/api/models/post-cast-req-body.d.ts +4 -4
- package/build/api/models/post-cast-req-body.js +3 -3
- package/build/api/models/post-cast-response-cast-author.d.ts +4 -4
- package/build/api/models/post-cast-response-cast-author.js +3 -3
- package/build/api/models/post-cast-response-cast.d.ts +4 -4
- package/build/api/models/post-cast-response-cast.js +3 -3
- package/build/api/models/post-cast-response.d.ts +3 -3
- package/build/api/models/post-cast-response.js +3 -3
- package/build/api/models/reaction-for-cast.d.ts +6 -10
- package/build/api/models/reaction-for-cast.js +4 -8
- package/build/api/models/reaction-like.d.ts +4 -4
- package/build/api/models/reaction-like.js +3 -3
- package/build/api/models/reaction-recast.d.ts +4 -4
- package/build/api/models/reaction-recast.js +3 -3
- package/build/api/models/reaction-req-body.d.ts +4 -4
- package/build/api/models/reaction-req-body.js +3 -3
- package/build/api/models/reaction-type.d.ts +3 -3
- package/build/api/models/reaction-type.js +3 -3
- package/build/api/models/reaction-with-cast-info.d.ts +6 -6
- package/build/api/models/reaction-with-cast-info.js +3 -3
- package/build/api/models/reaction-with-user-info.d.ts +3 -3
- package/build/api/models/reaction-with-user-info.js +3 -3
- package/build/api/models/reactions-cast-response.d.ts +3 -3
- package/build/api/models/reactions-cast-response.js +3 -3
- package/build/api/models/reactions-response.d.ts +3 -3
- package/build/api/models/reactions-response.js +3 -3
- package/build/api/models/register-auth-address-developer-managed-signed-key-req-body.d.ts +55 -0
- package/build/api/models/register-auth-address-developer-managed-signed-key-req-body.js +15 -0
- package/build/api/models/register-developer-managed-signed-key-req-body.d.ts +6 -6
- package/build/api/models/register-developer-managed-signed-key-req-body.js +3 -3
- package/build/api/models/register-signed-key-for-developer-managed-auth-address200-response.d.ts +48 -0
- package/build/api/models/register-signed-key-for-developer-managed-auth-address200-response.js +21 -0
- package/build/api/models/register-signer-key-req-body.d.ts +6 -6
- package/build/api/models/register-signer-key-req-body.js +3 -3
- package/build/api/models/register-user-on-chain-req-body-pre-registration-calls-inner.d.ts +14 -14
- package/build/api/models/register-user-on-chain-req-body-pre-registration-calls-inner.js +3 -3
- package/build/api/models/register-user-on-chain-req-body-registration.d.ts +3 -3
- package/build/api/models/register-user-on-chain-req-body-registration.js +3 -3
- package/build/api/models/register-user-on-chain-req-body-signers-inner.d.ts +3 -3
- package/build/api/models/register-user-on-chain-req-body-signers-inner.js +3 -3
- package/build/api/models/register-user-on-chain-req-body.d.ts +14 -14
- package/build/api/models/register-user-on-chain-req-body.js +3 -3
- package/build/api/models/register-user-on-chain-response.d.ts +3 -3
- package/build/api/models/register-user-on-chain-response.js +3 -3
- package/build/api/models/register-user-req-body-metadata.d.ts +3 -3
- package/build/api/models/register-user-req-body-metadata.js +3 -3
- package/build/api/models/register-user-req-body.d.ts +3 -3
- package/build/api/models/register-user-req-body.js +3 -3
- package/build/api/models/register-user-response.d.ts +3 -3
- package/build/api/models/register-user-response.js +3 -3
- package/build/api/models/relevant-followers-response.d.ts +3 -3
- package/build/api/models/relevant-followers-response.js +3 -3
- package/build/api/models/relevant-fungible-owners-response.d.ts +5 -5
- package/build/api/models/relevant-fungible-owners-response.js +3 -3
- package/build/api/models/remove-channel-member-req-body.d.ts +4 -4
- package/build/api/models/remove-channel-member-req-body.js +3 -3
- package/build/api/models/remove-verification-req-body.d.ts +9 -3
- package/build/api/models/remove-verification-req-body.js +3 -3
- package/build/api/models/respond-channel-invite-req-body.d.ts +3 -3
- package/build/api/models/respond-channel-invite-req-body.js +3 -3
- package/build/api/models/send-frame-notifications-req-body-filters-near-location.d.ts +32 -6
- package/build/api/models/send-frame-notifications-req-body-filters-near-location.js +3 -3
- package/build/api/models/send-frame-notifications-req-body-filters.d.ts +3 -3
- package/build/api/models/send-frame-notifications-req-body-filters.js +3 -3
- package/build/api/models/send-frame-notifications-req-body-notification.d.ts +3 -3
- package/build/api/models/send-frame-notifications-req-body-notification.js +3 -3
- package/build/api/models/send-frame-notifications-req-body.d.ts +7 -7
- package/build/api/models/send-frame-notifications-req-body.js +3 -3
- package/build/api/models/send-frame-notifications-response.d.ts +3 -3
- package/build/api/models/send-frame-notifications-response.js +3 -3
- package/build/api/models/shared-signer-permission.d.ts +3 -3
- package/build/api/models/shared-signer-permission.js +3 -3
- package/build/api/models/signed-key-request-sponsor.d.ts +5 -5
- package/build/api/models/signed-key-request-sponsor.js +3 -3
- package/build/api/models/signer-list-response.d.ts +3 -3
- package/build/api/models/signer-list-response.js +3 -3
- package/build/api/models/signer.d.ts +4 -4
- package/build/api/models/signer.js +3 -3
- package/build/api/models/simulate-nft-mint-response-inner.d.ts +73 -0
- package/build/api/models/simulate-nft-mint-response-inner.js +15 -0
- package/build/api/models/simulate-nft-mint-response.d.ts +19 -0
- package/build/api/models/simulate-nft-mint-response.js +15 -0
- package/build/api/models/storage-allocation.d.ts +3 -3
- package/build/api/models/storage-allocation.js +3 -3
- package/build/api/models/storage-allocations-response.d.ts +3 -3
- package/build/api/models/storage-allocations-response.js +3 -3
- package/build/api/models/storage-object.d.ts +3 -3
- package/build/api/models/storage-object.js +3 -3
- package/build/api/models/storage-usage-response.d.ts +3 -3
- package/build/api/models/storage-usage-response.js +3 -3
- package/build/api/models/subscribed-to-object.d.ts +3 -3
- package/build/api/models/subscribed-to-object.js +3 -3
- package/build/api/models/subscribed-to-response.d.ts +3 -3
- package/build/api/models/subscribed-to-response.js +3 -3
- package/build/api/models/subscribed-to.d.ts +100 -7
- package/build/api/models/subscribed-to.js +7 -3
- package/build/api/models/subscriber.d.ts +3 -3
- package/build/api/models/subscriber.js +3 -3
- package/build/api/models/subscribers-response.d.ts +3 -3
- package/build/api/models/subscribers-response.js +3 -3
- package/build/api/models/subscription-check-response-value.d.ts +53 -0
- package/build/api/models/{subscription-status.js → subscription-check-response-value.js} +5 -5
- package/build/api/models/subscription-check-response.d.ts +5 -5
- package/build/api/models/subscription-check-response.js +3 -3
- package/build/api/models/subscription-metadata.d.ts +3 -3
- package/build/api/models/subscription-metadata.js +3 -3
- package/build/api/models/subscription-price.d.ts +3 -3
- package/build/api/models/subscription-price.js +3 -3
- package/build/api/models/subscription-tier-price.d.ts +3 -3
- package/build/api/models/subscription-tier-price.js +3 -3
- package/build/api/models/subscription-tier.d.ts +3 -3
- package/build/api/models/subscription-tier.js +3 -3
- package/build/api/models/subscription-token.d.ts +3 -3
- package/build/api/models/subscription-token.js +3 -3
- package/build/api/models/subscription.d.ts +3 -3
- package/build/api/models/subscription.js +3 -3
- package/build/api/models/subscriptions-response.d.ts +3 -3
- package/build/api/models/subscriptions-response.js +3 -3
- package/build/api/models/subscriptions.d.ts +3 -3
- package/build/api/models/subscriptions.js +3 -3
- package/build/api/models/text-range.d.ts +3 -3
- package/build/api/models/text-range.js +3 -3
- package/build/api/models/token-balance-balance.d.ts +3 -3
- package/build/api/models/token-balance-balance.js +3 -3
- package/build/api/models/token-balance-token.d.ts +3 -3
- package/build/api/models/token-balance-token.js +3 -3
- package/build/api/models/token-balance.d.ts +3 -3
- package/build/api/models/token-balance.js +3 -3
- package/build/api/models/transaction-frame-action.d.ts +4 -4
- package/build/api/models/transaction-frame-action.js +3 -3
- package/build/api/models/transaction-frame-config.d.ts +4 -4
- package/build/api/models/transaction-frame-config.js +3 -3
- package/build/api/models/transaction-frame-destination.d.ts +3 -3
- package/build/api/models/transaction-frame-destination.js +3 -3
- package/build/api/models/transaction-frame-line-item.d.ts +3 -3
- package/build/api/models/transaction-frame-line-item.js +3 -3
- package/build/api/models/transaction-frame-pay.d.ts +47 -7
- package/build/api/models/transaction-frame-pay.js +3 -3
- package/build/api/models/transaction-frame-response.d.ts +3 -3
- package/build/api/models/transaction-frame-response.js +3 -3
- package/build/api/models/transaction-frame-status.d.ts +3 -3
- package/build/api/models/transaction-frame-status.js +3 -3
- package/build/api/models/transaction-frame-type.d.ts +3 -3
- package/build/api/models/transaction-frame-type.js +3 -3
- package/build/api/models/transaction-frame.d.ts +3 -3
- package/build/api/models/transaction-frame.js +3 -3
- package/build/api/models/transaction-send-fungibles-receipt.d.ts +4 -4
- package/build/api/models/transaction-send-fungibles-receipt.js +3 -3
- package/build/api/models/transaction-send-fungibles-recipient.d.ts +4 -4
- package/build/api/models/transaction-send-fungibles-recipient.js +3 -3
- package/build/api/models/{transaction-send-fungibles-request.d.ts → transaction-send-fungibles-req-body.d.ts} +11 -11
- package/build/api/models/transaction-send-fungibles-req-body.js +21 -0
- package/build/api/models/transaction-send-fungibles-response.d.ts +3 -3
- package/build/api/models/transaction-send-fungibles-response.js +3 -3
- package/build/api/models/transaction-send-tx-info.d.ts +3 -3
- package/build/api/models/transaction-send-tx-info.js +3 -3
- package/build/api/models/trending-channel-response.d.ts +3 -3
- package/build/api/models/trending-channel-response.js +3 -3
- package/build/api/models/update-user-req-body-location.d.ts +3 -3
- package/build/api/models/update-user-req-body-location.js +3 -3
- package/build/api/models/update-user-req-body-verified-accounts.d.ts +3 -3
- package/build/api/models/update-user-req-body-verified-accounts.js +3 -3
- package/build/api/models/update-user-req-body.d.ts +9 -3
- package/build/api/models/update-user-req-body.js +3 -3
- package/build/api/models/user-dehydrated.d.ts +4 -4
- package/build/api/models/user-dehydrated.js +3 -3
- package/build/api/models/user-experimental.d.ts +3 -3
- package/build/api/models/user-experimental.js +3 -3
- package/build/api/models/user-fidresponse.d.ts +4 -4
- package/build/api/models/user-fidresponse.js +3 -3
- package/build/api/models/user-power-lite-response-result.d.ts +3 -3
- package/build/api/models/user-power-lite-response-result.js +3 -3
- package/build/api/models/user-power-lite-response.d.ts +3 -3
- package/build/api/models/user-power-lite-response.js +3 -3
- package/build/api/models/user-pro.d.ts +41 -0
- package/build/api/models/user-pro.js +20 -0
- package/build/api/models/user-profile-banner.d.ts +24 -0
- package/build/api/models/user-profile-banner.js +15 -0
- package/build/api/models/user-profile-bio.d.ts +3 -3
- package/build/api/models/user-profile-bio.js +3 -3
- package/build/api/models/user-profile.d.ts +10 -3
- package/build/api/models/user-profile.js +3 -3
- package/build/api/models/user-response.d.ts +3 -3
- package/build/api/models/user-response.js +3 -3
- package/build/api/models/user-search-response-result.d.ts +6 -6
- package/build/api/models/user-search-response-result.js +3 -3
- package/build/api/models/user-search-response.d.ts +3 -3
- package/build/api/models/user-search-response.js +3 -3
- package/build/api/models/user-verified-accounts-inner.d.ts +4 -4
- package/build/api/models/user-verified-accounts-inner.js +3 -3
- package/build/api/models/user-verified-addresses-primary.d.ts +3 -3
- package/build/api/models/user-verified-addresses-primary.js +3 -3
- package/build/api/models/user-verified-addresses.d.ts +3 -3
- package/build/api/models/user-verified-addresses.js +3 -3
- package/build/api/models/user-viewer-context.d.ts +3 -3
- package/build/api/models/user-viewer-context.js +3 -3
- package/build/api/models/user.d.ts +18 -11
- package/build/api/models/user.js +3 -3
- package/build/api/models/users-active-channels-response.d.ts +3 -3
- package/build/api/models/users-active-channels-response.js +3 -3
- package/build/api/models/users-response.d.ts +3 -3
- package/build/api/models/users-response.js +3 -3
- package/build/api/models/validate-frame-action-req-body.d.ts +3 -3
- package/build/api/models/validate-frame-action-req-body.js +3 -3
- package/build/api/models/validate-frame-action-response.d.ts +3 -3
- package/build/api/models/validate-frame-action-response.js +3 -3
- package/build/api/models/validated-frame-action-signer.d.ts +3 -3
- package/build/api/models/validated-frame-action-signer.js +3 -3
- package/build/api/models/validated-frame-action-tapped-button.d.ts +3 -3
- package/build/api/models/validated-frame-action-tapped-button.js +3 -3
- package/build/api/models/validated-frame-action.d.ts +6 -6
- package/build/api/models/validated-frame-action.js +3 -3
- package/build/api/models/verification-chain-id.d.ts +3 -3
- package/build/api/models/verification-chain-id.js +3 -3
- package/build/api/models/verification-type.d.ts +3 -3
- package/build/api/models/verification-type.js +3 -3
- package/build/api/models/video-object.d.ts +3 -3
- package/build/api/models/video-object.js +3 -3
- package/build/api/models/webhook-delete-req-body.d.ts +3 -3
- package/build/api/models/webhook-delete-req-body.js +3 -3
- package/build/api/models/webhook-list-response.d.ts +3 -3
- package/build/api/models/webhook-list-response.js +3 -3
- package/build/api/models/webhook-patch-req-body.d.ts +3 -3
- package/build/api/models/webhook-patch-req-body.js +3 -3
- package/build/api/models/webhook-post-req-body.d.ts +3 -3
- package/build/api/models/webhook-post-req-body.js +3 -3
- package/build/api/models/webhook-put-req-body.d.ts +3 -3
- package/build/api/models/webhook-put-req-body.js +3 -3
- package/build/api/models/webhook-response.d.ts +3 -3
- package/build/api/models/webhook-response.js +3 -3
- package/build/api/models/webhook-secret.d.ts +3 -3
- package/build/api/models/webhook-secret.js +3 -3
- package/build/api/models/webhook-subscription-filters-cast.d.ts +9 -3
- package/build/api/models/webhook-subscription-filters-cast.js +3 -3
- package/build/api/models/webhook-subscription-filters-follow.d.ts +3 -3
- package/build/api/models/webhook-subscription-filters-follow.js +3 -3
- package/build/api/models/webhook-subscription-filters-reaction.d.ts +9 -3
- package/build/api/models/webhook-subscription-filters-reaction.js +3 -3
- package/build/api/models/webhook-subscription-filters-user-updated.d.ts +3 -3
- package/build/api/models/webhook-subscription-filters-user-updated.js +3 -3
- package/build/api/models/webhook-subscription-filters.d.ts +3 -3
- package/build/api/models/webhook-subscription-filters.js +3 -3
- package/build/api/models/webhook-subscription.d.ts +3 -3
- package/build/api/models/webhook-subscription.js +3 -3
- package/build/api/models/webhook.d.ts +3 -3
- package/build/api/models/webhook.js +3 -3
- package/build/api/models/zod-error-errors-inner.d.ts +3 -3
- package/build/api/models/zod-error-errors-inner.js +3 -3
- package/build/api/models/zod-error.d.ts +3 -3
- package/build/api/models/zod-error.js +3 -3
- package/build/clients/NeynarAPIClient.d.ts +508 -252
- package/build/clients/NeynarAPIClient.js +490 -201
- package/build/hub-api/models/index.d.ts +2 -0
- package/build/hub-api/models/index.js +2 -0
- package/build/hub-api/models/storage-limits-response-tier-subscriptions-inner.d.ts +34 -0
- package/build/hub-api/models/storage-limits-response-tier-subscriptions-inner.js +19 -0
- package/build/hub-api/models/storage-limits-response-unit-details.d.ts +35 -0
- package/build/hub-api/models/storage-limits-response-unit-details.js +20 -0
- package/build/hub-api/models/storage-limits-response.d.ts +20 -0
- package/build/types/webhooks.d.ts +1 -12
- package/package.json +3 -3
- package/build/api/models/authorization-url-response-type.d.ts +0 -20
- package/build/api/models/authorization-url-response-type.js +0 -24
- package/build/api/models/bulk-user-address-type.d.ts +0 -21
- package/build/api/models/bulk-user-address-type.js +0 -25
- package/build/api/models/cast-composer-type.d.ts +0 -21
- package/build/api/models/cast-composer-type.js +0 -25
- package/build/api/models/cast-conversation-sort-type.d.ts +0 -22
- package/build/api/models/cast-conversation-sort-type.js +0 -26
- package/build/api/models/cast-param-type.d.ts +0 -21
- package/build/api/models/cast-param-type.js +0 -25
- package/build/api/models/cast-with-interactions-all-of.d.ts +0 -93
- package/build/api/models/cast-with-interactions-and-conversations-all-of.d.ts +0 -25
- package/build/api/models/cast-with-interactions-and-conversations-ref-all-of.d.ts +0 -24
- package/build/api/models/cast-with-interactions-and-conversations-ref.d.ts +0 -19
- package/build/api/models/cast-with-interactions-and-conversations.d.ts +0 -18
- package/build/api/models/cast-with-interactions-and-conversations.js +0 -15
- package/build/api/models/cast-with-interactions-reactions.js +0 -15
- package/build/api/models/cast-with-interactions-replies.d.ts +0 -24
- package/build/api/models/cast-with-interactions-replies.js +0 -15
- package/build/api/models/cast-with-interactions.d.ts +0 -18
- package/build/api/models/cast-with-interactions.js +0 -15
- package/build/api/models/casts-search-response-result.d.ts +0 -32
- package/build/api/models/casts-search-response-result.js +0 -15
- package/build/api/models/channel-type.d.ts +0 -21
- package/build/api/models/channel-type.js +0 -25
- package/build/api/models/embed-type.d.ts +0 -37
- package/build/api/models/embed-type.js +0 -41
- package/build/api/models/farcaster-manifest-account-association.d.ts +0 -36
- package/build/api/models/farcaster-manifest-account-association.js +0 -15
- package/build/api/models/feed-trending-provider.d.ts +0 -22
- package/build/api/models/feed-trending-provider.js +0 -26
- package/build/api/models/feed-type.d.ts +0 -21
- package/build/api/models/feed-type.js +0 -25
- package/build/api/models/filter-type.d.ts +0 -25
- package/build/api/models/filter-type.js +0 -29
- package/build/api/models/follow-sort-type.d.ts +0 -21
- package/build/api/models/follow-sort-type.js +0 -25
- package/build/api/models/for-you-provider.d.ts +0 -22
- package/build/api/models/for-you-provider.js +0 -26
- package/build/api/models/frame-base.d.ts +0 -36
- package/build/api/models/frame-base.js +0 -15
- package/build/api/models/frame-pay-transaction-request-body.js +0 -15
- package/build/api/models/frame-type.d.ts +0 -21
- package/build/api/models/frame-type.js +0 -25
- package/build/api/models/frame-v1-all-of-input.js +0 -15
- package/build/api/models/frame-v1-all-of-state.js +0 -15
- package/build/api/models/frame-v1-all-of.d.ts +0 -57
- package/build/api/models/frame-v1-all-of.js +0 -15
- package/build/api/models/frame-v2-all-of-metadata.js +0 -15
- package/build/api/models/frame-v2-all-of.d.ts +0 -45
- package/build/api/models/frame-v2-all-of.js +0 -15
- package/build/api/models/frame-v2-with-full-author-all-of.d.ts +0 -45
- package/build/api/models/frame-v2-with-full-author-all-of.js +0 -15
- package/build/api/models/fungible-owner-relevant-network.d.ts +0 -24
- package/build/api/models/fungible-owner-relevant-network.js +0 -28
- package/build/api/models/html-metadata-all-of-oembed.js +0 -15
- package/build/api/models/html-metadata-all-of.d.ts +0 -25
- package/build/api/models/html-metadata-all-of.js +0 -15
- package/build/api/models/mini-app-time-window.d.ts +0 -24
- package/build/api/models/mini-app-time-window.js +0 -28
- package/build/api/models/oembed-data.d.ts +0 -84
- package/build/api/models/oembed-data.js +0 -15
- package/build/api/models/oembed-link-data-all-of.d.ts +0 -28
- package/build/api/models/oembed-link-data-all-of.js +0 -19
- package/build/api/models/oembed-photo-data-all-of.d.ts +0 -46
- package/build/api/models/oembed-photo-data-all-of.js +0 -19
- package/build/api/models/oembed-rich-data-all-of.d.ts +0 -46
- package/build/api/models/oembed-rich-data-all-of.js +0 -19
- package/build/api/models/oembed-video-data-all-of.d.ts +0 -46
- package/build/api/models/oembed-video-data-all-of.js +0 -19
- package/build/api/models/og-object.d.ts +0 -314
- package/build/api/models/og-object.js +0 -15
- package/build/api/models/profile-url-pfp.d.ts +0 -24
- package/build/api/models/profile-url-pfp.js +0 -15
- package/build/api/models/profile-url.d.ts +0 -25
- package/build/api/models/profile-url.js +0 -15
- package/build/api/models/reactions-type.d.ts +0 -22
- package/build/api/models/reactions-type.js +0 -26
- package/build/api/models/search-sort-type.d.ts +0 -21
- package/build/api/models/search-sort-type.js +0 -25
- package/build/api/models/searched-user.d.ts +0 -130
- package/build/api/models/searched-user.js +0 -19
- package/build/api/models/subscribed-to-all-of.d.ts +0 -44
- package/build/api/models/subscribed-to-all-of.js +0 -15
- package/build/api/models/subscription-provider.d.ts +0 -20
- package/build/api/models/subscription-provider.js +0 -24
- package/build/api/models/subscription-providers.d.ts +0 -21
- package/build/api/models/subscription-providers.js +0 -25
- package/build/api/models/subscription-status.d.ts +0 -53
- package/build/api/models/transaction-frame-base.d.ts +0 -51
- package/build/api/models/transaction-frame-base.js +0 -15
- package/build/api/models/transaction-frame-pay-all-of-transaction.js +0 -15
- package/build/api/models/transaction-frame-pay-all-of.d.ts +0 -25
- package/build/api/models/transaction-frame-pay-all-of.js +0 -15
- package/build/api/models/validate-frame-aggregate-window.d.ts +0 -30
- package/build/api/models/validate-frame-aggregate-window.js +0 -34
- package/build/api/models/validate-frame-analytics-type.d.ts +0 -23
- package/build/api/models/validate-frame-analytics-type.js +0 -27
|
@@ -2,7 +2,7 @@ import { Logger } from "../common/logger";
|
|
|
2
2
|
import { AxiosError, AxiosInstance } from "axios";
|
|
3
3
|
import type { SetRequired } from "type-fest";
|
|
4
4
|
import { Configuration } from './configuration';
|
|
5
|
-
import type {
|
|
5
|
+
import type { AppHostGetEventEventEnum, AppHostGetEventResponse, AppHostPostEventResponse, AppHostUserStateResponse, AuthorizationUrlResponse, BalanceResponse, BanListResponse, BanResponse, BestFriendsResponse, BlockListResponse, BulkCastsResponse, BulkFollowResponse, BulkUsersByAddressResponse, BulkUsersResponse, CastComposerActionsListResponse, CastEmbedCrawlResponse, CastResponse, CastsMetricsResponse, CastsResponse, CastsSearchResponse, ChannelListResponse, ChannelMemberInviteListResponse, ChannelMemberListResponse, ChannelMemberRole, ChannelResponse, ChannelResponseBulk, ChannelSearchResponse, Conversation, ConversationSummary, DeleteFrameResponse, DeployFungibleFactoryEnum, DeployFungibleMetadataNsfwEnum, DeployFungibleNetworkEnum, DeployFungibleResponse, DeveloperManagedSigner, ErrorRes, FarcasterActionReqBodyAction, FeedResponse, FetchAllNotificationsTypeEnum, FetchAuthorizationUrlResponseTypeEnum, FetchBulkCastsSortTypeEnum, FetchBulkChannelsTypeEnum, FetchBulkUsersByEthOrSolAddressAddressTypesEnum, FetchCastMetricsIntervalEnum, FetchCastQuotes200Response, FetchCastQuotesIdentifierParameter, FetchCastQuotesTypeEnum, FetchCastReactionsTypesEnum, FetchComposerActionsListEnum, FetchFeedEmbedTypesEnum, FetchFeedFeedTypeEnum, FetchFeedFilterTypeEnum, FetchFeedForYouProviderEnum, FetchFrameCatalogCategoriesEnum, FetchFrameCatalogTimeWindowEnum, FetchFrameMetaTagsFromUrl200Response, FetchRelevantFrames200Response, FetchRelevantFramesTimeWindowEnum, FetchRelevantFungibleOwnersNetworkEnum, FetchRepliesAndRecastsForUserFilterEnum, FetchSubscribedToForFidSubscriptionProviderEnum, FetchSubscribersForFidSubscriptionProviderEnum, FetchSubscriptionsForFidSubscriptionProviderEnum, FetchTrendingChannelsTimeWindowEnum, FetchTrendingFeedProviderEnum, FetchTrendingFeedTimeWindowEnum, FetchUserBalanceNetworksEnum, FetchUserFollowersSortTypeEnum, FetchUserFollowingSortTypeEnum, FetchUserInteractions200Response, FetchUserInteractionsTypeEnum, FetchUserReactionsTypeEnum, FetchValidateFrameAnalyticsAggregateWindowEnum, FetchValidateFrameAnalyticsAnalyticsTypeEnum, FnameAvailabilityResponse, FollowersResponse, Frame, FrameAction, FrameCatalogResponse, FrameNotificationTokens, FramePayTransactionReqBodyTransaction, FrameSignaturePacket, FrameValidateAnalyticsResponse, FrameValidateListResponse, GetNotificationCampaignStats200Response, LookupCastByHashOrWarpcastUrlTypeEnum, LookupCastConversationFoldEnum, LookupCastConversationSortTypeEnum, LookupCastConversationTypeEnum, LookupChannelTypeEnum, LookupNeynarFrameTypeEnum, MintNft200Response, MintNftRequest, MuteListResponse, MuteResponse, NeynarFrame, NeynarFramePage, NonceResponse, NotificationType, NotificationsResponse, OperationResponse, PostCastReqBodyEmbeds, PostCastResponse, ReactionType, ReactionsCastResponse, ReactionsResponse, RegisterSignedKeyForDeveloperManagedAuthAddress200Response, RegisterUserOnChainReqBodyPreRegistrationCallsInner, RegisterUserOnChainReqBodyRegistration, RegisterUserOnChainReqBodySignersInner, RegisterUserOnChainResponse, RegisterUserReqBodyMetadata, RegisterUserResponse, RelevantFollowersResponse, RelevantFungibleOwnersResponse, SearchCastsModeEnum, SearchCastsSortTypeEnum, SendFrameNotificationsReqBodyFilters, SendFrameNotificationsReqBodyNotification, SendFrameNotificationsResponse, SignedKeyRequestSponsor, Signer, SignerListResponse, SimulateNftMintNetworkEnum, SimulateNftMintResponse, StorageAllocationsResponse, StorageUsageResponse, SubscribedToResponse, SubscribersResponse, SubscriptionCheckResponse, SubscriptionsResponse, TransactionFrameConfig, TransactionFrameResponse, TransactionSendFungiblesRecipient, TransactionSendFungiblesReqBodyNetworkEnum, TransactionSendFungiblesResponse, TrendingChannelResponse, UpdateUserReqBodyLocation, UpdateUserReqBodyVerifiedAccounts, UserFIDResponse, UserResponse, UserSearchResponse, UsersActiveChannelsResponse, UsersResponse, ValidateFrameActionResponse, VerificationChainId, VerificationType, WebhookListResponse, WebhookPatchReqBodyActiveEnum, WebhookResponse, WebhookSubscriptionFilters } from '../api';
|
|
6
6
|
export interface NeynarAPIClientOptions {
|
|
7
7
|
logger?: Logger;
|
|
8
8
|
axiosInstance?: AxiosInstance;
|
|
@@ -36,7 +36,7 @@ export declare class NeynarAPIClient {
|
|
|
36
36
|
* console.log('response:', response);
|
|
37
37
|
* });
|
|
38
38
|
*
|
|
39
|
-
* For more information, refer to the [API documentation](https://docs.neynar.com/
|
|
39
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/publish-farcaster-action)
|
|
40
40
|
*
|
|
41
41
|
*/
|
|
42
42
|
publishFarcasterAction(params: {
|
|
@@ -52,21 +52,30 @@ export declare class NeynarAPIClient {
|
|
|
52
52
|
* @summary Create transaction pay mini app
|
|
53
53
|
*
|
|
54
54
|
* @param {object} params
|
|
55
|
-
* @param {
|
|
55
|
+
* @param {FramePayTransactionReqBodyTransaction} params.transaction
|
|
56
|
+
* @param {TransactionFrameConfig} params.config
|
|
57
|
+
* @param {string} params.idem [optional] - An Idempotency key is a unique identifier for the request. **Note:** 1) This is used to prevent duplicate requests. Use the same idem key on retry attempts. 2) This should be a unique identifier for each request. 3) Recommended format is a 16-character string generated by the developer at the time of making this request.
|
|
56
58
|
*
|
|
57
59
|
* @returns {Promise<TransactionFrameResponse>} A promise that resolves to a `TransactionFrameResponse` object.
|
|
58
60
|
*
|
|
59
61
|
* @example
|
|
60
62
|
*
|
|
61
63
|
* // Fill in the appropriate values
|
|
62
|
-
* const
|
|
64
|
+
* const transaction =
|
|
65
|
+
* const config =
|
|
66
|
+
* const idem =
|
|
63
67
|
*
|
|
64
|
-
* client.createTransactionPayFrame({
|
|
68
|
+
* client.createTransactionPayFrame({transaction, config, idem}).then(response => {
|
|
65
69
|
* console.log('response:', response);
|
|
66
70
|
* });
|
|
71
|
+
*
|
|
72
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/create-transaction-pay-frame)
|
|
73
|
+
*
|
|
67
74
|
*/
|
|
68
75
|
createTransactionPayFrame(params: {
|
|
69
|
-
|
|
76
|
+
transaction: FramePayTransactionReqBodyTransaction;
|
|
77
|
+
config: TransactionFrameConfig;
|
|
78
|
+
idem?: string;
|
|
70
79
|
}): Promise<TransactionFrameResponse>;
|
|
71
80
|
/**
|
|
72
81
|
* Returns a list of interactions between two users
|
|
@@ -75,7 +84,7 @@ export declare class NeynarAPIClient {
|
|
|
75
84
|
*
|
|
76
85
|
* @param {object} params
|
|
77
86
|
* @param {number[]} params.fids - Comma separated list of two FIDs
|
|
78
|
-
* @param {Array<
|
|
87
|
+
* @param {Array<FetchUserInteractionsTypeEnum>} params.type [optional] - Comma seperated list of Interaction type to fetch
|
|
79
88
|
*
|
|
80
89
|
* @returns {Promise<FetchUserInteractions200Response>} A promise that resolves to a `FetchUserInteractions200Response` object.
|
|
81
90
|
*
|
|
@@ -88,18 +97,21 @@ export declare class NeynarAPIClient {
|
|
|
88
97
|
* client.fetchUserInteractions({ fids, type }).then(response => {
|
|
89
98
|
* console.log('response:', response);
|
|
90
99
|
* });
|
|
100
|
+
*
|
|
101
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-user-interactions)
|
|
102
|
+
*
|
|
91
103
|
*/
|
|
92
104
|
fetchUserInteractions(params: {
|
|
93
105
|
fids: number[];
|
|
94
|
-
type?: Array<
|
|
106
|
+
type?: Array<FetchUserInteractionsTypeEnum>;
|
|
95
107
|
}): Promise<FetchUserInteractions200Response>;
|
|
96
108
|
/**
|
|
97
|
-
* Generates a summary of all casts related to a conversation surrounding a cast by passing in a cast hash or
|
|
109
|
+
* Generates a summary of all casts related to a conversation surrounding a cast by passing in a cast hash or Farcaster URL. Summary is generated by an LLM and is intended to be passed as a context to AI agents.
|
|
98
110
|
*
|
|
99
111
|
* @summary Cast conversation summary
|
|
100
112
|
*
|
|
101
113
|
* @param {object} params
|
|
102
|
-
* @param {string} params.identifier - Cast identifier (
|
|
114
|
+
* @param {string} params.identifier - Cast identifier (It's either a URL or a hash))
|
|
103
115
|
* @param {number} params.limit [optional] - Number of casts to consider in a summary up to a point of target cast (Default: 20, Maximum: 50)
|
|
104
116
|
* @param {string} params.prompt [optional] - Additional prompt used to generate a summary
|
|
105
117
|
*
|
|
@@ -124,6 +136,152 @@ export declare class NeynarAPIClient {
|
|
|
124
136
|
limit?: number;
|
|
125
137
|
prompt?: string;
|
|
126
138
|
}): Promise<ConversationSummary>;
|
|
139
|
+
/**
|
|
140
|
+
* Returns event object for app host events. Used if the app host intends to sign the event message instead of using Neynar-hosted signers.
|
|
141
|
+
*
|
|
142
|
+
* @summary Generate event
|
|
143
|
+
*
|
|
144
|
+
* @param {object} params
|
|
145
|
+
* @param {string} params.appDomain - The domain of the mini app
|
|
146
|
+
* @param {number} params.fid - The FID of the user who initiated the event
|
|
147
|
+
* @param {AppHostGetEventEventEnum} params.event - The type of event
|
|
148
|
+
*
|
|
149
|
+
* @returns {Promise<AppHostGetEventResponse>} A promise that resolves to a `AppHostGetEventResponse` object.
|
|
150
|
+
*
|
|
151
|
+
* @example
|
|
152
|
+
*
|
|
153
|
+
* // Fill in the appropriate values
|
|
154
|
+
* const appDomain =
|
|
155
|
+
* const fid =
|
|
156
|
+
* const event =
|
|
157
|
+
*
|
|
158
|
+
* client.appHostGetEvent({ appDomain, fid, event }).then(response => {
|
|
159
|
+
* console.log('response:', response);
|
|
160
|
+
* });
|
|
161
|
+
*
|
|
162
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/app-host-get-event)
|
|
163
|
+
*
|
|
164
|
+
*/
|
|
165
|
+
appHostGetEvent(params: {
|
|
166
|
+
appDomain: string;
|
|
167
|
+
fid: number;
|
|
168
|
+
event: AppHostGetEventEventEnum;
|
|
169
|
+
}): Promise<AppHostGetEventResponse>;
|
|
170
|
+
/**
|
|
171
|
+
* Returns the current notification state for a specific user across all mini app domains in this app host. Shows which domains have notifications enabled.
|
|
172
|
+
*
|
|
173
|
+
* @summary Enabled notifications
|
|
174
|
+
*
|
|
175
|
+
* @param {object} params
|
|
176
|
+
* @param {number} params.fid - The FID of the user
|
|
177
|
+
*
|
|
178
|
+
* @returns {Promise<AppHostUserStateResponse>} A promise that resolves to a `AppHostUserStateResponse` object.
|
|
179
|
+
*
|
|
180
|
+
* @example
|
|
181
|
+
*
|
|
182
|
+
* // Fill in the appropriate values
|
|
183
|
+
* const fid =
|
|
184
|
+
*
|
|
185
|
+
* client.appHostGetUserState({ fid }).then(response => {
|
|
186
|
+
* console.log('response:', response);
|
|
187
|
+
* });
|
|
188
|
+
*
|
|
189
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/app-host-get-user-state)
|
|
190
|
+
*
|
|
191
|
+
*/
|
|
192
|
+
appHostGetUserState(params: {
|
|
193
|
+
fid: number;
|
|
194
|
+
}): Promise<AppHostUserStateResponse>;
|
|
195
|
+
/**
|
|
196
|
+
* Post an app_host event to the domain\'s webhook. Events such as enabling or disabling notifications for a user. Provide either a signed message or the signer UUID of an authorized neynar-hosted signers.
|
|
197
|
+
*
|
|
198
|
+
* @summary Send event
|
|
199
|
+
*
|
|
200
|
+
* @param {object} params
|
|
201
|
+
* @param {any} params.appHostPostEventReqBody
|
|
202
|
+
*
|
|
203
|
+
* @returns {Promise<AppHostPostEventResponse>} A promise that resolves to a `AppHostPostEventResponse` object.
|
|
204
|
+
*
|
|
205
|
+
* @example
|
|
206
|
+
*
|
|
207
|
+
* // Fill in the appropriate values
|
|
208
|
+
* const appHostPostEventReqBody =
|
|
209
|
+
*
|
|
210
|
+
* client.appHostPostEvent({appHostPostEventReqBody}).then(response => {
|
|
211
|
+
* console.log('response:', response);
|
|
212
|
+
* });
|
|
213
|
+
*
|
|
214
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/app-host-post-event)
|
|
215
|
+
*
|
|
216
|
+
*/
|
|
217
|
+
appHostPostEvent(params: {
|
|
218
|
+
appHostPostEventReqBody: any;
|
|
219
|
+
}): Promise<AppHostPostEventResponse>;
|
|
220
|
+
/**
|
|
221
|
+
* Fetches the status of a developer managed auth address by auth address
|
|
222
|
+
*
|
|
223
|
+
* @summary Status by auth address
|
|
224
|
+
*
|
|
225
|
+
* @param {object} params
|
|
226
|
+
* @param {string} params.address - Ethereum address
|
|
227
|
+
*
|
|
228
|
+
* @returns {Promise<RegisterSignedKeyForDeveloperManagedAuthAddress200Response>} A promise that resolves to a `RegisterSignedKeyForDeveloperManagedAuthAddress200Response` object.
|
|
229
|
+
*
|
|
230
|
+
* @example
|
|
231
|
+
*
|
|
232
|
+
* // Fill in the appropriate values
|
|
233
|
+
* const address =
|
|
234
|
+
*
|
|
235
|
+
* client.lookupDeveloperManagedAuthAddress({ address }).then(response => {
|
|
236
|
+
* console.log('response:', response);
|
|
237
|
+
* });
|
|
238
|
+
*
|
|
239
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/lookup-developer-managed-auth-address)
|
|
240
|
+
*
|
|
241
|
+
*/
|
|
242
|
+
lookupDeveloperManagedAuthAddress(params: {
|
|
243
|
+
address: string;
|
|
244
|
+
}): Promise<RegisterSignedKeyForDeveloperManagedAuthAddress200Response>;
|
|
245
|
+
/**
|
|
246
|
+
* Allow apps to register an Ethereum addresses as authorized \"auth addresses\" for a user\'s Farcaster account, enabling seamless Sign-In With Farcaster (SIWF) across applications without repeated custody wallet authorizations.
|
|
247
|
+
*
|
|
248
|
+
* @summary Register Signed Key
|
|
249
|
+
*
|
|
250
|
+
* @param {object} params
|
|
251
|
+
* @param {string} params.address - Ethereum address
|
|
252
|
+
* @param {number} params.appFid - The unique identifier of a farcaster user or app (unsigned integer)
|
|
253
|
+
* @param {number} params.deadline - unix timestamp in seconds that controls how long the signed key request is valid for. (24 hours from now is recommended)
|
|
254
|
+
* @param {string} params.signature - Signature generated by the custody address of the app. Signed data includes app_fid, deadline, 32 bytes padded auth address. [Refer guide for more details.](https://docs.neynar.com/docs/auth-address-signature-generation)
|
|
255
|
+
* @param {string} params.redirectUrl [optional] - Url to redirect to after the signer is approved. **Note** : This should only be used when requesting a signer from a native mobile application.
|
|
256
|
+
* @param {SignedKeyRequestSponsor} params.sponsor [optional]
|
|
257
|
+
*
|
|
258
|
+
* @returns {Promise<RegisterSignedKeyForDeveloperManagedAuthAddress200Response>} A promise that resolves to a `RegisterSignedKeyForDeveloperManagedAuthAddress200Response` object.
|
|
259
|
+
*
|
|
260
|
+
* @example
|
|
261
|
+
*
|
|
262
|
+
* // Fill in the appropriate values
|
|
263
|
+
* const address =
|
|
264
|
+
* const appFid =
|
|
265
|
+
* const deadline =
|
|
266
|
+
* const signature =
|
|
267
|
+
* const redirectUrl =
|
|
268
|
+
* const sponsor =
|
|
269
|
+
*
|
|
270
|
+
* client.registerSignedKeyForDeveloperManagedAuthAddress({address, appFid, deadline, signature, redirectUrl, sponsor}).then(response => {
|
|
271
|
+
* console.log('response:', response);
|
|
272
|
+
* });
|
|
273
|
+
*
|
|
274
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/register-signed-key-for-developer-managed-auth-address)
|
|
275
|
+
*
|
|
276
|
+
*/
|
|
277
|
+
registerSignedKeyForDeveloperManagedAuthAddress(params: {
|
|
278
|
+
address: string;
|
|
279
|
+
appFid: number;
|
|
280
|
+
deadline: number;
|
|
281
|
+
signature: string;
|
|
282
|
+
redirectUrl?: string;
|
|
283
|
+
sponsor?: SignedKeyRequestSponsor;
|
|
284
|
+
}): Promise<RegisterSignedKeyForDeveloperManagedAuthAddress200Response>;
|
|
127
285
|
/**
|
|
128
286
|
* Deletes a list of FIDs from the app associated with your API key.
|
|
129
287
|
*
|
|
@@ -208,7 +366,7 @@ export declare class NeynarAPIClient {
|
|
|
208
366
|
*
|
|
209
367
|
* @param {object} params
|
|
210
368
|
* @param {string} params.signerUuid - UUID of the signer. `signer_uuid` is paired with API key, can't use a `uuid` made with a different API key.
|
|
211
|
-
* @param {number} params.blockedFid - The unique identifier of a farcaster user (unsigned integer)
|
|
369
|
+
* @param {number} params.blockedFid - The unique identifier of a farcaster user or app (unsigned integer)
|
|
212
370
|
*
|
|
213
371
|
* @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
|
|
214
372
|
*
|
|
@@ -269,7 +427,7 @@ export declare class NeynarAPIClient {
|
|
|
269
427
|
*
|
|
270
428
|
* @param {object} params
|
|
271
429
|
* @param {string} params.signerUuid - UUID of the signer. `signer_uuid` is paired with API key, can't use a `uuid` made with a different API key.
|
|
272
|
-
* @param {number} params.blockedFid - The unique identifier of a farcaster user (unsigned integer)
|
|
430
|
+
* @param {number} params.blockedFid - The unique identifier of a farcaster user or app (unsigned integer)
|
|
273
431
|
*
|
|
274
432
|
* @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
|
|
275
433
|
*
|
|
@@ -291,13 +449,13 @@ export declare class NeynarAPIClient {
|
|
|
291
449
|
blockedFid: number;
|
|
292
450
|
}): Promise<OperationResponse>;
|
|
293
451
|
/**
|
|
294
|
-
* Delete an existing cast.
|
|
452
|
+
* Delete an existing cast. (In order to delete a cast `signer_uuid` must be approved)
|
|
295
453
|
*
|
|
296
454
|
* @summary Delete a cast
|
|
297
455
|
*
|
|
298
456
|
* @param {object} params
|
|
299
457
|
* @param {string} params.signerUuid - UUID of the signer. `signer_uuid` is paired with API key, can't use a `uuid` made with a different API key.
|
|
300
|
-
* @param {string} params.targetHash
|
|
458
|
+
* @param {string} params.targetHash
|
|
301
459
|
*
|
|
302
460
|
* @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
|
|
303
461
|
*
|
|
@@ -349,13 +507,49 @@ export declare class NeynarAPIClient {
|
|
|
349
507
|
viewerFid?: number;
|
|
350
508
|
sortType?: FetchBulkCastsSortTypeEnum;
|
|
351
509
|
}): Promise<CastsResponse>;
|
|
510
|
+
/**
|
|
511
|
+
* Fetch casts that quote a given cast
|
|
512
|
+
*
|
|
513
|
+
* @summary Cast Quotes
|
|
514
|
+
*
|
|
515
|
+
* @param {object} params
|
|
516
|
+
* @param {FetchCastQuotesIdentifierParameter} params.identifier - Cast identifier (It's either a URL or a hash)
|
|
517
|
+
* @param {FetchCastQuotesTypeEnum} params.type - The query param accepted by the API. Sent along with identifier param. url - Cast identifier is a url hash - Cast identifier is a hash
|
|
518
|
+
* @param {number} params.viewerFid [optional]
|
|
519
|
+
* @param {number} params.limit [optional] - Number of results to fetch (Default: 25, Maximum: 100)
|
|
520
|
+
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
521
|
+
*
|
|
522
|
+
* @returns {Promise<FetchCastQuotes200Response>} A promise that resolves to a `FetchCastQuotes200Response` object.
|
|
523
|
+
*
|
|
524
|
+
* @example
|
|
525
|
+
*
|
|
526
|
+
* // Fill in the appropriate values
|
|
527
|
+
* const identifier =
|
|
528
|
+
* const type =
|
|
529
|
+
* const viewerFid =
|
|
530
|
+
* const limit =
|
|
531
|
+
*
|
|
532
|
+
* client.fetchCastQuotes({ identifier, type, viewerFid, limit }).then(response => {
|
|
533
|
+
* console.log('response:', response);
|
|
534
|
+
* });
|
|
535
|
+
*
|
|
536
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-cast-quotes)
|
|
537
|
+
*
|
|
538
|
+
*/
|
|
539
|
+
fetchCastQuotes(params: {
|
|
540
|
+
identifier: FetchCastQuotesIdentifierParameter;
|
|
541
|
+
type: FetchCastQuotesTypeEnum;
|
|
542
|
+
viewerFid?: number;
|
|
543
|
+
limit?: number;
|
|
544
|
+
cursor?: string;
|
|
545
|
+
}): Promise<FetchCastQuotes200Response>;
|
|
352
546
|
/**
|
|
353
547
|
* Fetches all composer actions on Warpcast. You can filter by top or featured.
|
|
354
548
|
*
|
|
355
549
|
* @summary Fetch composer actions
|
|
356
550
|
*
|
|
357
551
|
* @param {object} params
|
|
358
|
-
* @param {
|
|
552
|
+
* @param {FetchComposerActionsListEnum} params.list - Type of list to fetch.
|
|
359
553
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 25, Maximum: 25)
|
|
360
554
|
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
361
555
|
*
|
|
@@ -375,7 +569,7 @@ export declare class NeynarAPIClient {
|
|
|
375
569
|
*
|
|
376
570
|
*/
|
|
377
571
|
fetchComposerActions(params: {
|
|
378
|
-
list:
|
|
572
|
+
list: FetchComposerActionsListEnum;
|
|
379
573
|
limit?: number;
|
|
380
574
|
cursor?: string;
|
|
381
575
|
}): Promise<CastComposerActionsListResponse>;
|
|
@@ -405,13 +599,13 @@ export declare class NeynarAPIClient {
|
|
|
405
599
|
url: string;
|
|
406
600
|
}): Promise<CastEmbedCrawlResponse>;
|
|
407
601
|
/**
|
|
408
|
-
* Gets information about an individual cast by passing in a
|
|
602
|
+
* Gets information about an individual cast by passing in a Farcaster web URL or cast hash
|
|
409
603
|
*
|
|
410
604
|
* @summary By hash or URL
|
|
411
605
|
*
|
|
412
606
|
* @param {object} params
|
|
413
|
-
* @param {
|
|
414
|
-
* @param {
|
|
607
|
+
* @param {FetchCastQuotesIdentifierParameter} params.identifier - Cast identifier (It's either a URL or a hash)
|
|
608
|
+
* @param {LookupCastByHashOrWarpcastUrlTypeEnum} params.type - The query param accepted by the API. Sent along with identifier param. url - Cast identifier is a url hash - Cast identifier is a hash
|
|
415
609
|
* @param {number} params.viewerFid [optional] - adds viewer_context to cast object to show whether viewer has liked or recasted the cast.
|
|
416
610
|
*
|
|
417
611
|
* @returns {Promise<CastResponse>} A promise that resolves to a `CastResponse` object.
|
|
@@ -431,22 +625,22 @@ export declare class NeynarAPIClient {
|
|
|
431
625
|
*
|
|
432
626
|
*/
|
|
433
627
|
lookupCastByHashOrWarpcastUrl(params: {
|
|
434
|
-
identifier:
|
|
435
|
-
type:
|
|
628
|
+
identifier: FetchCastQuotesIdentifierParameter;
|
|
629
|
+
type: LookupCastByHashOrWarpcastUrlTypeEnum;
|
|
436
630
|
viewerFid?: number;
|
|
437
631
|
}): Promise<CastResponse>;
|
|
438
632
|
/**
|
|
439
|
-
* Gets all casts related to a conversation surrounding a cast by passing in a cast hash or
|
|
633
|
+
* Gets all casts related to a conversation surrounding a cast by passing in a cast hash or Farcaster URL. Includes all the ancestors of a cast up to the root parent in a chronological order. Includes all direct_replies to the cast up to the reply_depth specified in the query parameter.
|
|
440
634
|
*
|
|
441
635
|
* @summary Conversation for a cast
|
|
442
636
|
*
|
|
443
637
|
* @param {object} params
|
|
444
|
-
* @param {string} params.identifier - Cast identifier (
|
|
445
|
-
* @param {
|
|
446
|
-
* @param {number} params.replyDepth [optional] - The depth of replies in the conversation that will be returned (default 2)
|
|
447
|
-
* @param {boolean} params.includeChronologicalParentCasts [optional] - Include all parent casts in chronological order
|
|
638
|
+
* @param {string} params.identifier - Cast identifier (It's either a URL or a hash)
|
|
639
|
+
* @param {LookupCastConversationTypeEnum} params.type - The query param accepted by the API. Sent along with identifier param. url - Cast identifier is a url hash - Cast identifier is a hash
|
|
640
|
+
* @param {number | null} params.replyDepth [optional] - The depth of replies in the conversation that will be returned (default 2)
|
|
641
|
+
* @param {boolean | null} params.includeChronologicalParentCasts [optional] - Include all parent casts in chronological order
|
|
448
642
|
* @param {number} params.viewerFid [optional] - Providing this will return a conversation that respects this user's mutes and blocks and includes `viewer_context`.
|
|
449
|
-
* @param {
|
|
643
|
+
* @param {LookupCastConversationSortTypeEnum} params.sortType [optional] - Sort type for the ordering of descendants. Default is `chron`
|
|
450
644
|
* @param {LookupCastConversationFoldEnum} params.fold [optional] - Show conversation above or below the fold. Lower quality responses are hidden below the fold. Not passing in a value shows the full conversation without any folding.
|
|
451
645
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 20, Maximum: 50)
|
|
452
646
|
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
@@ -474,11 +668,11 @@ export declare class NeynarAPIClient {
|
|
|
474
668
|
*/
|
|
475
669
|
lookupCastConversation(params: {
|
|
476
670
|
identifier: string;
|
|
477
|
-
type:
|
|
478
|
-
replyDepth?: number;
|
|
479
|
-
includeChronologicalParentCasts?: boolean;
|
|
671
|
+
type: LookupCastConversationTypeEnum;
|
|
672
|
+
replyDepth?: number | null;
|
|
673
|
+
includeChronologicalParentCasts?: boolean | null;
|
|
480
674
|
viewerFid?: number;
|
|
481
|
-
sortType?:
|
|
675
|
+
sortType?: LookupCastConversationSortTypeEnum;
|
|
482
676
|
fold?: LookupCastConversationFoldEnum;
|
|
483
677
|
limit?: number;
|
|
484
678
|
cursor?: string;
|
|
@@ -495,7 +689,7 @@ export declare class NeynarAPIClient {
|
|
|
495
689
|
* @param {string} params.parent [optional] - parent_url of the channel the cast is in, or hash of the cast
|
|
496
690
|
* @param {string} params.channelId [optional] - Channel ID of the channel where the cast is to be posted. e.g. neynar, farcaster, warpcast
|
|
497
691
|
* @param {string} params.idem [optional] - An Idempotency key is a unique identifier for the request. **Note:** 1) This is used to prevent duplicate requests. Use the same idem key on retry attempts. 2) This should be a unique identifier for each request. 3) Recommended format is a 16-character string generated by the developer at the time of making this request.
|
|
498
|
-
* @param {number} params.parentAuthorFid [optional] - The unique identifier of a farcaster user (unsigned integer)
|
|
692
|
+
* @param {number} params.parentAuthorFid [optional] - The unique identifier of a farcaster user or app (unsigned integer)
|
|
499
693
|
*
|
|
500
694
|
* @returns {Promise<PostCastResponse>} A promise that resolves to a `PostCastResponse` object.
|
|
501
695
|
*
|
|
@@ -534,12 +728,11 @@ export declare class NeynarAPIClient {
|
|
|
534
728
|
* @param {object} params
|
|
535
729
|
* @param {string} params.q - Query string to search for casts. Supported operators: | Operator | Description | | --------- | -------------------------------------------------------------------------------------------------------- | | `+` | Acts as the AND operator. This is the default operator between terms and can usually be omitted. | | `|` | Acts as the OR operator. | | `*` | When used at the end of a term, signifies a prefix query. | | `"` | Wraps several terms into a phrase (for example, `"star wars"`). | | `(`, `)` | Wrap a clause for precedence (for example, `star + (wars | trek)`). | | `~n` | When used after a term (for example, `satr~3`), sets `fuzziness`. When used after a phrase, sets `slop`. | | `-` | Negates the term. | | `before:` | Search for casts before a specific date. (e.g. `before:2025-04-20`) | | `after:` | Search for casts after a specific date. (e.g. `after:2025-04-20`) |
|
|
536
730
|
* @param {SearchCastsModeEnum} params.mode [optional] - Choices are: - `literal` - Searches for the words in the query string (default) - `semantic` - Searches for the meaning of the query string - `hybrid` - Combines both literal and semantic results
|
|
537
|
-
* @param {
|
|
731
|
+
* @param {SearchCastsSortTypeEnum} params.sortType [optional] - Choices are: - `desc_chron` - All casts sorted by time (default) - `algorithmic` - Casts sorted by engagement and time
|
|
538
732
|
* @param {number} params.authorFid [optional] - Fid of the user whose casts you want to search
|
|
539
733
|
* @param {number} params.viewerFid [optional] - Providing this will return search results that respects this user's mutes and blocks and includes `viewer_context`.
|
|
540
734
|
* @param {string} params.parentUrl [optional] - Parent URL of the casts you want to search
|
|
541
735
|
* @param {string} params.channelId [optional] - Channel ID of the casts you want to search
|
|
542
|
-
* @param {boolean} params.priorityMode [optional] - When true, only returns search results from power badge users and users that the viewer follows (if viewer_fid is provided).
|
|
543
736
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 25, Maximum: 100)
|
|
544
737
|
* @param {string} params.cursor [optional] - Pagination cursor
|
|
545
738
|
*
|
|
@@ -555,10 +748,9 @@ export declare class NeynarAPIClient {
|
|
|
555
748
|
* const viewerFid =
|
|
556
749
|
* const parentUrl =
|
|
557
750
|
* const channelId =
|
|
558
|
-
* const priorityMode =
|
|
559
751
|
* const limit =
|
|
560
752
|
*
|
|
561
|
-
* client.searchCasts({ q, mode, sortType, authorFid, viewerFid, parentUrl, channelId,
|
|
753
|
+
* client.searchCasts({ q, mode, sortType, authorFid, viewerFid, parentUrl, channelId, limit }).then(response => {
|
|
562
754
|
* console.log('response:', response);
|
|
563
755
|
* });
|
|
564
756
|
*
|
|
@@ -568,12 +760,11 @@ export declare class NeynarAPIClient {
|
|
|
568
760
|
searchCasts(params: {
|
|
569
761
|
q: string;
|
|
570
762
|
mode?: SearchCastsModeEnum;
|
|
571
|
-
sortType?:
|
|
763
|
+
sortType?: SearchCastsSortTypeEnum;
|
|
572
764
|
authorFid?: number;
|
|
573
765
|
viewerFid?: number;
|
|
574
766
|
parentUrl?: string;
|
|
575
767
|
channelId?: string;
|
|
576
|
-
priorityMode?: boolean;
|
|
577
768
|
limit?: number;
|
|
578
769
|
cursor?: string;
|
|
579
770
|
}): Promise<CastsSearchResponse>;
|
|
@@ -611,7 +802,7 @@ export declare class NeynarAPIClient {
|
|
|
611
802
|
*
|
|
612
803
|
* @param {object} params
|
|
613
804
|
* @param {string[]} params.ids - Comma separated list of channel IDs or parent_urls, up to 100 at a time
|
|
614
|
-
* @param {
|
|
805
|
+
* @param {FetchBulkChannelsTypeEnum} params.type [optional] - Type of identifier being used to query the channels. Defaults to ID.
|
|
615
806
|
* @param {number} params.viewerFid [optional] - FID of the user viewing the channels.
|
|
616
807
|
*
|
|
617
808
|
* @returns {Promise<ChannelResponseBulk>} A promise that resolves to a `ChannelResponseBulk` object.
|
|
@@ -632,7 +823,7 @@ export declare class NeynarAPIClient {
|
|
|
632
823
|
*/
|
|
633
824
|
fetchBulkChannels(params: {
|
|
634
825
|
ids: string[];
|
|
635
|
-
type?:
|
|
826
|
+
type?: FetchBulkChannelsTypeEnum;
|
|
636
827
|
viewerFid?: number;
|
|
637
828
|
}): Promise<ChannelResponseBulk>;
|
|
638
829
|
/**
|
|
@@ -918,7 +1109,7 @@ export declare class NeynarAPIClient {
|
|
|
918
1109
|
* @param {object} params
|
|
919
1110
|
* @param {string} params.signerUuid - UUID of the signer. `signer_uuid` is paired with API key, can't use a `uuid` made with a different API key.
|
|
920
1111
|
* @param {string} params.channelId - The unique identifier of a farcaster channel
|
|
921
|
-
* @param {number} params.fid - The unique identifier of a farcaster user (unsigned integer)
|
|
1112
|
+
* @param {number} params.fid - The unique identifier of a farcaster user or app (unsigned integer)
|
|
922
1113
|
* @param {ChannelMemberRole} params.role
|
|
923
1114
|
*
|
|
924
1115
|
* @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
|
|
@@ -951,7 +1142,7 @@ export declare class NeynarAPIClient {
|
|
|
951
1142
|
*
|
|
952
1143
|
* @param {object} params
|
|
953
1144
|
* @param {string} params.id - Channel ID for the channel being queried
|
|
954
|
-
* @param {
|
|
1145
|
+
* @param {LookupChannelTypeEnum} params.type [optional] - Type of identifier being used to query the channel. Defaults to ID.
|
|
955
1146
|
* @param {number} params.viewerFid [optional] - FID of the user viewing the channel.
|
|
956
1147
|
*
|
|
957
1148
|
* @returns {Promise<ChannelResponse>} A promise that resolves to a `ChannelResponse` object.
|
|
@@ -972,7 +1163,7 @@ export declare class NeynarAPIClient {
|
|
|
972
1163
|
*/
|
|
973
1164
|
lookupChannel(params: {
|
|
974
1165
|
id: string;
|
|
975
|
-
type?:
|
|
1166
|
+
type?: LookupChannelTypeEnum;
|
|
976
1167
|
viewerFid?: number;
|
|
977
1168
|
}): Promise<ChannelResponse>;
|
|
978
1169
|
/**
|
|
@@ -983,7 +1174,7 @@ export declare class NeynarAPIClient {
|
|
|
983
1174
|
* @param {object} params
|
|
984
1175
|
* @param {string} params.signerUuid - UUID of the signer. `signer_uuid` is paired with API key, can't use a `uuid` made with a different API key.
|
|
985
1176
|
* @param {string} params.channelId - The unique identifier of a farcaster channel
|
|
986
|
-
* @param {number} params.fid - The unique identifier of a farcaster user (unsigned integer)
|
|
1177
|
+
* @param {number} params.fid - The unique identifier of a farcaster user or app (unsigned integer)
|
|
987
1178
|
* @param {ChannelMemberRole} params.role
|
|
988
1179
|
*
|
|
989
1180
|
* @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
|
|
@@ -1112,7 +1303,7 @@ export declare class NeynarAPIClient {
|
|
|
1112
1303
|
* @param {number} params.viewerFid [optional] - FID of the user viewing the feed
|
|
1113
1304
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 25, Maximum: 150)
|
|
1114
1305
|
* @param {string} params.cursor [optional] - Pagination cursor
|
|
1115
|
-
* @param {boolean} params.includeReplies [optional] - Include reply casts by the author in the response, true by default
|
|
1306
|
+
* @param {boolean | null} params.includeReplies [optional] - Include reply casts by the author in the response, true by default
|
|
1116
1307
|
* @param {string} params.parentUrl [optional] - Parent URL to filter the feed; mutually exclusive with channel_id
|
|
1117
1308
|
* @param {string} params.channelId [optional] - Channel ID to filter the feed; mutually exclusive with parent_url
|
|
1118
1309
|
*
|
|
@@ -1142,7 +1333,7 @@ export declare class NeynarAPIClient {
|
|
|
1142
1333
|
viewerFid?: number;
|
|
1143
1334
|
limit?: number;
|
|
1144
1335
|
cursor?: string;
|
|
1145
|
-
includeReplies?: boolean;
|
|
1336
|
+
includeReplies?: boolean | null;
|
|
1146
1337
|
parentUrl?: string;
|
|
1147
1338
|
channelId?: string;
|
|
1148
1339
|
}): Promise<FeedResponse>;
|
|
@@ -1152,16 +1343,16 @@ export declare class NeynarAPIClient {
|
|
|
1152
1343
|
* @summary By filters
|
|
1153
1344
|
*
|
|
1154
1345
|
* @param {object} params
|
|
1155
|
-
* @param {
|
|
1156
|
-
* @param {
|
|
1346
|
+
* @param {FetchFeedFeedTypeEnum} params.feedType [optional] - Defaults to following (requires FID or address). If set to filter (requires filter_type)
|
|
1347
|
+
* @param {FetchFeedFilterTypeEnum} params.filterType [optional] - Used when feed_type=filter. Can be set to FIDs (requires FIDs) or parent_url (requires parent_url) or channel_id (requires channel_id)
|
|
1157
1348
|
* @param {number} params.fid [optional] - (Optional) FID of user whose feed you want to create. By default, the API expects this field, except if you pass a filter_type
|
|
1158
|
-
* @param {
|
|
1349
|
+
* @param {number[]} params.fids [optional] - Used when filter_type=FIDs . Create a feed based on a list of FIDs. Max array size is 100. Requires feed_type and filter_type.
|
|
1159
1350
|
* @param {string} params.parentUrl [optional] - Used when filter_type=parent_url can be used to fetch content under any parent url e.g. FIP-2 channels on Warpcast. Requires feed_type and filter_type.
|
|
1160
1351
|
* @param {string} params.channelId [optional] - Used when filter_type=channel_id can be used to fetch casts under a channel. Requires feed_type and filter_type.
|
|
1161
|
-
* @param {boolean} params.membersOnly [optional] - Used when filter_type=channel_id. Only include casts from members of the channel. True by default.
|
|
1352
|
+
* @param {boolean | null} params.membersOnly [optional] - Used when filter_type=channel_id. Only include casts from members of the channel. True by default.
|
|
1162
1353
|
* @param {string} params.embedUrl [optional] - Used when filter_type=embed_url. Casts with embedded URLs prefixed by this embed_url param will be returned. We normalize your given URL prefix and prepend 'https://' if no protocol is included. Requires feed_type and filter_type.
|
|
1163
|
-
* @param {Array<
|
|
1164
|
-
* @param {boolean} params.withRecasts [optional] - Include recasts in the response, true by default
|
|
1354
|
+
* @param {Array<FetchFeedEmbedTypesEnum>} params.embedTypes [optional] - Used when filter_type=embed_types can be used to fetch all casts with matching content types. Requires feed_type and filter_type.
|
|
1355
|
+
* @param {boolean | null} params.withRecasts [optional] - Include recasts in the response, true by default
|
|
1165
1356
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 25, Maximum: 100)
|
|
1166
1357
|
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
1167
1358
|
* @param {number} params.viewerFid [optional] - Providing this will return a feed that respects this user's mutes and blocks and includes `viewer_context`.
|
|
@@ -1192,16 +1383,16 @@ export declare class NeynarAPIClient {
|
|
|
1192
1383
|
*
|
|
1193
1384
|
*/
|
|
1194
1385
|
fetchFeed(params: {
|
|
1195
|
-
feedType
|
|
1196
|
-
filterType?:
|
|
1386
|
+
feedType?: FetchFeedFeedTypeEnum;
|
|
1387
|
+
filterType?: FetchFeedFilterTypeEnum;
|
|
1197
1388
|
fid?: number;
|
|
1198
|
-
fids?:
|
|
1389
|
+
fids?: number[];
|
|
1199
1390
|
parentUrl?: string;
|
|
1200
1391
|
channelId?: string;
|
|
1201
|
-
membersOnly?: boolean;
|
|
1392
|
+
membersOnly?: boolean | null;
|
|
1202
1393
|
embedUrl?: string;
|
|
1203
|
-
embedTypes?: Array<
|
|
1204
|
-
withRecasts?: boolean;
|
|
1394
|
+
embedTypes?: Array<FetchFeedEmbedTypesEnum>;
|
|
1395
|
+
withRecasts?: boolean | null;
|
|
1205
1396
|
limit?: number;
|
|
1206
1397
|
cursor?: string;
|
|
1207
1398
|
viewerFid?: number;
|
|
@@ -1213,14 +1404,14 @@ export declare class NeynarAPIClient {
|
|
|
1213
1404
|
*
|
|
1214
1405
|
* @param {object} params
|
|
1215
1406
|
* @param {string[]} params.channelIds - Comma separated list of up to 10 channel IDs e.g. neynar,farcaster
|
|
1216
|
-
* @param {boolean} params.withRecasts [optional] - Include recasts in the response, true by default
|
|
1407
|
+
* @param {boolean | null} params.withRecasts [optional] - Include recasts in the response, true by default
|
|
1217
1408
|
* @param {number} params.viewerFid [optional] - Providing this will return a feed that respects this user's mutes and blocks and includes `viewer_context`.
|
|
1218
|
-
* @param {boolean} params.withReplies [optional] - Include replies in the response, false by default
|
|
1219
|
-
* @param {boolean} params.membersOnly [optional] - Only include casts from members of the channel. True by default.
|
|
1409
|
+
* @param {boolean | null} params.withReplies [optional] - Include replies in the response, false by default
|
|
1410
|
+
* @param {boolean | null} params.membersOnly [optional] - Used when filter_type=channel_id. Only include casts from members of the channel. True by default.
|
|
1220
1411
|
* @param {number[]} params.fids [optional] - Comma separated list of FIDs to filter the feed by, up to 10 at a time
|
|
1221
1412
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 25, Maximum: 100)
|
|
1222
1413
|
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
1223
|
-
* @param {boolean} params.shouldModerate [optional] - If true, only casts that have been liked by the moderator (if one exists) will be returned.
|
|
1414
|
+
* @param {boolean | null} params.shouldModerate [optional] - If true, only casts that have been liked by the moderator (if one exists) will be returned.
|
|
1224
1415
|
*
|
|
1225
1416
|
* @returns {Promise<FeedResponse>} A promise that resolves to a `FeedResponse` object.
|
|
1226
1417
|
*
|
|
@@ -1245,14 +1436,14 @@ export declare class NeynarAPIClient {
|
|
|
1245
1436
|
*/
|
|
1246
1437
|
fetchFeedByChannelIds(params: {
|
|
1247
1438
|
channelIds: string[];
|
|
1248
|
-
withRecasts?: boolean;
|
|
1439
|
+
withRecasts?: boolean | null;
|
|
1249
1440
|
viewerFid?: number;
|
|
1250
|
-
withReplies?: boolean;
|
|
1251
|
-
membersOnly?: boolean;
|
|
1441
|
+
withReplies?: boolean | null;
|
|
1442
|
+
membersOnly?: boolean | null;
|
|
1252
1443
|
fids?: number[];
|
|
1253
1444
|
limit?: number;
|
|
1254
1445
|
cursor?: string;
|
|
1255
|
-
shouldModerate?: boolean;
|
|
1446
|
+
shouldModerate?: boolean | null;
|
|
1256
1447
|
}): Promise<FeedResponse>;
|
|
1257
1448
|
/**
|
|
1258
1449
|
* Fetch feed based on parent URLs
|
|
@@ -1261,9 +1452,9 @@ export declare class NeynarAPIClient {
|
|
|
1261
1452
|
*
|
|
1262
1453
|
* @param {object} params
|
|
1263
1454
|
* @param {string[]} params.parentUrls - Comma separated list of parent_urls
|
|
1264
|
-
* @param {boolean} params.withRecasts [optional] - Include recasts in the response, true by default
|
|
1455
|
+
* @param {boolean | null} params.withRecasts [optional] - Include recasts in the response, true by default
|
|
1265
1456
|
* @param {number} params.viewerFid [optional] - Providing this will return a feed that respects this user's mutes and blocks and includes `viewer_context`.
|
|
1266
|
-
* @param {boolean} params.withReplies [optional] - Include replies in the response, false by default
|
|
1457
|
+
* @param {boolean | null} params.withReplies [optional] - Include replies in the response, false by default
|
|
1267
1458
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 25, Maximum: 100)
|
|
1268
1459
|
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
1269
1460
|
*
|
|
@@ -1287,9 +1478,9 @@ export declare class NeynarAPIClient {
|
|
|
1287
1478
|
*/
|
|
1288
1479
|
fetchFeedByParentUrls(params: {
|
|
1289
1480
|
parentUrls: string[];
|
|
1290
|
-
withRecasts?: boolean;
|
|
1481
|
+
withRecasts?: boolean | null;
|
|
1291
1482
|
viewerFid?: number;
|
|
1292
|
-
withReplies?: boolean;
|
|
1483
|
+
withReplies?: boolean | null;
|
|
1293
1484
|
limit?: number;
|
|
1294
1485
|
cursor?: string;
|
|
1295
1486
|
}): Promise<FeedResponse>;
|
|
@@ -1301,10 +1492,9 @@ export declare class NeynarAPIClient {
|
|
|
1301
1492
|
* @param {object} params
|
|
1302
1493
|
* @param {number} params.fid - FID of user whose feed you want to create
|
|
1303
1494
|
* @param {number} params.viewerFid [optional] - Providing this will return a feed that respects this user's mutes and blocks and includes `viewer_context`.
|
|
1304
|
-
* @param {
|
|
1495
|
+
* @param {FetchFeedForYouProviderEnum} params.provider [optional] - The provider of the For You feed.
|
|
1305
1496
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 25, Maximum: 50)
|
|
1306
1497
|
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
1307
|
-
* @param {string} params.providerMetadata [optional] - provider_metadata is a URI-encoded stringified JSON object that can be used to pass additional metadata to the provider. Only available for mbd provider right now. See [here](https://docs.neynar.com/docs/feed-for-you-w-external-providers) on how to use.
|
|
1308
1498
|
*
|
|
1309
1499
|
* @returns {Promise<FeedResponse>} A promise that resolves to a `FeedResponse` object.
|
|
1310
1500
|
*
|
|
@@ -1315,9 +1505,8 @@ export declare class NeynarAPIClient {
|
|
|
1315
1505
|
* const viewerFid =
|
|
1316
1506
|
* const provider =
|
|
1317
1507
|
* const limit =
|
|
1318
|
-
* const providerMetadata =
|
|
1319
1508
|
*
|
|
1320
|
-
* client.fetchFeedForYou({ fid, viewerFid, provider, limit
|
|
1509
|
+
* client.fetchFeedForYou({ fid, viewerFid, provider, limit }).then(response => {
|
|
1321
1510
|
* console.log('response:', response);
|
|
1322
1511
|
* });
|
|
1323
1512
|
*
|
|
@@ -1327,10 +1516,9 @@ export declare class NeynarAPIClient {
|
|
|
1327
1516
|
fetchFeedForYou(params: {
|
|
1328
1517
|
fid: number;
|
|
1329
1518
|
viewerFid?: number;
|
|
1330
|
-
provider?:
|
|
1519
|
+
provider?: FetchFeedForYouProviderEnum;
|
|
1331
1520
|
limit?: number;
|
|
1332
1521
|
cursor?: string;
|
|
1333
|
-
providerMetadata?: string;
|
|
1334
1522
|
}): Promise<FeedResponse>;
|
|
1335
1523
|
/**
|
|
1336
1524
|
* Fetch feed of casts with mini apps, reverse chronological order
|
|
@@ -1397,7 +1585,7 @@ export declare class NeynarAPIClient {
|
|
|
1397
1585
|
*
|
|
1398
1586
|
* @param {object} params
|
|
1399
1587
|
* @param {number} params.fid - FID of user whose replies and recasts you want to fetch
|
|
1400
|
-
* @param {FetchRepliesAndRecastsForUserFilterEnum} params.filter [optional] -
|
|
1588
|
+
* @param {FetchRepliesAndRecastsForUserFilterEnum} params.filter [optional] - Filter to fetch only replies or recasts
|
|
1401
1589
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 25, Maximum: 50)
|
|
1402
1590
|
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
1403
1591
|
* @param {number} params.viewerFid [optional] - Providing this will return a feed that respects this user's mutes and blocks and includes `viewer_context`.
|
|
@@ -1438,7 +1626,7 @@ export declare class NeynarAPIClient {
|
|
|
1438
1626
|
* @param {FetchTrendingFeedTimeWindowEnum} params.timeWindow [optional] - Time window for trending casts (7d window for channel feeds only)
|
|
1439
1627
|
* @param {string} params.channelId [optional] - Channel ID to filter trending casts. Less active channels might have no casts in the time window selected. Provide either `channel_id` or `parent_url`, not both.
|
|
1440
1628
|
* @param {string} params.parentUrl [optional] - Parent URL to filter trending casts. Less active channels might have no casts in the time window selected. Provide either `channel_id` or `parent_url`, not both.
|
|
1441
|
-
* @param {
|
|
1629
|
+
* @param {FetchTrendingFeedProviderEnum} params.provider [optional] - The provider of the trending casts feed.
|
|
1442
1630
|
* @param {string} params.providerMetadata [optional] - provider_metadata is a URI-encoded stringified JSON object that can be used to pass additional metadata to the provider. Only available for mbd provider right now. See [here](https://docs.neynar.com/docs/feed-for-you-w-external-providers) on how to use.
|
|
1443
1631
|
*
|
|
1444
1632
|
* @returns {Promise<FeedResponse>} A promise that resolves to a `FeedResponse` object.
|
|
@@ -1468,7 +1656,7 @@ export declare class NeynarAPIClient {
|
|
|
1468
1656
|
timeWindow?: FetchTrendingFeedTimeWindowEnum;
|
|
1469
1657
|
channelId?: string;
|
|
1470
1658
|
parentUrl?: string;
|
|
1471
|
-
provider?:
|
|
1659
|
+
provider?: FetchTrendingFeedProviderEnum;
|
|
1472
1660
|
providerMetadata?: string;
|
|
1473
1661
|
}): Promise<FeedResponse>;
|
|
1474
1662
|
/**
|
|
@@ -1479,7 +1667,7 @@ export declare class NeynarAPIClient {
|
|
|
1479
1667
|
* @param {object} params
|
|
1480
1668
|
* @param {number} params.fid - FID of user whose feed you want to create
|
|
1481
1669
|
* @param {number} params.viewerFid [optional] - Providing this will return a feed that respects this user's mutes and blocks and includes `viewer_context`.
|
|
1482
|
-
* @param {boolean} params.withRecasts [optional] - Include recasts in the response, true by default
|
|
1670
|
+
* @param {boolean | null} params.withRecasts [optional] - Include recasts in the response, true by default
|
|
1483
1671
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 25, Maximum: 100)
|
|
1484
1672
|
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
1485
1673
|
*
|
|
@@ -1503,7 +1691,7 @@ export declare class NeynarAPIClient {
|
|
|
1503
1691
|
fetchUserFollowingFeed(params: {
|
|
1504
1692
|
fid: number;
|
|
1505
1693
|
viewerFid?: number;
|
|
1506
|
-
withRecasts?: boolean;
|
|
1694
|
+
withRecasts?: boolean | null;
|
|
1507
1695
|
limit?: number;
|
|
1508
1696
|
cursor?: string;
|
|
1509
1697
|
}): Promise<FeedResponse>;
|
|
@@ -1538,8 +1726,8 @@ export declare class NeynarAPIClient {
|
|
|
1538
1726
|
* @summary Suggest Follows
|
|
1539
1727
|
*
|
|
1540
1728
|
* @param {object} params
|
|
1541
|
-
* @param {number} params.fid - FID of the user whose following you want to fetch.
|
|
1542
|
-
* @param {number} params.viewerFid [optional] - Providing this will return a list of users that respects this user's mutes and blocks and includes `viewer_context`.
|
|
1729
|
+
* @param {number | null} params.fid - FID of the user whose following you want to fetch.
|
|
1730
|
+
* @param {number | null} params.viewerFid [optional] - Providing this will return a list of users that respects this user's mutes and blocks and includes `viewer_context`.
|
|
1543
1731
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 25, Maximum: 100)
|
|
1544
1732
|
*
|
|
1545
1733
|
* @returns {Promise<UsersResponse>} A promise that resolves to a `UsersResponse` object.
|
|
@@ -1559,8 +1747,8 @@ export declare class NeynarAPIClient {
|
|
|
1559
1747
|
*
|
|
1560
1748
|
*/
|
|
1561
1749
|
fetchFollowSuggestions(params: {
|
|
1562
|
-
fid: number;
|
|
1563
|
-
viewerFid?: number;
|
|
1750
|
+
fid: number | null;
|
|
1751
|
+
viewerFid?: number | null;
|
|
1564
1752
|
limit?: number;
|
|
1565
1753
|
}): Promise<UsersResponse>;
|
|
1566
1754
|
/**
|
|
@@ -1599,7 +1787,7 @@ export declare class NeynarAPIClient {
|
|
|
1599
1787
|
* @param {object} params
|
|
1600
1788
|
* @param {number} params.fid - User who's profile you are looking at
|
|
1601
1789
|
* @param {number} params.viewerFid [optional] - Providing this will return a list of followers that respects this user's mutes and blocks and includes `viewer_context`.
|
|
1602
|
-
* @param {
|
|
1790
|
+
* @param {FetchUserFollowersSortTypeEnum} params.sortType [optional] - Sort type for fetch followers. Default is `desc_chron`
|
|
1603
1791
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 20, Maximum: 100)
|
|
1604
1792
|
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
1605
1793
|
*
|
|
@@ -1623,7 +1811,7 @@ export declare class NeynarAPIClient {
|
|
|
1623
1811
|
fetchUserFollowers(params: {
|
|
1624
1812
|
fid: number;
|
|
1625
1813
|
viewerFid?: number;
|
|
1626
|
-
sortType?:
|
|
1814
|
+
sortType?: FetchUserFollowersSortTypeEnum;
|
|
1627
1815
|
limit?: number;
|
|
1628
1816
|
cursor?: string;
|
|
1629
1817
|
}): Promise<FollowersResponse>;
|
|
@@ -1635,7 +1823,7 @@ export declare class NeynarAPIClient {
|
|
|
1635
1823
|
* @param {object} params
|
|
1636
1824
|
* @param {number} params.fid - FID of the user whose following you want to fetch.
|
|
1637
1825
|
* @param {number} params.viewerFid [optional] - Providing this will return a list of users that respects this user's mutes and blocks and includes `viewer_context`.
|
|
1638
|
-
* @param {
|
|
1826
|
+
* @param {FetchUserFollowingSortTypeEnum} params.sortType [optional] - Optional parameter to sort the users based on different criteria.
|
|
1639
1827
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 25, Maximum: 100)
|
|
1640
1828
|
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
1641
1829
|
*
|
|
@@ -1659,7 +1847,7 @@ export declare class NeynarAPIClient {
|
|
|
1659
1847
|
fetchUserFollowing(params: {
|
|
1660
1848
|
fid: number;
|
|
1661
1849
|
viewerFid?: number;
|
|
1662
|
-
sortType?:
|
|
1850
|
+
sortType?: FetchUserFollowingSortTypeEnum;
|
|
1663
1851
|
limit?: number;
|
|
1664
1852
|
cursor?: string;
|
|
1665
1853
|
}): Promise<FollowersResponse>;
|
|
@@ -1696,8 +1884,8 @@ export declare class NeynarAPIClient {
|
|
|
1696
1884
|
* @param {object} params
|
|
1697
1885
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 100, Maximum: 100)
|
|
1698
1886
|
* @param {string} params.cursor [optional] - Pagination cursor
|
|
1699
|
-
* @param {
|
|
1700
|
-
* @param {Array<FetchFrameCatalogCategoriesEnum>} params.categories [optional] - Comma separated list of categories to include in the results.
|
|
1887
|
+
* @param {FetchFrameCatalogTimeWindowEnum} params.timeWindow [optional] - Time window used to calculate the change in trending score for each mini app, used to sort mini app results
|
|
1888
|
+
* @param {Array<FetchFrameCatalogCategoriesEnum>} params.categories [optional] - Comma separated list of categories to include in the results. Includes all if left blank. Example: categories=games,social OR categories=games&categories=social
|
|
1701
1889
|
*
|
|
1702
1890
|
* @returns {Promise<FrameCatalogResponse>} A promise that resolves to a `FrameCatalogResponse` object.
|
|
1703
1891
|
*
|
|
@@ -1711,11 +1899,14 @@ export declare class NeynarAPIClient {
|
|
|
1711
1899
|
* client.fetchFrameCatalog({ limit, timeWindow, categories }).then(response => {
|
|
1712
1900
|
* console.log('response:', response);
|
|
1713
1901
|
* });
|
|
1902
|
+
*
|
|
1903
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-frame-catalog)
|
|
1904
|
+
*
|
|
1714
1905
|
*/
|
|
1715
1906
|
fetchFrameCatalog(params: {
|
|
1716
1907
|
limit?: number;
|
|
1717
1908
|
cursor?: string;
|
|
1718
|
-
timeWindow?:
|
|
1909
|
+
timeWindow?: FetchFrameCatalogTimeWindowEnum;
|
|
1719
1910
|
categories?: Array<FetchFrameCatalogCategoriesEnum>;
|
|
1720
1911
|
}): Promise<FrameCatalogResponse>;
|
|
1721
1912
|
/**
|
|
@@ -1798,7 +1989,7 @@ export declare class NeynarAPIClient {
|
|
|
1798
1989
|
*
|
|
1799
1990
|
* @param {object} params
|
|
1800
1991
|
* @param {number} params.viewerFid - FID of the user to fetch relevant mini apps for
|
|
1801
|
-
* @param {
|
|
1992
|
+
* @param {FetchRelevantFramesTimeWindowEnum} params.timeWindow [optional] - Time window used to limit statistics used to calculate mini app relevance
|
|
1802
1993
|
*
|
|
1803
1994
|
* @returns {Promise<FetchRelevantFrames200Response>} A promise that resolves to a `FetchRelevantFrames200Response` object.
|
|
1804
1995
|
*
|
|
@@ -1812,12 +2003,12 @@ export declare class NeynarAPIClient {
|
|
|
1812
2003
|
* console.log('response:', response);
|
|
1813
2004
|
* });
|
|
1814
2005
|
*
|
|
1815
|
-
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-
|
|
2006
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-relevant-frames)
|
|
1816
2007
|
*
|
|
1817
2008
|
*/
|
|
1818
2009
|
fetchRelevantFrames(params: {
|
|
1819
2010
|
viewerFid: number;
|
|
1820
|
-
timeWindow?:
|
|
2011
|
+
timeWindow?: FetchRelevantFramesTimeWindowEnum;
|
|
1821
2012
|
}): Promise<FetchRelevantFrames200Response>;
|
|
1822
2013
|
/**
|
|
1823
2014
|
* Fetch analytics for total-interactors, interactors, nteractions-per-cast and input-text.
|
|
@@ -1825,11 +2016,11 @@ export declare class NeynarAPIClient {
|
|
|
1825
2016
|
* @summary Analytics for the mini app
|
|
1826
2017
|
*
|
|
1827
2018
|
* @param {object} params
|
|
1828
|
-
* @param {string} params.frameUrl
|
|
1829
|
-
* @param {
|
|
2019
|
+
* @param {string} params.frameUrl - URL of the mini app to fetch analytics for
|
|
2020
|
+
* @param {FetchValidateFrameAnalyticsAnalyticsTypeEnum} params.analyticsType - Type of analytics to fetch
|
|
1830
2021
|
* @param {string} params.start
|
|
1831
2022
|
* @param {string} params.stop
|
|
1832
|
-
* @param {
|
|
2023
|
+
* @param {FetchValidateFrameAnalyticsAggregateWindowEnum} params.aggregateWindow [optional] - Required for `analytics_type=interactions-per-cast`
|
|
1833
2024
|
*
|
|
1834
2025
|
* @returns {Promise<FrameValidateAnalyticsResponse>} A promise that resolves to a `FrameValidateAnalyticsResponse` object.
|
|
1835
2026
|
*
|
|
@@ -1851,10 +2042,10 @@ export declare class NeynarAPIClient {
|
|
|
1851
2042
|
*/
|
|
1852
2043
|
fetchValidateFrameAnalytics(params: {
|
|
1853
2044
|
frameUrl: string;
|
|
1854
|
-
analyticsType:
|
|
2045
|
+
analyticsType: FetchValidateFrameAnalyticsAnalyticsTypeEnum;
|
|
1855
2046
|
start: string;
|
|
1856
2047
|
stop: string;
|
|
1857
|
-
aggregateWindow?:
|
|
2048
|
+
aggregateWindow?: FetchValidateFrameAnalyticsAggregateWindowEnum;
|
|
1858
2049
|
}): Promise<FrameValidateAnalyticsResponse>;
|
|
1859
2050
|
/**
|
|
1860
2051
|
* Fetch a list of all the mini apps validated by a user
|
|
@@ -1874,6 +2065,36 @@ export declare class NeynarAPIClient {
|
|
|
1874
2065
|
*
|
|
1875
2066
|
*/
|
|
1876
2067
|
fetchValidateFrameList(): Promise<FrameValidateListResponse>;
|
|
2068
|
+
/**
|
|
2069
|
+
* Retrieve notification delivery and opened stats for notification campaigns
|
|
2070
|
+
*
|
|
2071
|
+
* @summary Get notification campaign stats
|
|
2072
|
+
*
|
|
2073
|
+
* @param {object} params
|
|
2074
|
+
* @param {string} params.campaignId [optional] - An ID of a specific notification campaign to query
|
|
2075
|
+
* @param {number} params.limit [optional] - The number of results to return (Default: 100, Maximum: 1000)
|
|
2076
|
+
* @param {string} params.cursor [optional] - Pagination cursor
|
|
2077
|
+
*
|
|
2078
|
+
* @returns {Promise<GetNotificationCampaignStats200Response>} A promise that resolves to a `GetNotificationCampaignStats200Response` object.
|
|
2079
|
+
*
|
|
2080
|
+
* @example
|
|
2081
|
+
*
|
|
2082
|
+
* // Fill in the appropriate values
|
|
2083
|
+
* const campaignId =
|
|
2084
|
+
* const limit =
|
|
2085
|
+
*
|
|
2086
|
+
* client.getNotificationCampaignStats({ campaignId, limit }).then(response => {
|
|
2087
|
+
* console.log('response:', response);
|
|
2088
|
+
* });
|
|
2089
|
+
*
|
|
2090
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-notification-campaign-stats)
|
|
2091
|
+
*
|
|
2092
|
+
*/
|
|
2093
|
+
getNotificationCampaignStats(params: {
|
|
2094
|
+
campaignId?: string;
|
|
2095
|
+
limit?: number;
|
|
2096
|
+
cursor?: string;
|
|
2097
|
+
}): Promise<GetNotificationCampaignStats200Response>;
|
|
1877
2098
|
/**
|
|
1878
2099
|
* Retrieves details about a transaction pay mini app by ID
|
|
1879
2100
|
*
|
|
@@ -1892,6 +2113,9 @@ export declare class NeynarAPIClient {
|
|
|
1892
2113
|
* client.getTransactionPayFrame({ id }).then(response => {
|
|
1893
2114
|
* console.log('response:', response);
|
|
1894
2115
|
* });
|
|
2116
|
+
*
|
|
2117
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-transaction-pay-frame)
|
|
2118
|
+
*
|
|
1895
2119
|
*/
|
|
1896
2120
|
getTransactionPayFrame(params: {
|
|
1897
2121
|
id: string;
|
|
@@ -1902,7 +2126,7 @@ export declare class NeynarAPIClient {
|
|
|
1902
2126
|
* @summary Mini app by UUID or URL
|
|
1903
2127
|
*
|
|
1904
2128
|
* @param {object} params
|
|
1905
|
-
* @param {
|
|
2129
|
+
* @param {LookupNeynarFrameTypeEnum} params.type - Type of identifier (either 'uuid' or 'url')
|
|
1906
2130
|
* @param {string} params.uuid [optional] - UUID of the mini app to fetch
|
|
1907
2131
|
* @param {string} params.url [optional] - URL of the Neynar mini app to fetch
|
|
1908
2132
|
*
|
|
@@ -1923,18 +2147,18 @@ export declare class NeynarAPIClient {
|
|
|
1923
2147
|
*
|
|
1924
2148
|
*/
|
|
1925
2149
|
lookupNeynarFrame(params: {
|
|
1926
|
-
type:
|
|
2150
|
+
type: LookupNeynarFrameTypeEnum;
|
|
1927
2151
|
uuid?: string;
|
|
1928
2152
|
url?: string;
|
|
1929
2153
|
}): Promise<NeynarFrame>;
|
|
1930
2154
|
/**
|
|
1931
|
-
* Post mini app actions, cast actions or cast composer actions to the server
|
|
2155
|
+
* Post mini app actions, cast actions or cast composer actions to the server (In order to post any of these actions, you need to have an approved `signer_uuid`) The POST request to the post_url has a timeout of 5 seconds for mini apps.
|
|
1932
2156
|
*
|
|
1933
2157
|
* @summary Post a mini app action, cast action or a cast composer action
|
|
1934
2158
|
*
|
|
1935
2159
|
* @param {object} params
|
|
1936
2160
|
* @param {string} params.signerUuid - UUID of the signer. `signer_uuid` is paired with API key, can't use a `uuid` made with a different API key.
|
|
1937
|
-
* @param {string} params.castHash [optional]
|
|
2161
|
+
* @param {string} params.castHash [optional]
|
|
1938
2162
|
* @param {FrameAction} params.action
|
|
1939
2163
|
*
|
|
1940
2164
|
* @returns {Promise<Frame>} A promise that resolves to a `Frame` object.
|
|
@@ -1964,7 +2188,7 @@ export declare class NeynarAPIClient {
|
|
|
1964
2188
|
* @summary Signature packet
|
|
1965
2189
|
*
|
|
1966
2190
|
* @param {object} params
|
|
1967
|
-
* @param {string} params.castHash [optional]
|
|
2191
|
+
* @param {string} params.castHash [optional]
|
|
1968
2192
|
* @param {FrameAction} params.action
|
|
1969
2193
|
* @param {FrameSignaturePacket} params.signaturePacket
|
|
1970
2194
|
*
|
|
@@ -1996,8 +2220,8 @@ export declare class NeynarAPIClient {
|
|
|
1996
2220
|
*
|
|
1997
2221
|
* @param {object} params
|
|
1998
2222
|
* @param {Array<number>} params.targetFids - 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.
|
|
1999
|
-
* @param {SendFrameNotificationsReqBodyNotification} params.notification
|
|
2000
2223
|
* @param {SendFrameNotificationsReqBodyFilters} params.filters [optional]
|
|
2224
|
+
* @param {SendFrameNotificationsReqBodyNotification} params.notification
|
|
2001
2225
|
*
|
|
2002
2226
|
* @returns {Promise<SendFrameNotificationsResponse>} A promise that resolves to a `SendFrameNotificationsResponse` object.
|
|
2003
2227
|
*
|
|
@@ -2005,10 +2229,10 @@ export declare class NeynarAPIClient {
|
|
|
2005
2229
|
*
|
|
2006
2230
|
* // Fill in the appropriate values
|
|
2007
2231
|
* const targetFids =
|
|
2008
|
-
* const notification =
|
|
2009
2232
|
* const filters =
|
|
2233
|
+
* const notification =
|
|
2010
2234
|
*
|
|
2011
|
-
* client.publishFrameNotifications({targetFids,
|
|
2235
|
+
* client.publishFrameNotifications({targetFids, filters, notification}).then(response => {
|
|
2012
2236
|
* console.log('response:', response);
|
|
2013
2237
|
* });
|
|
2014
2238
|
*
|
|
@@ -2017,8 +2241,8 @@ export declare class NeynarAPIClient {
|
|
|
2017
2241
|
*/
|
|
2018
2242
|
publishFrameNotifications(params: {
|
|
2019
2243
|
targetFids: Array<number>;
|
|
2020
|
-
notification: SendFrameNotificationsReqBodyNotification;
|
|
2021
2244
|
filters?: SendFrameNotificationsReqBodyFilters;
|
|
2245
|
+
notification: SendFrameNotificationsReqBodyNotification;
|
|
2022
2246
|
}): Promise<SendFrameNotificationsResponse>;
|
|
2023
2247
|
/**
|
|
2024
2248
|
* Create a new mini app with a list of pages.
|
|
@@ -2110,7 +2334,7 @@ export declare class NeynarAPIClient {
|
|
|
2110
2334
|
pages: Array<NeynarFramePage>;
|
|
2111
2335
|
}): Promise<NeynarFrame>;
|
|
2112
2336
|
/**
|
|
2113
|
-
* Validates a mini app against by an interacting user against a Farcaster Hub
|
|
2337
|
+
* Validates a mini app against by an interacting user against a Farcaster Hub (In order to validate a mini app, message bytes from Frame Action must be provided in hex)
|
|
2114
2338
|
*
|
|
2115
2339
|
* @summary Validate mini app action
|
|
2116
2340
|
*
|
|
@@ -2171,7 +2395,7 @@ export declare class NeynarAPIClient {
|
|
|
2171
2395
|
*
|
|
2172
2396
|
* @param {object} params
|
|
2173
2397
|
* @param {string} params.q - Query string to search for casts
|
|
2174
|
-
* @param {FetchCastMetricsIntervalEnum} params.interval [optional] - Interval of time for which to fetch metrics.
|
|
2398
|
+
* @param {FetchCastMetricsIntervalEnum} params.interval [optional] - Interval of time for which to fetch metrics. Default is 30d.
|
|
2175
2399
|
* @param {number} params.authorFid [optional] - Fid of the user whose casts you want to search
|
|
2176
2400
|
* @param {string} params.channelId [optional] - Channel ID of the casts you want to search
|
|
2177
2401
|
*
|
|
@@ -2204,8 +2428,8 @@ export declare class NeynarAPIClient {
|
|
|
2204
2428
|
* @summary Unmute FID
|
|
2205
2429
|
*
|
|
2206
2430
|
* @param {object} params
|
|
2207
|
-
* @param {number} params.fid - The unique identifier of a farcaster user (unsigned integer)
|
|
2208
|
-
* @param {number} params.mutedFid - The unique identifier of a farcaster user (unsigned integer)
|
|
2431
|
+
* @param {number} params.fid - The unique identifier of a farcaster user or app (unsigned integer)
|
|
2432
|
+
* @param {number} params.mutedFid - The unique identifier of a farcaster user or app (unsigned integer)
|
|
2209
2433
|
*
|
|
2210
2434
|
* @returns {Promise<MuteResponse>} A promise that resolves to a `MuteResponse` object.
|
|
2211
2435
|
*
|
|
@@ -2262,8 +2486,8 @@ export declare class NeynarAPIClient {
|
|
|
2262
2486
|
* @summary Mute FID
|
|
2263
2487
|
*
|
|
2264
2488
|
* @param {object} params
|
|
2265
|
-
* @param {number} params.fid - The unique identifier of a farcaster user (unsigned integer)
|
|
2266
|
-
* @param {number} params.mutedFid - The unique identifier of a farcaster user (unsigned integer)
|
|
2489
|
+
* @param {number} params.fid - The unique identifier of a farcaster user or app (unsigned integer)
|
|
2490
|
+
* @param {number} params.mutedFid - The unique identifier of a farcaster user or app (unsigned integer)
|
|
2267
2491
|
*
|
|
2268
2492
|
* @returns {Promise<MuteResponse>} A promise that resolves to a `MuteResponse` object.
|
|
2269
2493
|
*
|
|
@@ -2291,8 +2515,7 @@ export declare class NeynarAPIClient {
|
|
|
2291
2515
|
*
|
|
2292
2516
|
* @param {object} params
|
|
2293
2517
|
* @param {number} params.fid - FID of the user you you want to fetch notifications for. The response will respect this user's mutes and blocks.
|
|
2294
|
-
* @param {Array<
|
|
2295
|
-
* @param {boolean} params.priorityMode [optional] - When true, only returns notifications from power badge users and users that the user follows.
|
|
2518
|
+
* @param {Array<FetchAllNotificationsTypeEnum>} params.type [optional] - Notification type to fetch. Comma separated values of follows, recasts, likes, mentions, replies.
|
|
2296
2519
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 15, Maximum: 25)
|
|
2297
2520
|
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
2298
2521
|
*
|
|
@@ -2303,10 +2526,9 @@ export declare class NeynarAPIClient {
|
|
|
2303
2526
|
* // Fill in the appropriate values
|
|
2304
2527
|
* const fid =
|
|
2305
2528
|
* const type =
|
|
2306
|
-
* const priorityMode =
|
|
2307
2529
|
* const limit =
|
|
2308
2530
|
*
|
|
2309
|
-
* client.fetchAllNotifications({ fid, type,
|
|
2531
|
+
* client.fetchAllNotifications({ fid, type, limit }).then(response => {
|
|
2310
2532
|
* console.log('response:', response);
|
|
2311
2533
|
* });
|
|
2312
2534
|
*
|
|
@@ -2315,8 +2537,7 @@ export declare class NeynarAPIClient {
|
|
|
2315
2537
|
*/
|
|
2316
2538
|
fetchAllNotifications(params: {
|
|
2317
2539
|
fid: number;
|
|
2318
|
-
type?: Array<
|
|
2319
|
-
priorityMode?: boolean;
|
|
2540
|
+
type?: Array<FetchAllNotificationsTypeEnum>;
|
|
2320
2541
|
limit?: number;
|
|
2321
2542
|
cursor?: string;
|
|
2322
2543
|
}): Promise<NotificationsResponse>;
|
|
@@ -2328,7 +2549,6 @@ export declare class NeynarAPIClient {
|
|
|
2328
2549
|
* @param {object} params
|
|
2329
2550
|
* @param {number} params.fid - FID of the user you you want to fetch notifications for. The response will respect this user's mutes and blocks.
|
|
2330
2551
|
* @param {string[]} params.channelIds - Comma separated channel_ids (find list of all channels here - https://docs.neynar.com/reference/list-all-channels)
|
|
2331
|
-
* @param {boolean} params.priorityMode [optional] - When true, only returns notifications from power badge users and users that the user follows.
|
|
2332
2552
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 15, Maximum: 25)
|
|
2333
2553
|
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
2334
2554
|
*
|
|
@@ -2339,10 +2559,9 @@ export declare class NeynarAPIClient {
|
|
|
2339
2559
|
* // Fill in the appropriate values
|
|
2340
2560
|
* const fid =
|
|
2341
2561
|
* const channelIds =
|
|
2342
|
-
* const priorityMode =
|
|
2343
2562
|
* const limit =
|
|
2344
2563
|
*
|
|
2345
|
-
* client.fetchChannelNotificationsForUser({ fid, channelIds,
|
|
2564
|
+
* client.fetchChannelNotificationsForUser({ fid, channelIds, limit }).then(response => {
|
|
2346
2565
|
* console.log('response:', response);
|
|
2347
2566
|
* });
|
|
2348
2567
|
*
|
|
@@ -2352,7 +2571,6 @@ export declare class NeynarAPIClient {
|
|
|
2352
2571
|
fetchChannelNotificationsForUser(params: {
|
|
2353
2572
|
fid: number;
|
|
2354
2573
|
channelIds: string[];
|
|
2355
|
-
priorityMode?: boolean;
|
|
2356
2574
|
limit?: number;
|
|
2357
2575
|
cursor?: string;
|
|
2358
2576
|
}): Promise<NotificationsResponse>;
|
|
@@ -2364,7 +2582,6 @@ export declare class NeynarAPIClient {
|
|
|
2364
2582
|
* @param {object} params
|
|
2365
2583
|
* @param {number} params.fid - FID of the user you you want to fetch notifications for. The response will respect this user's mutes and blocks.
|
|
2366
2584
|
* @param {string[]} params.parentUrls - Comma separated parent_urls
|
|
2367
|
-
* @param {boolean} params.priorityMode [optional] - When true, only returns notifications from power badge users and users that the user follows.
|
|
2368
2585
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 15, Maximum: 25)
|
|
2369
2586
|
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
2370
2587
|
*
|
|
@@ -2375,10 +2592,9 @@ export declare class NeynarAPIClient {
|
|
|
2375
2592
|
* // Fill in the appropriate values
|
|
2376
2593
|
* const fid =
|
|
2377
2594
|
* const parentUrls =
|
|
2378
|
-
* const priorityMode =
|
|
2379
2595
|
* const limit =
|
|
2380
2596
|
*
|
|
2381
|
-
* client.fetchNotificationsByParentUrlForUser({ fid, parentUrls,
|
|
2597
|
+
* client.fetchNotificationsByParentUrlForUser({ fid, parentUrls, limit }).then(response => {
|
|
2382
2598
|
* console.log('response:', response);
|
|
2383
2599
|
* });
|
|
2384
2600
|
*
|
|
@@ -2388,7 +2604,6 @@ export declare class NeynarAPIClient {
|
|
|
2388
2604
|
fetchNotificationsByParentUrlForUser(params: {
|
|
2389
2605
|
fid: number;
|
|
2390
2606
|
parentUrls: string[];
|
|
2391
|
-
priorityMode?: boolean;
|
|
2392
2607
|
limit?: number;
|
|
2393
2608
|
cursor?: string;
|
|
2394
2609
|
}): Promise<NotificationsResponse>;
|
|
@@ -2400,7 +2615,6 @@ export declare class NeynarAPIClient {
|
|
|
2400
2615
|
* @param {object} params
|
|
2401
2616
|
* @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.
|
|
2402
2617
|
* @param {NotificationType} params.type [optional]
|
|
2403
|
-
* @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).
|
|
2404
2618
|
*
|
|
2405
2619
|
* @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
|
|
2406
2620
|
*
|
|
@@ -2409,9 +2623,8 @@ export declare class NeynarAPIClient {
|
|
|
2409
2623
|
* // Fill in the appropriate values
|
|
2410
2624
|
* const signerUuid =
|
|
2411
2625
|
* const type =
|
|
2412
|
-
* const authorization =
|
|
2413
2626
|
*
|
|
2414
|
-
* client.markNotificationsAsSeen({signerUuid, type
|
|
2627
|
+
* client.markNotificationsAsSeen({signerUuid, type}).then(response => {
|
|
2415
2628
|
* console.log('response:', response);
|
|
2416
2629
|
* });
|
|
2417
2630
|
*
|
|
@@ -2421,7 +2634,6 @@ export declare class NeynarAPIClient {
|
|
|
2421
2634
|
markNotificationsAsSeen(params: {
|
|
2422
2635
|
signerUuid?: string;
|
|
2423
2636
|
type?: NotificationType;
|
|
2424
|
-
authorization?: string;
|
|
2425
2637
|
}): Promise<OperationResponse>;
|
|
2426
2638
|
/**
|
|
2427
2639
|
* Creates a new token. This is an allowlisted API, reach out if you want access.
|
|
@@ -2432,7 +2644,7 @@ export declare class NeynarAPIClient {
|
|
|
2432
2644
|
* @param {string} params.owner - Ethereum address of the one who is creating the token
|
|
2433
2645
|
* @param {string} params.symbol - Symbol/Ticker for the token
|
|
2434
2646
|
* @param {string} params.name - Name of the token
|
|
2435
|
-
* @param {File} params.metadataMedia [optional] - Media file associated with the token. Supported formats are image/jpeg, image/gif and image/png
|
|
2647
|
+
* @param {File | null} params.metadataMedia [optional] - Media file associated with the token. Supported formats are image/jpeg, image/gif and image/png
|
|
2436
2648
|
* @param {string} params.metadataDescription [optional] - Description of the token
|
|
2437
2649
|
* @param {DeployFungibleMetadataNsfwEnum} params.metadataNsfw [optional] - Indicates if the token is NSFW (Not Safe For Work).
|
|
2438
2650
|
* @param {string} params.metadataWebsiteLink [optional] - Website link related to the token
|
|
@@ -2471,7 +2683,7 @@ export declare class NeynarAPIClient {
|
|
|
2471
2683
|
owner: string;
|
|
2472
2684
|
symbol: string;
|
|
2473
2685
|
name: string;
|
|
2474
|
-
metadataMedia?: File;
|
|
2686
|
+
metadataMedia?: File | null;
|
|
2475
2687
|
metadataDescription?: string;
|
|
2476
2688
|
metadataNsfw?: DeployFungibleMetadataNsfwEnum;
|
|
2477
2689
|
metadataWebsiteLink?: string;
|
|
@@ -2482,13 +2694,13 @@ export declare class NeynarAPIClient {
|
|
|
2482
2694
|
factory?: DeployFungibleFactoryEnum;
|
|
2483
2695
|
}): Promise<DeployFungibleResponse>;
|
|
2484
2696
|
/**
|
|
2485
|
-
* Fetch a list of relevant owners for a
|
|
2697
|
+
* Fetch a list of relevant owners for a on chain asset. If a viewer is provided, only relevant holders will be shown. This usually shows on a fungible asset page as \"X, Y, Z and N others you know own this asset\".
|
|
2486
2698
|
*
|
|
2487
2699
|
* @summary Relevant owners
|
|
2488
2700
|
*
|
|
2489
2701
|
* @param {object} params
|
|
2490
2702
|
* @param {string} params.contractAddress - Contract address of the fungible asset
|
|
2491
|
-
* @param {
|
|
2703
|
+
* @param {FetchRelevantFungibleOwnersNetworkEnum} params.network - Network of the fungible asset.
|
|
2492
2704
|
* @param {number} params.viewerFid [optional] - If you provide a viewer_fid, the response will include token holders from the user's network, respecting their mutes and blocks and including viewer_context; if not provided, the response will show top token holders across the network—both sets can be combined to generate a longer list if desired.
|
|
2493
2705
|
*
|
|
2494
2706
|
* @returns {Promise<RelevantFungibleOwnersResponse>} A promise that resolves to a `RelevantFungibleOwnersResponse` object.
|
|
@@ -2509,7 +2721,7 @@ export declare class NeynarAPIClient {
|
|
|
2509
2721
|
*/
|
|
2510
2722
|
fetchRelevantFungibleOwners(params: {
|
|
2511
2723
|
contractAddress: string;
|
|
2512
|
-
network:
|
|
2724
|
+
network: FetchRelevantFungibleOwnersNetworkEnum;
|
|
2513
2725
|
viewerFid?: number;
|
|
2514
2726
|
}): Promise<RelevantFungibleOwnersResponse>;
|
|
2515
2727
|
/**
|
|
@@ -2519,7 +2731,7 @@ export declare class NeynarAPIClient {
|
|
|
2519
2731
|
*
|
|
2520
2732
|
* @param {object} params
|
|
2521
2733
|
* @param {number} params.fid - FID of the user to fetch
|
|
2522
|
-
* @param {Array<
|
|
2734
|
+
* @param {Array<FetchUserBalanceNetworksEnum>} params.networks - Comma separated list of networks to fetch balances for
|
|
2523
2735
|
*
|
|
2524
2736
|
* @returns {Promise<BalanceResponse>} A promise that resolves to a `BalanceResponse` object.
|
|
2525
2737
|
*
|
|
@@ -2538,32 +2750,57 @@ export declare class NeynarAPIClient {
|
|
|
2538
2750
|
*/
|
|
2539
2751
|
fetchUserBalance(params: {
|
|
2540
2752
|
fid: number;
|
|
2541
|
-
networks: Array<
|
|
2753
|
+
networks: Array<FetchUserBalanceNetworksEnum>;
|
|
2542
2754
|
}): Promise<BalanceResponse>;
|
|
2543
2755
|
/**
|
|
2544
|
-
*
|
|
2756
|
+
* Mints an NFT to one or more recipients on a specified network and contract, using a configured server wallet. Contact us to set up your wallet configuration if you don\'t have one.
|
|
2757
|
+
*
|
|
2758
|
+
* @summary Mint NFT(s)
|
|
2759
|
+
*
|
|
2760
|
+
* @param {object} params
|
|
2761
|
+
* @param {MintNftRequest} params.mintNftRequest
|
|
2762
|
+
*
|
|
2763
|
+
* @returns {Promise<MintNft200Response>} A promise that resolves to a `MintNft200Response` object.
|
|
2764
|
+
*
|
|
2765
|
+
* @example
|
|
2766
|
+
*
|
|
2767
|
+
* // Fill in the appropriate values
|
|
2768
|
+
* const mintNftRequest =
|
|
2769
|
+
*
|
|
2770
|
+
* client.mintNft({ mintNftRequest }).then(response => {
|
|
2771
|
+
* console.log('response:', response);
|
|
2772
|
+
* });
|
|
2773
|
+
*
|
|
2774
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/mint-nft)
|
|
2775
|
+
*
|
|
2776
|
+
*/
|
|
2777
|
+
mintNft(params: {
|
|
2778
|
+
mintNftRequest: MintNftRequest;
|
|
2779
|
+
}): Promise<MintNft200Response>;
|
|
2780
|
+
/**
|
|
2781
|
+
* Register a new farcaster account onchain. Optionally you can pass in signers to register a new account and create multiple signers in a single transaction
|
|
2545
2782
|
*
|
|
2546
2783
|
* @summary Register Farcaster account onchain
|
|
2547
2784
|
*
|
|
2548
2785
|
* @param {object} params
|
|
2786
|
+
* @param {string} params.idem [optional] - An Idempotency key is a unique identifier for the request. **Note:** 1) Pre-registration calls must be idempotent when using idempotency keys. 2) This is used to prevent duplicate requests. Use the same idem key on retry attempts. 3) This should be a unique identifier for each request. 4) Recommended format is a 16-character string generated by the developer at the time of making this request.
|
|
2787
|
+
* @param {Array<RegisterUserOnChainReqBodyPreRegistrationCallsInner>} params.preRegistrationCalls [optional]
|
|
2549
2788
|
* @param {RegisterUserOnChainReqBodyRegistration} params.registration
|
|
2550
2789
|
* @param {number} params.storageUnits [optional]
|
|
2551
2790
|
* @param {Array<RegisterUserOnChainReqBodySignersInner>} params.signers [optional]
|
|
2552
|
-
* @param {Array<RegisterUserOnChainReqBodyPreRegistrationCallsInner>} params.preRegistrationCalls [optional]
|
|
2553
|
-
* @param {string} params.idem [optional]
|
|
2554
2791
|
*
|
|
2555
2792
|
* @returns {Promise<RegisterUserOnChainResponse>} A promise that resolves to a `RegisterUserOnChainResponse` object.
|
|
2556
2793
|
*
|
|
2557
2794
|
* @example
|
|
2558
2795
|
*
|
|
2559
2796
|
* // Fill in the appropriate values
|
|
2797
|
+
* const idem =
|
|
2798
|
+
* const preRegistrationCalls =
|
|
2560
2799
|
* const registration =
|
|
2561
2800
|
* const storageUnits =
|
|
2562
2801
|
* const signers =
|
|
2563
|
-
* const preRegistrationCalls =
|
|
2564
|
-
* const idem =
|
|
2565
2802
|
*
|
|
2566
|
-
* client.registerAccountOnchain({
|
|
2803
|
+
* client.registerAccountOnchain({idem, preRegistrationCalls, registration, storageUnits, signers}).then(response => {
|
|
2567
2804
|
* console.log('response:', response);
|
|
2568
2805
|
* });
|
|
2569
2806
|
*
|
|
@@ -2571,11 +2808,11 @@ export declare class NeynarAPIClient {
|
|
|
2571
2808
|
*
|
|
2572
2809
|
*/
|
|
2573
2810
|
registerAccountOnchain(params: {
|
|
2811
|
+
idem?: string;
|
|
2812
|
+
preRegistrationCalls?: Array<RegisterUserOnChainReqBodyPreRegistrationCallsInner>;
|
|
2574
2813
|
registration: RegisterUserOnChainReqBodyRegistration;
|
|
2575
2814
|
storageUnits?: number;
|
|
2576
2815
|
signers?: Array<RegisterUserOnChainReqBodySignersInner>;
|
|
2577
|
-
preRegistrationCalls?: Array<RegisterUserOnChainReqBodyPreRegistrationCallsInner>;
|
|
2578
|
-
idem?: string;
|
|
2579
2816
|
}): Promise<RegisterUserOnChainResponse>;
|
|
2580
2817
|
/**
|
|
2581
2818
|
* 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.
|
|
@@ -2583,18 +2820,20 @@ export declare class NeynarAPIClient {
|
|
|
2583
2820
|
* @summary Send fungibles
|
|
2584
2821
|
*
|
|
2585
2822
|
* @param {object} params
|
|
2586
|
-
* @param {
|
|
2587
|
-
* @param {
|
|
2823
|
+
* @param {TransactionSendFungiblesReqBodyNetworkEnum} params.network
|
|
2824
|
+
* @param {string} params.fungibleContractAddress [optional] - Contract address of the fungible token to send. If not provided, the default is the native token of the network.
|
|
2825
|
+
* @param {Array<TransactionSendFungiblesRecipient>} params.recipients
|
|
2588
2826
|
*
|
|
2589
2827
|
* @returns {Promise<TransactionSendFungiblesResponse>} A promise that resolves to a `TransactionSendFungiblesResponse` object.
|
|
2590
2828
|
*
|
|
2591
2829
|
* @example
|
|
2592
2830
|
*
|
|
2593
2831
|
* // Fill in the appropriate values
|
|
2594
|
-
* const
|
|
2595
|
-
* const
|
|
2832
|
+
* const network =
|
|
2833
|
+
* const fungibleContractAddress =
|
|
2834
|
+
* const recipients =
|
|
2596
2835
|
*
|
|
2597
|
-
* client.sendFungiblesToUsers({
|
|
2836
|
+
* client.sendFungiblesToUsers({network, fungibleContractAddress, recipients}).then(response => {
|
|
2598
2837
|
* console.log('response:', response);
|
|
2599
2838
|
* });
|
|
2600
2839
|
*
|
|
@@ -2602,11 +2841,43 @@ export declare class NeynarAPIClient {
|
|
|
2602
2841
|
*
|
|
2603
2842
|
*/
|
|
2604
2843
|
sendFungiblesToUsers(params: {
|
|
2605
|
-
|
|
2606
|
-
|
|
2844
|
+
network: TransactionSendFungiblesReqBodyNetworkEnum;
|
|
2845
|
+
fungibleContractAddress?: string;
|
|
2846
|
+
recipients: Array<TransactionSendFungiblesRecipient>;
|
|
2607
2847
|
}): Promise<TransactionSendFungiblesResponse>;
|
|
2608
2848
|
/**
|
|
2609
|
-
*
|
|
2849
|
+
* Simulates mint calldata for the given recipients, contract, and network. Useful for previewing calldata and ABI before minting.
|
|
2850
|
+
*
|
|
2851
|
+
* @summary Simulate NFT mint calldata
|
|
2852
|
+
*
|
|
2853
|
+
* @param {object} params
|
|
2854
|
+
* @param {string} params.recipients - JSON array of recipients (same structure as POST).
|
|
2855
|
+
* @param {string} params.nftContractAddress - Ethereum address
|
|
2856
|
+
* @param {SimulateNftMintNetworkEnum} params.network - Network to mint on.
|
|
2857
|
+
*
|
|
2858
|
+
* @returns {Promise<SimulateNftMintResponse>} A promise that resolves to a `SimulateNftMintResponse` object.
|
|
2859
|
+
*
|
|
2860
|
+
* @example
|
|
2861
|
+
*
|
|
2862
|
+
* // Fill in the appropriate values
|
|
2863
|
+
* const recipients =
|
|
2864
|
+
* const nftContractAddress =
|
|
2865
|
+
* const network =
|
|
2866
|
+
*
|
|
2867
|
+
* client.simulateNftMint({ recipients, nftContractAddress, network }).then(response => {
|
|
2868
|
+
* console.log('response:', response);
|
|
2869
|
+
* });
|
|
2870
|
+
*
|
|
2871
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/simulate-nft-mint)
|
|
2872
|
+
*
|
|
2873
|
+
*/
|
|
2874
|
+
simulateNftMint(params: {
|
|
2875
|
+
recipients: string;
|
|
2876
|
+
nftContractAddress: string;
|
|
2877
|
+
network: SimulateNftMintNetworkEnum;
|
|
2878
|
+
}): Promise<SimulateNftMintResponse>;
|
|
2879
|
+
/**
|
|
2880
|
+
* Delete a reaction (like or recast) to a cast (In order to delete a reaction `signer_uuid` must be approved)
|
|
2610
2881
|
*
|
|
2611
2882
|
* @summary Delete reaction
|
|
2612
2883
|
*
|
|
@@ -2614,7 +2885,7 @@ export declare class NeynarAPIClient {
|
|
|
2614
2885
|
* @param {string} params.signerUuid - UUID of the signer. `signer_uuid` is paired with API key, can't use a `uuid` made with a different API key.
|
|
2615
2886
|
* @param {ReactionType} params.reactionType
|
|
2616
2887
|
* @param {string} params.target - Target cast hash (hex string starting with 0x) OR a valid URL.
|
|
2617
|
-
* @param {number} params.targetAuthorFid [optional] - The unique identifier of a farcaster user (unsigned integer)
|
|
2888
|
+
* @param {number} params.targetAuthorFid [optional] - The unique identifier of a farcaster user or app (unsigned integer)
|
|
2618
2889
|
* @param {string} params.idem [optional] - An Idempotency key is a unique identifier for the request. **Note:** 1) This is used to prevent duplicate requests. Use the same idem key on retry attempts. 2) This should be a unique identifier for each request. 3) Recommended format is a 16-character string generated by the developer at the time of making this request.
|
|
2619
2890
|
*
|
|
2620
2891
|
* @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
|
|
@@ -2649,7 +2920,7 @@ export declare class NeynarAPIClient {
|
|
|
2649
2920
|
*
|
|
2650
2921
|
* @param {object} params
|
|
2651
2922
|
* @param {string} params.hash
|
|
2652
|
-
* @param {Array<
|
|
2923
|
+
* @param {Array<FetchCastReactionsTypesEnum>} params.types - Customize which reaction types the request should search for. This is a comma-separated string that can include the following values: 'likes' and 'recasts'. By default api returns both. To select multiple types, use a comma-separated list of these values.
|
|
2653
2924
|
* @param {number} params.viewerFid [optional] - Providing this will return a list of reactions that respects this user's mutes and blocks and includes `viewer_context`.
|
|
2654
2925
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 25, Maximum: 100)
|
|
2655
2926
|
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
@@ -2673,7 +2944,7 @@ export declare class NeynarAPIClient {
|
|
|
2673
2944
|
*/
|
|
2674
2945
|
fetchCastReactions(params: {
|
|
2675
2946
|
hash: string;
|
|
2676
|
-
types: Array<
|
|
2947
|
+
types: Array<FetchCastReactionsTypesEnum>;
|
|
2677
2948
|
viewerFid?: number;
|
|
2678
2949
|
limit?: number;
|
|
2679
2950
|
cursor?: string;
|
|
@@ -2684,8 +2955,8 @@ export declare class NeynarAPIClient {
|
|
|
2684
2955
|
* @summary Reactions for user
|
|
2685
2956
|
*
|
|
2686
2957
|
* @param {object} params
|
|
2687
|
-
* @param {number} params.fid
|
|
2688
|
-
* @param {
|
|
2958
|
+
* @param {number} params.fid - The unique identifier of a farcaster user or app (unsigned integer)
|
|
2959
|
+
* @param {FetchUserReactionsTypeEnum} params.type - Type of reaction to fetch (likes or recasts or all)
|
|
2689
2960
|
* @param {number} params.viewerFid [optional] - Providing this will return a list of reactions that respects this user's mutes and blocks and includes `viewer_context`.
|
|
2690
2961
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 25, Maximum: 100)
|
|
2691
2962
|
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
@@ -2709,13 +2980,13 @@ export declare class NeynarAPIClient {
|
|
|
2709
2980
|
*/
|
|
2710
2981
|
fetchUserReactions(params: {
|
|
2711
2982
|
fid: number;
|
|
2712
|
-
type:
|
|
2983
|
+
type: FetchUserReactionsTypeEnum;
|
|
2713
2984
|
viewerFid?: number;
|
|
2714
2985
|
limit?: number;
|
|
2715
2986
|
cursor?: string;
|
|
2716
2987
|
}): Promise<ReactionsResponse>;
|
|
2717
2988
|
/**
|
|
2718
|
-
* Post a reaction (like or recast) to a given cast
|
|
2989
|
+
* Post a reaction (like or recast) to a given cast (In order to post a reaction `signer_uuid` must be approved)
|
|
2719
2990
|
*
|
|
2720
2991
|
* @summary Post a reaction
|
|
2721
2992
|
*
|
|
@@ -2723,7 +2994,7 @@ export declare class NeynarAPIClient {
|
|
|
2723
2994
|
* @param {string} params.signerUuid - UUID of the signer. `signer_uuid` is paired with API key, can't use a `uuid` made with a different API key.
|
|
2724
2995
|
* @param {ReactionType} params.reactionType
|
|
2725
2996
|
* @param {string} params.target - Target cast hash (hex string starting with 0x) OR a valid URL.
|
|
2726
|
-
* @param {number} params.targetAuthorFid [optional] - The unique identifier of a farcaster user (unsigned integer)
|
|
2997
|
+
* @param {number} params.targetAuthorFid [optional] - The unique identifier of a farcaster user or app (unsigned integer)
|
|
2727
2998
|
* @param {string} params.idem [optional] - An Idempotency key is a unique identifier for the request. **Note:** 1) This is used to prevent duplicate requests. Use the same idem key on retry attempts. 2) This should be a unique identifier for each request. 3) Recommended format is a 16-character string generated by the developer at the time of making this request.
|
|
2728
2999
|
*
|
|
2729
3000
|
* @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
|
|
@@ -2752,7 +3023,7 @@ export declare class NeynarAPIClient {
|
|
|
2752
3023
|
idem?: string;
|
|
2753
3024
|
}): Promise<OperationResponse>;
|
|
2754
3025
|
/**
|
|
2755
|
-
* Creates a signer and returns the signer status.
|
|
3026
|
+
* Creates a signer and returns the signer status. **Note**: While tesing please reuse the signer, it costs money to approve a signer.
|
|
2756
3027
|
*
|
|
2757
3028
|
* @summary Create signer
|
|
2758
3029
|
*
|
|
@@ -2776,7 +3047,7 @@ export declare class NeynarAPIClient {
|
|
|
2776
3047
|
*
|
|
2777
3048
|
* @param {object} params
|
|
2778
3049
|
* @param {string} params.clientId
|
|
2779
|
-
* @param {
|
|
3050
|
+
* @param {FetchAuthorizationUrlResponseTypeEnum} params.responseType
|
|
2780
3051
|
*
|
|
2781
3052
|
* @returns {Promise<AuthorizationUrlResponse>} A promise that resolves to a `AuthorizationUrlResponse` object.
|
|
2782
3053
|
*
|
|
@@ -2795,7 +3066,7 @@ export declare class NeynarAPIClient {
|
|
|
2795
3066
|
*/
|
|
2796
3067
|
fetchAuthorizationUrl(params: {
|
|
2797
3068
|
clientId: string;
|
|
2798
|
-
responseType:
|
|
3069
|
+
responseType: FetchAuthorizationUrlResponseTypeEnum;
|
|
2799
3070
|
}): Promise<AuthorizationUrlResponse>;
|
|
2800
3071
|
/**
|
|
2801
3072
|
* Fetches a list of signers for a custody address
|
|
@@ -2803,7 +3074,7 @@ export declare class NeynarAPIClient {
|
|
|
2803
3074
|
* @summary List signers
|
|
2804
3075
|
*
|
|
2805
3076
|
* @param {object} params
|
|
2806
|
-
* @param {string} params.message - A Sign-In with Ethereum (SIWE) message that the user's Ethereum wallet signs. This message includes details such as the domain, address, statement, URI, nonce, and other relevant information following the EIP-4361 standard. It should be structured and URL-encoded.
|
|
3077
|
+
* @param {string} params.message - A Sign-In with Ethereum (SIWE) message that the user's Ethereum wallet signs. This message includes details such as the domain, address, statement, URI, nonce, and other relevant information following the EIP-4361 standard. It should be structured and URL-encoded.
|
|
2807
3078
|
* @param {string} params.signature - The digital signature produced by signing the provided SIWE message with the user's Ethereum private key. This signature is used to verify the authenticity of the message and the identity of the signer.
|
|
2808
3079
|
*
|
|
2809
3080
|
* @returns {Promise<SignerListResponse>} A promise that resolves to a `SignerListResponse` object.
|
|
@@ -2831,7 +3102,7 @@ export declare class NeynarAPIClient {
|
|
|
2831
3102
|
* @summary Status by public key
|
|
2832
3103
|
*
|
|
2833
3104
|
* @param {object} params
|
|
2834
|
-
* @param {string} params.publicKey
|
|
3105
|
+
* @param {string} params.publicKey - Ed25519 public key
|
|
2835
3106
|
*
|
|
2836
3107
|
* @returns {Promise<DeveloperManagedSigner>} A promise that resolves to a `DeveloperManagedSigner` object.
|
|
2837
3108
|
*
|
|
@@ -2856,7 +3127,7 @@ export declare class NeynarAPIClient {
|
|
|
2856
3127
|
* @summary Status
|
|
2857
3128
|
*
|
|
2858
3129
|
* @param {object} params
|
|
2859
|
-
* @param {string} params.signerUuid
|
|
3130
|
+
* @param {string} params.signerUuid - UUID of the signer. `signer_uuid` is paired with API key, can't use a `uuid` made with a different API key.
|
|
2860
3131
|
*
|
|
2861
3132
|
* @returns {Promise<Signer>} A promise that resolves to a `Signer` object.
|
|
2862
3133
|
*
|
|
@@ -2907,10 +3178,10 @@ export declare class NeynarAPIClient {
|
|
|
2907
3178
|
*
|
|
2908
3179
|
* @param {object} params
|
|
2909
3180
|
* @param {string} params.signerUuid - UUID of the signer. `signer_uuid` is paired with API key, can't use a `uuid` made with a different API key.
|
|
2910
|
-
* @param {string} params.signature - Signature generated by the custody address of the app. Signed data includes app_fid, deadline, signer
|
|
2911
|
-
* @param {number} params.appFid - The unique identifier of a farcaster user (unsigned integer)
|
|
3181
|
+
* @param {string} params.signature - Signature generated by the custody address of the app. Signed data includes app_fid, deadline, signer's public key
|
|
3182
|
+
* @param {number} params.appFid - The unique identifier of a farcaster user or app (unsigned integer)
|
|
2912
3183
|
* @param {number} params.deadline - unix timestamp in seconds that controls how long the signed key request is valid for. (24 hours from now is recommended)
|
|
2913
|
-
* @param {string} params.redirectUrl [optional] - Url to redirect to after the signer is approved.
|
|
3184
|
+
* @param {string} params.redirectUrl [optional] - Url to redirect to after the signer is approved. **Note** : This should only be used when requesting a signer from a native mobile application.
|
|
2914
3185
|
* @param {SignedKeyRequestSponsor} params.sponsor [optional]
|
|
2915
3186
|
*
|
|
2916
3187
|
* @returns {Promise<Signer>} A promise that resolves to a `Signer` object.
|
|
@@ -2947,10 +3218,10 @@ export declare class NeynarAPIClient {
|
|
|
2947
3218
|
*
|
|
2948
3219
|
* @param {object} params
|
|
2949
3220
|
* @param {string} params.publicKey - Ed25519 public key
|
|
2950
|
-
* @param {string} params.signature - Signature generated by the custody address of the app. Signed data includes app_fid, deadline, signer
|
|
2951
|
-
* @param {number} params.appFid - The unique identifier of a farcaster user (unsigned integer)
|
|
3221
|
+
* @param {string} params.signature - Signature generated by the custody address of the app. Signed data includes app_fid, deadline, signer's public key
|
|
3222
|
+
* @param {number} params.appFid - The unique identifier of a farcaster user or app (unsigned integer)
|
|
2952
3223
|
* @param {number} params.deadline - unix timestamp in seconds that controls how long the signed key request is valid for. (24 hours from now is recommended)
|
|
2953
|
-
* @param {string} params.redirectUrl [optional] - Url to redirect to after the signer is approved.
|
|
3224
|
+
* @param {string} params.redirectUrl [optional] - Url to redirect to after the signer is approved. **Note** : This should only be used when requesting a signer from a native mobile application.
|
|
2954
3225
|
* @param {SignedKeyRequestSponsor} params.sponsor [optional]
|
|
2955
3226
|
*
|
|
2956
3227
|
* @returns {Promise<DeveloperManagedSigner>} A promise that resolves to a `DeveloperManagedSigner` object.
|
|
@@ -3017,7 +3288,7 @@ export declare class NeynarAPIClient {
|
|
|
3017
3288
|
* @summary Allocation of user
|
|
3018
3289
|
*
|
|
3019
3290
|
* @param {object} params
|
|
3020
|
-
* @param {number} params.fid
|
|
3291
|
+
* @param {number} params.fid - The unique identifier of a farcaster user or app (unsigned integer)
|
|
3021
3292
|
*
|
|
3022
3293
|
* @returns {Promise<StorageAllocationsResponse>} A promise that resolves to a `StorageAllocationsResponse` object.
|
|
3023
3294
|
*
|
|
@@ -3042,7 +3313,7 @@ export declare class NeynarAPIClient {
|
|
|
3042
3313
|
* @summary Usage of user
|
|
3043
3314
|
*
|
|
3044
3315
|
* @param {object} params
|
|
3045
|
-
* @param {number} params.fid
|
|
3316
|
+
* @param {number} params.fid - The unique identifier of a farcaster user or app (unsigned integer)
|
|
3046
3317
|
*
|
|
3047
3318
|
* @returns {Promise<StorageUsageResponse>} A promise that resolves to a `StorageUsageResponse` object.
|
|
3048
3319
|
*
|
|
@@ -3067,8 +3338,8 @@ export declare class NeynarAPIClient {
|
|
|
3067
3338
|
* @summary Subscribed to
|
|
3068
3339
|
*
|
|
3069
3340
|
* @param {object} params
|
|
3070
|
-
* @param {number} params.fid
|
|
3071
|
-
* @param {
|
|
3341
|
+
* @param {number} params.fid - The unique identifier of a farcaster user or app (unsigned integer)
|
|
3342
|
+
* @param {FetchSubscribedToForFidSubscriptionProviderEnum} params.subscriptionProvider - The provider of the subscription.
|
|
3072
3343
|
* @param {number} params.viewerFid [optional]
|
|
3073
3344
|
*
|
|
3074
3345
|
* @returns {Promise<SubscribedToResponse>} A promise that resolves to a `SubscribedToResponse` object.
|
|
@@ -3089,7 +3360,7 @@ export declare class NeynarAPIClient {
|
|
|
3089
3360
|
*/
|
|
3090
3361
|
fetchSubscribedToForFid(params: {
|
|
3091
3362
|
fid: number;
|
|
3092
|
-
subscriptionProvider:
|
|
3363
|
+
subscriptionProvider: FetchSubscribedToForFidSubscriptionProviderEnum;
|
|
3093
3364
|
viewerFid?: number;
|
|
3094
3365
|
}): Promise<SubscribedToResponse>;
|
|
3095
3366
|
/**
|
|
@@ -3098,8 +3369,8 @@ export declare class NeynarAPIClient {
|
|
|
3098
3369
|
* @summary Subscribers of a user
|
|
3099
3370
|
*
|
|
3100
3371
|
* @param {object} params
|
|
3101
|
-
* @param {number} params.fid
|
|
3102
|
-
* @param {
|
|
3372
|
+
* @param {number} params.fid - The unique identifier of a farcaster user or app (unsigned integer)
|
|
3373
|
+
* @param {FetchSubscribersForFidSubscriptionProviderEnum} params.subscriptionProvider - The provider of the subscription.
|
|
3103
3374
|
* @param {number} params.viewerFid [optional]
|
|
3104
3375
|
*
|
|
3105
3376
|
* @returns {Promise<SubscribersResponse>} A promise that resolves to a `SubscribersResponse` object.
|
|
@@ -3120,7 +3391,7 @@ export declare class NeynarAPIClient {
|
|
|
3120
3391
|
*/
|
|
3121
3392
|
fetchSubscribersForFid(params: {
|
|
3122
3393
|
fid: number;
|
|
3123
|
-
subscriptionProvider:
|
|
3394
|
+
subscriptionProvider: FetchSubscribersForFidSubscriptionProviderEnum;
|
|
3124
3395
|
viewerFid?: number;
|
|
3125
3396
|
}): Promise<SubscribersResponse>;
|
|
3126
3397
|
/**
|
|
@@ -3160,8 +3431,8 @@ export declare class NeynarAPIClient {
|
|
|
3160
3431
|
* @summary Subscriptions created by FID
|
|
3161
3432
|
*
|
|
3162
3433
|
* @param {object} params
|
|
3163
|
-
* @param {number} params.fid
|
|
3164
|
-
* @param {
|
|
3434
|
+
* @param {number} params.fid - The unique identifier of a farcaster user or app (unsigned integer)
|
|
3435
|
+
* @param {FetchSubscriptionsForFidSubscriptionProviderEnum} params.subscriptionProvider - The provider of the subscription.
|
|
3165
3436
|
*
|
|
3166
3437
|
* @returns {Promise<SubscriptionsResponse>} A promise that resolves to a `SubscriptionsResponse` object.
|
|
3167
3438
|
*
|
|
@@ -3180,10 +3451,10 @@ export declare class NeynarAPIClient {
|
|
|
3180
3451
|
*/
|
|
3181
3452
|
fetchSubscriptionsForFid(params: {
|
|
3182
3453
|
fid: number;
|
|
3183
|
-
subscriptionProvider:
|
|
3454
|
+
subscriptionProvider: FetchSubscriptionsForFidSubscriptionProviderEnum;
|
|
3184
3455
|
}): Promise<SubscriptionsResponse>;
|
|
3185
3456
|
/**
|
|
3186
|
-
* Removes verification for an eth address for the user
|
|
3457
|
+
* Removes verification for an eth address for the user (In order to delete verification `signer_uuid` must be approved)
|
|
3187
3458
|
*
|
|
3188
3459
|
* @summary Delete verification
|
|
3189
3460
|
*
|
|
@@ -3191,6 +3462,7 @@ export declare class NeynarAPIClient {
|
|
|
3191
3462
|
* @param {string} params.signerUuid - UUID of the signer. `signer_uuid` is paired with API key, can't use a `uuid` made with a different API key.
|
|
3192
3463
|
* @param {string} params.address - Ethereum address
|
|
3193
3464
|
* @param {string} params.blockHash
|
|
3465
|
+
* @param {string} params.ethSignature
|
|
3194
3466
|
*
|
|
3195
3467
|
* @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
|
|
3196
3468
|
*
|
|
@@ -3200,8 +3472,9 @@ export declare class NeynarAPIClient {
|
|
|
3200
3472
|
* const signerUuid =
|
|
3201
3473
|
* const address =
|
|
3202
3474
|
* const blockHash =
|
|
3475
|
+
* const ethSignature =
|
|
3203
3476
|
*
|
|
3204
|
-
* client.deleteVerification({signerUuid, address, blockHash}).then(response => {
|
|
3477
|
+
* client.deleteVerification({signerUuid, address, blockHash, ethSignature}).then(response => {
|
|
3205
3478
|
* console.log('response:', response);
|
|
3206
3479
|
* });
|
|
3207
3480
|
*
|
|
@@ -3212,6 +3485,7 @@ export declare class NeynarAPIClient {
|
|
|
3212
3485
|
signerUuid: string;
|
|
3213
3486
|
address: string;
|
|
3214
3487
|
blockHash: string;
|
|
3488
|
+
ethSignature: string;
|
|
3215
3489
|
}): Promise<OperationResponse>;
|
|
3216
3490
|
/**
|
|
3217
3491
|
* Fetches information about multiple users based on FIDs
|
|
@@ -3248,7 +3522,7 @@ export declare class NeynarAPIClient {
|
|
|
3248
3522
|
*
|
|
3249
3523
|
* @param {object} params
|
|
3250
3524
|
* @param {string[]} params.addresses - Comma separated list of Ethereum addresses, up to 350 at a time
|
|
3251
|
-
* @param {Array<
|
|
3525
|
+
* @param {Array<FetchBulkUsersByEthOrSolAddressAddressTypesEnum>} params.addressTypes [optional] - Customize which address types the request should search for. This is a comma-separated string that can include the following values: 'custody_address' and 'verified_address'. By default api returns both. To select multiple types, use a comma-separated list of these values.
|
|
3252
3526
|
* @param {number} params.viewerFid [optional]
|
|
3253
3527
|
*
|
|
3254
3528
|
* @returns {Promise<BulkUsersByAddressResponse>} A promise that resolves to a `BulkUsersByAddressResponse` object.
|
|
@@ -3269,68 +3543,17 @@ export declare class NeynarAPIClient {
|
|
|
3269
3543
|
*/
|
|
3270
3544
|
fetchBulkUsersByEthOrSolAddress(params: {
|
|
3271
3545
|
addresses: string[];
|
|
3272
|
-
addressTypes?: Array<
|
|
3546
|
+
addressTypes?: Array<FetchBulkUsersByEthOrSolAddressAddressTypesEnum>;
|
|
3273
3547
|
viewerFid?: number;
|
|
3274
3548
|
}): Promise<BulkUsersByAddressResponse>;
|
|
3275
|
-
/**
|
|
3276
|
-
* Fetches power users based on Warpcast power badges. Information is updated once a day.
|
|
3277
|
-
*
|
|
3278
|
-
* @summary Power users
|
|
3279
|
-
*
|
|
3280
|
-
* @param {object} params
|
|
3281
|
-
* @param {number} params.viewerFid [optional]
|
|
3282
|
-
* @param {number} params.limit [optional] - Number of power users to fetch (Default: 25, Maximum: 100)
|
|
3283
|
-
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
3284
|
-
*
|
|
3285
|
-
* @returns {Promise<UsersResponse>} A promise that resolves to a `UsersResponse` object.
|
|
3286
|
-
*
|
|
3287
|
-
* @example
|
|
3288
|
-
*
|
|
3289
|
-
* // Fill in the appropriate values
|
|
3290
|
-
* const viewerFid =
|
|
3291
|
-
* const limit =
|
|
3292
|
-
*
|
|
3293
|
-
* client.fetchPowerUsers({ viewerFid, limit }).then(response => {
|
|
3294
|
-
* console.log('response:', response);
|
|
3295
|
-
* });
|
|
3296
|
-
*
|
|
3297
|
-
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-power-users)
|
|
3298
|
-
*
|
|
3299
|
-
*/
|
|
3300
|
-
fetchPowerUsers(params: {
|
|
3301
|
-
viewerFid?: number;
|
|
3302
|
-
limit?: number;
|
|
3303
|
-
cursor?: string;
|
|
3304
|
-
}): Promise<UsersResponse>;
|
|
3305
|
-
/**
|
|
3306
|
-
* Fetches power users and respond in a backwards compatible format to Warpcast\'s deprecated power badge endpoint.
|
|
3307
|
-
*
|
|
3308
|
-
* @summary Power user FIDs
|
|
3309
|
-
*
|
|
3310
|
-
* @param {object} params
|
|
3311
|
-
*
|
|
3312
|
-
* @returns {Promise<UserPowerLiteResponse>} A promise that resolves to a `UserPowerLiteResponse` object.
|
|
3313
|
-
*
|
|
3314
|
-
* @example
|
|
3315
|
-
*
|
|
3316
|
-
* // Fill in the appropriate values
|
|
3317
|
-
*
|
|
3318
|
-
* client.fetchPowerUsersLite().then(response => {
|
|
3319
|
-
* console.log('response:', response);
|
|
3320
|
-
* });
|
|
3321
|
-
*
|
|
3322
|
-
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-power-users-lite)
|
|
3323
|
-
*
|
|
3324
|
-
*/
|
|
3325
|
-
fetchPowerUsersLite(): Promise<UserPowerLiteResponse>;
|
|
3326
3549
|
/**
|
|
3327
3550
|
* Fetches a list of users given a location
|
|
3328
3551
|
*
|
|
3329
3552
|
* @summary By location
|
|
3330
3553
|
*
|
|
3331
3554
|
* @param {object} params
|
|
3332
|
-
* @param {number} params.latitude - Latitude of the location
|
|
3333
|
-
* @param {number} params.longitude - Longitude of the location
|
|
3555
|
+
* @param {number | null} params.latitude - Latitude of the location
|
|
3556
|
+
* @param {number | null} params.longitude - Longitude of the location
|
|
3334
3557
|
* @param {number} params.viewerFid [optional] - FID of the user viewing the feed. Providing this will return a list of users that respects this user's mutes and blocks and includes `viewer_context`.
|
|
3335
3558
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 25, Maximum: 100)
|
|
3336
3559
|
* @param {string} params.cursor [optional] - Pagination cursor
|
|
@@ -3353,14 +3576,14 @@ export declare class NeynarAPIClient {
|
|
|
3353
3576
|
*
|
|
3354
3577
|
*/
|
|
3355
3578
|
fetchUsersByLocation(params: {
|
|
3356
|
-
latitude: number;
|
|
3357
|
-
longitude: number;
|
|
3579
|
+
latitude: number | null;
|
|
3580
|
+
longitude: number | null;
|
|
3358
3581
|
viewerFid?: number;
|
|
3359
3582
|
limit?: number;
|
|
3360
3583
|
cursor?: string;
|
|
3361
3584
|
}): Promise<UsersResponse>;
|
|
3362
3585
|
/**
|
|
3363
|
-
* Follow a user
|
|
3586
|
+
* Follow a user (In order to follow a user `signer_uuid` must be approved)
|
|
3364
3587
|
*
|
|
3365
3588
|
* @summary Follow user
|
|
3366
3589
|
*
|
|
@@ -3408,6 +3631,36 @@ export declare class NeynarAPIClient {
|
|
|
3408
3631
|
*
|
|
3409
3632
|
*/
|
|
3410
3633
|
getFreshAccountFID(): Promise<UserFIDResponse>;
|
|
3634
|
+
/**
|
|
3635
|
+
* Returns the best friends of a user ranked by mutual affinity score based on interactions with each other.
|
|
3636
|
+
*
|
|
3637
|
+
* @summary Best friends
|
|
3638
|
+
*
|
|
3639
|
+
* @param {object} params
|
|
3640
|
+
* @param {number} params.fid - The FID of the user
|
|
3641
|
+
* @param {number} params.limit [optional] - Number of results to fetch (Default: 3, Maximum: 100)
|
|
3642
|
+
* @param {string} params.cursor [optional] - Pagination cursor
|
|
3643
|
+
*
|
|
3644
|
+
* @returns {Promise<BestFriendsResponse>} A promise that resolves to a `BestFriendsResponse` object.
|
|
3645
|
+
*
|
|
3646
|
+
* @example
|
|
3647
|
+
*
|
|
3648
|
+
* // Fill in the appropriate values
|
|
3649
|
+
* const fid =
|
|
3650
|
+
* const limit =
|
|
3651
|
+
*
|
|
3652
|
+
* client.getUserBestFriends({ fid, limit }).then(response => {
|
|
3653
|
+
* console.log('response:', response);
|
|
3654
|
+
* });
|
|
3655
|
+
*
|
|
3656
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-user-best-friends)
|
|
3657
|
+
*
|
|
3658
|
+
*/
|
|
3659
|
+
getUserBestFriends(params: {
|
|
3660
|
+
fid: number;
|
|
3661
|
+
limit?: number;
|
|
3662
|
+
cursor?: string;
|
|
3663
|
+
}): Promise<BestFriendsResponse>;
|
|
3411
3664
|
/**
|
|
3412
3665
|
* Lookup a user by custody-address
|
|
3413
3666
|
*
|
|
@@ -3490,7 +3743,7 @@ export declare class NeynarAPIClient {
|
|
|
3490
3743
|
viewerFid?: number;
|
|
3491
3744
|
}): Promise<BulkUsersResponse>;
|
|
3492
3745
|
/**
|
|
3493
|
-
* Adds verification for an eth address or contract for the user
|
|
3746
|
+
* Adds verification for an eth address or contract for the user (In order to add verification `signer_uuid` must be approved)
|
|
3494
3747
|
*
|
|
3495
3748
|
* @summary Add verification
|
|
3496
3749
|
*
|
|
@@ -3530,7 +3783,7 @@ export declare class NeynarAPIClient {
|
|
|
3530
3783
|
chainId?: VerificationChainId;
|
|
3531
3784
|
}): Promise<OperationResponse>;
|
|
3532
3785
|
/**
|
|
3533
|
-
* Register account on farcaster.
|
|
3786
|
+
* Register account on farcaster. **Note:** This API must be called within 10 minutes of the fetch FID API call (i.e., /v2/farcaster/user/fid). Otherwise, Neynar will assign this FID to another available user.
|
|
3534
3787
|
*
|
|
3535
3788
|
* @summary Register new account
|
|
3536
3789
|
*
|
|
@@ -3603,7 +3856,7 @@ export declare class NeynarAPIClient {
|
|
|
3603
3856
|
cursor?: string;
|
|
3604
3857
|
}): Promise<UserSearchResponse>;
|
|
3605
3858
|
/**
|
|
3606
|
-
* Unfollow a user
|
|
3859
|
+
* Unfollow a user (In order to unfollow a user `signer_uuid` must be approved)
|
|
3607
3860
|
*
|
|
3608
3861
|
* @summary Unfollow user
|
|
3609
3862
|
*
|
|
@@ -3631,7 +3884,7 @@ export declare class NeynarAPIClient {
|
|
|
3631
3884
|
targetFids: Array<number>;
|
|
3632
3885
|
}): Promise<BulkFollowResponse>;
|
|
3633
3886
|
/**
|
|
3634
|
-
* Update user profile
|
|
3887
|
+
* Update user profile (In order to update user\'s profile `signer_uuid` must be approved)
|
|
3635
3888
|
*
|
|
3636
3889
|
* @summary Update user profile
|
|
3637
3890
|
*
|
|
@@ -3643,6 +3896,7 @@ export declare class NeynarAPIClient {
|
|
|
3643
3896
|
* @param {string} params.username [optional]
|
|
3644
3897
|
* @param {string} params.displayName [optional]
|
|
3645
3898
|
* @param {UpdateUserReqBodyLocation} params.location [optional]
|
|
3899
|
+
* @param {string} params.banner [optional]
|
|
3646
3900
|
* @param {UpdateUserReqBodyVerifiedAccounts} params.verifiedAccounts [optional]
|
|
3647
3901
|
*
|
|
3648
3902
|
* @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
|
|
@@ -3657,9 +3911,10 @@ export declare class NeynarAPIClient {
|
|
|
3657
3911
|
* const username =
|
|
3658
3912
|
* const displayName =
|
|
3659
3913
|
* const location =
|
|
3914
|
+
* const banner =
|
|
3660
3915
|
* const verifiedAccounts =
|
|
3661
3916
|
*
|
|
3662
|
-
* client.updateUser({signerUuid, bio, pfpUrl, url, username, displayName, location, verifiedAccounts}).then(response => {
|
|
3917
|
+
* client.updateUser({signerUuid, bio, pfpUrl, url, username, displayName, location, banner, verifiedAccounts}).then(response => {
|
|
3663
3918
|
* console.log('response:', response);
|
|
3664
3919
|
* });
|
|
3665
3920
|
*
|
|
@@ -3674,6 +3929,7 @@ export declare class NeynarAPIClient {
|
|
|
3674
3929
|
username?: string;
|
|
3675
3930
|
displayName?: string;
|
|
3676
3931
|
location?: UpdateUserReqBodyLocation;
|
|
3932
|
+
banner?: string;
|
|
3677
3933
|
verifiedAccounts?: UpdateUserReqBodyVerifiedAccounts;
|
|
3678
3934
|
}): Promise<OperationResponse>;
|
|
3679
3935
|
/**
|