@neynar/nodejs-sdk 2.31.0 → 2.33.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 +1 -1
- package/build/api/api.js +1 -1
- package/build/api/apis/action-api.d.ts +1 -1
- package/build/api/apis/action-api.js +1 -1
- package/build/api/apis/agents-api.d.ts +11 -11
- package/build/api/apis/agents-api.js +9 -9
- package/build/api/apis/ban-api.d.ts +1 -1
- package/build/api/apis/ban-api.js +1 -1
- package/build/api/apis/block-api.d.ts +1 -1
- package/build/api/apis/block-api.js +1 -1
- package/build/api/apis/cast-api.d.ts +1 -1
- package/build/api/apis/cast-api.js +1 -1
- package/build/api/apis/channel-api.d.ts +1 -1
- package/build/api/apis/channel-api.js +1 -1
- package/build/api/apis/feed-api.d.ts +11 -11
- package/build/api/apis/feed-api.js +9 -9
- package/build/api/apis/fname-api.d.ts +1 -1
- package/build/api/apis/fname-api.js +1 -1
- package/build/api/apis/follows-api.d.ts +1 -1
- package/build/api/apis/follows-api.js +1 -1
- package/build/api/apis/frame-api.d.ts +172 -162
- package/build/api/apis/frame-api.js +135 -127
- package/build/api/apis/login-api.d.ts +1 -1
- package/build/api/apis/login-api.js +1 -1
- package/build/api/apis/metrics-api.d.ts +1 -1
- package/build/api/apis/metrics-api.js +1 -1
- package/build/api/apis/mute-api.d.ts +1 -1
- package/build/api/apis/mute-api.js +1 -1
- package/build/api/apis/notifications-api.d.ts +1 -1
- package/build/api/apis/notifications-api.js +1 -1
- package/build/api/apis/onchain-api.d.ts +1 -1
- package/build/api/apis/onchain-api.js +1 -1
- package/build/api/apis/reaction-api.d.ts +1 -1
- package/build/api/apis/reaction-api.js +1 -1
- package/build/api/apis/signer-api.d.ts +1 -1
- package/build/api/apis/signer-api.js +1 -1
- package/build/api/apis/storage-api.d.ts +1 -1
- package/build/api/apis/storage-api.js +1 -1
- package/build/api/apis/subscribers-api.d.ts +1 -1
- package/build/api/apis/subscribers-api.js +1 -1
- package/build/api/apis/user-api.d.ts +1 -1
- package/build/api/apis/user-api.js +1 -1
- package/build/api/apis/webhook-api.d.ts +1 -1
- package/build/api/apis/webhook-api.js +1 -1
- package/build/api/base.d.ts +1 -1
- package/build/api/base.js +1 -1
- package/build/api/common.d.ts +1 -1
- package/build/api/common.js +1 -1
- package/build/api/configuration.d.ts +1 -1
- package/build/api/configuration.js +1 -1
- package/build/api/index.d.ts +1 -1
- package/build/api/index.js +1 -1
- package/build/api/models/add-verification-req-body.d.ts +1 -1
- package/build/api/models/add-verification-req-body.js +1 -1
- package/build/api/models/address-balance-verified-address.d.ts +1 -1
- package/build/api/models/address-balance-verified-address.js +1 -1
- package/build/api/models/address-balance.d.ts +1 -1
- package/build/api/models/address-balance.js +1 -1
- package/build/api/models/authorization-url-response-type.d.ts +1 -1
- package/build/api/models/authorization-url-response-type.js +1 -1
- package/build/api/models/authorization-url-response.d.ts +1 -1
- package/build/api/models/authorization-url-response.js +1 -1
- package/build/api/models/balance-response-user-balance.d.ts +1 -1
- package/build/api/models/balance-response-user-balance.js +1 -1
- package/build/api/models/balance-response.d.ts +1 -1
- package/build/api/models/balance-response.js +1 -1
- package/build/api/models/ban-list-response.d.ts +1 -1
- package/build/api/models/ban-list-response.js +1 -1
- package/build/api/models/ban-record.d.ts +1 -1
- package/build/api/models/ban-record.js +1 -1
- package/build/api/models/ban-req-body.d.ts +1 -1
- package/build/api/models/ban-req-body.js +1 -1
- package/build/api/models/ban-response.d.ts +1 -1
- package/build/api/models/ban-response.js +1 -1
- package/build/api/models/block-list-response.d.ts +1 -1
- package/build/api/models/block-list-response.js +1 -1
- package/build/api/models/block-record.d.ts +1 -1
- package/build/api/models/block-record.js +1 -1
- package/build/api/models/block-req-body.d.ts +1 -1
- package/build/api/models/block-req-body.js +1 -1
- package/build/api/models/bulk-casts-response.d.ts +1 -1
- package/build/api/models/bulk-casts-response.js +1 -1
- package/build/api/models/bulk-follow-response.d.ts +1 -1
- package/build/api/models/bulk-follow-response.js +1 -1
- package/build/api/models/bulk-user-address-type.d.ts +1 -1
- package/build/api/models/bulk-user-address-type.js +1 -1
- package/build/api/models/bulk-users-by-address-response.d.ts +1 -1
- package/build/api/models/bulk-users-by-address-response.js +1 -1
- package/build/api/models/bulk-users-response.d.ts +1 -1
- package/build/api/models/bulk-users-response.js +1 -1
- package/build/api/models/buy-storage-req-body.d.ts +1 -1
- package/build/api/models/buy-storage-req-body.js +1 -1
- package/build/api/models/cast-composer-actions-list-response-actions-inner-action.d.ts +1 -1
- package/build/api/models/cast-composer-actions-list-response-actions-inner-action.js +1 -1
- package/build/api/models/cast-composer-actions-list-response-actions-inner.d.ts +1 -1
- package/build/api/models/cast-composer-actions-list-response-actions-inner.js +1 -1
- package/build/api/models/cast-composer-actions-list-response.d.ts +1 -1
- package/build/api/models/cast-composer-actions-list-response.js +1 -1
- package/build/api/models/cast-composer-type.d.ts +1 -1
- package/build/api/models/cast-composer-type.js +1 -1
- package/build/api/models/cast-conversation-sort-type.d.ts +1 -1
- package/build/api/models/cast-conversation-sort-type.js +1 -1
- package/build/api/models/cast-dehydrated.d.ts +1 -1
- package/build/api/models/cast-dehydrated.js +1 -1
- package/build/api/models/cast-embed-crawl-response.d.ts +1 -1
- package/build/api/models/cast-embed-crawl-response.js +1 -1
- package/build/api/models/cast-embedded-parent-author.d.ts +1 -1
- package/build/api/models/cast-embedded-parent-author.js +1 -1
- package/build/api/models/cast-embedded.d.ts +1 -1
- package/build/api/models/cast-embedded.js +1 -1
- package/build/api/models/cast-id.d.ts +1 -1
- package/build/api/models/cast-id.js +1 -1
- package/build/api/models/cast-notification-type.d.ts +1 -1
- package/build/api/models/cast-notification-type.js +1 -1
- package/build/api/models/cast-param-type.d.ts +1 -1
- package/build/api/models/cast-param-type.js +1 -1
- package/build/api/models/cast-response.d.ts +1 -1
- package/build/api/models/cast-response.js +1 -1
- package/build/api/models/cast-viewer-context.d.ts +1 -1
- package/build/api/models/cast-viewer-context.js +1 -1
- package/build/api/models/cast-with-interactions-all-of.d.ts +1 -1
- package/build/api/models/cast-with-interactions-all-of.js +1 -1
- package/build/api/models/cast-with-interactions-and-conversations-all-of.d.ts +1 -1
- package/build/api/models/cast-with-interactions-and-conversations-all-of.js +1 -1
- package/build/api/models/cast-with-interactions-and-conversations-ref-all-of.d.ts +1 -1
- package/build/api/models/cast-with-interactions-and-conversations-ref-all-of.js +1 -1
- package/build/api/models/cast-with-interactions-and-conversations-ref.d.ts +1 -1
- package/build/api/models/cast-with-interactions-and-conversations-ref.js +1 -1
- package/build/api/models/cast-with-interactions-and-conversations.d.ts +1 -1
- package/build/api/models/cast-with-interactions-and-conversations.js +1 -1
- package/build/api/models/cast-with-interactions-reactions.d.ts +1 -1
- package/build/api/models/cast-with-interactions-reactions.js +1 -1
- package/build/api/models/cast-with-interactions-replies.d.ts +1 -1
- package/build/api/models/cast-with-interactions-replies.js +1 -1
- package/build/api/models/cast-with-interactions.d.ts +1 -1
- package/build/api/models/cast-with-interactions.js +1 -1
- package/build/api/models/cast.d.ts +1 -1
- package/build/api/models/cast.js +1 -1
- package/build/api/models/casts-metrics-response.d.ts +1 -1
- package/build/api/models/casts-metrics-response.js +1 -1
- package/build/api/models/casts-metrics.d.ts +1 -1
- package/build/api/models/casts-metrics.js +1 -1
- package/build/api/models/casts-response-result.d.ts +1 -1
- package/build/api/models/casts-response-result.js +1 -1
- package/build/api/models/casts-response.d.ts +1 -1
- package/build/api/models/casts-response.js +1 -1
- package/build/api/models/casts-search-response-result.d.ts +1 -1
- package/build/api/models/casts-search-response-result.js +1 -1
- package/build/api/models/casts-search-response.d.ts +1 -1
- package/build/api/models/casts-search-response.js +1 -1
- package/build/api/models/channel-activity.d.ts +1 -1
- package/build/api/models/channel-activity.js +1 -1
- package/build/api/models/channel-dehydrated.d.ts +1 -1
- package/build/api/models/channel-dehydrated.js +1 -1
- package/build/api/models/channel-external-link.d.ts +1 -1
- package/build/api/models/channel-external-link.js +1 -1
- package/build/api/models/channel-follow-req-body.d.ts +1 -1
- package/build/api/models/channel-follow-req-body.js +1 -1
- package/build/api/models/channel-list-response.d.ts +1 -1
- package/build/api/models/channel-list-response.js +1 -1
- package/build/api/models/channel-member-channel.d.ts +1 -1
- package/build/api/models/channel-member-channel.js +1 -1
- package/build/api/models/channel-member-invite-list-response.d.ts +1 -1
- package/build/api/models/channel-member-invite-list-response.js +1 -1
- package/build/api/models/channel-member-invite.d.ts +1 -1
- package/build/api/models/channel-member-invite.js +1 -1
- package/build/api/models/channel-member-list-response.d.ts +1 -1
- package/build/api/models/channel-member-list-response.js +1 -1
- package/build/api/models/channel-member-role.d.ts +1 -1
- package/build/api/models/channel-member-role.js +1 -1
- package/build/api/models/channel-member-user.d.ts +1 -1
- package/build/api/models/channel-member-user.js +1 -1
- package/build/api/models/channel-member.d.ts +1 -1
- package/build/api/models/channel-member.js +1 -1
- package/build/api/models/channel-or-channel-dehydrated.d.ts +1 -1
- package/build/api/models/channel-or-channel-dehydrated.js +1 -1
- package/build/api/models/channel-response-bulk.d.ts +1 -1
- package/build/api/models/channel-response-bulk.js +1 -1
- package/build/api/models/channel-response.d.ts +1 -1
- package/build/api/models/channel-response.js +1 -1
- package/build/api/models/channel-search-response.d.ts +1 -1
- package/build/api/models/channel-search-response.js +1 -1
- package/build/api/models/channel-type.d.ts +1 -1
- package/build/api/models/channel-type.js +1 -1
- package/build/api/models/channel-user-context.d.ts +1 -1
- package/build/api/models/channel-user-context.js +1 -1
- package/build/api/models/channel.d.ts +1 -1
- package/build/api/models/channel.js +1 -1
- package/build/api/models/conflict-error-res.d.ts +1 -1
- package/build/api/models/conflict-error-res.js +1 -1
- package/build/api/models/conversation-conversation.d.ts +1 -1
- package/build/api/models/conversation-conversation.js +1 -1
- package/build/api/models/conversation-summary-summary.d.ts +1 -1
- package/build/api/models/conversation-summary-summary.js +1 -1
- package/build/api/models/conversation-summary.d.ts +1 -1
- package/build/api/models/conversation-summary.js +1 -1
- package/build/api/models/conversation.d.ts +1 -1
- package/build/api/models/conversation.js +1 -1
- package/build/api/models/delete-cast-req-body.d.ts +1 -1
- package/build/api/models/delete-cast-req-body.js +1 -1
- package/build/api/models/delete-frame-req-body.d.ts +1 -1
- package/build/api/models/delete-frame-req-body.js +1 -1
- package/build/api/models/delete-frame-response.d.ts +1 -1
- package/build/api/models/delete-frame-response.js +1 -1
- package/build/api/models/deploy-fungible-req-body-metadata-media.d.ts +1 -1
- package/build/api/models/deploy-fungible-req-body-metadata-media.js +1 -1
- package/build/api/models/deploy-fungible-response-contract-fungible.d.ts +1 -1
- package/build/api/models/deploy-fungible-response-contract-fungible.js +1 -1
- package/build/api/models/deploy-fungible-response-contract.d.ts +1 -1
- package/build/api/models/deploy-fungible-response-contract.js +1 -1
- package/build/api/models/deploy-fungible-response.d.ts +1 -1
- package/build/api/models/deploy-fungible-response.js +1 -1
- package/build/api/models/developer-managed-signer.d.ts +1 -1
- package/build/api/models/developer-managed-signer.js +1 -1
- package/build/api/models/embed-cast-deep.d.ts +1 -1
- package/build/api/models/embed-cast-deep.js +1 -1
- package/build/api/models/embed-cast.d.ts +1 -1
- package/build/api/models/embed-cast.js +1 -1
- package/build/api/models/embed-deep.d.ts +1 -1
- package/build/api/models/embed-deep.js +1 -1
- package/build/api/models/embed-type.d.ts +1 -1
- package/build/api/models/embed-type.js +1 -1
- package/build/api/models/embed-url-metadata-image.d.ts +1 -1
- package/build/api/models/embed-url-metadata-image.js +1 -1
- package/build/api/models/embed-url-metadata-video-stream-inner.d.ts +1 -1
- package/build/api/models/embed-url-metadata-video-stream-inner.js +1 -1
- package/build/api/models/embed-url-metadata-video.d.ts +1 -1
- package/build/api/models/embed-url-metadata-video.js +1 -1
- package/build/api/models/embed-url-metadata.d.ts +1 -1
- package/build/api/models/embed-url-metadata.js +1 -1
- package/build/api/models/embed-url.d.ts +1 -1
- package/build/api/models/embed-url.js +1 -1
- package/build/api/models/embed.d.ts +1 -1
- package/build/api/models/embed.js +1 -1
- package/build/api/models/error-res.d.ts +1 -1
- package/build/api/models/error-res.js +1 -1
- package/build/api/models/farcaster-action-req-body-action.d.ts +1 -1
- package/build/api/models/farcaster-action-req-body-action.js +1 -1
- package/build/api/models/farcaster-action-req-body.d.ts +1 -1
- package/build/api/models/farcaster-action-req-body.js +1 -1
- package/build/api/models/farcaster-manifest-account-association.d.ts +1 -1
- package/build/api/models/farcaster-manifest-account-association.js +1 -1
- package/build/api/models/farcaster-manifest-frame.d.ts +1 -1
- package/build/api/models/farcaster-manifest-frame.js +1 -1
- package/build/api/models/farcaster-manifest-triggers-inner-one-of.d.ts +1 -1
- package/build/api/models/farcaster-manifest-triggers-inner-one-of.js +1 -1
- package/build/api/models/farcaster-manifest-triggers-inner-one-of1.d.ts +1 -1
- package/build/api/models/farcaster-manifest-triggers-inner-one-of1.js +1 -1
- package/build/api/models/farcaster-manifest-triggers-inner.d.ts +1 -1
- package/build/api/models/farcaster-manifest-triggers-inner.js +1 -1
- package/build/api/models/farcaster-manifest.d.ts +1 -1
- package/build/api/models/farcaster-manifest.js +1 -1
- package/build/api/models/feed-response.d.ts +1 -1
- package/build/api/models/feed-response.js +1 -1
- package/build/api/models/feed-trending-provider.d.ts +1 -1
- package/build/api/models/feed-trending-provider.js +1 -1
- package/build/api/models/feed-type.d.ts +1 -1
- package/build/api/models/feed-type.js +1 -1
- package/build/api/models/fetch-feed-for-you400-response.d.ts +1 -1
- package/build/api/models/fetch-feed-for-you400-response.js +1 -1
- package/build/api/models/fetch-frame-meta-tags-from-url200-response.d.ts +2 -2
- package/build/api/models/fetch-frame-meta-tags-from-url200-response.js +1 -1
- package/build/api/models/fetch-relevant-frames200-response-relevant-frames-inner.d.ts +1 -1
- package/build/api/models/fetch-relevant-frames200-response-relevant-frames-inner.js +1 -1
- package/build/api/models/fetch-relevant-frames200-response.d.ts +1 -1
- package/build/api/models/fetch-relevant-frames200-response.js +1 -1
- package/build/api/models/fetch-user-interactions200-response.d.ts +1 -1
- package/build/api/models/fetch-user-interactions200-response.js +1 -1
- package/build/api/models/fids.d.ts +1 -1
- package/build/api/models/fids.js +1 -1
- package/build/api/models/filter-type.d.ts +1 -1
- package/build/api/models/filter-type.js +1 -1
- package/build/api/models/fname-availability-response.d.ts +1 -1
- package/build/api/models/fname-availability-response.js +1 -1
- package/build/api/models/follow-req-body.d.ts +1 -1
- package/build/api/models/follow-req-body.js +1 -1
- package/build/api/models/follow-response.d.ts +1 -1
- package/build/api/models/follow-response.js +1 -1
- package/build/api/models/follow-sort-type.d.ts +1 -1
- package/build/api/models/follow-sort-type.js +1 -1
- package/build/api/models/follower-dehydrated.d.ts +1 -1
- package/build/api/models/follower-dehydrated.js +1 -1
- package/build/api/models/follower.d.ts +1 -1
- package/build/api/models/follower.js +1 -1
- package/build/api/models/followers-response.d.ts +1 -1
- package/build/api/models/followers-response.js +1 -1
- package/build/api/models/for-you-provider.d.ts +1 -1
- package/build/api/models/for-you-provider.js +1 -1
- package/build/api/models/frame-action-button.d.ts +1 -1
- package/build/api/models/frame-action-button.js +1 -1
- package/build/api/models/frame-action-req-body.d.ts +1 -1
- package/build/api/models/frame-action-req-body.js +1 -1
- package/build/api/models/frame-action.d.ts +3 -3
- package/build/api/models/frame-action.js +1 -1
- package/build/api/models/frame-base.d.ts +4 -4
- package/build/api/models/frame-base.js +1 -1
- package/build/api/models/frame-button-action-type.d.ts +2 -2
- package/build/api/models/frame-button-action-type.js +2 -2
- package/build/api/models/frame-catalog-response.d.ts +1 -1
- package/build/api/models/frame-catalog-response.js +1 -1
- package/build/api/models/frame-developer-managed-action-req-body.d.ts +1 -1
- package/build/api/models/frame-developer-managed-action-req-body.js +1 -1
- package/build/api/models/frame-input.d.ts +2 -2
- package/build/api/models/frame-input.js +1 -1
- package/build/api/models/frame-notification-tokens-notification-tokens-inner.d.ts +1 -1
- package/build/api/models/frame-notification-tokens-notification-tokens-inner.js +1 -1
- package/build/api/models/frame-notification-tokens.d.ts +1 -1
- package/build/api/models/frame-notification-tokens.js +1 -1
- package/build/api/models/frame-pay-transaction-request-body.d.ts +1 -1
- package/build/api/models/frame-pay-transaction-request-body.js +1 -1
- package/build/api/models/frame-signature-packet-trusted-data.d.ts +1 -1
- package/build/api/models/frame-signature-packet-trusted-data.js +1 -1
- package/build/api/models/frame-signature-packet-untrusted-data.d.ts +2 -2
- package/build/api/models/frame-signature-packet-untrusted-data.js +1 -1
- package/build/api/models/frame-signature-packet.d.ts +2 -2
- package/build/api/models/frame-signature-packet.js +1 -1
- package/build/api/models/frame-state.d.ts +2 -2
- package/build/api/models/frame-state.js +1 -1
- package/build/api/models/frame-transaction.d.ts +1 -1
- package/build/api/models/frame-transaction.js +1 -1
- package/build/api/models/frame-type.d.ts +1 -1
- package/build/api/models/frame-type.js +1 -1
- package/build/api/models/frame-v1-all-of-input.d.ts +2 -2
- package/build/api/models/frame-v1-all-of-input.js +1 -1
- package/build/api/models/frame-v1-all-of-state.d.ts +2 -2
- package/build/api/models/frame-v1-all-of-state.js +1 -1
- package/build/api/models/frame-v1-all-of.d.ts +2 -2
- package/build/api/models/frame-v1-all-of.js +1 -1
- package/build/api/models/frame-v1.d.ts +2 -2
- package/build/api/models/frame-v1.js +1 -1
- package/build/api/models/frame-v2-all-of-metadata.d.ts +1 -1
- package/build/api/models/frame-v2-all-of-metadata.js +1 -1
- package/build/api/models/frame-v2-all-of.d.ts +2 -2
- package/build/api/models/frame-v2-all-of.js +1 -1
- package/build/api/models/frame-v2-with-full-author-all-of.d.ts +2 -2
- package/build/api/models/frame-v2-with-full-author-all-of.js +1 -1
- package/build/api/models/frame-v2-with-full-author.d.ts +2 -2
- package/build/api/models/frame-v2-with-full-author.js +1 -1
- package/build/api/models/frame-v2.d.ts +2 -2
- package/build/api/models/frame-v2.js +1 -1
- package/build/api/models/frame-validate-analytics-input-text-input-texts-inner.d.ts +1 -1
- package/build/api/models/frame-validate-analytics-input-text-input-texts-inner.js +1 -1
- package/build/api/models/frame-validate-analytics-input-text.d.ts +1 -1
- package/build/api/models/frame-validate-analytics-input-text.js +1 -1
- package/build/api/models/frame-validate-analytics-interactions-per-cast-interactions-per-cast-inner.d.ts +1 -1
- package/build/api/models/frame-validate-analytics-interactions-per-cast-interactions-per-cast-inner.js +1 -1
- package/build/api/models/frame-validate-analytics-interactions-per-cast.d.ts +1 -1
- package/build/api/models/frame-validate-analytics-interactions-per-cast.js +1 -1
- package/build/api/models/frame-validate-analytics-interactors-interactors-inner.d.ts +1 -1
- package/build/api/models/frame-validate-analytics-interactors-interactors-inner.js +1 -1
- package/build/api/models/frame-validate-analytics-interactors.d.ts +1 -1
- package/build/api/models/frame-validate-analytics-interactors.js +1 -1
- package/build/api/models/frame-validate-analytics-response.d.ts +1 -1
- package/build/api/models/frame-validate-analytics-response.js +1 -1
- package/build/api/models/frame-validate-analytics-total-interactors.d.ts +1 -1
- package/build/api/models/frame-validate-analytics-total-interactors.js +1 -1
- package/build/api/models/frame-validate-list-response.d.ts +1 -1
- package/build/api/models/frame-validate-list-response.js +1 -1
- package/build/api/models/frame.d.ts +1 -1
- package/build/api/models/frame.js +1 -1
- package/build/api/models/html-metadata-all-of-oembed.d.ts +1 -1
- package/build/api/models/html-metadata-all-of-oembed.js +1 -1
- package/build/api/models/html-metadata-all-of.d.ts +1 -1
- package/build/api/models/html-metadata-all-of.js +1 -1
- package/build/api/models/html-metadata.d.ts +1 -1
- package/build/api/models/html-metadata.js +1 -1
- package/build/api/models/image-object.d.ts +1 -1
- package/build/api/models/image-object.js +1 -1
- package/build/api/models/invite-channel-member-req-body.d.ts +1 -1
- package/build/api/models/invite-channel-member-req-body.js +1 -1
- package/build/api/models/location-address.d.ts +1 -1
- package/build/api/models/location-address.js +1 -1
- package/build/api/models/location.d.ts +1 -1
- package/build/api/models/location.js +1 -1
- package/build/api/models/mark-notifications-as-seen-req-body.d.ts +1 -1
- package/build/api/models/mark-notifications-as-seen-req-body.js +1 -1
- package/build/api/models/mute-list-response.d.ts +1 -1
- package/build/api/models/mute-list-response.js +1 -1
- package/build/api/models/mute-record.d.ts +1 -1
- package/build/api/models/mute-record.js +1 -1
- package/build/api/models/mute-req-body.d.ts +1 -1
- package/build/api/models/mute-req-body.js +1 -1
- package/build/api/models/mute-response.d.ts +1 -1
- package/build/api/models/mute-response.js +1 -1
- package/build/api/models/networks.d.ts +1 -1
- package/build/api/models/networks.js +1 -1
- package/build/api/models/next-cursor.d.ts +1 -1
- package/build/api/models/next-cursor.js +1 -1
- package/build/api/models/neynar-frame-creation-req-body.d.ts +2 -2
- package/build/api/models/neynar-frame-creation-req-body.js +1 -1
- package/build/api/models/neynar-frame-page.d.ts +1 -1
- package/build/api/models/neynar-frame-page.js +1 -1
- package/build/api/models/neynar-frame-update-req-body.d.ts +3 -3
- package/build/api/models/neynar-frame-update-req-body.js +1 -1
- package/build/api/models/neynar-frame.d.ts +5 -5
- package/build/api/models/neynar-frame.js +1 -1
- package/build/api/models/neynar-next-frame-page-mint-url.d.ts +1 -1
- package/build/api/models/neynar-next-frame-page-mint-url.js +1 -1
- package/build/api/models/neynar-next-frame-page-redirect.d.ts +1 -1
- package/build/api/models/neynar-next-frame-page-redirect.js +1 -1
- package/build/api/models/neynar-next-frame-page.d.ts +1 -1
- package/build/api/models/neynar-next-frame-page.js +1 -1
- package/build/api/models/neynar-page-button-next-page.d.ts +1 -1
- package/build/api/models/neynar-page-button-next-page.js +1 -1
- package/build/api/models/neynar-page-button.d.ts +1 -1
- package/build/api/models/neynar-page-button.js +1 -1
- package/build/api/models/neynar-page-image.d.ts +1 -1
- package/build/api/models/neynar-page-image.js +1 -1
- package/build/api/models/neynar-page-input-text.d.ts +1 -1
- package/build/api/models/neynar-page-input-text.js +1 -1
- package/build/api/models/neynar-page-input.d.ts +1 -1
- package/build/api/models/neynar-page-input.js +1 -1
- package/build/api/models/nonce-response.d.ts +1 -1
- package/build/api/models/nonce-response.js +1 -1
- package/build/api/models/notification-delivery.d.ts +1 -1
- package/build/api/models/notification-delivery.js +1 -1
- package/build/api/models/notification-type.d.ts +1 -1
- package/build/api/models/notification-type.js +1 -1
- package/build/api/models/notification.d.ts +1 -1
- package/build/api/models/notification.js +1 -1
- package/build/api/models/notifications-response.d.ts +1 -1
- package/build/api/models/notifications-response.js +1 -1
- package/build/api/models/oembed-data.d.ts +1 -1
- package/build/api/models/oembed-data.js +1 -1
- package/build/api/models/oembed-link-data-all-of.d.ts +1 -1
- package/build/api/models/oembed-link-data-all-of.js +1 -1
- package/build/api/models/oembed-link-data.d.ts +1 -1
- package/build/api/models/oembed-link-data.js +1 -1
- package/build/api/models/oembed-photo-data-all-of.d.ts +1 -1
- package/build/api/models/oembed-photo-data-all-of.js +1 -1
- package/build/api/models/oembed-photo-data.d.ts +1 -1
- package/build/api/models/oembed-photo-data.js +1 -1
- package/build/api/models/oembed-rich-data-all-of.d.ts +1 -1
- package/build/api/models/oembed-rich-data-all-of.js +1 -1
- package/build/api/models/oembed-rich-data.d.ts +1 -1
- package/build/api/models/oembed-rich-data.js +1 -1
- package/build/api/models/oembed-video-data-all-of.d.ts +1 -1
- package/build/api/models/oembed-video-data-all-of.js +1 -1
- package/build/api/models/oembed-video-data.d.ts +1 -1
- package/build/api/models/oembed-video-data.js +1 -1
- package/build/api/models/og-object.d.ts +1 -1
- package/build/api/models/og-object.js +1 -1
- package/build/api/models/operation-response.d.ts +1 -1
- package/build/api/models/operation-response.js +1 -1
- package/build/api/models/post-cast-req-body-embeds-cast-id-properties.d.ts +1 -1
- package/build/api/models/post-cast-req-body-embeds-cast-id-properties.js +1 -1
- package/build/api/models/post-cast-req-body-embeds-one-of.d.ts +1 -1
- package/build/api/models/post-cast-req-body-embeds-one-of.js +1 -1
- package/build/api/models/post-cast-req-body-embeds-one-of1.d.ts +1 -1
- package/build/api/models/post-cast-req-body-embeds-one-of1.js +1 -1
- package/build/api/models/post-cast-req-body-embeds-one-of2.d.ts +1 -1
- package/build/api/models/post-cast-req-body-embeds-one-of2.js +1 -1
- package/build/api/models/post-cast-req-body-embeds.d.ts +1 -1
- package/build/api/models/post-cast-req-body-embeds.js +1 -1
- package/build/api/models/post-cast-req-body.d.ts +1 -1
- package/build/api/models/post-cast-req-body.js +1 -1
- package/build/api/models/post-cast-response-cast.d.ts +1 -1
- package/build/api/models/post-cast-response-cast.js +1 -1
- package/build/api/models/post-cast-response.d.ts +1 -1
- package/build/api/models/post-cast-response.js +1 -1
- package/build/api/models/profile-url-pfp.d.ts +1 -1
- package/build/api/models/profile-url-pfp.js +1 -1
- package/build/api/models/profile-url.d.ts +1 -1
- package/build/api/models/profile-url.js +1 -1
- package/build/api/models/reaction-for-cast.d.ts +1 -1
- package/build/api/models/reaction-for-cast.js +1 -1
- package/build/api/models/reaction-like.d.ts +1 -1
- package/build/api/models/reaction-like.js +1 -1
- package/build/api/models/reaction-recast.d.ts +1 -1
- package/build/api/models/reaction-recast.js +1 -1
- package/build/api/models/reaction-req-body.d.ts +1 -1
- package/build/api/models/reaction-req-body.js +1 -1
- package/build/api/models/reaction-type.d.ts +1 -1
- package/build/api/models/reaction-type.js +1 -1
- package/build/api/models/reaction-with-cast-info.d.ts +1 -1
- package/build/api/models/reaction-with-cast-info.js +1 -1
- package/build/api/models/reaction-with-user-info.d.ts +1 -1
- package/build/api/models/reaction-with-user-info.js +1 -1
- package/build/api/models/reactions-cast-response.d.ts +1 -1
- package/build/api/models/reactions-cast-response.js +1 -1
- package/build/api/models/reactions-response.d.ts +1 -1
- package/build/api/models/reactions-response.js +1 -1
- package/build/api/models/reactions-type.d.ts +1 -1
- package/build/api/models/reactions-type.js +1 -1
- package/build/api/models/register-developer-managed-signed-key-req-body.d.ts +1 -1
- package/build/api/models/register-developer-managed-signed-key-req-body.js +1 -1
- package/build/api/models/register-signer-key-req-body.d.ts +1 -1
- package/build/api/models/register-signer-key-req-body.js +1 -1
- package/build/api/models/register-user-req-body-metadata.d.ts +1 -1
- package/build/api/models/register-user-req-body-metadata.js +1 -1
- package/build/api/models/register-user-req-body.d.ts +1 -1
- package/build/api/models/register-user-req-body.js +1 -1
- package/build/api/models/register-user-response.d.ts +1 -1
- package/build/api/models/register-user-response.js +1 -1
- package/build/api/models/relevant-followers-response.d.ts +1 -1
- package/build/api/models/relevant-followers-response.js +1 -1
- package/build/api/models/relevant-fungible-owners-response.d.ts +1 -1
- package/build/api/models/relevant-fungible-owners-response.js +1 -1
- package/build/api/models/remove-channel-member-req-body.d.ts +1 -1
- package/build/api/models/remove-channel-member-req-body.js +1 -1
- package/build/api/models/remove-verification-req-body.d.ts +1 -1
- package/build/api/models/remove-verification-req-body.js +1 -1
- package/build/api/models/respond-channel-invite-req-body.d.ts +1 -1
- package/build/api/models/respond-channel-invite-req-body.js +1 -1
- package/build/api/models/search-sort-type.d.ts +1 -1
- package/build/api/models/search-sort-type.js +1 -1
- package/build/api/models/searched-user.d.ts +7 -1
- package/build/api/models/searched-user.js +1 -1
- package/build/api/models/send-frame-notifications-req-body-notification.d.ts +1 -1
- package/build/api/models/send-frame-notifications-req-body-notification.js +1 -1
- package/build/api/models/send-frame-notifications-req-body.d.ts +1 -1
- package/build/api/models/send-frame-notifications-req-body.js +1 -1
- package/build/api/models/send-frame-notifications-response.d.ts +1 -1
- package/build/api/models/send-frame-notifications-response.js +1 -1
- package/build/api/models/shared-signer-permission.d.ts +1 -1
- package/build/api/models/shared-signer-permission.js +1 -1
- package/build/api/models/signed-key-request-sponsor.d.ts +1 -1
- package/build/api/models/signed-key-request-sponsor.js +1 -1
- package/build/api/models/signer-list-response.d.ts +1 -1
- package/build/api/models/signer-list-response.js +1 -1
- package/build/api/models/signer.d.ts +1 -1
- package/build/api/models/signer.js +1 -1
- package/build/api/models/storage-allocation.d.ts +1 -1
- package/build/api/models/storage-allocation.js +1 -1
- package/build/api/models/storage-allocations-response.d.ts +1 -1
- package/build/api/models/storage-allocations-response.js +1 -1
- package/build/api/models/storage-object.d.ts +1 -1
- package/build/api/models/storage-object.js +1 -1
- package/build/api/models/storage-usage-response.d.ts +1 -1
- package/build/api/models/storage-usage-response.js +1 -1
- package/build/api/models/subscribed-to-all-of.d.ts +1 -1
- package/build/api/models/subscribed-to-all-of.js +1 -1
- package/build/api/models/subscribed-to-object.d.ts +1 -1
- package/build/api/models/subscribed-to-object.js +1 -1
- package/build/api/models/subscribed-to-response.d.ts +1 -1
- package/build/api/models/subscribed-to-response.js +1 -1
- package/build/api/models/subscribed-to.d.ts +1 -1
- package/build/api/models/subscribed-to.js +1 -1
- package/build/api/models/subscriber.d.ts +1 -1
- package/build/api/models/subscriber.js +1 -1
- package/build/api/models/subscribers-response.d.ts +1 -1
- package/build/api/models/subscribers-response.js +1 -1
- package/build/api/models/subscription-check-response.d.ts +1 -1
- package/build/api/models/subscription-check-response.js +1 -1
- package/build/api/models/subscription-metadata.d.ts +1 -1
- package/build/api/models/subscription-metadata.js +1 -1
- package/build/api/models/subscription-price.d.ts +1 -1
- package/build/api/models/subscription-price.js +1 -1
- package/build/api/models/subscription-provider.d.ts +1 -1
- package/build/api/models/subscription-provider.js +1 -1
- package/build/api/models/subscription-providers.d.ts +1 -1
- package/build/api/models/subscription-providers.js +1 -1
- package/build/api/models/subscription-status.d.ts +1 -1
- package/build/api/models/subscription-status.js +1 -1
- package/build/api/models/subscription-tier-price.d.ts +1 -1
- package/build/api/models/subscription-tier-price.js +1 -1
- package/build/api/models/subscription-tier.d.ts +1 -1
- package/build/api/models/subscription-tier.js +1 -1
- package/build/api/models/subscription-token.d.ts +1 -1
- package/build/api/models/subscription-token.js +1 -1
- package/build/api/models/subscription.d.ts +1 -1
- package/build/api/models/subscription.js +1 -1
- package/build/api/models/subscriptions-response.d.ts +1 -1
- package/build/api/models/subscriptions-response.js +1 -1
- package/build/api/models/subscriptions.d.ts +1 -1
- package/build/api/models/subscriptions.js +1 -1
- package/build/api/models/text-range.d.ts +1 -1
- package/build/api/models/text-range.js +1 -1
- package/build/api/models/token-balance-balance.d.ts +1 -1
- package/build/api/models/token-balance-balance.js +1 -1
- package/build/api/models/token-balance-token.d.ts +1 -1
- package/build/api/models/token-balance-token.js +1 -1
- package/build/api/models/token-balance.d.ts +1 -1
- package/build/api/models/token-balance.js +1 -1
- package/build/api/models/transaction-frame-action.d.ts +1 -1
- package/build/api/models/transaction-frame-action.js +1 -1
- package/build/api/models/transaction-frame-base.d.ts +3 -3
- package/build/api/models/transaction-frame-base.js +1 -1
- package/build/api/models/transaction-frame-config.d.ts +3 -3
- package/build/api/models/transaction-frame-config.js +1 -1
- package/build/api/models/transaction-frame-destination.d.ts +1 -1
- package/build/api/models/transaction-frame-destination.js +1 -1
- package/build/api/models/transaction-frame-line-item.d.ts +1 -1
- package/build/api/models/transaction-frame-line-item.js +1 -1
- package/build/api/models/transaction-frame-pay-all-of-transaction.d.ts +1 -1
- package/build/api/models/transaction-frame-pay-all-of-transaction.js +1 -1
- package/build/api/models/transaction-frame-pay-all-of.d.ts +1 -1
- package/build/api/models/transaction-frame-pay-all-of.js +1 -1
- package/build/api/models/transaction-frame-pay.d.ts +1 -1
- package/build/api/models/transaction-frame-pay.js +1 -1
- package/build/api/models/transaction-frame-response.d.ts +1 -1
- package/build/api/models/transaction-frame-response.js +1 -1
- package/build/api/models/transaction-frame-status.d.ts +1 -1
- package/build/api/models/transaction-frame-status.js +1 -1
- package/build/api/models/transaction-frame-type.d.ts +2 -2
- package/build/api/models/transaction-frame-type.js +2 -2
- package/build/api/models/transaction-frame.d.ts +1 -1
- package/build/api/models/transaction-frame.js +1 -1
- package/build/api/models/trending-channel-response.d.ts +1 -1
- package/build/api/models/trending-channel-response.js +1 -1
- package/build/api/models/trending-time-window.d.ts +1 -1
- package/build/api/models/trending-time-window.js +1 -1
- package/build/api/models/update-user-req-body-location.d.ts +1 -1
- package/build/api/models/update-user-req-body-location.js +1 -1
- package/build/api/models/update-user-req-body-verified-accounts.d.ts +1 -1
- package/build/api/models/update-user-req-body-verified-accounts.js +1 -1
- package/build/api/models/update-user-req-body.d.ts +1 -1
- package/build/api/models/update-user-req-body.js +1 -1
- package/build/api/models/user-dehydrated.d.ts +1 -1
- package/build/api/models/user-dehydrated.js +1 -1
- package/build/api/models/user-experimental.d.ts +1 -1
- package/build/api/models/user-experimental.js +1 -1
- package/build/api/models/user-fidresponse.d.ts +1 -1
- package/build/api/models/user-fidresponse.js +1 -1
- package/build/api/models/user-power-lite-response-result.d.ts +1 -1
- package/build/api/models/user-power-lite-response-result.js +1 -1
- package/build/api/models/user-power-lite-response.d.ts +1 -1
- package/build/api/models/user-power-lite-response.js +1 -1
- package/build/api/models/user-profile-bio.d.ts +1 -1
- package/build/api/models/user-profile-bio.js +1 -1
- package/build/api/models/user-profile.d.ts +1 -1
- package/build/api/models/user-profile.js +1 -1
- package/build/api/models/user-response.d.ts +1 -1
- package/build/api/models/user-response.js +1 -1
- package/build/api/models/user-search-response-result.d.ts +1 -1
- package/build/api/models/user-search-response-result.js +1 -1
- package/build/api/models/user-search-response.d.ts +1 -1
- package/build/api/models/user-search-response.js +1 -1
- package/build/api/models/user-verified-accounts-inner.d.ts +1 -1
- package/build/api/models/user-verified-accounts-inner.js +1 -1
- package/build/api/models/user-verified-addresses-primary.d.ts +1 -1
- package/build/api/models/user-verified-addresses-primary.js +1 -1
- package/build/api/models/user-verified-addresses.d.ts +1 -1
- package/build/api/models/user-verified-addresses.js +1 -1
- package/build/api/models/user-viewer-context.d.ts +1 -1
- package/build/api/models/user-viewer-context.js +1 -1
- package/build/api/models/user.d.ts +7 -1
- package/build/api/models/user.js +1 -1
- package/build/api/models/users-active-channels-response.d.ts +1 -1
- package/build/api/models/users-active-channels-response.js +1 -1
- package/build/api/models/users-response.d.ts +1 -1
- package/build/api/models/users-response.js +1 -1
- package/build/api/models/validate-frame-action-req-body.d.ts +2 -2
- package/build/api/models/validate-frame-action-req-body.js +1 -1
- package/build/api/models/validate-frame-action-response.d.ts +1 -1
- package/build/api/models/validate-frame-action-response.js +1 -1
- package/build/api/models/validate-frame-aggregate-window.d.ts +1 -1
- package/build/api/models/validate-frame-aggregate-window.js +1 -1
- package/build/api/models/validate-frame-analytics-type.d.ts +1 -1
- package/build/api/models/validate-frame-analytics-type.js +1 -1
- package/build/api/models/validated-frame-action-signer.d.ts +1 -1
- package/build/api/models/validated-frame-action-signer.js +1 -1
- package/build/api/models/validated-frame-action-tapped-button.d.ts +1 -1
- package/build/api/models/validated-frame-action-tapped-button.js +1 -1
- package/build/api/models/validated-frame-action.d.ts +1 -1
- package/build/api/models/validated-frame-action.js +1 -1
- package/build/api/models/verification-chain-id.d.ts +1 -1
- package/build/api/models/verification-chain-id.js +1 -1
- package/build/api/models/verification-type.d.ts +1 -1
- package/build/api/models/verification-type.js +1 -1
- package/build/api/models/video-object.d.ts +1 -1
- package/build/api/models/video-object.js +1 -1
- package/build/api/models/webhook-delete-req-body.d.ts +1 -1
- package/build/api/models/webhook-delete-req-body.js +1 -1
- package/build/api/models/webhook-list-response.d.ts +1 -1
- package/build/api/models/webhook-list-response.js +1 -1
- package/build/api/models/webhook-patch-req-body.d.ts +1 -1
- package/build/api/models/webhook-patch-req-body.js +1 -1
- package/build/api/models/webhook-post-req-body.d.ts +1 -1
- package/build/api/models/webhook-post-req-body.js +1 -1
- package/build/api/models/webhook-put-req-body.d.ts +1 -1
- package/build/api/models/webhook-put-req-body.js +1 -1
- package/build/api/models/webhook-response.d.ts +1 -1
- package/build/api/models/webhook-response.js +1 -1
- package/build/api/models/webhook-secret.d.ts +1 -1
- package/build/api/models/webhook-secret.js +1 -1
- package/build/api/models/webhook-subscription-filters-cast.d.ts +1 -1
- package/build/api/models/webhook-subscription-filters-cast.js +1 -1
- package/build/api/models/webhook-subscription-filters-follow.d.ts +1 -1
- package/build/api/models/webhook-subscription-filters-follow.js +1 -1
- package/build/api/models/webhook-subscription-filters-reaction.d.ts +1 -1
- package/build/api/models/webhook-subscription-filters-reaction.js +1 -1
- package/build/api/models/webhook-subscription-filters-user-updated.d.ts +1 -1
- package/build/api/models/webhook-subscription-filters-user-updated.js +1 -1
- package/build/api/models/webhook-subscription-filters.d.ts +1 -1
- package/build/api/models/webhook-subscription-filters.js +1 -1
- package/build/api/models/webhook-subscription.d.ts +1 -1
- package/build/api/models/webhook-subscription.js +1 -1
- package/build/api/models/webhook.d.ts +1 -1
- package/build/api/models/webhook.js +1 -1
- package/build/api/models/zod-error-errors-inner.d.ts +1 -1
- package/build/api/models/zod-error-errors-inner.js +1 -1
- package/build/api/models/zod-error.d.ts +1 -1
- package/build/api/models/zod-error.js +1 -1
- package/build/clients/NeynarAPIClient.d.ts +46 -43
- package/build/clients/NeynarAPIClient.js +46 -43
- package/package.json +1 -1
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Farcaster API V2
|
|
3
3
|
* The Farcaster API allows you to interact with the Farcaster protocol. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 2.
|
|
5
|
+
* The version of the OpenAPI document: 2.33.0
|
|
6
6
|
* Contact: team@neynar.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -41,8 +41,8 @@ import type { ValidateFrameAnalyticsType } from '../models';
|
|
|
41
41
|
*/
|
|
42
42
|
export declare const FrameApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
43
43
|
/**
|
|
44
|
-
* Delete an existing
|
|
45
|
-
* @summary Delete
|
|
44
|
+
* Delete an existing mini app, if it was made by the developer (identified by API key)
|
|
45
|
+
* @summary Delete mini app
|
|
46
46
|
* @param {DeleteFrameReqBody} deleteFrameReqBody
|
|
47
47
|
* @param {*} [options] Override http request option.
|
|
48
48
|
* @throws {RequiredError}
|
|
@@ -53,11 +53,11 @@ export declare const FrameApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
53
53
|
*/
|
|
54
54
|
deleteNeynarFrame: (deleteFrameReqBody: DeleteFrameReqBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
55
55
|
/**
|
|
56
|
-
* A curated list of featured
|
|
57
|
-
* @summary
|
|
56
|
+
* A curated list of featured mini apps
|
|
57
|
+
* @summary Mini apps catalog
|
|
58
58
|
* @param {number} [limit] Number of results to fetch (Default: 100, Maximum: 100)
|
|
59
59
|
* @param {string} [cursor] Pagination cursor
|
|
60
|
-
* @param {TrendingTimeWindow} [timeWindow] Time window used to calculate the change in trending score for each
|
|
60
|
+
* @param {TrendingTimeWindow} [timeWindow] Time window used to calculate the change in trending score for each mini app, used to sort mini app results
|
|
61
61
|
* @param {*} [options] Override http request option.
|
|
62
62
|
* @throws {RequiredError}
|
|
63
63
|
* @returns {Promise<FrameCatalogResponse>} A promise that resolves to a `FrameCatalogResponse` object
|
|
@@ -65,9 +65,9 @@ export declare const FrameApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
65
65
|
*/
|
|
66
66
|
fetchFrameCatalog: (limit?: number, cursor?: string, timeWindow?: TrendingTimeWindow, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
67
67
|
/**
|
|
68
|
-
* Fetches the
|
|
68
|
+
* Fetches the mini app meta tags from the URL
|
|
69
69
|
* @summary Meta tags from URL
|
|
70
|
-
* @param {string} url The
|
|
70
|
+
* @param {string} url The mini app URL to crawl
|
|
71
71
|
* @param {*} [options] Override http request option.
|
|
72
72
|
* @throws {RequiredError}
|
|
73
73
|
* @returns {Promise<FetchFrameMetaTagsFromUrl200Response>} A promise that resolves to a `FetchFrameMetaTagsFromUrl200Response` object
|
|
@@ -77,8 +77,8 @@ export declare const FrameApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
77
77
|
*/
|
|
78
78
|
fetchFrameMetaTagsFromUrl: (url: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
79
79
|
/**
|
|
80
|
-
* Fetch a list of
|
|
81
|
-
* @summary List of
|
|
80
|
+
* Fetch a list of mini apps made by the developer (identified by API key)
|
|
81
|
+
* @summary List of mini apps
|
|
82
82
|
* @param {*} [options] Override http request option.
|
|
83
83
|
* @throws {RequiredError}
|
|
84
84
|
* @returns {Promise<Array<NeynarFrame>>} A promise that resolves to a `Array<NeynarFrame>` object
|
|
@@ -88,8 +88,8 @@ export declare const FrameApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
88
88
|
*/
|
|
89
89
|
fetchNeynarFrames: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
90
90
|
/**
|
|
91
|
-
* Returns a list of notifications tokens related
|
|
92
|
-
* @summary List of
|
|
91
|
+
* Returns a list of notifications tokens related to a mini app
|
|
92
|
+
* @summary List of mini app notification tokens
|
|
93
93
|
* @param {number} [limit] Number of results to fetch (Default: 20, Maximum: 100)
|
|
94
94
|
* @param {string} [fids] Comma separated list of FIDs, up to 100 at a time
|
|
95
95
|
* @param {string} [cursor] Pagination cursor
|
|
@@ -102,19 +102,21 @@ export declare const FrameApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
102
102
|
*/
|
|
103
103
|
fetchNotificationTokens: (limit?: number, fids?: string, cursor?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
104
104
|
/**
|
|
105
|
-
* Fetch a list of
|
|
106
|
-
* @summary Relevant
|
|
107
|
-
* @param {number} viewerFid FID of the user to fetch relevant
|
|
108
|
-
* @param {TrendingTimeWindow} [timeWindow] Time window used to limit statistics used to calculate
|
|
105
|
+
* Fetch a list of mini apps relevant to the user based on casts by users with strong affinity score for the user
|
|
106
|
+
* @summary Relevant mini apps
|
|
107
|
+
* @param {number} viewerFid FID of the user to fetch relevant mini apps for
|
|
108
|
+
* @param {TrendingTimeWindow} [timeWindow] Time window used to limit statistics used to calculate mini app relevance
|
|
109
109
|
* @param {*} [options] Override http request option.
|
|
110
110
|
* @throws {RequiredError}
|
|
111
111
|
* @returns {Promise<FetchRelevantFrames200Response>} A promise that resolves to a `FetchRelevantFrames200Response` object
|
|
112
112
|
*
|
|
113
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-frame-relevant)
|
|
114
|
+
*
|
|
113
115
|
*/
|
|
114
116
|
fetchRelevantFrames: (viewerFid: number, timeWindow?: TrendingTimeWindow, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
115
117
|
/**
|
|
116
118
|
* Fetch analytics for total-interactors, interactors, nteractions-per-cast and input-text.
|
|
117
|
-
* @summary Analytics for the
|
|
119
|
+
* @summary Analytics for the mini app
|
|
118
120
|
* @param {string} frameUrl
|
|
119
121
|
* @param {ValidateFrameAnalyticsType} analyticsType
|
|
120
122
|
* @param {string} start
|
|
@@ -129,8 +131,8 @@ export declare const FrameApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
129
131
|
*/
|
|
130
132
|
fetchValidateFrameAnalytics: (frameUrl: string, analyticsType: ValidateFrameAnalyticsType, start: string, stop: string, aggregateWindow?: ValidateFrameAggregateWindow, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
131
133
|
/**
|
|
132
|
-
* Fetch a list of all the
|
|
133
|
-
* @summary All
|
|
134
|
+
* Fetch a list of all the mini apps validated by a user
|
|
135
|
+
* @summary All mini apps validated by user
|
|
134
136
|
* @param {*} [options] Override http request option.
|
|
135
137
|
* @throws {RequiredError}
|
|
136
138
|
* @returns {Promise<FrameValidateListResponse>} A promise that resolves to a `FrameValidateListResponse` object
|
|
@@ -140,9 +142,9 @@ export declare const FrameApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
140
142
|
*/
|
|
141
143
|
fetchValidateFrameList: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
142
144
|
/**
|
|
143
|
-
* Retrieves details about a transaction pay
|
|
144
|
-
* @summary Get transaction pay
|
|
145
|
-
* @param {string} id ID of the transaction
|
|
145
|
+
* Retrieves details about a transaction pay mini app by ID
|
|
146
|
+
* @summary Get transaction pay mini app
|
|
147
|
+
* @param {string} id ID of the transaction mini app to retrieve
|
|
146
148
|
* @param {*} [options] Override http request option.
|
|
147
149
|
* @throws {RequiredError}
|
|
148
150
|
* @returns {Promise<TransactionFrameResponse>} A promise that resolves to a `TransactionFrameResponse` object
|
|
@@ -150,11 +152,11 @@ export declare const FrameApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
150
152
|
*/
|
|
151
153
|
getTransactionPayFrame: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
152
154
|
/**
|
|
153
|
-
* Fetch a
|
|
154
|
-
* @summary
|
|
155
|
+
* Fetch a mini app either by UUID or Neynar URL
|
|
156
|
+
* @summary Mini app by UUID or URL
|
|
155
157
|
* @param {FrameType} type
|
|
156
|
-
* @param {string} [uuid] UUID of the
|
|
157
|
-
* @param {string} [url] URL of the Neynar
|
|
158
|
+
* @param {string} [uuid] UUID of the mini app to fetch
|
|
159
|
+
* @param {string} [url] URL of the Neynar mini app to fetch
|
|
158
160
|
* @param {*} [options] Override http request option.
|
|
159
161
|
* @throws {RequiredError}
|
|
160
162
|
* @returns {Promise<NeynarFrame>} A promise that resolves to a `NeynarFrame` object
|
|
@@ -164,8 +166,8 @@ export declare const FrameApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
164
166
|
*/
|
|
165
167
|
lookupNeynarFrame: (type: FrameType, uuid?: string, url?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
166
168
|
/**
|
|
167
|
-
* Post
|
|
168
|
-
* @summary Post a
|
|
169
|
+
* 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.
|
|
170
|
+
* @summary Post a mini app action, cast action or a cast composer action
|
|
169
171
|
* @param {FrameActionReqBody} frameActionReqBody
|
|
170
172
|
* @param {*} [options] Override http request option.
|
|
171
173
|
* @throws {RequiredError}
|
|
@@ -176,7 +178,7 @@ export declare const FrameApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
176
178
|
*/
|
|
177
179
|
postFrameAction: (frameActionReqBody: FrameActionReqBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
178
180
|
/**
|
|
179
|
-
* Post a
|
|
181
|
+
* Post a mini app action that has been signed with a developer managed signer The POST request to the post_url has a timeout of 5 seconds.
|
|
180
182
|
* @summary Signature packet
|
|
181
183
|
* @param {FrameDeveloperManagedActionReqBody} frameDeveloperManagedActionReqBody
|
|
182
184
|
* @param {*} [options] Override http request option.
|
|
@@ -188,7 +190,7 @@ export declare const FrameApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
188
190
|
*/
|
|
189
191
|
postFrameActionDeveloperManaged: (frameDeveloperManagedActionReqBody: FrameDeveloperManagedActionReqBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
190
192
|
/**
|
|
191
|
-
* Send notifications to interactors of a
|
|
193
|
+
* Send notifications to interactors of a mini app
|
|
192
194
|
* @summary Send notifications
|
|
193
195
|
* @param {SendFrameNotificationsReqBody} sendFrameNotificationsReqBody
|
|
194
196
|
* @param {*} [options] Override http request option.
|
|
@@ -200,8 +202,8 @@ export declare const FrameApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
200
202
|
*/
|
|
201
203
|
publishFrameNotifications: (sendFrameNotificationsReqBody: SendFrameNotificationsReqBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
202
204
|
/**
|
|
203
|
-
* Create a new
|
|
204
|
-
* @summary Create
|
|
205
|
+
* Create a new mini app with a list of pages.
|
|
206
|
+
* @summary Create mini app
|
|
205
207
|
* @param {NeynarFrameCreationReqBody} neynarFrameCreationReqBody
|
|
206
208
|
* @param {*} [options] Override http request option.
|
|
207
209
|
* @throws {RequiredError}
|
|
@@ -212,8 +214,8 @@ export declare const FrameApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
212
214
|
*/
|
|
213
215
|
publishNeynarFrame: (neynarFrameCreationReqBody: NeynarFrameCreationReqBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
214
216
|
/**
|
|
215
|
-
* Update an existing
|
|
216
|
-
* @summary Update
|
|
217
|
+
* Update an existing mini app with a list of pages, if it was made by the developer (identified by API key)
|
|
218
|
+
* @summary Update mini app
|
|
217
219
|
* @param {NeynarFrameUpdateReqBody} neynarFrameUpdateReqBody
|
|
218
220
|
* @param {*} [options] Override http request option.
|
|
219
221
|
* @throws {RequiredError}
|
|
@@ -224,8 +226,8 @@ export declare const FrameApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
224
226
|
*/
|
|
225
227
|
updateNeynarFrame: (neynarFrameUpdateReqBody: NeynarFrameUpdateReqBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
226
228
|
/**
|
|
227
|
-
* Validates a
|
|
228
|
-
* @summary Validate
|
|
229
|
+
* 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)
|
|
230
|
+
* @summary Validate mini app action
|
|
229
231
|
* @param {ValidateFrameActionReqBody} validateFrameActionReqBody
|
|
230
232
|
* @param {*} [options] Override http request option.
|
|
231
233
|
* @throws {RequiredError}
|
|
@@ -242,8 +244,8 @@ export declare const FrameApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
242
244
|
*/
|
|
243
245
|
export declare const FrameApiFp: (configuration?: Configuration) => {
|
|
244
246
|
/**
|
|
245
|
-
* Delete an existing
|
|
246
|
-
* @summary Delete
|
|
247
|
+
* Delete an existing mini app, if it was made by the developer (identified by API key)
|
|
248
|
+
* @summary Delete mini app
|
|
247
249
|
* @param {DeleteFrameReqBody} deleteFrameReqBody
|
|
248
250
|
* @param {*} [options] Override http request option.
|
|
249
251
|
* @throws {RequiredError}
|
|
@@ -254,11 +256,11 @@ export declare const FrameApiFp: (configuration?: Configuration) => {
|
|
|
254
256
|
*/
|
|
255
257
|
deleteNeynarFrame(deleteFrameReqBody: DeleteFrameReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteFrameResponse>>;
|
|
256
258
|
/**
|
|
257
|
-
* A curated list of featured
|
|
258
|
-
* @summary
|
|
259
|
+
* A curated list of featured mini apps
|
|
260
|
+
* @summary Mini apps catalog
|
|
259
261
|
* @param {number} [limit] Number of results to fetch (Default: 100, Maximum: 100)
|
|
260
262
|
* @param {string} [cursor] Pagination cursor
|
|
261
|
-
* @param {TrendingTimeWindow} [timeWindow] Time window used to calculate the change in trending score for each
|
|
263
|
+
* @param {TrendingTimeWindow} [timeWindow] Time window used to calculate the change in trending score for each mini app, used to sort mini app results
|
|
262
264
|
* @param {*} [options] Override http request option.
|
|
263
265
|
* @throws {RequiredError}
|
|
264
266
|
* @returns {Promise<FrameCatalogResponse>} A promise that resolves to a `FrameCatalogResponse` object
|
|
@@ -266,9 +268,9 @@ export declare const FrameApiFp: (configuration?: Configuration) => {
|
|
|
266
268
|
*/
|
|
267
269
|
fetchFrameCatalog(limit?: number, cursor?: string, timeWindow?: TrendingTimeWindow, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FrameCatalogResponse>>;
|
|
268
270
|
/**
|
|
269
|
-
* Fetches the
|
|
271
|
+
* Fetches the mini app meta tags from the URL
|
|
270
272
|
* @summary Meta tags from URL
|
|
271
|
-
* @param {string} url The
|
|
273
|
+
* @param {string} url The mini app URL to crawl
|
|
272
274
|
* @param {*} [options] Override http request option.
|
|
273
275
|
* @throws {RequiredError}
|
|
274
276
|
* @returns {Promise<FetchFrameMetaTagsFromUrl200Response>} A promise that resolves to a `FetchFrameMetaTagsFromUrl200Response` object
|
|
@@ -278,8 +280,8 @@ export declare const FrameApiFp: (configuration?: Configuration) => {
|
|
|
278
280
|
*/
|
|
279
281
|
fetchFrameMetaTagsFromUrl(url: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FetchFrameMetaTagsFromUrl200Response>>;
|
|
280
282
|
/**
|
|
281
|
-
* Fetch a list of
|
|
282
|
-
* @summary List of
|
|
283
|
+
* Fetch a list of mini apps made by the developer (identified by API key)
|
|
284
|
+
* @summary List of mini apps
|
|
283
285
|
* @param {*} [options] Override http request option.
|
|
284
286
|
* @throws {RequiredError}
|
|
285
287
|
* @returns {Promise<Array<NeynarFrame>>} A promise that resolves to a `Array<NeynarFrame>` object
|
|
@@ -289,8 +291,8 @@ export declare const FrameApiFp: (configuration?: Configuration) => {
|
|
|
289
291
|
*/
|
|
290
292
|
fetchNeynarFrames(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<NeynarFrame>>>;
|
|
291
293
|
/**
|
|
292
|
-
* Returns a list of notifications tokens related
|
|
293
|
-
* @summary List of
|
|
294
|
+
* Returns a list of notifications tokens related to a mini app
|
|
295
|
+
* @summary List of mini app notification tokens
|
|
294
296
|
* @param {number} [limit] Number of results to fetch (Default: 20, Maximum: 100)
|
|
295
297
|
* @param {string} [fids] Comma separated list of FIDs, up to 100 at a time
|
|
296
298
|
* @param {string} [cursor] Pagination cursor
|
|
@@ -303,19 +305,21 @@ export declare const FrameApiFp: (configuration?: Configuration) => {
|
|
|
303
305
|
*/
|
|
304
306
|
fetchNotificationTokens(limit?: number, fids?: string, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FrameNotificationTokens>>;
|
|
305
307
|
/**
|
|
306
|
-
* Fetch a list of
|
|
307
|
-
* @summary Relevant
|
|
308
|
-
* @param {number} viewerFid FID of the user to fetch relevant
|
|
309
|
-
* @param {TrendingTimeWindow} [timeWindow] Time window used to limit statistics used to calculate
|
|
308
|
+
* Fetch a list of mini apps relevant to the user based on casts by users with strong affinity score for the user
|
|
309
|
+
* @summary Relevant mini apps
|
|
310
|
+
* @param {number} viewerFid FID of the user to fetch relevant mini apps for
|
|
311
|
+
* @param {TrendingTimeWindow} [timeWindow] Time window used to limit statistics used to calculate mini app relevance
|
|
310
312
|
* @param {*} [options] Override http request option.
|
|
311
313
|
* @throws {RequiredError}
|
|
312
314
|
* @returns {Promise<FetchRelevantFrames200Response>} A promise that resolves to a `FetchRelevantFrames200Response` object
|
|
313
315
|
*
|
|
316
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-frame-relevant)
|
|
317
|
+
*
|
|
314
318
|
*/
|
|
315
319
|
fetchRelevantFrames(viewerFid: number, timeWindow?: TrendingTimeWindow, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FetchRelevantFrames200Response>>;
|
|
316
320
|
/**
|
|
317
321
|
* Fetch analytics for total-interactors, interactors, nteractions-per-cast and input-text.
|
|
318
|
-
* @summary Analytics for the
|
|
322
|
+
* @summary Analytics for the mini app
|
|
319
323
|
* @param {string} frameUrl
|
|
320
324
|
* @param {ValidateFrameAnalyticsType} analyticsType
|
|
321
325
|
* @param {string} start
|
|
@@ -330,8 +334,8 @@ export declare const FrameApiFp: (configuration?: Configuration) => {
|
|
|
330
334
|
*/
|
|
331
335
|
fetchValidateFrameAnalytics(frameUrl: string, analyticsType: ValidateFrameAnalyticsType, start: string, stop: string, aggregateWindow?: ValidateFrameAggregateWindow, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FrameValidateAnalyticsResponse>>;
|
|
332
336
|
/**
|
|
333
|
-
* Fetch a list of all the
|
|
334
|
-
* @summary All
|
|
337
|
+
* Fetch a list of all the mini apps validated by a user
|
|
338
|
+
* @summary All mini apps validated by user
|
|
335
339
|
* @param {*} [options] Override http request option.
|
|
336
340
|
* @throws {RequiredError}
|
|
337
341
|
* @returns {Promise<FrameValidateListResponse>} A promise that resolves to a `FrameValidateListResponse` object
|
|
@@ -341,9 +345,9 @@ export declare const FrameApiFp: (configuration?: Configuration) => {
|
|
|
341
345
|
*/
|
|
342
346
|
fetchValidateFrameList(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FrameValidateListResponse>>;
|
|
343
347
|
/**
|
|
344
|
-
* Retrieves details about a transaction pay
|
|
345
|
-
* @summary Get transaction pay
|
|
346
|
-
* @param {string} id ID of the transaction
|
|
348
|
+
* Retrieves details about a transaction pay mini app by ID
|
|
349
|
+
* @summary Get transaction pay mini app
|
|
350
|
+
* @param {string} id ID of the transaction mini app to retrieve
|
|
347
351
|
* @param {*} [options] Override http request option.
|
|
348
352
|
* @throws {RequiredError}
|
|
349
353
|
* @returns {Promise<TransactionFrameResponse>} A promise that resolves to a `TransactionFrameResponse` object
|
|
@@ -351,11 +355,11 @@ export declare const FrameApiFp: (configuration?: Configuration) => {
|
|
|
351
355
|
*/
|
|
352
356
|
getTransactionPayFrame(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TransactionFrameResponse>>;
|
|
353
357
|
/**
|
|
354
|
-
* Fetch a
|
|
355
|
-
* @summary
|
|
358
|
+
* Fetch a mini app either by UUID or Neynar URL
|
|
359
|
+
* @summary Mini app by UUID or URL
|
|
356
360
|
* @param {FrameType} type
|
|
357
|
-
* @param {string} [uuid] UUID of the
|
|
358
|
-
* @param {string} [url] URL of the Neynar
|
|
361
|
+
* @param {string} [uuid] UUID of the mini app to fetch
|
|
362
|
+
* @param {string} [url] URL of the Neynar mini app to fetch
|
|
359
363
|
* @param {*} [options] Override http request option.
|
|
360
364
|
* @throws {RequiredError}
|
|
361
365
|
* @returns {Promise<NeynarFrame>} A promise that resolves to a `NeynarFrame` object
|
|
@@ -365,8 +369,8 @@ export declare const FrameApiFp: (configuration?: Configuration) => {
|
|
|
365
369
|
*/
|
|
366
370
|
lookupNeynarFrame(type: FrameType, uuid?: string, url?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NeynarFrame>>;
|
|
367
371
|
/**
|
|
368
|
-
* Post
|
|
369
|
-
* @summary Post a
|
|
372
|
+
* 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.
|
|
373
|
+
* @summary Post a mini app action, cast action or a cast composer action
|
|
370
374
|
* @param {FrameActionReqBody} frameActionReqBody
|
|
371
375
|
* @param {*} [options] Override http request option.
|
|
372
376
|
* @throws {RequiredError}
|
|
@@ -377,7 +381,7 @@ export declare const FrameApiFp: (configuration?: Configuration) => {
|
|
|
377
381
|
*/
|
|
378
382
|
postFrameAction(frameActionReqBody: FrameActionReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Frame>>;
|
|
379
383
|
/**
|
|
380
|
-
* Post a
|
|
384
|
+
* Post a mini app action that has been signed with a developer managed signer The POST request to the post_url has a timeout of 5 seconds.
|
|
381
385
|
* @summary Signature packet
|
|
382
386
|
* @param {FrameDeveloperManagedActionReqBody} frameDeveloperManagedActionReqBody
|
|
383
387
|
* @param {*} [options] Override http request option.
|
|
@@ -389,7 +393,7 @@ export declare const FrameApiFp: (configuration?: Configuration) => {
|
|
|
389
393
|
*/
|
|
390
394
|
postFrameActionDeveloperManaged(frameDeveloperManagedActionReqBody: FrameDeveloperManagedActionReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Frame>>;
|
|
391
395
|
/**
|
|
392
|
-
* Send notifications to interactors of a
|
|
396
|
+
* Send notifications to interactors of a mini app
|
|
393
397
|
* @summary Send notifications
|
|
394
398
|
* @param {SendFrameNotificationsReqBody} sendFrameNotificationsReqBody
|
|
395
399
|
* @param {*} [options] Override http request option.
|
|
@@ -401,8 +405,8 @@ export declare const FrameApiFp: (configuration?: Configuration) => {
|
|
|
401
405
|
*/
|
|
402
406
|
publishFrameNotifications(sendFrameNotificationsReqBody: SendFrameNotificationsReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SendFrameNotificationsResponse>>;
|
|
403
407
|
/**
|
|
404
|
-
* Create a new
|
|
405
|
-
* @summary Create
|
|
408
|
+
* Create a new mini app with a list of pages.
|
|
409
|
+
* @summary Create mini app
|
|
406
410
|
* @param {NeynarFrameCreationReqBody} neynarFrameCreationReqBody
|
|
407
411
|
* @param {*} [options] Override http request option.
|
|
408
412
|
* @throws {RequiredError}
|
|
@@ -413,8 +417,8 @@ export declare const FrameApiFp: (configuration?: Configuration) => {
|
|
|
413
417
|
*/
|
|
414
418
|
publishNeynarFrame(neynarFrameCreationReqBody: NeynarFrameCreationReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NeynarFrame>>;
|
|
415
419
|
/**
|
|
416
|
-
* Update an existing
|
|
417
|
-
* @summary Update
|
|
420
|
+
* Update an existing mini app with a list of pages, if it was made by the developer (identified by API key)
|
|
421
|
+
* @summary Update mini app
|
|
418
422
|
* @param {NeynarFrameUpdateReqBody} neynarFrameUpdateReqBody
|
|
419
423
|
* @param {*} [options] Override http request option.
|
|
420
424
|
* @throws {RequiredError}
|
|
@@ -425,8 +429,8 @@ export declare const FrameApiFp: (configuration?: Configuration) => {
|
|
|
425
429
|
*/
|
|
426
430
|
updateNeynarFrame(neynarFrameUpdateReqBody: NeynarFrameUpdateReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NeynarFrame>>;
|
|
427
431
|
/**
|
|
428
|
-
* Validates a
|
|
429
|
-
* @summary Validate
|
|
432
|
+
* 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)
|
|
433
|
+
* @summary Validate mini app action
|
|
430
434
|
* @param {ValidateFrameActionReqBody} validateFrameActionReqBody
|
|
431
435
|
* @param {*} [options] Override http request option.
|
|
432
436
|
* @throws {RequiredError}
|
|
@@ -443,8 +447,8 @@ export declare const FrameApiFp: (configuration?: Configuration) => {
|
|
|
443
447
|
*/
|
|
444
448
|
export declare const FrameApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
445
449
|
/**
|
|
446
|
-
* Delete an existing
|
|
447
|
-
* @summary Delete
|
|
450
|
+
* Delete an existing mini app, if it was made by the developer (identified by API key)
|
|
451
|
+
* @summary Delete mini app
|
|
448
452
|
* @param {FrameApiDeleteNeynarFrameRequest} requestParameters Request parameters.
|
|
449
453
|
* @param {*} [options] Override http request option.
|
|
450
454
|
* @throws {RequiredError}
|
|
@@ -455,8 +459,8 @@ export declare const FrameApiFactory: (configuration?: Configuration, basePath?:
|
|
|
455
459
|
*/
|
|
456
460
|
deleteNeynarFrame(requestParameters: FrameApiDeleteNeynarFrameRequest, options?: RawAxiosRequestConfig): AxiosPromise<DeleteFrameResponse>;
|
|
457
461
|
/**
|
|
458
|
-
* A curated list of featured
|
|
459
|
-
* @summary
|
|
462
|
+
* A curated list of featured mini apps
|
|
463
|
+
* @summary Mini apps catalog
|
|
460
464
|
* @param {FrameApiFetchFrameCatalogRequest} requestParameters Request parameters.
|
|
461
465
|
* @param {*} [options] Override http request option.
|
|
462
466
|
* @throws {RequiredError}
|
|
@@ -465,7 +469,7 @@ export declare const FrameApiFactory: (configuration?: Configuration, basePath?:
|
|
|
465
469
|
*/
|
|
466
470
|
fetchFrameCatalog(requestParameters?: FrameApiFetchFrameCatalogRequest, options?: RawAxiosRequestConfig): AxiosPromise<FrameCatalogResponse>;
|
|
467
471
|
/**
|
|
468
|
-
* Fetches the
|
|
472
|
+
* Fetches the mini app meta tags from the URL
|
|
469
473
|
* @summary Meta tags from URL
|
|
470
474
|
* @param {FrameApiFetchFrameMetaTagsFromUrlRequest} requestParameters Request parameters.
|
|
471
475
|
* @param {*} [options] Override http request option.
|
|
@@ -477,8 +481,8 @@ export declare const FrameApiFactory: (configuration?: Configuration, basePath?:
|
|
|
477
481
|
*/
|
|
478
482
|
fetchFrameMetaTagsFromUrl(requestParameters: FrameApiFetchFrameMetaTagsFromUrlRequest, options?: RawAxiosRequestConfig): AxiosPromise<FetchFrameMetaTagsFromUrl200Response>;
|
|
479
483
|
/**
|
|
480
|
-
* Fetch a list of
|
|
481
|
-
* @summary List of
|
|
484
|
+
* Fetch a list of mini apps made by the developer (identified by API key)
|
|
485
|
+
* @summary List of mini apps
|
|
482
486
|
* @param {*} [options] Override http request option.
|
|
483
487
|
* @throws {RequiredError}
|
|
484
488
|
* @returns {Promise<Array<NeynarFrame>>} A promise that resolves to a `Array<NeynarFrame>` object
|
|
@@ -488,8 +492,8 @@ export declare const FrameApiFactory: (configuration?: Configuration, basePath?:
|
|
|
488
492
|
*/
|
|
489
493
|
fetchNeynarFrames(options?: RawAxiosRequestConfig): AxiosPromise<Array<NeynarFrame>>;
|
|
490
494
|
/**
|
|
491
|
-
* Returns a list of notifications tokens related
|
|
492
|
-
* @summary List of
|
|
495
|
+
* Returns a list of notifications tokens related to a mini app
|
|
496
|
+
* @summary List of mini app notification tokens
|
|
493
497
|
* @param {FrameApiFetchNotificationTokensRequest} requestParameters Request parameters.
|
|
494
498
|
* @param {*} [options] Override http request option.
|
|
495
499
|
* @throws {RequiredError}
|
|
@@ -500,18 +504,20 @@ export declare const FrameApiFactory: (configuration?: Configuration, basePath?:
|
|
|
500
504
|
*/
|
|
501
505
|
fetchNotificationTokens(requestParameters?: FrameApiFetchNotificationTokensRequest, options?: RawAxiosRequestConfig): AxiosPromise<FrameNotificationTokens>;
|
|
502
506
|
/**
|
|
503
|
-
* Fetch a list of
|
|
504
|
-
* @summary Relevant
|
|
507
|
+
* Fetch a list of mini apps relevant to the user based on casts by users with strong affinity score for the user
|
|
508
|
+
* @summary Relevant mini apps
|
|
505
509
|
* @param {FrameApiFetchRelevantFramesRequest} requestParameters Request parameters.
|
|
506
510
|
* @param {*} [options] Override http request option.
|
|
507
511
|
* @throws {RequiredError}
|
|
508
512
|
* @returns {Promise<FetchRelevantFrames200Response>} A promise that resolves to a `FetchRelevantFrames200Response` object
|
|
509
513
|
*
|
|
514
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-frame-relevant)
|
|
515
|
+
*
|
|
510
516
|
*/
|
|
511
517
|
fetchRelevantFrames(requestParameters: FrameApiFetchRelevantFramesRequest, options?: RawAxiosRequestConfig): AxiosPromise<FetchRelevantFrames200Response>;
|
|
512
518
|
/**
|
|
513
519
|
* Fetch analytics for total-interactors, interactors, nteractions-per-cast and input-text.
|
|
514
|
-
* @summary Analytics for the
|
|
520
|
+
* @summary Analytics for the mini app
|
|
515
521
|
* @param {FrameApiFetchValidateFrameAnalyticsRequest} requestParameters Request parameters.
|
|
516
522
|
* @param {*} [options] Override http request option.
|
|
517
523
|
* @throws {RequiredError}
|
|
@@ -522,8 +528,8 @@ export declare const FrameApiFactory: (configuration?: Configuration, basePath?:
|
|
|
522
528
|
*/
|
|
523
529
|
fetchValidateFrameAnalytics(requestParameters: FrameApiFetchValidateFrameAnalyticsRequest, options?: RawAxiosRequestConfig): AxiosPromise<FrameValidateAnalyticsResponse>;
|
|
524
530
|
/**
|
|
525
|
-
* Fetch a list of all the
|
|
526
|
-
* @summary All
|
|
531
|
+
* Fetch a list of all the mini apps validated by a user
|
|
532
|
+
* @summary All mini apps validated by user
|
|
527
533
|
* @param {*} [options] Override http request option.
|
|
528
534
|
* @throws {RequiredError}
|
|
529
535
|
* @returns {Promise<FrameValidateListResponse>} A promise that resolves to a `FrameValidateListResponse` object
|
|
@@ -533,8 +539,8 @@ export declare const FrameApiFactory: (configuration?: Configuration, basePath?:
|
|
|
533
539
|
*/
|
|
534
540
|
fetchValidateFrameList(options?: RawAxiosRequestConfig): AxiosPromise<FrameValidateListResponse>;
|
|
535
541
|
/**
|
|
536
|
-
* Retrieves details about a transaction pay
|
|
537
|
-
* @summary Get transaction pay
|
|
542
|
+
* Retrieves details about a transaction pay mini app by ID
|
|
543
|
+
* @summary Get transaction pay mini app
|
|
538
544
|
* @param {FrameApiGetTransactionPayFrameRequest} requestParameters Request parameters.
|
|
539
545
|
* @param {*} [options] Override http request option.
|
|
540
546
|
* @throws {RequiredError}
|
|
@@ -543,8 +549,8 @@ export declare const FrameApiFactory: (configuration?: Configuration, basePath?:
|
|
|
543
549
|
*/
|
|
544
550
|
getTransactionPayFrame(requestParameters: FrameApiGetTransactionPayFrameRequest, options?: RawAxiosRequestConfig): AxiosPromise<TransactionFrameResponse>;
|
|
545
551
|
/**
|
|
546
|
-
* Fetch a
|
|
547
|
-
* @summary
|
|
552
|
+
* Fetch a mini app either by UUID or Neynar URL
|
|
553
|
+
* @summary Mini app by UUID or URL
|
|
548
554
|
* @param {FrameApiLookupNeynarFrameRequest} requestParameters Request parameters.
|
|
549
555
|
* @param {*} [options] Override http request option.
|
|
550
556
|
* @throws {RequiredError}
|
|
@@ -555,8 +561,8 @@ export declare const FrameApiFactory: (configuration?: Configuration, basePath?:
|
|
|
555
561
|
*/
|
|
556
562
|
lookupNeynarFrame(requestParameters: FrameApiLookupNeynarFrameRequest, options?: RawAxiosRequestConfig): AxiosPromise<NeynarFrame>;
|
|
557
563
|
/**
|
|
558
|
-
* Post
|
|
559
|
-
* @summary Post a
|
|
564
|
+
* 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.
|
|
565
|
+
* @summary Post a mini app action, cast action or a cast composer action
|
|
560
566
|
* @param {FrameApiPostFrameActionRequest} requestParameters Request parameters.
|
|
561
567
|
* @param {*} [options] Override http request option.
|
|
562
568
|
* @throws {RequiredError}
|
|
@@ -567,7 +573,7 @@ export declare const FrameApiFactory: (configuration?: Configuration, basePath?:
|
|
|
567
573
|
*/
|
|
568
574
|
postFrameAction(requestParameters: FrameApiPostFrameActionRequest, options?: RawAxiosRequestConfig): AxiosPromise<Frame>;
|
|
569
575
|
/**
|
|
570
|
-
* Post a
|
|
576
|
+
* Post a mini app action that has been signed with a developer managed signer The POST request to the post_url has a timeout of 5 seconds.
|
|
571
577
|
* @summary Signature packet
|
|
572
578
|
* @param {FrameApiPostFrameActionDeveloperManagedRequest} requestParameters Request parameters.
|
|
573
579
|
* @param {*} [options] Override http request option.
|
|
@@ -579,7 +585,7 @@ export declare const FrameApiFactory: (configuration?: Configuration, basePath?:
|
|
|
579
585
|
*/
|
|
580
586
|
postFrameActionDeveloperManaged(requestParameters: FrameApiPostFrameActionDeveloperManagedRequest, options?: RawAxiosRequestConfig): AxiosPromise<Frame>;
|
|
581
587
|
/**
|
|
582
|
-
* Send notifications to interactors of a
|
|
588
|
+
* Send notifications to interactors of a mini app
|
|
583
589
|
* @summary Send notifications
|
|
584
590
|
* @param {FrameApiPublishFrameNotificationsRequest} requestParameters Request parameters.
|
|
585
591
|
* @param {*} [options] Override http request option.
|
|
@@ -591,8 +597,8 @@ export declare const FrameApiFactory: (configuration?: Configuration, basePath?:
|
|
|
591
597
|
*/
|
|
592
598
|
publishFrameNotifications(requestParameters: FrameApiPublishFrameNotificationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<SendFrameNotificationsResponse>;
|
|
593
599
|
/**
|
|
594
|
-
* Create a new
|
|
595
|
-
* @summary Create
|
|
600
|
+
* Create a new mini app with a list of pages.
|
|
601
|
+
* @summary Create mini app
|
|
596
602
|
* @param {FrameApiPublishNeynarFrameRequest} requestParameters Request parameters.
|
|
597
603
|
* @param {*} [options] Override http request option.
|
|
598
604
|
* @throws {RequiredError}
|
|
@@ -603,8 +609,8 @@ export declare const FrameApiFactory: (configuration?: Configuration, basePath?:
|
|
|
603
609
|
*/
|
|
604
610
|
publishNeynarFrame(requestParameters: FrameApiPublishNeynarFrameRequest, options?: RawAxiosRequestConfig): AxiosPromise<NeynarFrame>;
|
|
605
611
|
/**
|
|
606
|
-
* Update an existing
|
|
607
|
-
* @summary Update
|
|
612
|
+
* Update an existing mini app with a list of pages, if it was made by the developer (identified by API key)
|
|
613
|
+
* @summary Update mini app
|
|
608
614
|
* @param {FrameApiUpdateNeynarFrameRequest} requestParameters Request parameters.
|
|
609
615
|
* @param {*} [options] Override http request option.
|
|
610
616
|
* @throws {RequiredError}
|
|
@@ -615,8 +621,8 @@ export declare const FrameApiFactory: (configuration?: Configuration, basePath?:
|
|
|
615
621
|
*/
|
|
616
622
|
updateNeynarFrame(requestParameters: FrameApiUpdateNeynarFrameRequest, options?: RawAxiosRequestConfig): AxiosPromise<NeynarFrame>;
|
|
617
623
|
/**
|
|
618
|
-
* Validates a
|
|
619
|
-
* @summary Validate
|
|
624
|
+
* 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)
|
|
625
|
+
* @summary Validate mini app action
|
|
620
626
|
* @param {FrameApiValidateFrameActionRequest} requestParameters Request parameters.
|
|
621
627
|
* @param {*} [options] Override http request option.
|
|
622
628
|
* @throws {RequiredError}
|
|
@@ -634,8 +640,8 @@ export declare const FrameApiFactory: (configuration?: Configuration, basePath?:
|
|
|
634
640
|
*/
|
|
635
641
|
export interface FrameApiInterface {
|
|
636
642
|
/**
|
|
637
|
-
* Delete an existing
|
|
638
|
-
* @summary Delete
|
|
643
|
+
* Delete an existing mini app, if it was made by the developer (identified by API key)
|
|
644
|
+
* @summary Delete mini app
|
|
639
645
|
* @param {FrameApiDeleteNeynarFrameRequest} requestParameters Request parameters.
|
|
640
646
|
* @param {*} [options] Override http request option.
|
|
641
647
|
* @throws {RequiredError}
|
|
@@ -647,8 +653,8 @@ export interface FrameApiInterface {
|
|
|
647
653
|
*/
|
|
648
654
|
deleteNeynarFrame(requestParameters: FrameApiDeleteNeynarFrameRequest, options?: RawAxiosRequestConfig): AxiosPromise<DeleteFrameResponse>;
|
|
649
655
|
/**
|
|
650
|
-
* A curated list of featured
|
|
651
|
-
* @summary
|
|
656
|
+
* A curated list of featured mini apps
|
|
657
|
+
* @summary Mini apps catalog
|
|
652
658
|
* @param {FrameApiFetchFrameCatalogRequest} requestParameters Request parameters.
|
|
653
659
|
* @param {*} [options] Override http request option.
|
|
654
660
|
* @throws {RequiredError}
|
|
@@ -658,7 +664,7 @@ export interface FrameApiInterface {
|
|
|
658
664
|
*/
|
|
659
665
|
fetchFrameCatalog(requestParameters?: FrameApiFetchFrameCatalogRequest, options?: RawAxiosRequestConfig): AxiosPromise<FrameCatalogResponse>;
|
|
660
666
|
/**
|
|
661
|
-
* Fetches the
|
|
667
|
+
* Fetches the mini app meta tags from the URL
|
|
662
668
|
* @summary Meta tags from URL
|
|
663
669
|
* @param {FrameApiFetchFrameMetaTagsFromUrlRequest} requestParameters Request parameters.
|
|
664
670
|
* @param {*} [options] Override http request option.
|
|
@@ -671,8 +677,8 @@ export interface FrameApiInterface {
|
|
|
671
677
|
*/
|
|
672
678
|
fetchFrameMetaTagsFromUrl(requestParameters: FrameApiFetchFrameMetaTagsFromUrlRequest, options?: RawAxiosRequestConfig): AxiosPromise<FetchFrameMetaTagsFromUrl200Response>;
|
|
673
679
|
/**
|
|
674
|
-
* Fetch a list of
|
|
675
|
-
* @summary List of
|
|
680
|
+
* Fetch a list of mini apps made by the developer (identified by API key)
|
|
681
|
+
* @summary List of mini apps
|
|
676
682
|
* @param {*} [options] Override http request option.
|
|
677
683
|
* @throws {RequiredError}
|
|
678
684
|
* @memberof FrameApiInterface
|
|
@@ -683,8 +689,8 @@ export interface FrameApiInterface {
|
|
|
683
689
|
*/
|
|
684
690
|
fetchNeynarFrames(options?: RawAxiosRequestConfig): AxiosPromise<Array<NeynarFrame>>;
|
|
685
691
|
/**
|
|
686
|
-
* Returns a list of notifications tokens related
|
|
687
|
-
* @summary List of
|
|
692
|
+
* Returns a list of notifications tokens related to a mini app
|
|
693
|
+
* @summary List of mini app notification tokens
|
|
688
694
|
* @param {FrameApiFetchNotificationTokensRequest} requestParameters Request parameters.
|
|
689
695
|
* @param {*} [options] Override http request option.
|
|
690
696
|
* @throws {RequiredError}
|
|
@@ -696,19 +702,21 @@ export interface FrameApiInterface {
|
|
|
696
702
|
*/
|
|
697
703
|
fetchNotificationTokens(requestParameters?: FrameApiFetchNotificationTokensRequest, options?: RawAxiosRequestConfig): AxiosPromise<FrameNotificationTokens>;
|
|
698
704
|
/**
|
|
699
|
-
* Fetch a list of
|
|
700
|
-
* @summary Relevant
|
|
705
|
+
* Fetch a list of mini apps relevant to the user based on casts by users with strong affinity score for the user
|
|
706
|
+
* @summary Relevant mini apps
|
|
701
707
|
* @param {FrameApiFetchRelevantFramesRequest} requestParameters Request parameters.
|
|
702
708
|
* @param {*} [options] Override http request option.
|
|
703
709
|
* @throws {RequiredError}
|
|
704
710
|
* @memberof FrameApiInterface
|
|
705
711
|
* @returns {Promise<FetchRelevantFrames200Response>} A promise that resolves to a `FetchRelevantFrames200Response` object
|
|
706
712
|
*
|
|
713
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-frame-relevant)
|
|
714
|
+
*
|
|
707
715
|
*/
|
|
708
716
|
fetchRelevantFrames(requestParameters: FrameApiFetchRelevantFramesRequest, options?: RawAxiosRequestConfig): AxiosPromise<FetchRelevantFrames200Response>;
|
|
709
717
|
/**
|
|
710
718
|
* Fetch analytics for total-interactors, interactors, nteractions-per-cast and input-text.
|
|
711
|
-
* @summary Analytics for the
|
|
719
|
+
* @summary Analytics for the mini app
|
|
712
720
|
* @param {FrameApiFetchValidateFrameAnalyticsRequest} requestParameters Request parameters.
|
|
713
721
|
* @param {*} [options] Override http request option.
|
|
714
722
|
* @throws {RequiredError}
|
|
@@ -720,8 +728,8 @@ export interface FrameApiInterface {
|
|
|
720
728
|
*/
|
|
721
729
|
fetchValidateFrameAnalytics(requestParameters: FrameApiFetchValidateFrameAnalyticsRequest, options?: RawAxiosRequestConfig): AxiosPromise<FrameValidateAnalyticsResponse>;
|
|
722
730
|
/**
|
|
723
|
-
* Fetch a list of all the
|
|
724
|
-
* @summary All
|
|
731
|
+
* Fetch a list of all the mini apps validated by a user
|
|
732
|
+
* @summary All mini apps validated by user
|
|
725
733
|
* @param {*} [options] Override http request option.
|
|
726
734
|
* @throws {RequiredError}
|
|
727
735
|
* @memberof FrameApiInterface
|
|
@@ -732,8 +740,8 @@ export interface FrameApiInterface {
|
|
|
732
740
|
*/
|
|
733
741
|
fetchValidateFrameList(options?: RawAxiosRequestConfig): AxiosPromise<FrameValidateListResponse>;
|
|
734
742
|
/**
|
|
735
|
-
* Retrieves details about a transaction pay
|
|
736
|
-
* @summary Get transaction pay
|
|
743
|
+
* Retrieves details about a transaction pay mini app by ID
|
|
744
|
+
* @summary Get transaction pay mini app
|
|
737
745
|
* @param {FrameApiGetTransactionPayFrameRequest} requestParameters Request parameters.
|
|
738
746
|
* @param {*} [options] Override http request option.
|
|
739
747
|
* @throws {RequiredError}
|
|
@@ -743,8 +751,8 @@ export interface FrameApiInterface {
|
|
|
743
751
|
*/
|
|
744
752
|
getTransactionPayFrame(requestParameters: FrameApiGetTransactionPayFrameRequest, options?: RawAxiosRequestConfig): AxiosPromise<TransactionFrameResponse>;
|
|
745
753
|
/**
|
|
746
|
-
* Fetch a
|
|
747
|
-
* @summary
|
|
754
|
+
* Fetch a mini app either by UUID or Neynar URL
|
|
755
|
+
* @summary Mini app by UUID or URL
|
|
748
756
|
* @param {FrameApiLookupNeynarFrameRequest} requestParameters Request parameters.
|
|
749
757
|
* @param {*} [options] Override http request option.
|
|
750
758
|
* @throws {RequiredError}
|
|
@@ -756,8 +764,8 @@ export interface FrameApiInterface {
|
|
|
756
764
|
*/
|
|
757
765
|
lookupNeynarFrame(requestParameters: FrameApiLookupNeynarFrameRequest, options?: RawAxiosRequestConfig): AxiosPromise<NeynarFrame>;
|
|
758
766
|
/**
|
|
759
|
-
* Post
|
|
760
|
-
* @summary Post a
|
|
767
|
+
* 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.
|
|
768
|
+
* @summary Post a mini app action, cast action or a cast composer action
|
|
761
769
|
* @param {FrameApiPostFrameActionRequest} requestParameters Request parameters.
|
|
762
770
|
* @param {*} [options] Override http request option.
|
|
763
771
|
* @throws {RequiredError}
|
|
@@ -769,7 +777,7 @@ export interface FrameApiInterface {
|
|
|
769
777
|
*/
|
|
770
778
|
postFrameAction(requestParameters: FrameApiPostFrameActionRequest, options?: RawAxiosRequestConfig): AxiosPromise<Frame>;
|
|
771
779
|
/**
|
|
772
|
-
* Post a
|
|
780
|
+
* Post a mini app action that has been signed with a developer managed signer The POST request to the post_url has a timeout of 5 seconds.
|
|
773
781
|
* @summary Signature packet
|
|
774
782
|
* @param {FrameApiPostFrameActionDeveloperManagedRequest} requestParameters Request parameters.
|
|
775
783
|
* @param {*} [options] Override http request option.
|
|
@@ -782,7 +790,7 @@ export interface FrameApiInterface {
|
|
|
782
790
|
*/
|
|
783
791
|
postFrameActionDeveloperManaged(requestParameters: FrameApiPostFrameActionDeveloperManagedRequest, options?: RawAxiosRequestConfig): AxiosPromise<Frame>;
|
|
784
792
|
/**
|
|
785
|
-
* Send notifications to interactors of a
|
|
793
|
+
* Send notifications to interactors of a mini app
|
|
786
794
|
* @summary Send notifications
|
|
787
795
|
* @param {FrameApiPublishFrameNotificationsRequest} requestParameters Request parameters.
|
|
788
796
|
* @param {*} [options] Override http request option.
|
|
@@ -795,8 +803,8 @@ export interface FrameApiInterface {
|
|
|
795
803
|
*/
|
|
796
804
|
publishFrameNotifications(requestParameters: FrameApiPublishFrameNotificationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<SendFrameNotificationsResponse>;
|
|
797
805
|
/**
|
|
798
|
-
* Create a new
|
|
799
|
-
* @summary Create
|
|
806
|
+
* Create a new mini app with a list of pages.
|
|
807
|
+
* @summary Create mini app
|
|
800
808
|
* @param {FrameApiPublishNeynarFrameRequest} requestParameters Request parameters.
|
|
801
809
|
* @param {*} [options] Override http request option.
|
|
802
810
|
* @throws {RequiredError}
|
|
@@ -808,8 +816,8 @@ export interface FrameApiInterface {
|
|
|
808
816
|
*/
|
|
809
817
|
publishNeynarFrame(requestParameters: FrameApiPublishNeynarFrameRequest, options?: RawAxiosRequestConfig): AxiosPromise<NeynarFrame>;
|
|
810
818
|
/**
|
|
811
|
-
* Update an existing
|
|
812
|
-
* @summary Update
|
|
819
|
+
* Update an existing mini app with a list of pages, if it was made by the developer (identified by API key)
|
|
820
|
+
* @summary Update mini app
|
|
813
821
|
* @param {FrameApiUpdateNeynarFrameRequest} requestParameters Request parameters.
|
|
814
822
|
* @param {*} [options] Override http request option.
|
|
815
823
|
* @throws {RequiredError}
|
|
@@ -821,8 +829,8 @@ export interface FrameApiInterface {
|
|
|
821
829
|
*/
|
|
822
830
|
updateNeynarFrame(requestParameters: FrameApiUpdateNeynarFrameRequest, options?: RawAxiosRequestConfig): AxiosPromise<NeynarFrame>;
|
|
823
831
|
/**
|
|
824
|
-
* Validates a
|
|
825
|
-
* @summary Validate
|
|
832
|
+
* 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)
|
|
833
|
+
* @summary Validate mini app action
|
|
826
834
|
* @param {FrameApiValidateFrameActionRequest} requestParameters Request parameters.
|
|
827
835
|
* @param {*} [options] Override http request option.
|
|
828
836
|
* @throws {RequiredError}
|
|
@@ -875,7 +883,7 @@ export interface FrameApiFetchFrameCatalogRequest {
|
|
|
875
883
|
*/
|
|
876
884
|
readonly cursor?: string;
|
|
877
885
|
/**
|
|
878
|
-
* Time window used to calculate the change in trending score for each
|
|
886
|
+
* Time window used to calculate the change in trending score for each mini app, used to sort mini app results
|
|
879
887
|
*
|
|
880
888
|
*
|
|
881
889
|
*
|
|
@@ -891,7 +899,7 @@ export interface FrameApiFetchFrameCatalogRequest {
|
|
|
891
899
|
*/
|
|
892
900
|
export interface FrameApiFetchFrameMetaTagsFromUrlRequest {
|
|
893
901
|
/**
|
|
894
|
-
* The
|
|
902
|
+
* The mini app URL to crawl
|
|
895
903
|
*
|
|
896
904
|
*
|
|
897
905
|
*
|
|
@@ -941,7 +949,7 @@ export interface FrameApiFetchNotificationTokensRequest {
|
|
|
941
949
|
*/
|
|
942
950
|
export interface FrameApiFetchRelevantFramesRequest {
|
|
943
951
|
/**
|
|
944
|
-
* FID of the user to fetch relevant
|
|
952
|
+
* FID of the user to fetch relevant mini apps for
|
|
945
953
|
*
|
|
946
954
|
*
|
|
947
955
|
*
|
|
@@ -950,7 +958,7 @@ export interface FrameApiFetchRelevantFramesRequest {
|
|
|
950
958
|
*/
|
|
951
959
|
readonly viewerFid: number;
|
|
952
960
|
/**
|
|
953
|
-
* Time window used to limit statistics used to calculate
|
|
961
|
+
* Time window used to limit statistics used to calculate mini app relevance
|
|
954
962
|
*
|
|
955
963
|
*
|
|
956
964
|
*
|
|
@@ -1018,7 +1026,7 @@ export interface FrameApiFetchValidateFrameAnalyticsRequest {
|
|
|
1018
1026
|
*/
|
|
1019
1027
|
export interface FrameApiGetTransactionPayFrameRequest {
|
|
1020
1028
|
/**
|
|
1021
|
-
* ID of the transaction
|
|
1029
|
+
* ID of the transaction mini app to retrieve
|
|
1022
1030
|
*
|
|
1023
1031
|
*
|
|
1024
1032
|
*
|
|
@@ -1043,7 +1051,7 @@ export interface FrameApiLookupNeynarFrameRequest {
|
|
|
1043
1051
|
*/
|
|
1044
1052
|
readonly type: FrameType;
|
|
1045
1053
|
/**
|
|
1046
|
-
* UUID of the
|
|
1054
|
+
* UUID of the mini app to fetch
|
|
1047
1055
|
*
|
|
1048
1056
|
*
|
|
1049
1057
|
*
|
|
@@ -1052,7 +1060,7 @@ export interface FrameApiLookupNeynarFrameRequest {
|
|
|
1052
1060
|
*/
|
|
1053
1061
|
readonly uuid?: string;
|
|
1054
1062
|
/**
|
|
1055
|
-
* URL of the Neynar
|
|
1063
|
+
* URL of the Neynar mini app to fetch
|
|
1056
1064
|
*
|
|
1057
1065
|
*
|
|
1058
1066
|
*
|
|
@@ -1165,8 +1173,8 @@ export interface FrameApiValidateFrameActionRequest {
|
|
|
1165
1173
|
*/
|
|
1166
1174
|
export declare class FrameApi extends BaseAPI implements FrameApiInterface {
|
|
1167
1175
|
/**
|
|
1168
|
-
* Delete an existing
|
|
1169
|
-
* @summary Delete
|
|
1176
|
+
* Delete an existing mini app, if it was made by the developer (identified by API key)
|
|
1177
|
+
* @summary Delete mini app
|
|
1170
1178
|
* @param {FrameApiDeleteNeynarFrameRequest} requestParameters Request parameters.
|
|
1171
1179
|
* @param {*} [options] Override http request option.
|
|
1172
1180
|
* @throws {RequiredError}
|
|
@@ -1178,8 +1186,8 @@ export declare class FrameApi extends BaseAPI implements FrameApiInterface {
|
|
|
1178
1186
|
*/
|
|
1179
1187
|
deleteNeynarFrame(requestParameters: FrameApiDeleteNeynarFrameRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteFrameResponse, any>>;
|
|
1180
1188
|
/**
|
|
1181
|
-
* A curated list of featured
|
|
1182
|
-
* @summary
|
|
1189
|
+
* A curated list of featured mini apps
|
|
1190
|
+
* @summary Mini apps catalog
|
|
1183
1191
|
* @param {FrameApiFetchFrameCatalogRequest} requestParameters Request parameters.
|
|
1184
1192
|
* @param {*} [options] Override http request option.
|
|
1185
1193
|
* @throws {RequiredError}
|
|
@@ -1189,7 +1197,7 @@ export declare class FrameApi extends BaseAPI implements FrameApiInterface {
|
|
|
1189
1197
|
*/
|
|
1190
1198
|
fetchFrameCatalog(requestParameters?: FrameApiFetchFrameCatalogRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FrameCatalogResponse, any>>;
|
|
1191
1199
|
/**
|
|
1192
|
-
* Fetches the
|
|
1200
|
+
* Fetches the mini app meta tags from the URL
|
|
1193
1201
|
* @summary Meta tags from URL
|
|
1194
1202
|
* @param {FrameApiFetchFrameMetaTagsFromUrlRequest} requestParameters Request parameters.
|
|
1195
1203
|
* @param {*} [options] Override http request option.
|
|
@@ -1202,8 +1210,8 @@ export declare class FrameApi extends BaseAPI implements FrameApiInterface {
|
|
|
1202
1210
|
*/
|
|
1203
1211
|
fetchFrameMetaTagsFromUrl(requestParameters: FrameApiFetchFrameMetaTagsFromUrlRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FetchFrameMetaTagsFromUrl200Response, any>>;
|
|
1204
1212
|
/**
|
|
1205
|
-
* Fetch a list of
|
|
1206
|
-
* @summary List of
|
|
1213
|
+
* Fetch a list of mini apps made by the developer (identified by API key)
|
|
1214
|
+
* @summary List of mini apps
|
|
1207
1215
|
* @param {*} [options] Override http request option.
|
|
1208
1216
|
* @throws {RequiredError}
|
|
1209
1217
|
* @memberof FrameApi
|
|
@@ -1214,8 +1222,8 @@ export declare class FrameApi extends BaseAPI implements FrameApiInterface {
|
|
|
1214
1222
|
*/
|
|
1215
1223
|
fetchNeynarFrames(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<NeynarFrame[], any>>;
|
|
1216
1224
|
/**
|
|
1217
|
-
* Returns a list of notifications tokens related
|
|
1218
|
-
* @summary List of
|
|
1225
|
+
* Returns a list of notifications tokens related to a mini app
|
|
1226
|
+
* @summary List of mini app notification tokens
|
|
1219
1227
|
* @param {FrameApiFetchNotificationTokensRequest} requestParameters Request parameters.
|
|
1220
1228
|
* @param {*} [options] Override http request option.
|
|
1221
1229
|
* @throws {RequiredError}
|
|
@@ -1227,19 +1235,21 @@ export declare class FrameApi extends BaseAPI implements FrameApiInterface {
|
|
|
1227
1235
|
*/
|
|
1228
1236
|
fetchNotificationTokens(requestParameters?: FrameApiFetchNotificationTokensRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FrameNotificationTokens, any>>;
|
|
1229
1237
|
/**
|
|
1230
|
-
* Fetch a list of
|
|
1231
|
-
* @summary Relevant
|
|
1238
|
+
* Fetch a list of mini apps relevant to the user based on casts by users with strong affinity score for the user
|
|
1239
|
+
* @summary Relevant mini apps
|
|
1232
1240
|
* @param {FrameApiFetchRelevantFramesRequest} requestParameters Request parameters.
|
|
1233
1241
|
* @param {*} [options] Override http request option.
|
|
1234
1242
|
* @throws {RequiredError}
|
|
1235
1243
|
* @memberof FrameApi
|
|
1236
1244
|
* @returns {Promise<FetchRelevantFrames200Response>} A promise that resolves to a `FetchRelevantFrames200Response` object
|
|
1237
1245
|
*
|
|
1246
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-frame-relevant)
|
|
1247
|
+
*
|
|
1238
1248
|
*/
|
|
1239
1249
|
fetchRelevantFrames(requestParameters: FrameApiFetchRelevantFramesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FetchRelevantFrames200Response, any>>;
|
|
1240
1250
|
/**
|
|
1241
1251
|
* Fetch analytics for total-interactors, interactors, nteractions-per-cast and input-text.
|
|
1242
|
-
* @summary Analytics for the
|
|
1252
|
+
* @summary Analytics for the mini app
|
|
1243
1253
|
* @param {FrameApiFetchValidateFrameAnalyticsRequest} requestParameters Request parameters.
|
|
1244
1254
|
* @param {*} [options] Override http request option.
|
|
1245
1255
|
* @throws {RequiredError}
|
|
@@ -1251,8 +1261,8 @@ export declare class FrameApi extends BaseAPI implements FrameApiInterface {
|
|
|
1251
1261
|
*/
|
|
1252
1262
|
fetchValidateFrameAnalytics(requestParameters: FrameApiFetchValidateFrameAnalyticsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FrameValidateAnalyticsResponse, any>>;
|
|
1253
1263
|
/**
|
|
1254
|
-
* Fetch a list of all the
|
|
1255
|
-
* @summary All
|
|
1264
|
+
* Fetch a list of all the mini apps validated by a user
|
|
1265
|
+
* @summary All mini apps validated by user
|
|
1256
1266
|
* @param {*} [options] Override http request option.
|
|
1257
1267
|
* @throws {RequiredError}
|
|
1258
1268
|
* @memberof FrameApi
|
|
@@ -1263,8 +1273,8 @@ export declare class FrameApi extends BaseAPI implements FrameApiInterface {
|
|
|
1263
1273
|
*/
|
|
1264
1274
|
fetchValidateFrameList(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FrameValidateListResponse, any>>;
|
|
1265
1275
|
/**
|
|
1266
|
-
* Retrieves details about a transaction pay
|
|
1267
|
-
* @summary Get transaction pay
|
|
1276
|
+
* Retrieves details about a transaction pay mini app by ID
|
|
1277
|
+
* @summary Get transaction pay mini app
|
|
1268
1278
|
* @param {FrameApiGetTransactionPayFrameRequest} requestParameters Request parameters.
|
|
1269
1279
|
* @param {*} [options] Override http request option.
|
|
1270
1280
|
* @throws {RequiredError}
|
|
@@ -1274,8 +1284,8 @@ export declare class FrameApi extends BaseAPI implements FrameApiInterface {
|
|
|
1274
1284
|
*/
|
|
1275
1285
|
getTransactionPayFrame(requestParameters: FrameApiGetTransactionPayFrameRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TransactionFrameResponse, any>>;
|
|
1276
1286
|
/**
|
|
1277
|
-
* Fetch a
|
|
1278
|
-
* @summary
|
|
1287
|
+
* Fetch a mini app either by UUID or Neynar URL
|
|
1288
|
+
* @summary Mini app by UUID or URL
|
|
1279
1289
|
* @param {FrameApiLookupNeynarFrameRequest} requestParameters Request parameters.
|
|
1280
1290
|
* @param {*} [options] Override http request option.
|
|
1281
1291
|
* @throws {RequiredError}
|
|
@@ -1287,8 +1297,8 @@ export declare class FrameApi extends BaseAPI implements FrameApiInterface {
|
|
|
1287
1297
|
*/
|
|
1288
1298
|
lookupNeynarFrame(requestParameters: FrameApiLookupNeynarFrameRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<NeynarFrame, any>>;
|
|
1289
1299
|
/**
|
|
1290
|
-
* Post
|
|
1291
|
-
* @summary Post a
|
|
1300
|
+
* 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.
|
|
1301
|
+
* @summary Post a mini app action, cast action or a cast composer action
|
|
1292
1302
|
* @param {FrameApiPostFrameActionRequest} requestParameters Request parameters.
|
|
1293
1303
|
* @param {*} [options] Override http request option.
|
|
1294
1304
|
* @throws {RequiredError}
|
|
@@ -1300,7 +1310,7 @@ export declare class FrameApi extends BaseAPI implements FrameApiInterface {
|
|
|
1300
1310
|
*/
|
|
1301
1311
|
postFrameAction(requestParameters: FrameApiPostFrameActionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Frame, any>>;
|
|
1302
1312
|
/**
|
|
1303
|
-
* Post a
|
|
1313
|
+
* Post a mini app action that has been signed with a developer managed signer The POST request to the post_url has a timeout of 5 seconds.
|
|
1304
1314
|
* @summary Signature packet
|
|
1305
1315
|
* @param {FrameApiPostFrameActionDeveloperManagedRequest} requestParameters Request parameters.
|
|
1306
1316
|
* @param {*} [options] Override http request option.
|
|
@@ -1313,7 +1323,7 @@ export declare class FrameApi extends BaseAPI implements FrameApiInterface {
|
|
|
1313
1323
|
*/
|
|
1314
1324
|
postFrameActionDeveloperManaged(requestParameters: FrameApiPostFrameActionDeveloperManagedRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Frame, any>>;
|
|
1315
1325
|
/**
|
|
1316
|
-
* Send notifications to interactors of a
|
|
1326
|
+
* Send notifications to interactors of a mini app
|
|
1317
1327
|
* @summary Send notifications
|
|
1318
1328
|
* @param {FrameApiPublishFrameNotificationsRequest} requestParameters Request parameters.
|
|
1319
1329
|
* @param {*} [options] Override http request option.
|
|
@@ -1326,8 +1336,8 @@ export declare class FrameApi extends BaseAPI implements FrameApiInterface {
|
|
|
1326
1336
|
*/
|
|
1327
1337
|
publishFrameNotifications(requestParameters: FrameApiPublishFrameNotificationsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SendFrameNotificationsResponse, any>>;
|
|
1328
1338
|
/**
|
|
1329
|
-
* Create a new
|
|
1330
|
-
* @summary Create
|
|
1339
|
+
* Create a new mini app with a list of pages.
|
|
1340
|
+
* @summary Create mini app
|
|
1331
1341
|
* @param {FrameApiPublishNeynarFrameRequest} requestParameters Request parameters.
|
|
1332
1342
|
* @param {*} [options] Override http request option.
|
|
1333
1343
|
* @throws {RequiredError}
|
|
@@ -1339,8 +1349,8 @@ export declare class FrameApi extends BaseAPI implements FrameApiInterface {
|
|
|
1339
1349
|
*/
|
|
1340
1350
|
publishNeynarFrame(requestParameters: FrameApiPublishNeynarFrameRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<NeynarFrame, any>>;
|
|
1341
1351
|
/**
|
|
1342
|
-
* Update an existing
|
|
1343
|
-
* @summary Update
|
|
1352
|
+
* Update an existing mini app with a list of pages, if it was made by the developer (identified by API key)
|
|
1353
|
+
* @summary Update mini app
|
|
1344
1354
|
* @param {FrameApiUpdateNeynarFrameRequest} requestParameters Request parameters.
|
|
1345
1355
|
* @param {*} [options] Override http request option.
|
|
1346
1356
|
* @throws {RequiredError}
|
|
@@ -1352,8 +1362,8 @@ export declare class FrameApi extends BaseAPI implements FrameApiInterface {
|
|
|
1352
1362
|
*/
|
|
1353
1363
|
updateNeynarFrame(requestParameters: FrameApiUpdateNeynarFrameRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<NeynarFrame, any>>;
|
|
1354
1364
|
/**
|
|
1355
|
-
* Validates a
|
|
1356
|
-
* @summary Validate
|
|
1365
|
+
* 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)
|
|
1366
|
+
* @summary Validate mini app action
|
|
1357
1367
|
* @param {FrameApiValidateFrameActionRequest} requestParameters Request parameters.
|
|
1358
1368
|
* @param {*} [options] Override http request option.
|
|
1359
1369
|
* @throws {RequiredError}
|