@neynar/nodejs-sdk 2.46.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 +4 -3
- package/build/api/api.js +4 -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 +51 -20
- package/build/api/apis/agents-api.js +49 -22
- package/build/api/apis/app-host-api.d.ts +71 -32
- package/build/api/apis/app-host-api.js +64 -31
- 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 +272 -103
- package/build/api/apis/cast-api.js +223 -68
- 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 +144 -61
- package/build/api/apis/frame-api.js +127 -51
- 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 +16 -16
- package/build/api/apis/metrics-api.js +11 -11
- 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 +265 -45
- package/build/api/apis/onchain-api.js +253 -38
- 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 +3 -3
- package/build/api/models/app-host-event-type.js +3 -3
- package/build/api/models/app-host-get-event-response-notification-details.d.ts +3 -3
- package/build/api/models/app-host-get-event-response-notification-details.js +3 -3
- package/build/api/models/app-host-get-event-response.d.ts +3 -3
- package/build/api/models/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/{app-host-post-event-body.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/{app-host-post-event-body-one-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/{cast-with-interactions-all-of.js → app-host-post-event-req-body-one-of.js} +3 -3
- package/build/api/models/{app-host-post-event-body-one-of1.d.ts → app-host-post-event-req-body-one-of1.d.ts} +9 -9
- package/build/api/models/{app-host-post-event-body-one-of1.js → app-host-post-event-req-body-one-of1.js} +3 -3
- 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 +3 -3
- package/build/api/models/app-host-post-event-response.js +3 -3
- package/build/api/models/app-host-user-state-response-notifications-enabled-inner.d.ts +3 -3
- package/build/api/models/app-host-user-state-response-notifications-enabled-inner.js +3 -3
- package/build/api/models/app-host-user-state-response.d.ts +3 -3
- package/build/api/models/app-host-user-state-response.js +3 -3
- 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 +3 -3
- 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 +3 -3
- 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 +3 -3
- 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 +3 -3
- 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 +3 -3
- 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 +3 -3
- 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 +3 -3
- 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 +3 -3
- 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 +3 -3
- 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 +11 -11
- package/build/api/models/get-notification-campaign-stats200-response-notification-campaigns-inner-stats.js +3 -3
- package/build/api/models/get-notification-campaign-stats200-response-notification-campaigns-inner.d.ts +8 -8
- package/build/api/models/get-notification-campaign-stats200-response-notification-campaigns-inner.js +3 -3
- package/build/api/models/get-notification-campaign-stats200-response.d.ts +5 -5
- package/build/api/models/get-notification-campaign-stats200-response.js +3 -3
- 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 +33 -59
- package/build/api/models/index.js +33 -59
- package/build/api/models/invite-channel-member-req-body.d.ts +3 -3
- 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 +3 -3
- 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 +3 -3
- 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 +3 -3
- 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 +3 -3
- package/build/api/models/post-cast-req-body.js +3 -3
- package/build/api/models/post-cast-response-cast-author.d.ts +3 -3
- 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 +3 -3
- package/build/api/models/reaction-like.js +3 -3
- package/build/api/models/reaction-recast.d.ts +3 -3
- package/build/api/models/reaction-recast.js +3 -3
- package/build/api/models/reaction-req-body.d.ts +3 -3
- 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 +5 -5
- 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 +5 -5
- 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 +3 -3
- package/build/api/models/relevant-fungible-owners-response.js +3 -3
- package/build/api/models/remove-channel-member-req-body.d.ts +3 -3
- 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 +4 -4
- 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 +3 -3
- 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 +3 -3
- package/build/api/models/transaction-send-fungibles-receipt.js +3 -3
- package/build/api/models/transaction-send-fungibles-recipient.d.ts +3 -3
- 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 +3 -3
- 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 +17 -10
- 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 +403 -246
- package/build/clients/NeynarAPIClient.js +374 -194
- 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/app-host-post-event-body-one-of.d.ts +0 -30
- package/build/api/models/app-host-post-event-body.d.ts +0 -19
- 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-all-of.js +0 -15
- 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-all-of.js +0 -15
- package/build/api/models/cast-with-interactions-and-conversations-ref.d.ts +0 -19
- package/build/api/models/cast-with-interactions-and-conversations-ref.js +0 -15
- 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
|
@@ -33,6 +33,7 @@ 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
35
|
const app_host_api_1 = require("../api/apis/app-host-api");
|
|
36
|
+
const auth_address_api_1 = require("../api/apis/auth-address-api");
|
|
36
37
|
const ban_api_1 = require("../api/apis/ban-api");
|
|
37
38
|
const block_api_1 = require("../api/apis/block-api");
|
|
38
39
|
const cast_api_1 = require("../api/apis/cast-api");
|
|
@@ -142,6 +143,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
142
143
|
actionApi: new action_api_1.ActionApi(this.config, undefined, axiosInstance),
|
|
143
144
|
agentsApi: new agents_api_1.AgentsApi(this.config, undefined, axiosInstance),
|
|
144
145
|
appHostApi: new app_host_api_1.AppHostApi(this.config, undefined, axiosInstance),
|
|
146
|
+
authAddressApi: new auth_address_api_1.AuthAddressApi(this.config, undefined, axiosInstance),
|
|
145
147
|
banApi: new ban_api_1.BanApi(this.config, undefined, axiosInstance),
|
|
146
148
|
blockApi: new block_api_1.BlockApi(this.config, undefined, axiosInstance),
|
|
147
149
|
castApi: new cast_api_1.CastApi(this.config, undefined, axiosInstance),
|
|
@@ -192,7 +194,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
192
194
|
* console.log('response:', response);
|
|
193
195
|
* });
|
|
194
196
|
*
|
|
195
|
-
* 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)
|
|
196
198
|
*
|
|
197
199
|
*/
|
|
198
200
|
async publishFarcasterAction(params) {
|
|
@@ -208,22 +210,30 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
208
210
|
* @summary Create transaction pay mini app
|
|
209
211
|
*
|
|
210
212
|
* @param {object} params
|
|
211
|
-
* @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.
|
|
212
216
|
*
|
|
213
217
|
* @returns {Promise<TransactionFrameResponse>} A promise that resolves to a `TransactionFrameResponse` object.
|
|
214
218
|
*
|
|
215
219
|
* @example
|
|
216
220
|
*
|
|
217
221
|
* // Fill in the appropriate values
|
|
218
|
-
* const
|
|
222
|
+
* const transaction =
|
|
223
|
+
* const config =
|
|
224
|
+
* const idem =
|
|
219
225
|
*
|
|
220
|
-
* client.createTransactionPayFrame({
|
|
226
|
+
* client.createTransactionPayFrame({transaction, config, idem}).then(response => {
|
|
221
227
|
* console.log('response:', response);
|
|
222
228
|
* });
|
|
229
|
+
*
|
|
230
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/create-transaction-pay-frame)
|
|
231
|
+
*
|
|
223
232
|
*/
|
|
224
233
|
async createTransactionPayFrame(params) {
|
|
225
234
|
const adjustedParams = {};
|
|
226
|
-
|
|
235
|
+
const _params = { framePayTransactionReqBody: camelCaseToSnakeCaseKeys(params) };
|
|
236
|
+
Object.assign(adjustedParams, _params);
|
|
227
237
|
const response = await this.apis.agentsApi.createTransactionPayFrame(adjustedParams);
|
|
228
238
|
return response.data;
|
|
229
239
|
}
|
|
@@ -234,7 +244,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
234
244
|
*
|
|
235
245
|
* @param {object} params
|
|
236
246
|
* @param {number[]} params.fids - Comma separated list of two FIDs
|
|
237
|
-
* @param {Array<
|
|
247
|
+
* @param {Array<FetchUserInteractionsTypeEnum>} params.type [optional] - Comma seperated list of Interaction type to fetch
|
|
238
248
|
*
|
|
239
249
|
* @returns {Promise<FetchUserInteractions200Response>} A promise that resolves to a `FetchUserInteractions200Response` object.
|
|
240
250
|
*
|
|
@@ -247,6 +257,9 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
247
257
|
* client.fetchUserInteractions({ fids, type }).then(response => {
|
|
248
258
|
* console.log('response:', response);
|
|
249
259
|
* });
|
|
260
|
+
*
|
|
261
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-user-interactions)
|
|
262
|
+
*
|
|
250
263
|
*/
|
|
251
264
|
async fetchUserInteractions(params) {
|
|
252
265
|
const adjustedParams = {};
|
|
@@ -266,7 +279,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
266
279
|
* @summary Cast conversation summary
|
|
267
280
|
*
|
|
268
281
|
* @param {object} params
|
|
269
|
-
* @param {string} params.identifier - Cast identifier (
|
|
282
|
+
* @param {string} params.identifier - Cast identifier (It's either a URL or a hash))
|
|
270
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)
|
|
271
284
|
* @param {string} params.prompt [optional] - Additional prompt used to generate a summary
|
|
272
285
|
*
|
|
@@ -295,12 +308,12 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
295
308
|
/**
|
|
296
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.
|
|
297
310
|
*
|
|
298
|
-
* @summary
|
|
311
|
+
* @summary Generate event
|
|
299
312
|
*
|
|
300
313
|
* @param {object} params
|
|
301
314
|
* @param {string} params.appDomain - The domain of the mini app
|
|
302
315
|
* @param {number} params.fid - The FID of the user who initiated the event
|
|
303
|
-
* @param {
|
|
316
|
+
* @param {AppHostGetEventEventEnum} params.event - The type of event
|
|
304
317
|
*
|
|
305
318
|
* @returns {Promise<AppHostGetEventResponse>} A promise that resolves to a `AppHostGetEventResponse` object.
|
|
306
319
|
*
|
|
@@ -314,6 +327,9 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
314
327
|
* client.appHostGetEvent({ appDomain, fid, event }).then(response => {
|
|
315
328
|
* console.log('response:', response);
|
|
316
329
|
* });
|
|
330
|
+
*
|
|
331
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/app-host-get-event)
|
|
332
|
+
*
|
|
317
333
|
*/
|
|
318
334
|
async appHostGetEvent(params) {
|
|
319
335
|
const adjustedParams = {};
|
|
@@ -324,7 +340,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
324
340
|
/**
|
|
325
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.
|
|
326
342
|
*
|
|
327
|
-
* @summary
|
|
343
|
+
* @summary Enabled notifications
|
|
328
344
|
*
|
|
329
345
|
* @param {object} params
|
|
330
346
|
* @param {number} params.fid - The FID of the user
|
|
@@ -339,6 +355,9 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
339
355
|
* client.appHostGetUserState({ fid }).then(response => {
|
|
340
356
|
* console.log('response:', response);
|
|
341
357
|
* });
|
|
358
|
+
*
|
|
359
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/app-host-get-user-state)
|
|
360
|
+
*
|
|
342
361
|
*/
|
|
343
362
|
async appHostGetUserState(params) {
|
|
344
363
|
const adjustedParams = {};
|
|
@@ -349,28 +368,99 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
349
368
|
/**
|
|
350
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.
|
|
351
370
|
*
|
|
352
|
-
* @summary
|
|
371
|
+
* @summary Send event
|
|
353
372
|
*
|
|
354
373
|
* @param {object} params
|
|
355
|
-
* @param {
|
|
374
|
+
* @param {any} params.appHostPostEventReqBody
|
|
356
375
|
*
|
|
357
376
|
* @returns {Promise<AppHostPostEventResponse>} A promise that resolves to a `AppHostPostEventResponse` object.
|
|
358
377
|
*
|
|
359
378
|
* @example
|
|
360
379
|
*
|
|
361
380
|
* // Fill in the appropriate values
|
|
362
|
-
* const
|
|
381
|
+
* const appHostPostEventReqBody =
|
|
363
382
|
*
|
|
364
|
-
* client.appHostPostEvent({
|
|
383
|
+
* client.appHostPostEvent({appHostPostEventReqBody}).then(response => {
|
|
365
384
|
* console.log('response:', response);
|
|
366
385
|
* });
|
|
386
|
+
*
|
|
387
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/app-host-post-event)
|
|
388
|
+
*
|
|
367
389
|
*/
|
|
368
390
|
async appHostPostEvent(params) {
|
|
369
391
|
const adjustedParams = {};
|
|
370
|
-
|
|
392
|
+
const _params = { appHostPostEventReqBody: camelCaseToSnakeCaseKeys(params) };
|
|
393
|
+
Object.assign(adjustedParams, _params);
|
|
371
394
|
const response = await this.apis.appHostApi.appHostPostEvent(adjustedParams);
|
|
372
395
|
return response.data;
|
|
373
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
|
+
}
|
|
374
464
|
/**
|
|
375
465
|
* Deletes a list of FIDs from the app associated with your API key.
|
|
376
466
|
*
|
|
@@ -558,13 +648,13 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
558
648
|
return response.data;
|
|
559
649
|
}
|
|
560
650
|
/**
|
|
561
|
-
* Delete an existing cast.
|
|
651
|
+
* Delete an existing cast. (In order to delete a cast `signer_uuid` must be approved)
|
|
562
652
|
*
|
|
563
653
|
* @summary Delete a cast
|
|
564
654
|
*
|
|
565
655
|
* @param {object} params
|
|
566
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.
|
|
567
|
-
* @param {string} params.targetHash
|
|
657
|
+
* @param {string} params.targetHash
|
|
568
658
|
*
|
|
569
659
|
* @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
|
|
570
660
|
*
|
|
@@ -625,13 +715,50 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
625
715
|
const response = await this.apis.castApi.fetchBulkCasts(adjustedParams);
|
|
626
716
|
return response.data;
|
|
627
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
|
+
}
|
|
628
755
|
/**
|
|
629
756
|
* Fetches all composer actions on Warpcast. You can filter by top or featured.
|
|
630
757
|
*
|
|
631
758
|
* @summary Fetch composer actions
|
|
632
759
|
*
|
|
633
760
|
* @param {object} params
|
|
634
|
-
* @param {
|
|
761
|
+
* @param {FetchComposerActionsListEnum} params.list - Type of list to fetch.
|
|
635
762
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 25, Maximum: 25)
|
|
636
763
|
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
637
764
|
*
|
|
@@ -690,8 +817,8 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
690
817
|
* @summary By hash or URL
|
|
691
818
|
*
|
|
692
819
|
* @param {object} params
|
|
693
|
-
* @param {
|
|
694
|
-
* @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
|
|
695
822
|
* @param {number} params.viewerFid [optional] - adds viewer_context to cast object to show whether viewer has liked or recasted the cast.
|
|
696
823
|
*
|
|
697
824
|
* @returns {Promise<CastResponse>} A promise that resolves to a `CastResponse` object.
|
|
@@ -724,12 +851,12 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
724
851
|
* @summary Conversation for a cast
|
|
725
852
|
*
|
|
726
853
|
* @param {object} params
|
|
727
|
-
* @param {string} params.identifier - Cast identifier (
|
|
728
|
-
* @param {
|
|
729
|
-
* @param {number} params.replyDepth [optional] - The depth of replies in the conversation that will be returned (default 2)
|
|
730
|
-
* @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
|
|
731
858
|
* @param {number} params.viewerFid [optional] - Providing this will return a conversation that respects this user's mutes and blocks and includes `viewer_context`.
|
|
732
|
-
* @param {
|
|
859
|
+
* @param {LookupCastConversationSortTypeEnum} params.sortType [optional] - Sort type for the ordering of descendants. Default is `chron`
|
|
733
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.
|
|
734
861
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 20, Maximum: 50)
|
|
735
862
|
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
@@ -812,12 +939,11 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
812
939
|
* @param {object} params
|
|
813
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`) |
|
|
814
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
|
|
815
|
-
* @param {
|
|
942
|
+
* @param {SearchCastsSortTypeEnum} params.sortType [optional] - Choices are: - `desc_chron` - All casts sorted by time (default) - `algorithmic` - Casts sorted by engagement and time
|
|
816
943
|
* @param {number} params.authorFid [optional] - Fid of the user whose casts you want to search
|
|
817
944
|
* @param {number} params.viewerFid [optional] - Providing this will return search results that respects this user's mutes and blocks and includes `viewer_context`.
|
|
818
945
|
* @param {string} params.parentUrl [optional] - Parent URL of the casts you want to search
|
|
819
946
|
* @param {string} params.channelId [optional] - Channel ID of the casts you want to search
|
|
820
|
-
* @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).
|
|
821
947
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 25, Maximum: 100)
|
|
822
948
|
* @param {string} params.cursor [optional] - Pagination cursor
|
|
823
949
|
*
|
|
@@ -833,10 +959,9 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
833
959
|
* const viewerFid =
|
|
834
960
|
* const parentUrl =
|
|
835
961
|
* const channelId =
|
|
836
|
-
* const priorityMode =
|
|
837
962
|
* const limit =
|
|
838
963
|
*
|
|
839
|
-
* client.searchCasts({ q, mode, sortType, authorFid, viewerFid, parentUrl, channelId,
|
|
964
|
+
* client.searchCasts({ q, mode, sortType, authorFid, viewerFid, parentUrl, channelId, limit }).then(response => {
|
|
840
965
|
* console.log('response:', response);
|
|
841
966
|
* });
|
|
842
967
|
*
|
|
@@ -887,7 +1012,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
887
1012
|
*
|
|
888
1013
|
* @param {object} params
|
|
889
1014
|
* @param {string[]} params.ids - Comma separated list of channel IDs or parent_urls, up to 100 at a time
|
|
890
|
-
* @param {
|
|
1015
|
+
* @param {FetchBulkChannelsTypeEnum} params.type [optional] - Type of identifier being used to query the channels. Defaults to ID.
|
|
891
1016
|
* @param {number} params.viewerFid [optional] - FID of the user viewing the channels.
|
|
892
1017
|
*
|
|
893
1018
|
* @returns {Promise<ChannelResponseBulk>} A promise that resolves to a `ChannelResponseBulk` object.
|
|
@@ -1247,7 +1372,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
1247
1372
|
*
|
|
1248
1373
|
* @param {object} params
|
|
1249
1374
|
* @param {string} params.id - Channel ID for the channel being queried
|
|
1250
|
-
* @param {
|
|
1375
|
+
* @param {LookupChannelTypeEnum} params.type [optional] - Type of identifier being used to query the channel. Defaults to ID.
|
|
1251
1376
|
* @param {number} params.viewerFid [optional] - FID of the user viewing the channel.
|
|
1252
1377
|
*
|
|
1253
1378
|
* @returns {Promise<ChannelResponse>} A promise that resolves to a `ChannelResponse` object.
|
|
@@ -1415,7 +1540,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
1415
1540
|
* @param {number} params.viewerFid [optional] - FID of the user viewing the feed
|
|
1416
1541
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 25, Maximum: 150)
|
|
1417
1542
|
* @param {string} params.cursor [optional] - Pagination cursor
|
|
1418
|
-
* @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
|
|
1419
1544
|
* @param {string} params.parentUrl [optional] - Parent URL to filter the feed; mutually exclusive with channel_id
|
|
1420
1545
|
* @param {string} params.channelId [optional] - Channel ID to filter the feed; mutually exclusive with parent_url
|
|
1421
1546
|
*
|
|
@@ -1453,16 +1578,16 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
1453
1578
|
* @summary By filters
|
|
1454
1579
|
*
|
|
1455
1580
|
* @param {object} params
|
|
1456
|
-
* @param {
|
|
1457
|
-
* @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)
|
|
1458
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
|
|
1459
|
-
* @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.
|
|
1460
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.
|
|
1461
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.
|
|
1462
|
-
* @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.
|
|
1463
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.
|
|
1464
|
-
* @param {Array<
|
|
1465
|
-
* @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
|
|
1466
1591
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 25, Maximum: 100)
|
|
1467
1592
|
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
1468
1593
|
* @param {number} params.viewerFid [optional] - Providing this will return a feed that respects this user's mutes and blocks and includes `viewer_context`.
|
|
@@ -1497,6 +1622,12 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
1497
1622
|
const adjustedParams = {};
|
|
1498
1623
|
Object.assign(adjustedParams, params);
|
|
1499
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
|
+
}
|
|
1500
1631
|
const response = await this.apis.feedApi.fetchFeed(adjustedParams);
|
|
1501
1632
|
return response.data;
|
|
1502
1633
|
}
|
|
@@ -1507,14 +1638,14 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
1507
1638
|
*
|
|
1508
1639
|
* @param {object} params
|
|
1509
1640
|
* @param {string[]} params.channelIds - Comma separated list of up to 10 channel IDs e.g. neynar,farcaster
|
|
1510
|
-
* @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
|
|
1511
1642
|
* @param {number} params.viewerFid [optional] - Providing this will return a feed that respects this user's mutes and blocks and includes `viewer_context`.
|
|
1512
|
-
* @param {boolean} params.withReplies [optional] - Include replies in the response, false by default
|
|
1513
|
-
* @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.
|
|
1514
1645
|
* @param {number[]} params.fids [optional] - Comma separated list of FIDs to filter the feed by, up to 10 at a time
|
|
1515
1646
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 25, Maximum: 100)
|
|
1516
1647
|
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
1517
|
-
* @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.
|
|
1518
1649
|
*
|
|
1519
1650
|
* @returns {Promise<FeedResponse>} A promise that resolves to a `FeedResponse` object.
|
|
1520
1651
|
*
|
|
@@ -1561,9 +1692,9 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
1561
1692
|
*
|
|
1562
1693
|
* @param {object} params
|
|
1563
1694
|
* @param {string[]} params.parentUrls - Comma separated list of parent_urls
|
|
1564
|
-
* @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
|
|
1565
1696
|
* @param {number} params.viewerFid [optional] - Providing this will return a feed that respects this user's mutes and blocks and includes `viewer_context`.
|
|
1566
|
-
* @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
|
|
1567
1698
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 25, Maximum: 100)
|
|
1568
1699
|
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
1569
1700
|
*
|
|
@@ -1604,10 +1735,9 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
1604
1735
|
* @param {object} params
|
|
1605
1736
|
* @param {number} params.fid - FID of user whose feed you want to create
|
|
1606
1737
|
* @param {number} params.viewerFid [optional] - Providing this will return a feed that respects this user's mutes and blocks and includes `viewer_context`.
|
|
1607
|
-
* @param {
|
|
1738
|
+
* @param {FetchFeedForYouProviderEnum} params.provider [optional] - The provider of the For You feed.
|
|
1608
1739
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 25, Maximum: 50)
|
|
1609
1740
|
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
1610
|
-
* @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.
|
|
1611
1741
|
*
|
|
1612
1742
|
* @returns {Promise<FeedResponse>} A promise that resolves to a `FeedResponse` object.
|
|
1613
1743
|
*
|
|
@@ -1618,9 +1748,8 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
1618
1748
|
* const viewerFid =
|
|
1619
1749
|
* const provider =
|
|
1620
1750
|
* const limit =
|
|
1621
|
-
* const providerMetadata =
|
|
1622
1751
|
*
|
|
1623
|
-
* client.fetchFeedForYou({ fid, viewerFid, provider, limit
|
|
1752
|
+
* client.fetchFeedForYou({ fid, viewerFid, provider, limit }).then(response => {
|
|
1624
1753
|
* console.log('response:', response);
|
|
1625
1754
|
* });
|
|
1626
1755
|
*
|
|
@@ -1705,7 +1834,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
1705
1834
|
*
|
|
1706
1835
|
* @param {object} params
|
|
1707
1836
|
* @param {number} params.fid - FID of user whose replies and recasts you want to fetch
|
|
1708
|
-
* @param {FetchRepliesAndRecastsForUserFilterEnum} params.filter [optional] -
|
|
1837
|
+
* @param {FetchRepliesAndRecastsForUserFilterEnum} params.filter [optional] - Filter to fetch only replies or recasts
|
|
1709
1838
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 25, Maximum: 50)
|
|
1710
1839
|
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
1711
1840
|
* @param {number} params.viewerFid [optional] - Providing this will return a feed that respects this user's mutes and blocks and includes `viewer_context`.
|
|
@@ -1745,7 +1874,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
1745
1874
|
* @param {FetchTrendingFeedTimeWindowEnum} params.timeWindow [optional] - Time window for trending casts (7d window for channel feeds only)
|
|
1746
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.
|
|
1747
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.
|
|
1748
|
-
* @param {
|
|
1877
|
+
* @param {FetchTrendingFeedProviderEnum} params.provider [optional] - The provider of the trending casts feed.
|
|
1749
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.
|
|
1750
1879
|
*
|
|
1751
1880
|
* @returns {Promise<FeedResponse>} A promise that resolves to a `FeedResponse` object.
|
|
@@ -1784,7 +1913,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
1784
1913
|
* @param {object} params
|
|
1785
1914
|
* @param {number} params.fid - FID of user whose feed you want to create
|
|
1786
1915
|
* @param {number} params.viewerFid [optional] - Providing this will return a feed that respects this user's mutes and blocks and includes `viewer_context`.
|
|
1787
|
-
* @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
|
|
1788
1917
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 25, Maximum: 100)
|
|
1789
1918
|
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
1790
1919
|
*
|
|
@@ -1847,8 +1976,8 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
1847
1976
|
* @summary Suggest Follows
|
|
1848
1977
|
*
|
|
1849
1978
|
* @param {object} params
|
|
1850
|
-
* @param {number} params.fid - FID of the user whose following you want to fetch.
|
|
1851
|
-
* @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`.
|
|
1852
1981
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 25, Maximum: 100)
|
|
1853
1982
|
*
|
|
1854
1983
|
* @returns {Promise<UsersResponse>} A promise that resolves to a `UsersResponse` object.
|
|
@@ -1915,7 +2044,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
1915
2044
|
* @param {object} params
|
|
1916
2045
|
* @param {number} params.fid - User who's profile you are looking at
|
|
1917
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`.
|
|
1918
|
-
* @param {
|
|
2047
|
+
* @param {FetchUserFollowersSortTypeEnum} params.sortType [optional] - Sort type for fetch followers. Default is `desc_chron`
|
|
1919
2048
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 20, Maximum: 100)
|
|
1920
2049
|
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
1921
2050
|
*
|
|
@@ -1952,7 +2081,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
1952
2081
|
* @param {object} params
|
|
1953
2082
|
* @param {number} params.fid - FID of the user whose following you want to fetch.
|
|
1954
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`.
|
|
1955
|
-
* @param {
|
|
2084
|
+
* @param {FetchUserFollowingSortTypeEnum} params.sortType [optional] - Optional parameter to sort the users based on different criteria.
|
|
1956
2085
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 25, Maximum: 100)
|
|
1957
2086
|
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
1958
2087
|
*
|
|
@@ -2018,8 +2147,8 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2018
2147
|
* @param {object} params
|
|
2019
2148
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 100, Maximum: 100)
|
|
2020
2149
|
* @param {string} params.cursor [optional] - Pagination cursor
|
|
2021
|
-
* @param {
|
|
2022
|
-
* @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
|
|
2023
2152
|
*
|
|
2024
2153
|
* @returns {Promise<FrameCatalogResponse>} A promise that resolves to a `FrameCatalogResponse` object.
|
|
2025
2154
|
*
|
|
@@ -2033,6 +2162,9 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2033
2162
|
* client.fetchFrameCatalog({ limit, timeWindow, categories }).then(response => {
|
|
2034
2163
|
* console.log('response:', response);
|
|
2035
2164
|
* });
|
|
2165
|
+
*
|
|
2166
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-frame-catalog)
|
|
2167
|
+
*
|
|
2036
2168
|
*/
|
|
2037
2169
|
async fetchFrameCatalog(params) {
|
|
2038
2170
|
const adjustedParams = {};
|
|
@@ -2133,7 +2265,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2133
2265
|
*
|
|
2134
2266
|
* @param {object} params
|
|
2135
2267
|
* @param {number} params.viewerFid - FID of the user to fetch relevant mini apps for
|
|
2136
|
-
* @param {
|
|
2268
|
+
* @param {FetchRelevantFramesTimeWindowEnum} params.timeWindow [optional] - Time window used to limit statistics used to calculate mini app relevance
|
|
2137
2269
|
*
|
|
2138
2270
|
* @returns {Promise<FetchRelevantFrames200Response>} A promise that resolves to a `FetchRelevantFrames200Response` object.
|
|
2139
2271
|
*
|
|
@@ -2147,7 +2279,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2147
2279
|
* console.log('response:', response);
|
|
2148
2280
|
* });
|
|
2149
2281
|
*
|
|
2150
|
-
* 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)
|
|
2151
2283
|
*
|
|
2152
2284
|
*/
|
|
2153
2285
|
async fetchRelevantFrames(params) {
|
|
@@ -2162,11 +2294,11 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2162
2294
|
* @summary Analytics for the mini app
|
|
2163
2295
|
*
|
|
2164
2296
|
* @param {object} params
|
|
2165
|
-
* @param {string} params.frameUrl
|
|
2166
|
-
* @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
|
|
2167
2299
|
* @param {string} params.start
|
|
2168
2300
|
* @param {string} params.stop
|
|
2169
|
-
* @param {
|
|
2301
|
+
* @param {FetchValidateFrameAnalyticsAggregateWindowEnum} params.aggregateWindow [optional] - Required for `analytics_type=interactions-per-cast`
|
|
2170
2302
|
*
|
|
2171
2303
|
* @returns {Promise<FrameValidateAnalyticsResponse>} A promise that resolves to a `FrameValidateAnalyticsResponse` object.
|
|
2172
2304
|
*
|
|
@@ -2220,7 +2352,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2220
2352
|
*
|
|
2221
2353
|
* @param {object} params
|
|
2222
2354
|
* @param {string} params.campaignId [optional] - An ID of a specific notification campaign to query
|
|
2223
|
-
* @param {number} params.limit [optional] - The number of results to return (Default: 100,
|
|
2355
|
+
* @param {number} params.limit [optional] - The number of results to return (Default: 100, Maximum: 1000)
|
|
2224
2356
|
* @param {string} params.cursor [optional] - Pagination cursor
|
|
2225
2357
|
*
|
|
2226
2358
|
* @returns {Promise<GetNotificationCampaignStats200Response>} A promise that resolves to a `GetNotificationCampaignStats200Response` object.
|
|
@@ -2234,6 +2366,9 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2234
2366
|
* client.getNotificationCampaignStats({ campaignId, limit }).then(response => {
|
|
2235
2367
|
* console.log('response:', response);
|
|
2236
2368
|
* });
|
|
2369
|
+
*
|
|
2370
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-notification-campaign-stats)
|
|
2371
|
+
*
|
|
2237
2372
|
*/
|
|
2238
2373
|
async getNotificationCampaignStats(params) {
|
|
2239
2374
|
const adjustedParams = {};
|
|
@@ -2259,6 +2394,9 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2259
2394
|
* client.getTransactionPayFrame({ id }).then(response => {
|
|
2260
2395
|
* console.log('response:', response);
|
|
2261
2396
|
* });
|
|
2397
|
+
*
|
|
2398
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-transaction-pay-frame)
|
|
2399
|
+
*
|
|
2262
2400
|
*/
|
|
2263
2401
|
async getTransactionPayFrame(params) {
|
|
2264
2402
|
const adjustedParams = {};
|
|
@@ -2272,7 +2410,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2272
2410
|
* @summary Mini app by UUID or URL
|
|
2273
2411
|
*
|
|
2274
2412
|
* @param {object} params
|
|
2275
|
-
* @param {
|
|
2413
|
+
* @param {LookupNeynarFrameTypeEnum} params.type - Type of identifier (either 'uuid' or 'url')
|
|
2276
2414
|
* @param {string} params.uuid [optional] - UUID of the mini app to fetch
|
|
2277
2415
|
* @param {string} params.url [optional] - URL of the Neynar mini app to fetch
|
|
2278
2416
|
*
|
|
@@ -2299,13 +2437,13 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2299
2437
|
return response.data;
|
|
2300
2438
|
}
|
|
2301
2439
|
/**
|
|
2302
|
-
* 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.
|
|
2303
2441
|
*
|
|
2304
2442
|
* @summary Post a mini app action, cast action or a cast composer action
|
|
2305
2443
|
*
|
|
2306
2444
|
* @param {object} params
|
|
2307
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.
|
|
2308
|
-
* @param {string} params.castHash [optional]
|
|
2446
|
+
* @param {string} params.castHash [optional]
|
|
2309
2447
|
* @param {FrameAction} params.action
|
|
2310
2448
|
*
|
|
2311
2449
|
* @returns {Promise<Frame>} A promise that resolves to a `Frame` object.
|
|
@@ -2337,7 +2475,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2337
2475
|
* @summary Signature packet
|
|
2338
2476
|
*
|
|
2339
2477
|
* @param {object} params
|
|
2340
|
-
* @param {string} params.castHash [optional]
|
|
2478
|
+
* @param {string} params.castHash [optional]
|
|
2341
2479
|
* @param {FrameAction} params.action
|
|
2342
2480
|
* @param {FrameSignaturePacket} params.signaturePacket
|
|
2343
2481
|
*
|
|
@@ -2371,8 +2509,8 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2371
2509
|
*
|
|
2372
2510
|
* @param {object} params
|
|
2373
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.
|
|
2374
|
-
* @param {SendFrameNotificationsReqBodyNotification} params.notification
|
|
2375
2512
|
* @param {SendFrameNotificationsReqBodyFilters} params.filters [optional]
|
|
2513
|
+
* @param {SendFrameNotificationsReqBodyNotification} params.notification
|
|
2376
2514
|
*
|
|
2377
2515
|
* @returns {Promise<SendFrameNotificationsResponse>} A promise that resolves to a `SendFrameNotificationsResponse` object.
|
|
2378
2516
|
*
|
|
@@ -2380,10 +2518,10 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2380
2518
|
*
|
|
2381
2519
|
* // Fill in the appropriate values
|
|
2382
2520
|
* const targetFids =
|
|
2383
|
-
* const notification =
|
|
2384
2521
|
* const filters =
|
|
2522
|
+
* const notification =
|
|
2385
2523
|
*
|
|
2386
|
-
* client.publishFrameNotifications({targetFids,
|
|
2524
|
+
* client.publishFrameNotifications({targetFids, filters, notification}).then(response => {
|
|
2387
2525
|
* console.log('response:', response);
|
|
2388
2526
|
* });
|
|
2389
2527
|
*
|
|
@@ -2493,7 +2631,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2493
2631
|
return response.data;
|
|
2494
2632
|
}
|
|
2495
2633
|
/**
|
|
2496
|
-
* 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)
|
|
2497
2635
|
*
|
|
2498
2636
|
* @summary Validate mini app action
|
|
2499
2637
|
*
|
|
@@ -2688,8 +2826,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2688
2826
|
*
|
|
2689
2827
|
* @param {object} params
|
|
2690
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.
|
|
2691
|
-
* @param {Array<
|
|
2692
|
-
* @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.
|
|
2693
2830
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 15, Maximum: 25)
|
|
2694
2831
|
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
2695
2832
|
*
|
|
@@ -2700,10 +2837,9 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2700
2837
|
* // Fill in the appropriate values
|
|
2701
2838
|
* const fid =
|
|
2702
2839
|
* const type =
|
|
2703
|
-
* const priorityMode =
|
|
2704
2840
|
* const limit =
|
|
2705
2841
|
*
|
|
2706
|
-
* client.fetchAllNotifications({ fid, type,
|
|
2842
|
+
* client.fetchAllNotifications({ fid, type, limit }).then(response => {
|
|
2707
2843
|
* console.log('response:', response);
|
|
2708
2844
|
* });
|
|
2709
2845
|
*
|
|
@@ -2711,8 +2847,10 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2711
2847
|
*
|
|
2712
2848
|
*/
|
|
2713
2849
|
async fetchAllNotifications(params) {
|
|
2850
|
+
var _a, _b;
|
|
2714
2851
|
const adjustedParams = {};
|
|
2715
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'];
|
|
2716
2854
|
const response = await this.apis.notificationsApi.fetchAllNotifications(adjustedParams);
|
|
2717
2855
|
return response.data;
|
|
2718
2856
|
}
|
|
@@ -2724,7 +2862,6 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2724
2862
|
* @param {object} params
|
|
2725
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.
|
|
2726
2864
|
* @param {string[]} params.channelIds - Comma separated channel_ids (find list of all channels here - https://docs.neynar.com/reference/list-all-channels)
|
|
2727
|
-
* @param {boolean} params.priorityMode [optional] - When true, only returns notifications from power badge users and users that the user follows.
|
|
2728
2865
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 15, Maximum: 25)
|
|
2729
2866
|
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
2730
2867
|
*
|
|
@@ -2735,10 +2872,9 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2735
2872
|
* // Fill in the appropriate values
|
|
2736
2873
|
* const fid =
|
|
2737
2874
|
* const channelIds =
|
|
2738
|
-
* const priorityMode =
|
|
2739
2875
|
* const limit =
|
|
2740
2876
|
*
|
|
2741
|
-
* client.fetchChannelNotificationsForUser({ fid, channelIds,
|
|
2877
|
+
* client.fetchChannelNotificationsForUser({ fid, channelIds, limit }).then(response => {
|
|
2742
2878
|
* console.log('response:', response);
|
|
2743
2879
|
* });
|
|
2744
2880
|
*
|
|
@@ -2746,8 +2882,10 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2746
2882
|
*
|
|
2747
2883
|
*/
|
|
2748
2884
|
async fetchChannelNotificationsForUser(params) {
|
|
2885
|
+
var _a, _b;
|
|
2749
2886
|
const adjustedParams = {};
|
|
2750
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'];
|
|
2751
2889
|
if (adjustedParams.channelIds && Array.isArray(adjustedParams.channelIds)) {
|
|
2752
2890
|
adjustedParams.channelIds = adjustedParams.channelIds.join(",");
|
|
2753
2891
|
}
|
|
@@ -2762,7 +2900,6 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2762
2900
|
* @param {object} params
|
|
2763
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.
|
|
2764
2902
|
* @param {string[]} params.parentUrls - Comma separated parent_urls
|
|
2765
|
-
* @param {boolean} params.priorityMode [optional] - When true, only returns notifications from power badge users and users that the user follows.
|
|
2766
2903
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 15, Maximum: 25)
|
|
2767
2904
|
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
2768
2905
|
*
|
|
@@ -2773,10 +2910,9 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2773
2910
|
* // Fill in the appropriate values
|
|
2774
2911
|
* const fid =
|
|
2775
2912
|
* const parentUrls =
|
|
2776
|
-
* const priorityMode =
|
|
2777
2913
|
* const limit =
|
|
2778
2914
|
*
|
|
2779
|
-
* client.fetchNotificationsByParentUrlForUser({ fid, parentUrls,
|
|
2915
|
+
* client.fetchNotificationsByParentUrlForUser({ fid, parentUrls, limit }).then(response => {
|
|
2780
2916
|
* console.log('response:', response);
|
|
2781
2917
|
* });
|
|
2782
2918
|
*
|
|
@@ -2784,8 +2920,10 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2784
2920
|
*
|
|
2785
2921
|
*/
|
|
2786
2922
|
async fetchNotificationsByParentUrlForUser(params) {
|
|
2923
|
+
var _a, _b;
|
|
2787
2924
|
const adjustedParams = {};
|
|
2788
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'];
|
|
2789
2927
|
if (adjustedParams.parentUrls && Array.isArray(adjustedParams.parentUrls)) {
|
|
2790
2928
|
adjustedParams.parentUrls = adjustedParams.parentUrls.join(",");
|
|
2791
2929
|
}
|
|
@@ -2800,7 +2938,6 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2800
2938
|
* @param {object} params
|
|
2801
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.
|
|
2802
2940
|
* @param {NotificationType} params.type [optional]
|
|
2803
|
-
* @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).
|
|
2804
2941
|
*
|
|
2805
2942
|
* @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
|
|
2806
2943
|
*
|
|
@@ -2809,9 +2946,8 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2809
2946
|
* // Fill in the appropriate values
|
|
2810
2947
|
* const signerUuid =
|
|
2811
2948
|
* const type =
|
|
2812
|
-
* const authorization =
|
|
2813
2949
|
*
|
|
2814
|
-
* client.markNotificationsAsSeen({signerUuid, type
|
|
2950
|
+
* client.markNotificationsAsSeen({signerUuid, type}).then(response => {
|
|
2815
2951
|
* console.log('response:', response);
|
|
2816
2952
|
* });
|
|
2817
2953
|
*
|
|
@@ -2819,14 +2955,16 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2819
2955
|
*
|
|
2820
2956
|
*/
|
|
2821
2957
|
async markNotificationsAsSeen(params) {
|
|
2958
|
+
var _a, _b;
|
|
2822
2959
|
const adjustedParams = {};
|
|
2823
2960
|
const _params = { markNotificationsAsSeenReqBody: camelCaseToSnakeCaseKeys(params) };
|
|
2824
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'];
|
|
2825
2963
|
const response = await this.apis.notificationsApi.markNotificationsAsSeen(adjustedParams);
|
|
2826
2964
|
return response.data;
|
|
2827
2965
|
}
|
|
2828
2966
|
/**
|
|
2829
|
-
* Creates a new token.
|
|
2967
|
+
* Creates a new token. This is an allowlisted API, reach out if you want access.
|
|
2830
2968
|
*
|
|
2831
2969
|
* @summary Deploy fungible
|
|
2832
2970
|
*
|
|
@@ -2834,7 +2972,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2834
2972
|
* @param {string} params.owner - Ethereum address of the one who is creating the token
|
|
2835
2973
|
* @param {string} params.symbol - Symbol/Ticker for the token
|
|
2836
2974
|
* @param {string} params.name - Name of the token
|
|
2837
|
-
* @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
|
|
2838
2976
|
* @param {string} params.metadataDescription [optional] - Description of the token
|
|
2839
2977
|
* @param {DeployFungibleMetadataNsfwEnum} params.metadataNsfw [optional] - Indicates if the token is NSFW (Not Safe For Work).
|
|
2840
2978
|
* @param {string} params.metadataWebsiteLink [optional] - Website link related to the token
|
|
@@ -2876,13 +3014,13 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2876
3014
|
return response.data;
|
|
2877
3015
|
}
|
|
2878
3016
|
/**
|
|
2879
|
-
* 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\".
|
|
2880
3018
|
*
|
|
2881
3019
|
* @summary Relevant owners
|
|
2882
3020
|
*
|
|
2883
3021
|
* @param {object} params
|
|
2884
3022
|
* @param {string} params.contractAddress - Contract address of the fungible asset
|
|
2885
|
-
* @param {
|
|
3023
|
+
* @param {FetchRelevantFungibleOwnersNetworkEnum} params.network - Network of the fungible asset.
|
|
2886
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.
|
|
2887
3025
|
*
|
|
2888
3026
|
* @returns {Promise<RelevantFungibleOwnersResponse>} A promise that resolves to a `RelevantFungibleOwnersResponse` object.
|
|
@@ -2914,7 +3052,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2914
3052
|
*
|
|
2915
3053
|
* @param {object} params
|
|
2916
3054
|
* @param {number} params.fid - FID of the user to fetch
|
|
2917
|
-
* @param {Array<
|
|
3055
|
+
* @param {Array<FetchUserBalanceNetworksEnum>} params.networks - Comma separated list of networks to fetch balances for
|
|
2918
3056
|
*
|
|
2919
3057
|
* @returns {Promise<BalanceResponse>} A promise that resolves to a `BalanceResponse` object.
|
|
2920
3058
|
*
|
|
@@ -2938,29 +3076,59 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2938
3076
|
return response.data;
|
|
2939
3077
|
}
|
|
2940
3078
|
/**
|
|
2941
|
-
*
|
|
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
|
|
2942
3110
|
*
|
|
2943
3111
|
* @summary Register Farcaster account onchain
|
|
2944
3112
|
*
|
|
2945
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]
|
|
2946
3116
|
* @param {RegisterUserOnChainReqBodyRegistration} params.registration
|
|
2947
3117
|
* @param {number} params.storageUnits [optional]
|
|
2948
3118
|
* @param {Array<RegisterUserOnChainReqBodySignersInner>} params.signers [optional]
|
|
2949
|
-
* @param {Array<RegisterUserOnChainReqBodyPreRegistrationCallsInner>} params.preRegistrationCalls [optional]
|
|
2950
|
-
* @param {string} params.idem [optional]
|
|
2951
3119
|
*
|
|
2952
3120
|
* @returns {Promise<RegisterUserOnChainResponse>} A promise that resolves to a `RegisterUserOnChainResponse` object.
|
|
2953
3121
|
*
|
|
2954
3122
|
* @example
|
|
2955
3123
|
*
|
|
2956
3124
|
* // Fill in the appropriate values
|
|
3125
|
+
* const idem =
|
|
3126
|
+
* const preRegistrationCalls =
|
|
2957
3127
|
* const registration =
|
|
2958
3128
|
* const storageUnits =
|
|
2959
3129
|
* const signers =
|
|
2960
|
-
* const preRegistrationCalls =
|
|
2961
|
-
* const idem =
|
|
2962
3130
|
*
|
|
2963
|
-
* client.registerAccountOnchain({
|
|
3131
|
+
* client.registerAccountOnchain({idem, preRegistrationCalls, registration, storageUnits, signers}).then(response => {
|
|
2964
3132
|
* console.log('response:', response);
|
|
2965
3133
|
* });
|
|
2966
3134
|
*
|
|
@@ -2980,18 +3148,20 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2980
3148
|
* @summary Send fungibles
|
|
2981
3149
|
*
|
|
2982
3150
|
* @param {object} params
|
|
2983
|
-
* @param {
|
|
2984
|
-
* @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
|
|
2985
3154
|
*
|
|
2986
3155
|
* @returns {Promise<TransactionSendFungiblesResponse>} A promise that resolves to a `TransactionSendFungiblesResponse` object.
|
|
2987
3156
|
*
|
|
2988
3157
|
* @example
|
|
2989
3158
|
*
|
|
2990
3159
|
* // Fill in the appropriate values
|
|
2991
|
-
* const
|
|
2992
|
-
* const
|
|
3160
|
+
* const network =
|
|
3161
|
+
* const fungibleContractAddress =
|
|
3162
|
+
* const recipients =
|
|
2993
3163
|
*
|
|
2994
|
-
* client.sendFungiblesToUsers({
|
|
3164
|
+
* client.sendFungiblesToUsers({network, fungibleContractAddress, recipients}).then(response => {
|
|
2995
3165
|
* console.log('response:', response);
|
|
2996
3166
|
* });
|
|
2997
3167
|
*
|
|
@@ -2999,13 +3169,48 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
2999
3169
|
*
|
|
3000
3170
|
*/
|
|
3001
3171
|
async sendFungiblesToUsers(params) {
|
|
3172
|
+
var _a, _b;
|
|
3002
3173
|
const adjustedParams = {};
|
|
3003
|
-
|
|
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'];
|
|
3004
3177
|
const response = await this.apis.onchainApi.sendFungiblesToUsers(adjustedParams);
|
|
3005
3178
|
return response.data;
|
|
3006
3179
|
}
|
|
3007
3180
|
/**
|
|
3008
|
-
*
|
|
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)
|
|
3009
3214
|
*
|
|
3010
3215
|
* @summary Delete reaction
|
|
3011
3216
|
*
|
|
@@ -3048,7 +3253,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
3048
3253
|
*
|
|
3049
3254
|
* @param {object} params
|
|
3050
3255
|
* @param {string} params.hash
|
|
3051
|
-
* @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.
|
|
3052
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`.
|
|
3053
3258
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 25, Maximum: 100)
|
|
3054
3259
|
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
@@ -3082,8 +3287,8 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
3082
3287
|
* @summary Reactions for user
|
|
3083
3288
|
*
|
|
3084
3289
|
* @param {object} params
|
|
3085
|
-
* @param {number} params.fid
|
|
3086
|
-
* @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)
|
|
3087
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`.
|
|
3088
3293
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 25, Maximum: 100)
|
|
3089
3294
|
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
@@ -3112,7 +3317,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
3112
3317
|
return response.data;
|
|
3113
3318
|
}
|
|
3114
3319
|
/**
|
|
3115
|
-
* 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)
|
|
3116
3321
|
*
|
|
3117
3322
|
* @summary Post a reaction
|
|
3118
3323
|
*
|
|
@@ -3149,7 +3354,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
3149
3354
|
return response.data;
|
|
3150
3355
|
}
|
|
3151
3356
|
/**
|
|
3152
|
-
* 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.
|
|
3153
3358
|
*
|
|
3154
3359
|
* @summary Create signer
|
|
3155
3360
|
*
|
|
@@ -3176,7 +3381,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
3176
3381
|
*
|
|
3177
3382
|
* @param {object} params
|
|
3178
3383
|
* @param {string} params.clientId
|
|
3179
|
-
* @param {
|
|
3384
|
+
* @param {FetchAuthorizationUrlResponseTypeEnum} params.responseType
|
|
3180
3385
|
*
|
|
3181
3386
|
* @returns {Promise<AuthorizationUrlResponse>} A promise that resolves to a `AuthorizationUrlResponse` object.
|
|
3182
3387
|
*
|
|
@@ -3205,7 +3410,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
3205
3410
|
* @summary List signers
|
|
3206
3411
|
*
|
|
3207
3412
|
* @param {object} params
|
|
3208
|
-
* @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.
|
|
3209
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.
|
|
3210
3415
|
*
|
|
3211
3416
|
* @returns {Promise<SignerListResponse>} A promise that resolves to a `SignerListResponse` object.
|
|
@@ -3235,7 +3440,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
3235
3440
|
* @summary Status by public key
|
|
3236
3441
|
*
|
|
3237
3442
|
* @param {object} params
|
|
3238
|
-
* @param {string} params.publicKey
|
|
3443
|
+
* @param {string} params.publicKey - Ed25519 public key
|
|
3239
3444
|
*
|
|
3240
3445
|
* @returns {Promise<DeveloperManagedSigner>} A promise that resolves to a `DeveloperManagedSigner` object.
|
|
3241
3446
|
*
|
|
@@ -3263,7 +3468,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
3263
3468
|
* @summary Status
|
|
3264
3469
|
*
|
|
3265
3470
|
* @param {object} params
|
|
3266
|
-
* @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.
|
|
3267
3472
|
*
|
|
3268
3473
|
* @returns {Promise<Signer>} A promise that resolves to a `Signer` object.
|
|
3269
3474
|
*
|
|
@@ -3320,10 +3525,10 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
3320
3525
|
*
|
|
3321
3526
|
* @param {object} params
|
|
3322
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.
|
|
3323
|
-
* @param {string} params.signature - Signature generated by the custody address of the app. Signed data includes app_fid, deadline, signer
|
|
3528
|
+
* @param {string} params.signature - Signature generated by the custody address of the app. Signed data includes app_fid, deadline, signer's public key
|
|
3324
3529
|
* @param {number} params.appFid - The unique identifier of a farcaster user or app (unsigned integer)
|
|
3325
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)
|
|
3326
|
-
* @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.
|
|
3327
3532
|
* @param {SignedKeyRequestSponsor} params.sponsor [optional]
|
|
3328
3533
|
*
|
|
3329
3534
|
* @returns {Promise<Signer>} A promise that resolves to a `Signer` object.
|
|
@@ -3359,10 +3564,10 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
3359
3564
|
*
|
|
3360
3565
|
* @param {object} params
|
|
3361
3566
|
* @param {string} params.publicKey - Ed25519 public key
|
|
3362
|
-
* @param {string} params.signature - Signature generated by the custody address of the app. Signed data includes app_fid, deadline, signer
|
|
3567
|
+
* @param {string} params.signature - Signature generated by the custody address of the app. Signed data includes app_fid, deadline, signer's public key
|
|
3363
3568
|
* @param {number} params.appFid - The unique identifier of a farcaster user or app (unsigned integer)
|
|
3364
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)
|
|
3365
|
-
* @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.
|
|
3366
3571
|
* @param {SignedKeyRequestSponsor} params.sponsor [optional]
|
|
3367
3572
|
*
|
|
3368
3573
|
* @returns {Promise<DeveloperManagedSigner>} A promise that resolves to a `DeveloperManagedSigner` object.
|
|
@@ -3430,7 +3635,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
3430
3635
|
* @summary Allocation of user
|
|
3431
3636
|
*
|
|
3432
3637
|
* @param {object} params
|
|
3433
|
-
* @param {number} params.fid
|
|
3638
|
+
* @param {number} params.fid - The unique identifier of a farcaster user or app (unsigned integer)
|
|
3434
3639
|
*
|
|
3435
3640
|
* @returns {Promise<StorageAllocationsResponse>} A promise that resolves to a `StorageAllocationsResponse` object.
|
|
3436
3641
|
*
|
|
@@ -3458,7 +3663,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
3458
3663
|
* @summary Usage of user
|
|
3459
3664
|
*
|
|
3460
3665
|
* @param {object} params
|
|
3461
|
-
* @param {number} params.fid
|
|
3666
|
+
* @param {number} params.fid - The unique identifier of a farcaster user or app (unsigned integer)
|
|
3462
3667
|
*
|
|
3463
3668
|
* @returns {Promise<StorageUsageResponse>} A promise that resolves to a `StorageUsageResponse` object.
|
|
3464
3669
|
*
|
|
@@ -3486,8 +3691,8 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
3486
3691
|
* @summary Subscribed to
|
|
3487
3692
|
*
|
|
3488
3693
|
* @param {object} params
|
|
3489
|
-
* @param {number} params.fid
|
|
3490
|
-
* @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.
|
|
3491
3696
|
* @param {number} params.viewerFid [optional]
|
|
3492
3697
|
*
|
|
3493
3698
|
* @returns {Promise<SubscribedToResponse>} A promise that resolves to a `SubscribedToResponse` object.
|
|
@@ -3518,8 +3723,8 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
3518
3723
|
* @summary Subscribers of a user
|
|
3519
3724
|
*
|
|
3520
3725
|
* @param {object} params
|
|
3521
|
-
* @param {number} params.fid
|
|
3522
|
-
* @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.
|
|
3523
3728
|
* @param {number} params.viewerFid [optional]
|
|
3524
3729
|
*
|
|
3525
3730
|
* @returns {Promise<SubscribersResponse>} A promise that resolves to a `SubscribersResponse` object.
|
|
@@ -3585,8 +3790,8 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
3585
3790
|
* @summary Subscriptions created by FID
|
|
3586
3791
|
*
|
|
3587
3792
|
* @param {object} params
|
|
3588
|
-
* @param {number} params.fid
|
|
3589
|
-
* @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.
|
|
3590
3795
|
*
|
|
3591
3796
|
* @returns {Promise<SubscriptionsResponse>} A promise that resolves to a `SubscriptionsResponse` object.
|
|
3592
3797
|
*
|
|
@@ -3610,7 +3815,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
3610
3815
|
return response.data;
|
|
3611
3816
|
}
|
|
3612
3817
|
/**
|
|
3613
|
-
* 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)
|
|
3614
3819
|
*
|
|
3615
3820
|
* @summary Delete verification
|
|
3616
3821
|
*
|
|
@@ -3618,6 +3823,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
3618
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.
|
|
3619
3824
|
* @param {string} params.address - Ethereum address
|
|
3620
3825
|
* @param {string} params.blockHash
|
|
3826
|
+
* @param {string} params.ethSignature
|
|
3621
3827
|
*
|
|
3622
3828
|
* @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
|
|
3623
3829
|
*
|
|
@@ -3627,8 +3833,9 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
3627
3833
|
* const signerUuid =
|
|
3628
3834
|
* const address =
|
|
3629
3835
|
* const blockHash =
|
|
3836
|
+
* const ethSignature =
|
|
3630
3837
|
*
|
|
3631
|
-
* client.deleteVerification({signerUuid, address, blockHash}).then(response => {
|
|
3838
|
+
* client.deleteVerification({signerUuid, address, blockHash, ethSignature}).then(response => {
|
|
3632
3839
|
* console.log('response:', response);
|
|
3633
3840
|
* });
|
|
3634
3841
|
*
|
|
@@ -3687,7 +3894,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
3687
3894
|
*
|
|
3688
3895
|
* @param {object} params
|
|
3689
3896
|
* @param {string[]} params.addresses - Comma separated list of Ethereum addresses, up to 350 at a time
|
|
3690
|
-
* @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.
|
|
3691
3898
|
* @param {number} params.viewerFid [optional]
|
|
3692
3899
|
*
|
|
3693
3900
|
* @returns {Promise<BulkUsersByAddressResponse>} A promise that resolves to a `BulkUsersByAddressResponse` object.
|
|
@@ -3717,74 +3924,14 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
3717
3924
|
const response = await this.apis.userApi.fetchBulkUsersByEthOrSolAddress(adjustedParams);
|
|
3718
3925
|
return response.data;
|
|
3719
3926
|
}
|
|
3720
|
-
/**
|
|
3721
|
-
* Fetches power users based on Warpcast power badges. Information is updated once a day.
|
|
3722
|
-
*
|
|
3723
|
-
* @summary Power users
|
|
3724
|
-
*
|
|
3725
|
-
* @param {object} params
|
|
3726
|
-
* @param {number} params.viewerFid [optional]
|
|
3727
|
-
* @param {number} params.limit [optional] - Number of power users to fetch (Default: 25, Maximum: 100)
|
|
3728
|
-
* @param {string} params.cursor [optional] - Pagination cursor.
|
|
3729
|
-
*
|
|
3730
|
-
* @returns {Promise<UsersResponse>} A promise that resolves to a `UsersResponse` object.
|
|
3731
|
-
*
|
|
3732
|
-
* @example
|
|
3733
|
-
*
|
|
3734
|
-
* // Fill in the appropriate values
|
|
3735
|
-
* const viewerFid =
|
|
3736
|
-
* const limit =
|
|
3737
|
-
*
|
|
3738
|
-
* client.fetchPowerUsers({ viewerFid, limit }).then(response => {
|
|
3739
|
-
* console.log('response:', response);
|
|
3740
|
-
* });
|
|
3741
|
-
*
|
|
3742
|
-
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-power-users)
|
|
3743
|
-
*
|
|
3744
|
-
*/
|
|
3745
|
-
async fetchPowerUsers(params) {
|
|
3746
|
-
var _a, _b;
|
|
3747
|
-
const adjustedParams = {};
|
|
3748
|
-
Object.assign(adjustedParams, params);
|
|
3749
|
-
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'];
|
|
3750
|
-
const response = await this.apis.userApi.fetchPowerUsers(adjustedParams);
|
|
3751
|
-
return response.data;
|
|
3752
|
-
}
|
|
3753
|
-
/**
|
|
3754
|
-
* Fetches power users and respond in a backwards compatible format to Warpcast\'s deprecated power badge endpoint.
|
|
3755
|
-
*
|
|
3756
|
-
* @summary Power user FIDs
|
|
3757
|
-
*
|
|
3758
|
-
* @param {object} params
|
|
3759
|
-
*
|
|
3760
|
-
* @returns {Promise<UserPowerLiteResponse>} A promise that resolves to a `UserPowerLiteResponse` object.
|
|
3761
|
-
*
|
|
3762
|
-
* @example
|
|
3763
|
-
*
|
|
3764
|
-
* // Fill in the appropriate values
|
|
3765
|
-
*
|
|
3766
|
-
* client.fetchPowerUsersLite().then(response => {
|
|
3767
|
-
* console.log('response:', response);
|
|
3768
|
-
* });
|
|
3769
|
-
*
|
|
3770
|
-
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-power-users-lite)
|
|
3771
|
-
*
|
|
3772
|
-
*/
|
|
3773
|
-
async fetchPowerUsersLite() {
|
|
3774
|
-
var _a, _b;
|
|
3775
|
-
const adjustedParams = {};
|
|
3776
|
-
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'];
|
|
3777
|
-
const response = await this.apis.userApi.fetchPowerUsersLite(adjustedParams);
|
|
3778
|
-
return response.data;
|
|
3779
|
-
}
|
|
3780
3927
|
/**
|
|
3781
3928
|
* Fetches a list of users given a location
|
|
3782
3929
|
*
|
|
3783
3930
|
* @summary By location
|
|
3784
3931
|
*
|
|
3785
3932
|
* @param {object} params
|
|
3786
|
-
* @param {number} params.latitude - Latitude of the location
|
|
3787
|
-
* @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
|
|
3788
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`.
|
|
3789
3936
|
* @param {number} params.limit [optional] - Number of results to fetch (Default: 25, Maximum: 100)
|
|
3790
3937
|
* @param {string} params.cursor [optional] - Pagination cursor
|
|
@@ -3815,7 +3962,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
3815
3962
|
return response.data;
|
|
3816
3963
|
}
|
|
3817
3964
|
/**
|
|
3818
|
-
* Follow a user
|
|
3965
|
+
* Follow a user (In order to follow a user `signer_uuid` must be approved)
|
|
3819
3966
|
*
|
|
3820
3967
|
* @summary Follow user
|
|
3821
3968
|
*
|
|
@@ -3872,6 +4019,37 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
3872
4019
|
const response = await this.apis.userApi.getFreshAccountFID(adjustedParams);
|
|
3873
4020
|
return response.data;
|
|
3874
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
|
+
}
|
|
3875
4053
|
/**
|
|
3876
4054
|
* Lookup a user by custody-address
|
|
3877
4055
|
*
|
|
@@ -3965,7 +4143,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
3965
4143
|
return response.data;
|
|
3966
4144
|
}
|
|
3967
4145
|
/**
|
|
3968
|
-
* 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)
|
|
3969
4147
|
*
|
|
3970
4148
|
* @summary Add verification
|
|
3971
4149
|
*
|
|
@@ -4004,7 +4182,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
4004
4182
|
return response.data;
|
|
4005
4183
|
}
|
|
4006
4184
|
/**
|
|
4007
|
-
* 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.
|
|
4008
4186
|
*
|
|
4009
4187
|
* @summary Register new account
|
|
4010
4188
|
*
|
|
@@ -4078,7 +4256,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
4078
4256
|
return response.data;
|
|
4079
4257
|
}
|
|
4080
4258
|
/**
|
|
4081
|
-
* Unfollow a user
|
|
4259
|
+
* Unfollow a user (In order to unfollow a user `signer_uuid` must be approved)
|
|
4082
4260
|
*
|
|
4083
4261
|
* @summary Unfollow user
|
|
4084
4262
|
*
|
|
@@ -4109,7 +4287,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
4109
4287
|
return response.data;
|
|
4110
4288
|
}
|
|
4111
4289
|
/**
|
|
4112
|
-
* Update user profile
|
|
4290
|
+
* Update user profile (In order to update user\'s profile `signer_uuid` must be approved)
|
|
4113
4291
|
*
|
|
4114
4292
|
* @summary Update user profile
|
|
4115
4293
|
*
|
|
@@ -4121,6 +4299,7 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
4121
4299
|
* @param {string} params.username [optional]
|
|
4122
4300
|
* @param {string} params.displayName [optional]
|
|
4123
4301
|
* @param {UpdateUserReqBodyLocation} params.location [optional]
|
|
4302
|
+
* @param {string} params.banner [optional]
|
|
4124
4303
|
* @param {UpdateUserReqBodyVerifiedAccounts} params.verifiedAccounts [optional]
|
|
4125
4304
|
*
|
|
4126
4305
|
* @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
|
|
@@ -4135,9 +4314,10 @@ const client = new NeynarAPIClient(config);\n`);
|
|
|
4135
4314
|
* const username =
|
|
4136
4315
|
* const displayName =
|
|
4137
4316
|
* const location =
|
|
4317
|
+
* const banner =
|
|
4138
4318
|
* const verifiedAccounts =
|
|
4139
4319
|
*
|
|
4140
|
-
* 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 => {
|
|
4141
4321
|
* console.log('response:', response);
|
|
4142
4322
|
* });
|
|
4143
4323
|
*
|