@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
|
@@ -32,6 +32,8 @@ const constants_1 = require("../common/constants");
|
|
|
32
32
|
const utils_1 = require("../utils");
|
|
33
33
|
const action_api_1 = require("../api/apis/action-api");
|
|
34
34
|
const agents_api_1 = require("../api/apis/agents-api");
|
|
35
|
+
const app_host_api_1 = require("../api/apis/app-host-api");
|
|
36
|
+
const auth_address_api_1 = require("../api/apis/auth-address-api");
|
|
35
37
|
const ban_api_1 = require("../api/apis/ban-api");
|
|
36
38
|
const block_api_1 = require("../api/apis/block-api");
|
|
37
39
|
const cast_api_1 = require("../api/apis/cast-api");
|
|
@@ -140,6 +142,8 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
140
142
|
this.apis = {
|
|
141
143
|
actionApi: new action_api_1.ActionApi(this.config, undefined, axiosInstance),
|
|
142
144
|
agentsApi: new agents_api_1.AgentsApi(this.config, undefined, axiosInstance),
|
|
145
|
+
appHostApi: new app_host_api_1.AppHostApi(this.config, undefined, axiosInstance),
|
|
146
|
+
authAddressApi: new auth_address_api_1.AuthAddressApi(this.config, undefined, axiosInstance),
|
|
143
147
|
banApi: new ban_api_1.BanApi(this.config, undefined, axiosInstance),
|
|
144
148
|
blockApi: new block_api_1.BlockApi(this.config, undefined, axiosInstance),
|
|
145
149
|
castApi: new cast_api_1.CastApi(this.config, undefined, axiosInstance),
|
|
@@ -190,7 +194,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
190
194
|
* console.log('response:', response);
|
|
191
195
|
* });
|
|
192
196
|
*
|
|
193
|
-
* For more information, refer to the [API documentation](https://docs.neynar.com/
|
|
197
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/publish-farcaster-action)
|
|
194
198
|
*
|
|
195
199
|
*/
|
|
196
200
|
async publishFarcasterAction(params) {
|
|
@@ -206,22 +210,30 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
206
210
|
* @summary Create transaction pay mini app
|
|
207
211
|
*
|
|
208
212
|
* @param {object} params
|
|
209
|
-
* @param {
|
|
213
|
+
* @param {FramePayTransactionReqBodyTransaction} params.transaction
|
|
214
|
+
* @param {TransactionFrameConfig} params.config
|
|
215
|
+
* @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.
|
|
210
216
|
*
|
|
211
217
|
* @returns {Promise<TransactionFrameResponse>} A promise that resolves to a `TransactionFrameResponse` object.
|
|
212
218
|
*
|
|
213
219
|
* @example
|
|
214
220
|
*
|
|
215
221
|
* // Fill in the appropriate values
|
|
216
|
-
* const
|
|
222
|
+
* const transaction =
|
|
223
|
+
* const config =
|
|
224
|
+
* const idem =
|
|
217
225
|
*
|
|
218
|
-
* client.createTransactionPayFrame({
|
|
226
|
+
* client.createTransactionPayFrame({transaction, config, idem}).then(response => {
|
|
219
227
|
* console.log('response:', response);
|
|
220
228
|
* });
|
|
229
|
+
*
|
|
230
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/create-transaction-pay-frame)
|
|
231
|
+
*
|
|
221
232
|
*/
|
|
222
233
|
async createTransactionPayFrame(params) {
|
|
223
234
|
const adjustedParams = {};
|
|
224
|
-
|
|
235
|
+
const _params = { framePayTransactionReqBody: camelCaseToSnakeCaseKeys(params) };
|
|
236
|
+
Object.assign(adjustedParams, _params);
|
|
225
237
|
const response = await this.apis.agentsApi.createTransactionPayFrame(adjustedParams);
|
|
226
238
|
return response.data;
|
|
227
239
|
}
|
|
@@ -232,7 +244,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
232
244
|
*
|
|
233
245
|
* @param {object} params
|
|
234
246
|
* @param {number[]} params.fids - Comma separated list of two FIDs
|
|
235
|
-
* @param {Array<
|
|
247
|
+
* @param {Array<FetchUserInteractionsTypeEnum>} params.type [optional] - Comma seperated list of Interaction type to fetch
|
|
236
248
|
*
|
|
237
249
|
* @returns {Promise<FetchUserInteractions200Response>} A promise that resolves to a `FetchUserInteractions200Response` object.
|
|
238
250
|
*
|
|
@@ -245,6 +257,9 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
245
257
|
* client.fetchUserInteractions({ fids, type }).then(response => {
|
|
246
258
|
* console.log('response:', response);
|
|
247
259
|
* });
|
|
260
|
+
*
|
|
261
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-user-interactions)
|
|
262
|
+
*
|
|
248
263
|
*/
|
|
249
264
|
async fetchUserInteractions(params) {
|
|
250
265
|
const adjustedParams = {};
|
|
@@ -259,12 +274,12 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
259
274
|
return response.data;
|
|
260
275
|
}
|
|
261
276
|
/**
|
|
262
|
-
* Generates a summary of all casts related to a conversation surrounding a cast by passing in a cast hash or
|
|
277
|
+
* 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.
|
|
263
278
|
*
|
|
264
279
|
* @summary Cast conversation summary
|
|
265
280
|
*
|
|
266
281
|
* @param {object} params
|
|
267
|
-
* @param {string} params.identifier - Cast identifier (
|
|
282
|
+
* @param {string} params.identifier - Cast identifier (It's either a URL or a hash))
|
|
268
283
|
* @param {number} params.limit [optional] - Number of casts to consider in a summary up to a point of target cast (Default: 20, Maximum: 50)
|
|
269
284
|
* @param {string} params.prompt [optional] - Additional prompt used to generate a summary
|
|
270
285
|
*
|
|
@@ -290,6 +305,162 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
290
305
|
const response = await this.apis.agentsApi.lookupCastConversationSummary(adjustedParams);
|
|
291
306
|
return response.data;
|
|
292
307
|
}
|
|
308
|
+
/**
|
|
309
|
+
* Returns event object for app host events. Used if the app host intends to sign the event message instead of using Neynar-hosted signers.
|
|
310
|
+
*
|
|
311
|
+
* @summary Generate event
|
|
312
|
+
*
|
|
313
|
+
* @param {object} params
|
|
314
|
+
* @param {string} params.appDomain - The domain of the mini app
|
|
315
|
+
* @param {number} params.fid - The FID of the user who initiated the event
|
|
316
|
+
* @param {AppHostGetEventEventEnum} params.event - The type of event
|
|
317
|
+
*
|
|
318
|
+
* @returns {Promise<AppHostGetEventResponse>} A promise that resolves to a `AppHostGetEventResponse` object.
|
|
319
|
+
*
|
|
320
|
+
* @example
|
|
321
|
+
*
|
|
322
|
+
* // Fill in the appropriate values
|
|
323
|
+
* const appDomain =
|
|
324
|
+
* const fid =
|
|
325
|
+
* const event =
|
|
326
|
+
*
|
|
327
|
+
* client.appHostGetEvent({ appDomain, fid, event }).then(response => {
|
|
328
|
+
* console.log('response:', response);
|
|
329
|
+
* });
|
|
330
|
+
*
|
|
331
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/app-host-get-event)
|
|
332
|
+
*
|
|
333
|
+
*/
|
|
334
|
+
async appHostGetEvent(params) {
|
|
335
|
+
const adjustedParams = {};
|
|
336
|
+
Object.assign(adjustedParams, params);
|
|
337
|
+
const response = await this.apis.appHostApi.appHostGetEvent(adjustedParams);
|
|
338
|
+
return response.data;
|
|
339
|
+
}
|
|
340
|
+
/**
|
|
341
|
+
* Returns the current notification state for a specific user across all mini app domains in this app host. Shows which domains have notifications enabled.
|
|
342
|
+
*
|
|
343
|
+
* @summary Enabled notifications
|
|
344
|
+
*
|
|
345
|
+
* @param {object} params
|
|
346
|
+
* @param {number} params.fid - The FID of the user
|
|
347
|
+
*
|
|
348
|
+
* @returns {Promise<AppHostUserStateResponse>} A promise that resolves to a `AppHostUserStateResponse` object.
|
|
349
|
+
*
|
|
350
|
+
* @example
|
|
351
|
+
*
|
|
352
|
+
* // Fill in the appropriate values
|
|
353
|
+
* const fid =
|
|
354
|
+
*
|
|
355
|
+
* client.appHostGetUserState({ fid }).then(response => {
|
|
356
|
+
* console.log('response:', response);
|
|
357
|
+
* });
|
|
358
|
+
*
|
|
359
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/app-host-get-user-state)
|
|
360
|
+
*
|
|
361
|
+
*/
|
|
362
|
+
async appHostGetUserState(params) {
|
|
363
|
+
const adjustedParams = {};
|
|
364
|
+
Object.assign(adjustedParams, params);
|
|
365
|
+
const response = await this.apis.appHostApi.appHostGetUserState(adjustedParams);
|
|
366
|
+
return response.data;
|
|
367
|
+
}
|
|
368
|
+
/**
|
|
369
|
+
* 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.
|
|
370
|
+
*
|
|
371
|
+
* @summary Send event
|
|
372
|
+
*
|
|
373
|
+
* @param {object} params
|
|
374
|
+
* @param {any} params.appHostPostEventReqBody
|
|
375
|
+
*
|
|
376
|
+
* @returns {Promise<AppHostPostEventResponse>} A promise that resolves to a `AppHostPostEventResponse` object.
|
|
377
|
+
*
|
|
378
|
+
* @example
|
|
379
|
+
*
|
|
380
|
+
* // Fill in the appropriate values
|
|
381
|
+
* const appHostPostEventReqBody =
|
|
382
|
+
*
|
|
383
|
+
* client.appHostPostEvent({appHostPostEventReqBody}).then(response => {
|
|
384
|
+
* console.log('response:', response);
|
|
385
|
+
* });
|
|
386
|
+
*
|
|
387
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/app-host-post-event)
|
|
388
|
+
*
|
|
389
|
+
*/
|
|
390
|
+
async appHostPostEvent(params) {
|
|
391
|
+
const adjustedParams = {};
|
|
392
|
+
const _params = { appHostPostEventReqBody: camelCaseToSnakeCaseKeys(params) };
|
|
393
|
+
Object.assign(adjustedParams, _params);
|
|
394
|
+
const response = await this.apis.appHostApi.appHostPostEvent(adjustedParams);
|
|
395
|
+
return response.data;
|
|
396
|
+
}
|
|
397
|
+
/**
|
|
398
|
+
* Fetches the status of a developer managed auth address by auth address
|
|
399
|
+
*
|
|
400
|
+
* @summary Status by auth address
|
|
401
|
+
*
|
|
402
|
+
* @param {object} params
|
|
403
|
+
* @param {string} params.address - Ethereum address
|
|
404
|
+
*
|
|
405
|
+
* @returns {Promise<RegisterSignedKeyForDeveloperManagedAuthAddress200Response>} A promise that resolves to a `RegisterSignedKeyForDeveloperManagedAuthAddress200Response` object.
|
|
406
|
+
*
|
|
407
|
+
* @example
|
|
408
|
+
*
|
|
409
|
+
* // Fill in the appropriate values
|
|
410
|
+
* const address =
|
|
411
|
+
*
|
|
412
|
+
* client.lookupDeveloperManagedAuthAddress({ address }).then(response => {
|
|
413
|
+
* console.log('response:', response);
|
|
414
|
+
* });
|
|
415
|
+
*
|
|
416
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/lookup-developer-managed-auth-address)
|
|
417
|
+
*
|
|
418
|
+
*/
|
|
419
|
+
async lookupDeveloperManagedAuthAddress(params) {
|
|
420
|
+
const adjustedParams = {};
|
|
421
|
+
Object.assign(adjustedParams, params);
|
|
422
|
+
const response = await this.apis.authAddressApi.lookupDeveloperManagedAuthAddress(adjustedParams);
|
|
423
|
+
return response.data;
|
|
424
|
+
}
|
|
425
|
+
/**
|
|
426
|
+
* 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.
|
|
427
|
+
*
|
|
428
|
+
* @summary Register Signed Key
|
|
429
|
+
*
|
|
430
|
+
* @param {object} params
|
|
431
|
+
* @param {string} params.address - Ethereum address
|
|
432
|
+
* @param {number} params.appFid - The unique identifier of a farcaster user or app (unsigned integer)
|
|
433
|
+
* @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)
|
|
434
|
+
* @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)
|
|
435
|
+
* @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.
|
|
436
|
+
* @param {SignedKeyRequestSponsor} params.sponsor [optional]
|
|
437
|
+
*
|
|
438
|
+
* @returns {Promise<RegisterSignedKeyForDeveloperManagedAuthAddress200Response>} A promise that resolves to a `RegisterSignedKeyForDeveloperManagedAuthAddress200Response` object.
|
|
439
|
+
*
|
|
440
|
+
* @example
|
|
441
|
+
*
|
|
442
|
+
* // Fill in the appropriate values
|
|
443
|
+
* const address =
|
|
444
|
+
* const appFid =
|
|
445
|
+
* const deadline =
|
|
446
|
+
* const signature =
|
|
447
|
+
* const redirectUrl =
|
|
448
|
+
* const sponsor =
|
|
449
|
+
*
|
|
450
|
+
* client.registerSignedKeyForDeveloperManagedAuthAddress({address, appFid, deadline, signature, redirectUrl, sponsor}).then(response => {
|
|
451
|
+
* console.log('response:', response);
|
|
452
|
+
* });
|
|
453
|
+
*
|
|
454
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/register-signed-key-for-developer-managed-auth-address)
|
|
455
|
+
*
|
|
456
|
+
*/
|
|
457
|
+
async registerSignedKeyForDeveloperManagedAuthAddress(params) {
|
|
458
|
+
const adjustedParams = {};
|
|
459
|
+
const _params = { registerAuthAddressDeveloperManagedSignedKeyReqBody: camelCaseToSnakeCaseKeys(params) };
|
|
460
|
+
Object.assign(adjustedParams, _params);
|
|
461
|
+
const response = await this.apis.authAddressApi.registerSignedKeyForDeveloperManagedAuthAddress(adjustedParams);
|
|
462
|
+
return response.data;
|
|
463
|
+
}
|
|
293
464
|
/**
|
|
294
465
|
* Deletes a list of FIDs from the app associated with your API key.
|
|
295
466
|
*
|
|
@@ -386,7 +557,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
386
557
|
*
|
|
387
558
|
* @param {object} params
|
|
388
559
|
* @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.
|
|
389
|
-
* @param {number} params.blockedFid - The unique identifier of a farcaster user (unsigned integer)
|
|
560
|
+
* @param {number} params.blockedFid - The unique identifier of a farcaster user or app (unsigned integer)
|
|
390
561
|
*
|
|
391
562
|
* @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
|
|
392
563
|
*
|
|
@@ -452,7 +623,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
452
623
|
*
|
|
453
624
|
* @param {object} params
|
|
454
625
|
* @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.
|
|
455
|
-
* @param {number} params.blockedFid - The unique identifier of a farcaster user (unsigned integer)
|
|
626
|
+
* @param {number} params.blockedFid - The unique identifier of a farcaster user or app (unsigned integer)
|
|
456
627
|
*
|
|
457
628
|
* @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
|
|
458
629
|
*
|
|
@@ -477,13 +648,13 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
477
648
|
return response.data;
|
|
478
649
|
}
|
|
479
650
|
/**
|
|
480
|
-
* Delete an existing cast.
|
|
651
|
+
* Delete an existing cast. (In order to delete a cast `signer_uuid` must be approved)
|
|
481
652
|
*
|
|
482
653
|
* @summary Delete a cast
|
|
483
654
|
*
|
|
484
655
|
* @param {object} params
|
|
485
656
|
* @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.
|
|
486
|
-
* @param {string} params.targetHash
|
|
657
|
+
* @param {string} params.targetHash
|
|
487
658
|
*
|
|
488
659
|
* @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
|
|
489
660
|
*
|
|
@@ -544,13 +715,50 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
544
715
|
const response = await this.apis.castApi.fetchBulkCasts(adjustedParams);
|
|
545
716
|
return response.data;
|
|
546
717
|
}
|
|
718
|
+
/**
|
|
719
|
+
* Fetch casts that quote a given cast
|
|
720
|
+
*
|
|
721
|
+
* @summary Cast Quotes
|
|
722
|
+
*
|
|
723
|
+
* @param {object} params
|
|
724
|
+
* @param {FetchCastQuotesIdentifierParameter} params.identifier - Cast identifier (It's either a URL or a hash)
|
|
725
|
+
* @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
|
|
726
|
+
* @param {number} params.viewerFid [optional]
|
|
727
|
+
* @param {number} params.limit [optional] - Number of results to fetch (Default: 25, Maximum: 100)
|
|
728
|
+
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
729
|
+
*
|
|
730
|
+
* @returns {Promise<FetchCastQuotes200Response>} A promise that resolves to a `FetchCastQuotes200Response` object.
|
|
731
|
+
*
|
|
732
|
+
* @example
|
|
733
|
+
*
|
|
734
|
+
* // Fill in the appropriate values
|
|
735
|
+
* const identifier =
|
|
736
|
+
* const type =
|
|
737
|
+
* const viewerFid =
|
|
738
|
+
* const limit =
|
|
739
|
+
*
|
|
740
|
+
* client.fetchCastQuotes({ identifier, type, viewerFid, limit }).then(response => {
|
|
741
|
+
* console.log('response:', response);
|
|
742
|
+
* });
|
|
743
|
+
*
|
|
744
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-cast-quotes)
|
|
745
|
+
*
|
|
746
|
+
*/
|
|
747
|
+
async fetchCastQuotes(params) {
|
|
748
|
+
var _a, _b;
|
|
749
|
+
const adjustedParams = {};
|
|
750
|
+
Object.assign(adjustedParams, params);
|
|
751
|
+
adjustedParams['xNeynarExperimental'] = (_b = (_a = this.config.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) === null || _b === void 0 ? void 0 : _b['x-neynar-experimental'];
|
|
752
|
+
const response = await this.apis.castApi.fetchCastQuotes(adjustedParams);
|
|
753
|
+
return response.data;
|
|
754
|
+
}
|
|
547
755
|
/**
|
|
548
756
|
* Fetches all composer actions on Warpcast. You can filter by top or featured.
|
|
549
757
|
*
|
|
550
758
|
* @summary Fetch composer actions
|
|
551
759
|
*
|
|
552
760
|
* @param {object} params
|
|
553
|
-
* @param {
|
|
761
|
+
* @param {FetchComposerActionsListEnum} params.list - Type of list to fetch.
|
|
554
762
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 25, Maximum: 25)
|
|
555
763
|
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
556
764
|
*
|
|
@@ -604,13 +812,13 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
604
812
|
return response.data;
|
|
605
813
|
}
|
|
606
814
|
/**
|
|
607
|
-
* Gets information about an individual cast by passing in a
|
|
815
|
+
* Gets information about an individual cast by passing in a Farcaster web URL or cast hash
|
|
608
816
|
*
|
|
609
817
|
* @summary By hash or URL
|
|
610
818
|
*
|
|
611
819
|
* @param {object} params
|
|
612
|
-
* @param {
|
|
613
|
-
* @param {
|
|
820
|
+
* @param {FetchCastQuotesIdentifierParameter} params.identifier - Cast identifier (It's either a URL or a hash)
|
|
821
|
+
* @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
|
|
614
822
|
* @param {number} params.viewerFid [optional] - adds viewer_context to cast object to show whether viewer has liked or recasted the cast.
|
|
615
823
|
*
|
|
616
824
|
* @returns {Promise<CastResponse>} A promise that resolves to a `CastResponse` object.
|
|
@@ -638,17 +846,17 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
638
846
|
return response.data;
|
|
639
847
|
}
|
|
640
848
|
/**
|
|
641
|
-
* Gets all casts related to a conversation surrounding a cast by passing in a cast hash or
|
|
849
|
+
* 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.
|
|
642
850
|
*
|
|
643
851
|
* @summary Conversation for a cast
|
|
644
852
|
*
|
|
645
853
|
* @param {object} params
|
|
646
|
-
* @param {string} params.identifier - Cast identifier (
|
|
647
|
-
* @param {
|
|
648
|
-
* @param {number} params.replyDepth [optional] - The depth of replies in the conversation that will be returned (default 2)
|
|
649
|
-
* @param {boolean} params.includeChronologicalParentCasts [optional] - Include all parent casts in chronological order
|
|
854
|
+
* @param {string} params.identifier - Cast identifier (It's either a URL or a hash)
|
|
855
|
+
* @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
|
|
856
|
+
* @param {number | null} params.replyDepth [optional] - The depth of replies in the conversation that will be returned (default 2)
|
|
857
|
+
* @param {boolean | null} params.includeChronologicalParentCasts [optional] - Include all parent casts in chronological order
|
|
650
858
|
* @param {number} params.viewerFid [optional] - Providing this will return a conversation that respects this user's mutes and blocks and includes `viewer_context`.
|
|
651
|
-
* @param {
|
|
859
|
+
* @param {LookupCastConversationSortTypeEnum} params.sortType [optional] - Sort type for the ordering of descendants. Default is `chron`
|
|
652
860
|
* @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.
|
|
653
861
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 20, Maximum: 50)
|
|
654
862
|
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
@@ -694,7 +902,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
694
902
|
* @param {string} params.parent [optional] - parent_url of the channel the cast is in, or hash of the cast
|
|
695
903
|
* @param {string} params.channelId [optional] - Channel ID of the channel where the cast is to be posted. e.g. neynar, farcaster, warpcast
|
|
696
904
|
* @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.
|
|
697
|
-
* @param {number} params.parentAuthorFid [optional] - The unique identifier of a farcaster user (unsigned integer)
|
|
905
|
+
* @param {number} params.parentAuthorFid [optional] - The unique identifier of a farcaster user or app (unsigned integer)
|
|
698
906
|
*
|
|
699
907
|
* @returns {Promise<PostCastResponse>} A promise that resolves to a `PostCastResponse` object.
|
|
700
908
|
*
|
|
@@ -731,12 +939,11 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
731
939
|
* @param {object} params
|
|
732
940
|
* @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`) |
|
|
733
941
|
* @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
|
|
734
|
-
* @param {
|
|
942
|
+
* @param {SearchCastsSortTypeEnum} params.sortType [optional] - Choices are: - `desc_chron` - All casts sorted by time (default) - `algorithmic` - Casts sorted by engagement and time
|
|
735
943
|
* @param {number} params.authorFid [optional] - Fid of the user whose casts you want to search
|
|
736
944
|
* @param {number} params.viewerFid [optional] - Providing this will return search results that respects this user's mutes and blocks and includes `viewer_context`.
|
|
737
945
|
* @param {string} params.parentUrl [optional] - Parent URL of the casts you want to search
|
|
738
946
|
* @param {string} params.channelId [optional] - Channel ID of the casts you want to search
|
|
739
|
-
* @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).
|
|
740
947
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 25, Maximum: 100)
|
|
741
948
|
* @param {string} params.cursor [optional] - Pagination cursor
|
|
742
949
|
*
|
|
@@ -752,10 +959,9 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
752
959
|
* const viewerFid =
|
|
753
960
|
* const parentUrl =
|
|
754
961
|
* const channelId =
|
|
755
|
-
* const priorityMode =
|
|
756
962
|
* const limit =
|
|
757
963
|
*
|
|
758
|
-
* client.searchCasts({ q, mode, sortType, authorFid, viewerFid, parentUrl, channelId,
|
|
964
|
+
* client.searchCasts({ q, mode, sortType, authorFid, viewerFid, parentUrl, channelId, limit }).then(response => {
|
|
759
965
|
* console.log('response:', response);
|
|
760
966
|
* });
|
|
761
967
|
*
|
|
@@ -806,7 +1012,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
806
1012
|
*
|
|
807
1013
|
* @param {object} params
|
|
808
1014
|
* @param {string[]} params.ids - Comma separated list of channel IDs or parent_urls, up to 100 at a time
|
|
809
|
-
* @param {
|
|
1015
|
+
* @param {FetchBulkChannelsTypeEnum} params.type [optional] - Type of identifier being used to query the channels. Defaults to ID.
|
|
810
1016
|
* @param {number} params.viewerFid [optional] - FID of the user viewing the channels.
|
|
811
1017
|
*
|
|
812
1018
|
* @returns {Promise<ChannelResponseBulk>} A promise that resolves to a `ChannelResponseBulk` object.
|
|
@@ -1132,7 +1338,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
1132
1338
|
* @param {object} params
|
|
1133
1339
|
* @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.
|
|
1134
1340
|
* @param {string} params.channelId - The unique identifier of a farcaster channel
|
|
1135
|
-
* @param {number} params.fid - The unique identifier of a farcaster user (unsigned integer)
|
|
1341
|
+
* @param {number} params.fid - The unique identifier of a farcaster user or app (unsigned integer)
|
|
1136
1342
|
* @param {ChannelMemberRole} params.role
|
|
1137
1343
|
*
|
|
1138
1344
|
* @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
|
|
@@ -1166,7 +1372,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
1166
1372
|
*
|
|
1167
1373
|
* @param {object} params
|
|
1168
1374
|
* @param {string} params.id - Channel ID for the channel being queried
|
|
1169
|
-
* @param {
|
|
1375
|
+
* @param {LookupChannelTypeEnum} params.type [optional] - Type of identifier being used to query the channel. Defaults to ID.
|
|
1170
1376
|
* @param {number} params.viewerFid [optional] - FID of the user viewing the channel.
|
|
1171
1377
|
*
|
|
1172
1378
|
* @returns {Promise<ChannelResponse>} A promise that resolves to a `ChannelResponse` object.
|
|
@@ -1199,7 +1405,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
1199
1405
|
* @param {object} params
|
|
1200
1406
|
* @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.
|
|
1201
1407
|
* @param {string} params.channelId - The unique identifier of a farcaster channel
|
|
1202
|
-
* @param {number} params.fid - The unique identifier of a farcaster user (unsigned integer)
|
|
1408
|
+
* @param {number} params.fid - The unique identifier of a farcaster user or app (unsigned integer)
|
|
1203
1409
|
* @param {ChannelMemberRole} params.role
|
|
1204
1410
|
*
|
|
1205
1411
|
* @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
|
|
@@ -1334,7 +1540,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
1334
1540
|
* @param {number} params.viewerFid [optional] - FID of the user viewing the feed
|
|
1335
1541
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 25, Maximum: 150)
|
|
1336
1542
|
* @param {string} params.cursor [optional] - Pagination cursor
|
|
1337
|
-
* @param {boolean} params.includeReplies [optional] - Include reply casts by the author in the response, true by default
|
|
1543
|
+
* @param {boolean | null} params.includeReplies [optional] - Include reply casts by the author in the response, true by default
|
|
1338
1544
|
* @param {string} params.parentUrl [optional] - Parent URL to filter the feed; mutually exclusive with channel_id
|
|
1339
1545
|
* @param {string} params.channelId [optional] - Channel ID to filter the feed; mutually exclusive with parent_url
|
|
1340
1546
|
*
|
|
@@ -1372,16 +1578,16 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
1372
1578
|
* @summary By filters
|
|
1373
1579
|
*
|
|
1374
1580
|
* @param {object} params
|
|
1375
|
-
* @param {
|
|
1376
|
-
* @param {
|
|
1581
|
+
* @param {FetchFeedFeedTypeEnum} params.feedType [optional] - Defaults to following (requires FID or address). If set to filter (requires filter_type)
|
|
1582
|
+
* @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)
|
|
1377
1583
|
* @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
|
|
1378
|
-
* @param {
|
|
1584
|
+
* @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.
|
|
1379
1585
|
* @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.
|
|
1380
1586
|
* @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.
|
|
1381
|
-
* @param {boolean} params.membersOnly [optional] - Used when filter_type=channel_id. Only include casts from members of the channel. True by default.
|
|
1587
|
+
* @param {boolean | null} params.membersOnly [optional] - Used when filter_type=channel_id. Only include casts from members of the channel. True by default.
|
|
1382
1588
|
* @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.
|
|
1383
|
-
* @param {Array<
|
|
1384
|
-
* @param {boolean} params.withRecasts [optional] - Include recasts in the response, true by default
|
|
1589
|
+
* @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.
|
|
1590
|
+
* @param {boolean | null} params.withRecasts [optional] - Include recasts in the response, true by default
|
|
1385
1591
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 25, Maximum: 100)
|
|
1386
1592
|
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
1387
1593
|
* @param {number} params.viewerFid [optional] - Providing this will return a feed that respects this user's mutes and blocks and includes `viewer_context`.
|
|
@@ -1416,6 +1622,12 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
1416
1622
|
const adjustedParams = {};
|
|
1417
1623
|
Object.assign(adjustedParams, params);
|
|
1418
1624
|
adjustedParams['xNeynarExperimental'] = (_b = (_a = this.config.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) === null || _b === void 0 ? void 0 : _b['x-neynar-experimental'];
|
|
1625
|
+
if (adjustedParams.fids && Array.isArray(adjustedParams.fids)) {
|
|
1626
|
+
adjustedParams.fids = adjustedParams.fids.map(value => (String(value)));
|
|
1627
|
+
}
|
|
1628
|
+
if (adjustedParams.fids && Array.isArray(adjustedParams.fids)) {
|
|
1629
|
+
adjustedParams.fids = adjustedParams.fids.join(",");
|
|
1630
|
+
}
|
|
1419
1631
|
const response = await this.apis.feedApi.fetchFeed(adjustedParams);
|
|
1420
1632
|
return response.data;
|
|
1421
1633
|
}
|
|
@@ -1426,14 +1638,14 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
1426
1638
|
*
|
|
1427
1639
|
* @param {object} params
|
|
1428
1640
|
* @param {string[]} params.channelIds - Comma separated list of up to 10 channel IDs e.g. neynar,farcaster
|
|
1429
|
-
* @param {boolean} params.withRecasts [optional] - Include recasts in the response, true by default
|
|
1641
|
+
* @param {boolean | null} params.withRecasts [optional] - Include recasts in the response, true by default
|
|
1430
1642
|
* @param {number} params.viewerFid [optional] - Providing this will return a feed that respects this user's mutes and blocks and includes `viewer_context`.
|
|
1431
|
-
* @param {boolean} params.withReplies [optional] - Include replies in the response, false by default
|
|
1432
|
-
* @param {boolean} params.membersOnly [optional] - Only include casts from members of the channel. True by default.
|
|
1643
|
+
* @param {boolean | null} params.withReplies [optional] - Include replies in the response, false by default
|
|
1644
|
+
* @param {boolean | null} params.membersOnly [optional] - Used when filter_type=channel_id. Only include casts from members of the channel. True by default.
|
|
1433
1645
|
* @param {number[]} params.fids [optional] - Comma separated list of FIDs to filter the feed by, up to 10 at a time
|
|
1434
1646
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 25, Maximum: 100)
|
|
1435
1647
|
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
1436
|
-
* @param {boolean} params.shouldModerate [optional] - If true, only casts that have been liked by the moderator (if one exists) will be returned.
|
|
1648
|
+
* @param {boolean | null} params.shouldModerate [optional] - If true, only casts that have been liked by the moderator (if one exists) will be returned.
|
|
1437
1649
|
*
|
|
1438
1650
|
* @returns {Promise<FeedResponse>} A promise that resolves to a `FeedResponse` object.
|
|
1439
1651
|
*
|
|
@@ -1480,9 +1692,9 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
1480
1692
|
*
|
|
1481
1693
|
* @param {object} params
|
|
1482
1694
|
* @param {string[]} params.parentUrls - Comma separated list of parent_urls
|
|
1483
|
-
* @param {boolean} params.withRecasts [optional] - Include recasts in the response, true by default
|
|
1695
|
+
* @param {boolean | null} params.withRecasts [optional] - Include recasts in the response, true by default
|
|
1484
1696
|
* @param {number} params.viewerFid [optional] - Providing this will return a feed that respects this user's mutes and blocks and includes `viewer_context`.
|
|
1485
|
-
* @param {boolean} params.withReplies [optional] - Include replies in the response, false by default
|
|
1697
|
+
* @param {boolean | null} params.withReplies [optional] - Include replies in the response, false by default
|
|
1486
1698
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 25, Maximum: 100)
|
|
1487
1699
|
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
1488
1700
|
*
|
|
@@ -1523,10 +1735,9 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
1523
1735
|
* @param {object} params
|
|
1524
1736
|
* @param {number} params.fid - FID of user whose feed you want to create
|
|
1525
1737
|
* @param {number} params.viewerFid [optional] - Providing this will return a feed that respects this user's mutes and blocks and includes `viewer_context`.
|
|
1526
|
-
* @param {
|
|
1738
|
+
* @param {FetchFeedForYouProviderEnum} params.provider [optional] - The provider of the For You feed.
|
|
1527
1739
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 25, Maximum: 50)
|
|
1528
1740
|
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
1529
|
-
* @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.
|
|
1530
1741
|
*
|
|
1531
1742
|
* @returns {Promise<FeedResponse>} A promise that resolves to a `FeedResponse` object.
|
|
1532
1743
|
*
|
|
@@ -1537,9 +1748,8 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
1537
1748
|
* const viewerFid =
|
|
1538
1749
|
* const provider =
|
|
1539
1750
|
* const limit =
|
|
1540
|
-
* const providerMetadata =
|
|
1541
1751
|
*
|
|
1542
|
-
* client.fetchFeedForYou({ fid, viewerFid, provider, limit
|
|
1752
|
+
* client.fetchFeedForYou({ fid, viewerFid, provider, limit }).then(response => {
|
|
1543
1753
|
* console.log('response:', response);
|
|
1544
1754
|
* });
|
|
1545
1755
|
*
|
|
@@ -1624,7 +1834,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
1624
1834
|
*
|
|
1625
1835
|
* @param {object} params
|
|
1626
1836
|
* @param {number} params.fid - FID of user whose replies and recasts you want to fetch
|
|
1627
|
-
* @param {FetchRepliesAndRecastsForUserFilterEnum} params.filter [optional] -
|
|
1837
|
+
* @param {FetchRepliesAndRecastsForUserFilterEnum} params.filter [optional] - Filter to fetch only replies or recasts
|
|
1628
1838
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 25, Maximum: 50)
|
|
1629
1839
|
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
1630
1840
|
* @param {number} params.viewerFid [optional] - Providing this will return a feed that respects this user's mutes and blocks and includes `viewer_context`.
|
|
@@ -1664,7 +1874,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
1664
1874
|
* @param {FetchTrendingFeedTimeWindowEnum} params.timeWindow [optional] - Time window for trending casts (7d window for channel feeds only)
|
|
1665
1875
|
* @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.
|
|
1666
1876
|
* @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.
|
|
1667
|
-
* @param {
|
|
1877
|
+
* @param {FetchTrendingFeedProviderEnum} params.provider [optional] - The provider of the trending casts feed.
|
|
1668
1878
|
* @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.
|
|
1669
1879
|
*
|
|
1670
1880
|
* @returns {Promise<FeedResponse>} A promise that resolves to a `FeedResponse` object.
|
|
@@ -1703,7 +1913,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
1703
1913
|
* @param {object} params
|
|
1704
1914
|
* @param {number} params.fid - FID of user whose feed you want to create
|
|
1705
1915
|
* @param {number} params.viewerFid [optional] - Providing this will return a feed that respects this user's mutes and blocks and includes `viewer_context`.
|
|
1706
|
-
* @param {boolean} params.withRecasts [optional] - Include recasts in the response, true by default
|
|
1916
|
+
* @param {boolean | null} params.withRecasts [optional] - Include recasts in the response, true by default
|
|
1707
1917
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 25, Maximum: 100)
|
|
1708
1918
|
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
1709
1919
|
*
|
|
@@ -1766,8 +1976,8 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
1766
1976
|
* @summary Suggest Follows
|
|
1767
1977
|
*
|
|
1768
1978
|
* @param {object} params
|
|
1769
|
-
* @param {number} params.fid - FID of the user whose following you want to fetch.
|
|
1770
|
-
* @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`.
|
|
1979
|
+
* @param {number | null} params.fid - FID of the user whose following you want to fetch.
|
|
1980
|
+
* @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`.
|
|
1771
1981
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 25, Maximum: 100)
|
|
1772
1982
|
*
|
|
1773
1983
|
* @returns {Promise<UsersResponse>} A promise that resolves to a `UsersResponse` object.
|
|
@@ -1834,7 +2044,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
1834
2044
|
* @param {object} params
|
|
1835
2045
|
* @param {number} params.fid - User who's profile you are looking at
|
|
1836
2046
|
* @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`.
|
|
1837
|
-
* @param {
|
|
2047
|
+
* @param {FetchUserFollowersSortTypeEnum} params.sortType [optional] - Sort type for fetch followers. Default is `desc_chron`
|
|
1838
2048
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 20, Maximum: 100)
|
|
1839
2049
|
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
1840
2050
|
*
|
|
@@ -1871,7 +2081,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
1871
2081
|
* @param {object} params
|
|
1872
2082
|
* @param {number} params.fid - FID of the user whose following you want to fetch.
|
|
1873
2083
|
* @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`.
|
|
1874
|
-
* @param {
|
|
2084
|
+
* @param {FetchUserFollowingSortTypeEnum} params.sortType [optional] - Optional parameter to sort the users based on different criteria.
|
|
1875
2085
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 25, Maximum: 100)
|
|
1876
2086
|
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
1877
2087
|
*
|
|
@@ -1937,8 +2147,8 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
1937
2147
|
* @param {object} params
|
|
1938
2148
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 100, Maximum: 100)
|
|
1939
2149
|
* @param {string} params.cursor [optional] - Pagination cursor
|
|
1940
|
-
* @param {
|
|
1941
|
-
* @param {Array<FetchFrameCatalogCategoriesEnum>} params.categories [optional] - Comma separated list of categories to include in the results.
|
|
2150
|
+
* @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
|
|
2151
|
+
* @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
|
|
1942
2152
|
*
|
|
1943
2153
|
* @returns {Promise<FrameCatalogResponse>} A promise that resolves to a `FrameCatalogResponse` object.
|
|
1944
2154
|
*
|
|
@@ -1952,6 +2162,9 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
1952
2162
|
* client.fetchFrameCatalog({ limit, timeWindow, categories }).then(response => {
|
|
1953
2163
|
* console.log('response:', response);
|
|
1954
2164
|
* });
|
|
2165
|
+
*
|
|
2166
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-frame-catalog)
|
|
2167
|
+
*
|
|
1955
2168
|
*/
|
|
1956
2169
|
async fetchFrameCatalog(params) {
|
|
1957
2170
|
const adjustedParams = {};
|
|
@@ -2052,7 +2265,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2052
2265
|
*
|
|
2053
2266
|
* @param {object} params
|
|
2054
2267
|
* @param {number} params.viewerFid - FID of the user to fetch relevant mini apps for
|
|
2055
|
-
* @param {
|
|
2268
|
+
* @param {FetchRelevantFramesTimeWindowEnum} params.timeWindow [optional] - Time window used to limit statistics used to calculate mini app relevance
|
|
2056
2269
|
*
|
|
2057
2270
|
* @returns {Promise<FetchRelevantFrames200Response>} A promise that resolves to a `FetchRelevantFrames200Response` object.
|
|
2058
2271
|
*
|
|
@@ -2066,7 +2279,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2066
2279
|
* console.log('response:', response);
|
|
2067
2280
|
* });
|
|
2068
2281
|
*
|
|
2069
|
-
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-
|
|
2282
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-relevant-frames)
|
|
2070
2283
|
*
|
|
2071
2284
|
*/
|
|
2072
2285
|
async fetchRelevantFrames(params) {
|
|
@@ -2081,11 +2294,11 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2081
2294
|
* @summary Analytics for the mini app
|
|
2082
2295
|
*
|
|
2083
2296
|
* @param {object} params
|
|
2084
|
-
* @param {string} params.frameUrl
|
|
2085
|
-
* @param {
|
|
2297
|
+
* @param {string} params.frameUrl - URL of the mini app to fetch analytics for
|
|
2298
|
+
* @param {FetchValidateFrameAnalyticsAnalyticsTypeEnum} params.analyticsType - Type of analytics to fetch
|
|
2086
2299
|
* @param {string} params.start
|
|
2087
2300
|
* @param {string} params.stop
|
|
2088
|
-
* @param {
|
|
2301
|
+
* @param {FetchValidateFrameAnalyticsAggregateWindowEnum} params.aggregateWindow [optional] - Required for `analytics_type=interactions-per-cast`
|
|
2089
2302
|
*
|
|
2090
2303
|
* @returns {Promise<FrameValidateAnalyticsResponse>} A promise that resolves to a `FrameValidateAnalyticsResponse` object.
|
|
2091
2304
|
*
|
|
@@ -2132,6 +2345,37 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2132
2345
|
const response = await this.apis.frameApi.fetchValidateFrameList();
|
|
2133
2346
|
return response.data;
|
|
2134
2347
|
}
|
|
2348
|
+
/**
|
|
2349
|
+
* Retrieve notification delivery and opened stats for notification campaigns
|
|
2350
|
+
*
|
|
2351
|
+
* @summary Get notification campaign stats
|
|
2352
|
+
*
|
|
2353
|
+
* @param {object} params
|
|
2354
|
+
* @param {string} params.campaignId [optional] - An ID of a specific notification campaign to query
|
|
2355
|
+
* @param {number} params.limit [optional] - The number of results to return (Default: 100, Maximum: 1000)
|
|
2356
|
+
* @param {string} params.cursor [optional] - Pagination cursor
|
|
2357
|
+
*
|
|
2358
|
+
* @returns {Promise<GetNotificationCampaignStats200Response>} A promise that resolves to a `GetNotificationCampaignStats200Response` object.
|
|
2359
|
+
*
|
|
2360
|
+
* @example
|
|
2361
|
+
*
|
|
2362
|
+
* // Fill in the appropriate values
|
|
2363
|
+
* const campaignId =
|
|
2364
|
+
* const limit =
|
|
2365
|
+
*
|
|
2366
|
+
* client.getNotificationCampaignStats({ campaignId, limit }).then(response => {
|
|
2367
|
+
* console.log('response:', response);
|
|
2368
|
+
* });
|
|
2369
|
+
*
|
|
2370
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-notification-campaign-stats)
|
|
2371
|
+
*
|
|
2372
|
+
*/
|
|
2373
|
+
async getNotificationCampaignStats(params) {
|
|
2374
|
+
const adjustedParams = {};
|
|
2375
|
+
Object.assign(adjustedParams, params);
|
|
2376
|
+
const response = await this.apis.frameApi.getNotificationCampaignStats(adjustedParams);
|
|
2377
|
+
return response.data;
|
|
2378
|
+
}
|
|
2135
2379
|
/**
|
|
2136
2380
|
* Retrieves details about a transaction pay mini app by ID
|
|
2137
2381
|
*
|
|
@@ -2150,6 +2394,9 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2150
2394
|
* client.getTransactionPayFrame({ id }).then(response => {
|
|
2151
2395
|
* console.log('response:', response);
|
|
2152
2396
|
* });
|
|
2397
|
+
*
|
|
2398
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-transaction-pay-frame)
|
|
2399
|
+
*
|
|
2153
2400
|
*/
|
|
2154
2401
|
async getTransactionPayFrame(params) {
|
|
2155
2402
|
const adjustedParams = {};
|
|
@@ -2163,7 +2410,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2163
2410
|
* @summary Mini app by UUID or URL
|
|
2164
2411
|
*
|
|
2165
2412
|
* @param {object} params
|
|
2166
|
-
* @param {
|
|
2413
|
+
* @param {LookupNeynarFrameTypeEnum} params.type - Type of identifier (either 'uuid' or 'url')
|
|
2167
2414
|
* @param {string} params.uuid [optional] - UUID of the mini app to fetch
|
|
2168
2415
|
* @param {string} params.url [optional] - URL of the Neynar mini app to fetch
|
|
2169
2416
|
*
|
|
@@ -2190,13 +2437,13 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2190
2437
|
return response.data;
|
|
2191
2438
|
}
|
|
2192
2439
|
/**
|
|
2193
|
-
* Post mini app actions, cast actions or cast composer actions to the server
|
|
2440
|
+
* 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.
|
|
2194
2441
|
*
|
|
2195
2442
|
* @summary Post a mini app action, cast action or a cast composer action
|
|
2196
2443
|
*
|
|
2197
2444
|
* @param {object} params
|
|
2198
2445
|
* @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.
|
|
2199
|
-
* @param {string} params.castHash [optional]
|
|
2446
|
+
* @param {string} params.castHash [optional]
|
|
2200
2447
|
* @param {FrameAction} params.action
|
|
2201
2448
|
*
|
|
2202
2449
|
* @returns {Promise<Frame>} A promise that resolves to a `Frame` object.
|
|
@@ -2228,7 +2475,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2228
2475
|
* @summary Signature packet
|
|
2229
2476
|
*
|
|
2230
2477
|
* @param {object} params
|
|
2231
|
-
* @param {string} params.castHash [optional]
|
|
2478
|
+
* @param {string} params.castHash [optional]
|
|
2232
2479
|
* @param {FrameAction} params.action
|
|
2233
2480
|
* @param {FrameSignaturePacket} params.signaturePacket
|
|
2234
2481
|
*
|
|
@@ -2262,8 +2509,8 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2262
2509
|
*
|
|
2263
2510
|
* @param {object} params
|
|
2264
2511
|
* @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.
|
|
2265
|
-
* @param {SendFrameNotificationsReqBodyNotification} params.notification
|
|
2266
2512
|
* @param {SendFrameNotificationsReqBodyFilters} params.filters [optional]
|
|
2513
|
+
* @param {SendFrameNotificationsReqBodyNotification} params.notification
|
|
2267
2514
|
*
|
|
2268
2515
|
* @returns {Promise<SendFrameNotificationsResponse>} A promise that resolves to a `SendFrameNotificationsResponse` object.
|
|
2269
2516
|
*
|
|
@@ -2271,10 +2518,10 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2271
2518
|
*
|
|
2272
2519
|
* // Fill in the appropriate values
|
|
2273
2520
|
* const targetFids =
|
|
2274
|
-
* const notification =
|
|
2275
2521
|
* const filters =
|
|
2522
|
+
* const notification =
|
|
2276
2523
|
*
|
|
2277
|
-
* client.publishFrameNotifications({targetFids,
|
|
2524
|
+
* client.publishFrameNotifications({targetFids, filters, notification}).then(response => {
|
|
2278
2525
|
* console.log('response:', response);
|
|
2279
2526
|
* });
|
|
2280
2527
|
*
|
|
@@ -2384,7 +2631,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2384
2631
|
return response.data;
|
|
2385
2632
|
}
|
|
2386
2633
|
/**
|
|
2387
|
-
* Validates a mini app against by an interacting user against a Farcaster Hub
|
|
2634
|
+
* 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)
|
|
2388
2635
|
*
|
|
2389
2636
|
* @summary Validate mini app action
|
|
2390
2637
|
*
|
|
@@ -2448,7 +2695,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2448
2695
|
*
|
|
2449
2696
|
* @param {object} params
|
|
2450
2697
|
* @param {string} params.q - Query string to search for casts
|
|
2451
|
-
* @param {FetchCastMetricsIntervalEnum} params.interval [optional] - Interval of time for which to fetch metrics.
|
|
2698
|
+
* @param {FetchCastMetricsIntervalEnum} params.interval [optional] - Interval of time for which to fetch metrics. Default is 30d.
|
|
2452
2699
|
* @param {number} params.authorFid [optional] - Fid of the user whose casts you want to search
|
|
2453
2700
|
* @param {string} params.channelId [optional] - Channel ID of the casts you want to search
|
|
2454
2701
|
*
|
|
@@ -2483,8 +2730,8 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2483
2730
|
* @summary Unmute FID
|
|
2484
2731
|
*
|
|
2485
2732
|
* @param {object} params
|
|
2486
|
-
* @param {number} params.fid - The unique identifier of a farcaster user (unsigned integer)
|
|
2487
|
-
* @param {number} params.mutedFid - The unique identifier of a farcaster user (unsigned integer)
|
|
2733
|
+
* @param {number} params.fid - The unique identifier of a farcaster user or app (unsigned integer)
|
|
2734
|
+
* @param {number} params.mutedFid - The unique identifier of a farcaster user or app (unsigned integer)
|
|
2488
2735
|
*
|
|
2489
2736
|
* @returns {Promise<MuteResponse>} A promise that resolves to a `MuteResponse` object.
|
|
2490
2737
|
*
|
|
@@ -2547,8 +2794,8 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2547
2794
|
* @summary Mute FID
|
|
2548
2795
|
*
|
|
2549
2796
|
* @param {object} params
|
|
2550
|
-
* @param {number} params.fid - The unique identifier of a farcaster user (unsigned integer)
|
|
2551
|
-
* @param {number} params.mutedFid - The unique identifier of a farcaster user (unsigned integer)
|
|
2797
|
+
* @param {number} params.fid - The unique identifier of a farcaster user or app (unsigned integer)
|
|
2798
|
+
* @param {number} params.mutedFid - The unique identifier of a farcaster user or app (unsigned integer)
|
|
2552
2799
|
*
|
|
2553
2800
|
* @returns {Promise<MuteResponse>} A promise that resolves to a `MuteResponse` object.
|
|
2554
2801
|
*
|
|
@@ -2579,8 +2826,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2579
2826
|
*
|
|
2580
2827
|
* @param {object} params
|
|
2581
2828
|
* @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.
|
|
2582
|
-
* @param {Array<
|
|
2583
|
-
* @param {boolean} params.priorityMode [optional] - When true, only returns notifications from power badge users and users that the user follows.
|
|
2829
|
+
* @param {Array<FetchAllNotificationsTypeEnum>} params.type [optional] - Notification type to fetch. Comma separated values of follows, recasts, likes, mentions, replies.
|
|
2584
2830
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 15, Maximum: 25)
|
|
2585
2831
|
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
2586
2832
|
*
|
|
@@ -2591,10 +2837,9 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2591
2837
|
* // Fill in the appropriate values
|
|
2592
2838
|
* const fid =
|
|
2593
2839
|
* const type =
|
|
2594
|
-
* const priorityMode =
|
|
2595
2840
|
* const limit =
|
|
2596
2841
|
*
|
|
2597
|
-
* client.fetchAllNotifications({ fid, type,
|
|
2842
|
+
* client.fetchAllNotifications({ fid, type, limit }).then(response => {
|
|
2598
2843
|
* console.log('response:', response);
|
|
2599
2844
|
* });
|
|
2600
2845
|
*
|
|
@@ -2602,8 +2847,10 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2602
2847
|
*
|
|
2603
2848
|
*/
|
|
2604
2849
|
async fetchAllNotifications(params) {
|
|
2850
|
+
var _a, _b;
|
|
2605
2851
|
const adjustedParams = {};
|
|
2606
2852
|
Object.assign(adjustedParams, params);
|
|
2853
|
+
adjustedParams['xNeynarExperimental'] = (_b = (_a = this.config.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) === null || _b === void 0 ? void 0 : _b['x-neynar-experimental'];
|
|
2607
2854
|
const response = await this.apis.notificationsApi.fetchAllNotifications(adjustedParams);
|
|
2608
2855
|
return response.data;
|
|
2609
2856
|
}
|
|
@@ -2615,7 +2862,6 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2615
2862
|
* @param {object} params
|
|
2616
2863
|
* @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.
|
|
2617
2864
|
* @param {string[]} params.channelIds - Comma separated channel_ids (find list of all channels here - https://docs.neynar.com/reference/list-all-channels)
|
|
2618
|
-
* @param {boolean} params.priorityMode [optional] - When true, only returns notifications from power badge users and users that the user follows.
|
|
2619
2865
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 15, Maximum: 25)
|
|
2620
2866
|
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
2621
2867
|
*
|
|
@@ -2626,10 +2872,9 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2626
2872
|
* // Fill in the appropriate values
|
|
2627
2873
|
* const fid =
|
|
2628
2874
|
* const channelIds =
|
|
2629
|
-
* const priorityMode =
|
|
2630
2875
|
* const limit =
|
|
2631
2876
|
*
|
|
2632
|
-
* client.fetchChannelNotificationsForUser({ fid, channelIds,
|
|
2877
|
+
* client.fetchChannelNotificationsForUser({ fid, channelIds, limit }).then(response => {
|
|
2633
2878
|
* console.log('response:', response);
|
|
2634
2879
|
* });
|
|
2635
2880
|
*
|
|
@@ -2637,8 +2882,10 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2637
2882
|
*
|
|
2638
2883
|
*/
|
|
2639
2884
|
async fetchChannelNotificationsForUser(params) {
|
|
2885
|
+
var _a, _b;
|
|
2640
2886
|
const adjustedParams = {};
|
|
2641
2887
|
Object.assign(adjustedParams, params);
|
|
2888
|
+
adjustedParams['xNeynarExperimental'] = (_b = (_a = this.config.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) === null || _b === void 0 ? void 0 : _b['x-neynar-experimental'];
|
|
2642
2889
|
if (adjustedParams.channelIds && Array.isArray(adjustedParams.channelIds)) {
|
|
2643
2890
|
adjustedParams.channelIds = adjustedParams.channelIds.join(",");
|
|
2644
2891
|
}
|
|
@@ -2653,7 +2900,6 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2653
2900
|
* @param {object} params
|
|
2654
2901
|
* @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.
|
|
2655
2902
|
* @param {string[]} params.parentUrls - Comma separated parent_urls
|
|
2656
|
-
* @param {boolean} params.priorityMode [optional] - When true, only returns notifications from power badge users and users that the user follows.
|
|
2657
2903
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 15, Maximum: 25)
|
|
2658
2904
|
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
2659
2905
|
*
|
|
@@ -2664,10 +2910,9 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2664
2910
|
* // Fill in the appropriate values
|
|
2665
2911
|
* const fid =
|
|
2666
2912
|
* const parentUrls =
|
|
2667
|
-
* const priorityMode =
|
|
2668
2913
|
* const limit =
|
|
2669
2914
|
*
|
|
2670
|
-
* client.fetchNotificationsByParentUrlForUser({ fid, parentUrls,
|
|
2915
|
+
* client.fetchNotificationsByParentUrlForUser({ fid, parentUrls, limit }).then(response => {
|
|
2671
2916
|
* console.log('response:', response);
|
|
2672
2917
|
* });
|
|
2673
2918
|
*
|
|
@@ -2675,8 +2920,10 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2675
2920
|
*
|
|
2676
2921
|
*/
|
|
2677
2922
|
async fetchNotificationsByParentUrlForUser(params) {
|
|
2923
|
+
var _a, _b;
|
|
2678
2924
|
const adjustedParams = {};
|
|
2679
2925
|
Object.assign(adjustedParams, params);
|
|
2926
|
+
adjustedParams['xNeynarExperimental'] = (_b = (_a = this.config.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) === null || _b === void 0 ? void 0 : _b['x-neynar-experimental'];
|
|
2680
2927
|
if (adjustedParams.parentUrls && Array.isArray(adjustedParams.parentUrls)) {
|
|
2681
2928
|
adjustedParams.parentUrls = adjustedParams.parentUrls.join(",");
|
|
2682
2929
|
}
|
|
@@ -2691,7 +2938,6 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2691
2938
|
* @param {object} params
|
|
2692
2939
|
* @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.
|
|
2693
2940
|
* @param {NotificationType} params.type [optional]
|
|
2694
|
-
* @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).
|
|
2695
2941
|
*
|
|
2696
2942
|
* @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
|
|
2697
2943
|
*
|
|
@@ -2700,9 +2946,8 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2700
2946
|
* // Fill in the appropriate values
|
|
2701
2947
|
* const signerUuid =
|
|
2702
2948
|
* const type =
|
|
2703
|
-
* const authorization =
|
|
2704
2949
|
*
|
|
2705
|
-
* client.markNotificationsAsSeen({signerUuid, type
|
|
2950
|
+
* client.markNotificationsAsSeen({signerUuid, type}).then(response => {
|
|
2706
2951
|
* console.log('response:', response);
|
|
2707
2952
|
* });
|
|
2708
2953
|
*
|
|
@@ -2710,9 +2955,11 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2710
2955
|
*
|
|
2711
2956
|
*/
|
|
2712
2957
|
async markNotificationsAsSeen(params) {
|
|
2958
|
+
var _a, _b;
|
|
2713
2959
|
const adjustedParams = {};
|
|
2714
2960
|
const _params = { markNotificationsAsSeenReqBody: camelCaseToSnakeCaseKeys(params) };
|
|
2715
2961
|
Object.assign(adjustedParams, _params);
|
|
2962
|
+
adjustedParams['authorization'] = (_b = (_a = this.config.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) === null || _b === void 0 ? void 0 : _b['authorization'];
|
|
2716
2963
|
const response = await this.apis.notificationsApi.markNotificationsAsSeen(adjustedParams);
|
|
2717
2964
|
return response.data;
|
|
2718
2965
|
}
|
|
@@ -2725,7 +2972,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2725
2972
|
* @param {string} params.owner - Ethereum address of the one who is creating the token
|
|
2726
2973
|
* @param {string} params.symbol - Symbol/Ticker for the token
|
|
2727
2974
|
* @param {string} params.name - Name of the token
|
|
2728
|
-
* @param {File} params.metadataMedia [optional] - Media file associated with the token. Supported formats are image/jpeg, image/gif and image/png
|
|
2975
|
+
* @param {File | null} params.metadataMedia [optional] - Media file associated with the token. Supported formats are image/jpeg, image/gif and image/png
|
|
2729
2976
|
* @param {string} params.metadataDescription [optional] - Description of the token
|
|
2730
2977
|
* @param {DeployFungibleMetadataNsfwEnum} params.metadataNsfw [optional] - Indicates if the token is NSFW (Not Safe For Work).
|
|
2731
2978
|
* @param {string} params.metadataWebsiteLink [optional] - Website link related to the token
|
|
@@ -2767,13 +3014,13 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2767
3014
|
return response.data;
|
|
2768
3015
|
}
|
|
2769
3016
|
/**
|
|
2770
|
-
* Fetch a list of relevant owners for a
|
|
3017
|
+
* 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\".
|
|
2771
3018
|
*
|
|
2772
3019
|
* @summary Relevant owners
|
|
2773
3020
|
*
|
|
2774
3021
|
* @param {object} params
|
|
2775
3022
|
* @param {string} params.contractAddress - Contract address of the fungible asset
|
|
2776
|
-
* @param {
|
|
3023
|
+
* @param {FetchRelevantFungibleOwnersNetworkEnum} params.network - Network of the fungible asset.
|
|
2777
3024
|
* @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.
|
|
2778
3025
|
*
|
|
2779
3026
|
* @returns {Promise<RelevantFungibleOwnersResponse>} A promise that resolves to a `RelevantFungibleOwnersResponse` object.
|
|
@@ -2805,7 +3052,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2805
3052
|
*
|
|
2806
3053
|
* @param {object} params
|
|
2807
3054
|
* @param {number} params.fid - FID of the user to fetch
|
|
2808
|
-
* @param {Array<
|
|
3055
|
+
* @param {Array<FetchUserBalanceNetworksEnum>} params.networks - Comma separated list of networks to fetch balances for
|
|
2809
3056
|
*
|
|
2810
3057
|
* @returns {Promise<BalanceResponse>} A promise that resolves to a `BalanceResponse` object.
|
|
2811
3058
|
*
|
|
@@ -2829,29 +3076,59 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2829
3076
|
return response.data;
|
|
2830
3077
|
}
|
|
2831
3078
|
/**
|
|
2832
|
-
*
|
|
3079
|
+
* 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.
|
|
3080
|
+
*
|
|
3081
|
+
* @summary Mint NFT(s)
|
|
3082
|
+
*
|
|
3083
|
+
* @param {object} params
|
|
3084
|
+
* @param {MintNftRequest} params.mintNftRequest
|
|
3085
|
+
*
|
|
3086
|
+
* @returns {Promise<MintNft200Response>} A promise that resolves to a `MintNft200Response` object.
|
|
3087
|
+
*
|
|
3088
|
+
* @example
|
|
3089
|
+
*
|
|
3090
|
+
* // Fill in the appropriate values
|
|
3091
|
+
* const mintNftRequest =
|
|
3092
|
+
*
|
|
3093
|
+
* client.mintNft({ mintNftRequest }).then(response => {
|
|
3094
|
+
* console.log('response:', response);
|
|
3095
|
+
* });
|
|
3096
|
+
*
|
|
3097
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/mint-nft)
|
|
3098
|
+
*
|
|
3099
|
+
*/
|
|
3100
|
+
async mintNft(params) {
|
|
3101
|
+
var _a, _b;
|
|
3102
|
+
const adjustedParams = {};
|
|
3103
|
+
Object.assign(adjustedParams, params);
|
|
3104
|
+
adjustedParams['xWalletId'] = (_b = (_a = this.config.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) === null || _b === void 0 ? void 0 : _b['x-wallet-id'];
|
|
3105
|
+
const response = await this.apis.onchainApi.mintNft(adjustedParams);
|
|
3106
|
+
return response.data;
|
|
3107
|
+
}
|
|
3108
|
+
/**
|
|
3109
|
+
* 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
|
|
2833
3110
|
*
|
|
2834
3111
|
* @summary Register Farcaster account onchain
|
|
2835
3112
|
*
|
|
2836
3113
|
* @param {object} params
|
|
3114
|
+
* @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.
|
|
3115
|
+
* @param {Array<RegisterUserOnChainReqBodyPreRegistrationCallsInner>} params.preRegistrationCalls [optional]
|
|
2837
3116
|
* @param {RegisterUserOnChainReqBodyRegistration} params.registration
|
|
2838
3117
|
* @param {number} params.storageUnits [optional]
|
|
2839
3118
|
* @param {Array<RegisterUserOnChainReqBodySignersInner>} params.signers [optional]
|
|
2840
|
-
* @param {Array<RegisterUserOnChainReqBodyPreRegistrationCallsInner>} params.preRegistrationCalls [optional]
|
|
2841
|
-
* @param {string} params.idem [optional]
|
|
2842
3119
|
*
|
|
2843
3120
|
* @returns {Promise<RegisterUserOnChainResponse>} A promise that resolves to a `RegisterUserOnChainResponse` object.
|
|
2844
3121
|
*
|
|
2845
3122
|
* @example
|
|
2846
3123
|
*
|
|
2847
3124
|
* // Fill in the appropriate values
|
|
3125
|
+
* const idem =
|
|
3126
|
+
* const preRegistrationCalls =
|
|
2848
3127
|
* const registration =
|
|
2849
3128
|
* const storageUnits =
|
|
2850
3129
|
* const signers =
|
|
2851
|
-
* const preRegistrationCalls =
|
|
2852
|
-
* const idem =
|
|
2853
3130
|
*
|
|
2854
|
-
* client.registerAccountOnchain({
|
|
3131
|
+
* client.registerAccountOnchain({idem, preRegistrationCalls, registration, storageUnits, signers}).then(response => {
|
|
2855
3132
|
* console.log('response:', response);
|
|
2856
3133
|
* });
|
|
2857
3134
|
*
|
|
@@ -2871,18 +3148,20 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2871
3148
|
* @summary Send fungibles
|
|
2872
3149
|
*
|
|
2873
3150
|
* @param {object} params
|
|
2874
|
-
* @param {
|
|
2875
|
-
* @param {
|
|
3151
|
+
* @param {TransactionSendFungiblesReqBodyNetworkEnum} params.network
|
|
3152
|
+
* @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.
|
|
3153
|
+
* @param {Array<TransactionSendFungiblesRecipient>} params.recipients
|
|
2876
3154
|
*
|
|
2877
3155
|
* @returns {Promise<TransactionSendFungiblesResponse>} A promise that resolves to a `TransactionSendFungiblesResponse` object.
|
|
2878
3156
|
*
|
|
2879
3157
|
* @example
|
|
2880
3158
|
*
|
|
2881
3159
|
* // Fill in the appropriate values
|
|
2882
|
-
* const
|
|
2883
|
-
* const
|
|
3160
|
+
* const network =
|
|
3161
|
+
* const fungibleContractAddress =
|
|
3162
|
+
* const recipients =
|
|
2884
3163
|
*
|
|
2885
|
-
* client.sendFungiblesToUsers({
|
|
3164
|
+
* client.sendFungiblesToUsers({network, fungibleContractAddress, recipients}).then(response => {
|
|
2886
3165
|
* console.log('response:', response);
|
|
2887
3166
|
* });
|
|
2888
3167
|
*
|
|
@@ -2890,13 +3169,48 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2890
3169
|
*
|
|
2891
3170
|
*/
|
|
2892
3171
|
async sendFungiblesToUsers(params) {
|
|
3172
|
+
var _a, _b;
|
|
2893
3173
|
const adjustedParams = {};
|
|
2894
|
-
|
|
3174
|
+
const _params = { transactionSendFungiblesReqBody: camelCaseToSnakeCaseKeys(params) };
|
|
3175
|
+
Object.assign(adjustedParams, _params);
|
|
3176
|
+
adjustedParams['xWalletId'] = (_b = (_a = this.config.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) === null || _b === void 0 ? void 0 : _b['x-wallet-id'];
|
|
2895
3177
|
const response = await this.apis.onchainApi.sendFungiblesToUsers(adjustedParams);
|
|
2896
3178
|
return response.data;
|
|
2897
3179
|
}
|
|
2898
3180
|
/**
|
|
2899
|
-
*
|
|
3181
|
+
* Simulates mint calldata for the given recipients, contract, and network. Useful for previewing calldata and ABI before minting.
|
|
3182
|
+
*
|
|
3183
|
+
* @summary Simulate NFT mint calldata
|
|
3184
|
+
*
|
|
3185
|
+
* @param {object} params
|
|
3186
|
+
* @param {string} params.recipients - JSON array of recipients (same structure as POST).
|
|
3187
|
+
* @param {string} params.nftContractAddress - Ethereum address
|
|
3188
|
+
* @param {SimulateNftMintNetworkEnum} params.network - Network to mint on.
|
|
3189
|
+
*
|
|
3190
|
+
* @returns {Promise<SimulateNftMintResponse>} A promise that resolves to a `SimulateNftMintResponse` object.
|
|
3191
|
+
*
|
|
3192
|
+
* @example
|
|
3193
|
+
*
|
|
3194
|
+
* // Fill in the appropriate values
|
|
3195
|
+
* const recipients =
|
|
3196
|
+
* const nftContractAddress =
|
|
3197
|
+
* const network =
|
|
3198
|
+
*
|
|
3199
|
+
* client.simulateNftMint({ recipients, nftContractAddress, network }).then(response => {
|
|
3200
|
+
* console.log('response:', response);
|
|
3201
|
+
* });
|
|
3202
|
+
*
|
|
3203
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/simulate-nft-mint)
|
|
3204
|
+
*
|
|
3205
|
+
*/
|
|
3206
|
+
async simulateNftMint(params) {
|
|
3207
|
+
const adjustedParams = {};
|
|
3208
|
+
Object.assign(adjustedParams, params);
|
|
3209
|
+
const response = await this.apis.onchainApi.simulateNftMint(adjustedParams);
|
|
3210
|
+
return response.data;
|
|
3211
|
+
}
|
|
3212
|
+
/**
|
|
3213
|
+
* Delete a reaction (like or recast) to a cast (In order to delete a reaction `signer_uuid` must be approved)
|
|
2900
3214
|
*
|
|
2901
3215
|
* @summary Delete reaction
|
|
2902
3216
|
*
|
|
@@ -2904,7 +3218,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2904
3218
|
* @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.
|
|
2905
3219
|
* @param {ReactionType} params.reactionType
|
|
2906
3220
|
* @param {string} params.target - Target cast hash (hex string starting with 0x) OR a valid URL.
|
|
2907
|
-
* @param {number} params.targetAuthorFid [optional] - The unique identifier of a farcaster user (unsigned integer)
|
|
3221
|
+
* @param {number} params.targetAuthorFid [optional] - The unique identifier of a farcaster user or app (unsigned integer)
|
|
2908
3222
|
* @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.
|
|
2909
3223
|
*
|
|
2910
3224
|
* @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
|
|
@@ -2939,7 +3253,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2939
3253
|
*
|
|
2940
3254
|
* @param {object} params
|
|
2941
3255
|
* @param {string} params.hash
|
|
2942
|
-
* @param {Array<
|
|
3256
|
+
* @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.
|
|
2943
3257
|
* @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`.
|
|
2944
3258
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 25, Maximum: 100)
|
|
2945
3259
|
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
@@ -2973,8 +3287,8 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2973
3287
|
* @summary Reactions for user
|
|
2974
3288
|
*
|
|
2975
3289
|
* @param {object} params
|
|
2976
|
-
* @param {number} params.fid
|
|
2977
|
-
* @param {
|
|
3290
|
+
* @param {number} params.fid - The unique identifier of a farcaster user or app (unsigned integer)
|
|
3291
|
+
* @param {FetchUserReactionsTypeEnum} params.type - Type of reaction to fetch (likes or recasts or all)
|
|
2978
3292
|
* @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`.
|
|
2979
3293
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 25, Maximum: 100)
|
|
2980
3294
|
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
@@ -3003,7 +3317,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
3003
3317
|
return response.data;
|
|
3004
3318
|
}
|
|
3005
3319
|
/**
|
|
3006
|
-
* Post a reaction (like or recast) to a given cast
|
|
3320
|
+
* Post a reaction (like or recast) to a given cast (In order to post a reaction `signer_uuid` must be approved)
|
|
3007
3321
|
*
|
|
3008
3322
|
* @summary Post a reaction
|
|
3009
3323
|
*
|
|
@@ -3011,7 +3325,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
3011
3325
|
* @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.
|
|
3012
3326
|
* @param {ReactionType} params.reactionType
|
|
3013
3327
|
* @param {string} params.target - Target cast hash (hex string starting with 0x) OR a valid URL.
|
|
3014
|
-
* @param {number} params.targetAuthorFid [optional] - The unique identifier of a farcaster user (unsigned integer)
|
|
3328
|
+
* @param {number} params.targetAuthorFid [optional] - The unique identifier of a farcaster user or app (unsigned integer)
|
|
3015
3329
|
* @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.
|
|
3016
3330
|
*
|
|
3017
3331
|
* @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
|
|
@@ -3040,7 +3354,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
3040
3354
|
return response.data;
|
|
3041
3355
|
}
|
|
3042
3356
|
/**
|
|
3043
|
-
* Creates a signer and returns the signer status.
|
|
3357
|
+
* Creates a signer and returns the signer status. **Note**: While tesing please reuse the signer, it costs money to approve a signer.
|
|
3044
3358
|
*
|
|
3045
3359
|
* @summary Create signer
|
|
3046
3360
|
*
|
|
@@ -3067,7 +3381,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
3067
3381
|
*
|
|
3068
3382
|
* @param {object} params
|
|
3069
3383
|
* @param {string} params.clientId
|
|
3070
|
-
* @param {
|
|
3384
|
+
* @param {FetchAuthorizationUrlResponseTypeEnum} params.responseType
|
|
3071
3385
|
*
|
|
3072
3386
|
* @returns {Promise<AuthorizationUrlResponse>} A promise that resolves to a `AuthorizationUrlResponse` object.
|
|
3073
3387
|
*
|
|
@@ -3096,7 +3410,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
3096
3410
|
* @summary List signers
|
|
3097
3411
|
*
|
|
3098
3412
|
* @param {object} params
|
|
3099
|
-
* @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.
|
|
3413
|
+
* @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.
|
|
3100
3414
|
* @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.
|
|
3101
3415
|
*
|
|
3102
3416
|
* @returns {Promise<SignerListResponse>} A promise that resolves to a `SignerListResponse` object.
|
|
@@ -3126,7 +3440,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
3126
3440
|
* @summary Status by public key
|
|
3127
3441
|
*
|
|
3128
3442
|
* @param {object} params
|
|
3129
|
-
* @param {string} params.publicKey
|
|
3443
|
+
* @param {string} params.publicKey - Ed25519 public key
|
|
3130
3444
|
*
|
|
3131
3445
|
* @returns {Promise<DeveloperManagedSigner>} A promise that resolves to a `DeveloperManagedSigner` object.
|
|
3132
3446
|
*
|
|
@@ -3154,7 +3468,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
3154
3468
|
* @summary Status
|
|
3155
3469
|
*
|
|
3156
3470
|
* @param {object} params
|
|
3157
|
-
* @param {string} params.signerUuid
|
|
3471
|
+
* @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.
|
|
3158
3472
|
*
|
|
3159
3473
|
* @returns {Promise<Signer>} A promise that resolves to a `Signer` object.
|
|
3160
3474
|
*
|
|
@@ -3211,10 +3525,10 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
3211
3525
|
*
|
|
3212
3526
|
* @param {object} params
|
|
3213
3527
|
* @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.
|
|
3214
|
-
* @param {string} params.signature - Signature generated by the custody address of the app. Signed data includes app_fid, deadline, signer
|
|
3215
|
-
* @param {number} params.appFid - The unique identifier of a farcaster user (unsigned integer)
|
|
3528
|
+
* @param {string} params.signature - Signature generated by the custody address of the app. Signed data includes app_fid, deadline, signer's public key
|
|
3529
|
+
* @param {number} params.appFid - The unique identifier of a farcaster user or app (unsigned integer)
|
|
3216
3530
|
* @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)
|
|
3217
|
-
* @param {string} params.redirectUrl [optional] - Url to redirect to after the signer is approved.
|
|
3531
|
+
* @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.
|
|
3218
3532
|
* @param {SignedKeyRequestSponsor} params.sponsor [optional]
|
|
3219
3533
|
*
|
|
3220
3534
|
* @returns {Promise<Signer>} A promise that resolves to a `Signer` object.
|
|
@@ -3250,10 +3564,10 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
3250
3564
|
*
|
|
3251
3565
|
* @param {object} params
|
|
3252
3566
|
* @param {string} params.publicKey - Ed25519 public key
|
|
3253
|
-
* @param {string} params.signature - Signature generated by the custody address of the app. Signed data includes app_fid, deadline, signer
|
|
3254
|
-
* @param {number} params.appFid - The unique identifier of a farcaster user (unsigned integer)
|
|
3567
|
+
* @param {string} params.signature - Signature generated by the custody address of the app. Signed data includes app_fid, deadline, signer's public key
|
|
3568
|
+
* @param {number} params.appFid - The unique identifier of a farcaster user or app (unsigned integer)
|
|
3255
3569
|
* @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)
|
|
3256
|
-
* @param {string} params.redirectUrl [optional] - Url to redirect to after the signer is approved.
|
|
3570
|
+
* @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.
|
|
3257
3571
|
* @param {SignedKeyRequestSponsor} params.sponsor [optional]
|
|
3258
3572
|
*
|
|
3259
3573
|
* @returns {Promise<DeveloperManagedSigner>} A promise that resolves to a `DeveloperManagedSigner` object.
|
|
@@ -3321,7 +3635,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
3321
3635
|
* @summary Allocation of user
|
|
3322
3636
|
*
|
|
3323
3637
|
* @param {object} params
|
|
3324
|
-
* @param {number} params.fid
|
|
3638
|
+
* @param {number} params.fid - The unique identifier of a farcaster user or app (unsigned integer)
|
|
3325
3639
|
*
|
|
3326
3640
|
* @returns {Promise<StorageAllocationsResponse>} A promise that resolves to a `StorageAllocationsResponse` object.
|
|
3327
3641
|
*
|
|
@@ -3349,7 +3663,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
3349
3663
|
* @summary Usage of user
|
|
3350
3664
|
*
|
|
3351
3665
|
* @param {object} params
|
|
3352
|
-
* @param {number} params.fid
|
|
3666
|
+
* @param {number} params.fid - The unique identifier of a farcaster user or app (unsigned integer)
|
|
3353
3667
|
*
|
|
3354
3668
|
* @returns {Promise<StorageUsageResponse>} A promise that resolves to a `StorageUsageResponse` object.
|
|
3355
3669
|
*
|
|
@@ -3377,8 +3691,8 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
3377
3691
|
* @summary Subscribed to
|
|
3378
3692
|
*
|
|
3379
3693
|
* @param {object} params
|
|
3380
|
-
* @param {number} params.fid
|
|
3381
|
-
* @param {
|
|
3694
|
+
* @param {number} params.fid - The unique identifier of a farcaster user or app (unsigned integer)
|
|
3695
|
+
* @param {FetchSubscribedToForFidSubscriptionProviderEnum} params.subscriptionProvider - The provider of the subscription.
|
|
3382
3696
|
* @param {number} params.viewerFid [optional]
|
|
3383
3697
|
*
|
|
3384
3698
|
* @returns {Promise<SubscribedToResponse>} A promise that resolves to a `SubscribedToResponse` object.
|
|
@@ -3409,8 +3723,8 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
3409
3723
|
* @summary Subscribers of a user
|
|
3410
3724
|
*
|
|
3411
3725
|
* @param {object} params
|
|
3412
|
-
* @param {number} params.fid
|
|
3413
|
-
* @param {
|
|
3726
|
+
* @param {number} params.fid - The unique identifier of a farcaster user or app (unsigned integer)
|
|
3727
|
+
* @param {FetchSubscribersForFidSubscriptionProviderEnum} params.subscriptionProvider - The provider of the subscription.
|
|
3414
3728
|
* @param {number} params.viewerFid [optional]
|
|
3415
3729
|
*
|
|
3416
3730
|
* @returns {Promise<SubscribersResponse>} A promise that resolves to a `SubscribersResponse` object.
|
|
@@ -3476,8 +3790,8 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
3476
3790
|
* @summary Subscriptions created by FID
|
|
3477
3791
|
*
|
|
3478
3792
|
* @param {object} params
|
|
3479
|
-
* @param {number} params.fid
|
|
3480
|
-
* @param {
|
|
3793
|
+
* @param {number} params.fid - The unique identifier of a farcaster user or app (unsigned integer)
|
|
3794
|
+
* @param {FetchSubscriptionsForFidSubscriptionProviderEnum} params.subscriptionProvider - The provider of the subscription.
|
|
3481
3795
|
*
|
|
3482
3796
|
* @returns {Promise<SubscriptionsResponse>} A promise that resolves to a `SubscriptionsResponse` object.
|
|
3483
3797
|
*
|
|
@@ -3501,7 +3815,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
3501
3815
|
return response.data;
|
|
3502
3816
|
}
|
|
3503
3817
|
/**
|
|
3504
|
-
* Removes verification for an eth address for the user
|
|
3818
|
+
* Removes verification for an eth address for the user (In order to delete verification `signer_uuid` must be approved)
|
|
3505
3819
|
*
|
|
3506
3820
|
* @summary Delete verification
|
|
3507
3821
|
*
|
|
@@ -3509,6 +3823,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
3509
3823
|
* @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.
|
|
3510
3824
|
* @param {string} params.address - Ethereum address
|
|
3511
3825
|
* @param {string} params.blockHash
|
|
3826
|
+
* @param {string} params.ethSignature
|
|
3512
3827
|
*
|
|
3513
3828
|
* @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
|
|
3514
3829
|
*
|
|
@@ -3518,8 +3833,9 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
3518
3833
|
* const signerUuid =
|
|
3519
3834
|
* const address =
|
|
3520
3835
|
* const blockHash =
|
|
3836
|
+
* const ethSignature =
|
|
3521
3837
|
*
|
|
3522
|
-
* client.deleteVerification({signerUuid, address, blockHash}).then(response => {
|
|
3838
|
+
* client.deleteVerification({signerUuid, address, blockHash, ethSignature}).then(response => {
|
|
3523
3839
|
* console.log('response:', response);
|
|
3524
3840
|
* });
|
|
3525
3841
|
*
|
|
@@ -3578,7 +3894,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
3578
3894
|
*
|
|
3579
3895
|
* @param {object} params
|
|
3580
3896
|
* @param {string[]} params.addresses - Comma separated list of Ethereum addresses, up to 350 at a time
|
|
3581
|
-
* @param {Array<
|
|
3897
|
+
* @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.
|
|
3582
3898
|
* @param {number} params.viewerFid [optional]
|
|
3583
3899
|
*
|
|
3584
3900
|
* @returns {Promise<BulkUsersByAddressResponse>} A promise that resolves to a `BulkUsersByAddressResponse` object.
|
|
@@ -3608,74 +3924,14 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
3608
3924
|
const response = await this.apis.userApi.fetchBulkUsersByEthOrSolAddress(adjustedParams);
|
|
3609
3925
|
return response.data;
|
|
3610
3926
|
}
|
|
3611
|
-
/**
|
|
3612
|
-
* Fetches power users based on Warpcast power badges. Information is updated once a day.
|
|
3613
|
-
*
|
|
3614
|
-
* @summary Power users
|
|
3615
|
-
*
|
|
3616
|
-
* @param {object} params
|
|
3617
|
-
* @param {number} params.viewerFid [optional]
|
|
3618
|
-
* @param {number} params.limit [optional] - Number of power users to fetch (Default: 25, Maximum: 100)
|
|
3619
|
-
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
3620
|
-
*
|
|
3621
|
-
* @returns {Promise<UsersResponse>} A promise that resolves to a `UsersResponse` object.
|
|
3622
|
-
*
|
|
3623
|
-
* @example
|
|
3624
|
-
*
|
|
3625
|
-
* // Fill in the appropriate values
|
|
3626
|
-
* const viewerFid =
|
|
3627
|
-
* const limit =
|
|
3628
|
-
*
|
|
3629
|
-
* client.fetchPowerUsers({ viewerFid, limit }).then(response => {
|
|
3630
|
-
* console.log('response:', response);
|
|
3631
|
-
* });
|
|
3632
|
-
*
|
|
3633
|
-
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-power-users)
|
|
3634
|
-
*
|
|
3635
|
-
*/
|
|
3636
|
-
async fetchPowerUsers(params) {
|
|
3637
|
-
var _a, _b;
|
|
3638
|
-
const adjustedParams = {};
|
|
3639
|
-
Object.assign(adjustedParams, params);
|
|
3640
|
-
adjustedParams['xNeynarExperimental'] = (_b = (_a = this.config.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) === null || _b === void 0 ? void 0 : _b['x-neynar-experimental'];
|
|
3641
|
-
const response = await this.apis.userApi.fetchPowerUsers(adjustedParams);
|
|
3642
|
-
return response.data;
|
|
3643
|
-
}
|
|
3644
|
-
/**
|
|
3645
|
-
* Fetches power users and respond in a backwards compatible format to Warpcast\'s deprecated power badge endpoint.
|
|
3646
|
-
*
|
|
3647
|
-
* @summary Power user FIDs
|
|
3648
|
-
*
|
|
3649
|
-
* @param {object} params
|
|
3650
|
-
*
|
|
3651
|
-
* @returns {Promise<UserPowerLiteResponse>} A promise that resolves to a `UserPowerLiteResponse` object.
|
|
3652
|
-
*
|
|
3653
|
-
* @example
|
|
3654
|
-
*
|
|
3655
|
-
* // Fill in the appropriate values
|
|
3656
|
-
*
|
|
3657
|
-
* client.fetchPowerUsersLite().then(response => {
|
|
3658
|
-
* console.log('response:', response);
|
|
3659
|
-
* });
|
|
3660
|
-
*
|
|
3661
|
-
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-power-users-lite)
|
|
3662
|
-
*
|
|
3663
|
-
*/
|
|
3664
|
-
async fetchPowerUsersLite() {
|
|
3665
|
-
var _a, _b;
|
|
3666
|
-
const adjustedParams = {};
|
|
3667
|
-
adjustedParams['xNeynarExperimental'] = (_b = (_a = this.config.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) === null || _b === void 0 ? void 0 : _b['x-neynar-experimental'];
|
|
3668
|
-
const response = await this.apis.userApi.fetchPowerUsersLite(adjustedParams);
|
|
3669
|
-
return response.data;
|
|
3670
|
-
}
|
|
3671
3927
|
/**
|
|
3672
3928
|
* Fetches a list of users given a location
|
|
3673
3929
|
*
|
|
3674
3930
|
* @summary By location
|
|
3675
3931
|
*
|
|
3676
3932
|
* @param {object} params
|
|
3677
|
-
* @param {number} params.latitude - Latitude of the location
|
|
3678
|
-
* @param {number} params.longitude - Longitude of the location
|
|
3933
|
+
* @param {number | null} params.latitude - Latitude of the location
|
|
3934
|
+
* @param {number | null} params.longitude - Longitude of the location
|
|
3679
3935
|
* @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`.
|
|
3680
3936
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 25, Maximum: 100)
|
|
3681
3937
|
* @param {string} params.cursor [optional] - Pagination cursor
|
|
@@ -3706,7 +3962,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
3706
3962
|
return response.data;
|
|
3707
3963
|
}
|
|
3708
3964
|
/**
|
|
3709
|
-
* Follow a user
|
|
3965
|
+
* Follow a user (In order to follow a user `signer_uuid` must be approved)
|
|
3710
3966
|
*
|
|
3711
3967
|
* @summary Follow user
|
|
3712
3968
|
*
|
|
@@ -3763,6 +4019,37 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
3763
4019
|
const response = await this.apis.userApi.getFreshAccountFID(adjustedParams);
|
|
3764
4020
|
return response.data;
|
|
3765
4021
|
}
|
|
4022
|
+
/**
|
|
4023
|
+
* Returns the best friends of a user ranked by mutual affinity score based on interactions with each other.
|
|
4024
|
+
*
|
|
4025
|
+
* @summary Best friends
|
|
4026
|
+
*
|
|
4027
|
+
* @param {object} params
|
|
4028
|
+
* @param {number} params.fid - The FID of the user
|
|
4029
|
+
* @param {number} params.limit [optional] - Number of results to fetch (Default: 3, Maximum: 100)
|
|
4030
|
+
* @param {string} params.cursor [optional] - Pagination cursor
|
|
4031
|
+
*
|
|
4032
|
+
* @returns {Promise<BestFriendsResponse>} A promise that resolves to a `BestFriendsResponse` object.
|
|
4033
|
+
*
|
|
4034
|
+
* @example
|
|
4035
|
+
*
|
|
4036
|
+
* // Fill in the appropriate values
|
|
4037
|
+
* const fid =
|
|
4038
|
+
* const limit =
|
|
4039
|
+
*
|
|
4040
|
+
* client.getUserBestFriends({ fid, limit }).then(response => {
|
|
4041
|
+
* console.log('response:', response);
|
|
4042
|
+
* });
|
|
4043
|
+
*
|
|
4044
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-user-best-friends)
|
|
4045
|
+
*
|
|
4046
|
+
*/
|
|
4047
|
+
async getUserBestFriends(params) {
|
|
4048
|
+
const adjustedParams = {};
|
|
4049
|
+
Object.assign(adjustedParams, params);
|
|
4050
|
+
const response = await this.apis.userApi.getUserBestFriends(adjustedParams);
|
|
4051
|
+
return response.data;
|
|
4052
|
+
}
|
|
3766
4053
|
/**
|
|
3767
4054
|
* Lookup a user by custody-address
|
|
3768
4055
|
*
|
|
@@ -3856,7 +4143,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
3856
4143
|
return response.data;
|
|
3857
4144
|
}
|
|
3858
4145
|
/**
|
|
3859
|
-
* Adds verification for an eth address or contract for the user
|
|
4146
|
+
* Adds verification for an eth address or contract for the user (In order to add verification `signer_uuid` must be approved)
|
|
3860
4147
|
*
|
|
3861
4148
|
* @summary Add verification
|
|
3862
4149
|
*
|
|
@@ -3895,7 +4182,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
3895
4182
|
return response.data;
|
|
3896
4183
|
}
|
|
3897
4184
|
/**
|
|
3898
|
-
* Register account on farcaster.
|
|
4185
|
+
* 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.
|
|
3899
4186
|
*
|
|
3900
4187
|
* @summary Register new account
|
|
3901
4188
|
*
|
|
@@ -3969,7 +4256,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
3969
4256
|
return response.data;
|
|
3970
4257
|
}
|
|
3971
4258
|
/**
|
|
3972
|
-
* Unfollow a user
|
|
4259
|
+
* Unfollow a user (In order to unfollow a user `signer_uuid` must be approved)
|
|
3973
4260
|
*
|
|
3974
4261
|
* @summary Unfollow user
|
|
3975
4262
|
*
|
|
@@ -4000,7 +4287,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
4000
4287
|
return response.data;
|
|
4001
4288
|
}
|
|
4002
4289
|
/**
|
|
4003
|
-
* Update user profile
|
|
4290
|
+
* Update user profile (In order to update user\'s profile `signer_uuid` must be approved)
|
|
4004
4291
|
*
|
|
4005
4292
|
* @summary Update user profile
|
|
4006
4293
|
*
|
|
@@ -4012,6 +4299,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
4012
4299
|
* @param {string} params.username [optional]
|
|
4013
4300
|
* @param {string} params.displayName [optional]
|
|
4014
4301
|
* @param {UpdateUserReqBodyLocation} params.location [optional]
|
|
4302
|
+
* @param {string} params.banner [optional]
|
|
4015
4303
|
* @param {UpdateUserReqBodyVerifiedAccounts} params.verifiedAccounts [optional]
|
|
4016
4304
|
*
|
|
4017
4305
|
* @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
|
|
@@ -4026,9 +4314,10 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
4026
4314
|
* const username =
|
|
4027
4315
|
* const displayName =
|
|
4028
4316
|
* const location =
|
|
4317
|
+
* const banner =
|
|
4029
4318
|
* const verifiedAccounts =
|
|
4030
4319
|
*
|
|
4031
|
-
* client.updateUser({signerUuid, bio, pfpUrl, url, username, displayName, location, verifiedAccounts}).then(response => {
|
|
4320
|
+
* client.updateUser({signerUuid, bio, pfpUrl, url, username, displayName, location, banner, verifiedAccounts}).then(response => {
|
|
4032
4321
|
* console.log('response:', response);
|
|
4033
4322
|
* });
|
|
4034
4323
|
*
|