@neynar/nodejs-sdk 3.34.0 → 3.78.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/README.md +1 -1
- package/build/api/api.d.ts +2 -1
- package/build/api/api.js +2 -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 +1 -1
- package/build/api/apis/agents-api.js +1 -1
- package/build/api/apis/app-host-api.d.ts +1 -1
- package/build/api/apis/app-host-api.js +1 -1
- package/build/api/apis/auth-address-api.d.ts +1 -1
- package/build/api/apis/auth-address-api.js +1 -1
- 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 +4 -113
- package/build/api/apis/cast-api.js +4 -105
- 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 +2 -115
- package/build/api/apis/feed-api.js +2 -103
- 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 +1 -931
- package/build/api/apis/frame-api.js +19 -991
- 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 +188 -1
- package/build/api/apis/onchain-api.js +191 -2
- 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/studio-api.d.ts +1445 -0
- package/build/api/apis/studio-api.js +1470 -0
- 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/app-host-event-type.d.ts +1 -1
- package/build/api/models/app-host-event-type.js +1 -1
- package/build/api/models/app-host-get-event-response-notification-details.d.ts +1 -1
- package/build/api/models/app-host-get-event-response-notification-details.js +1 -1
- package/build/api/models/app-host-get-event-response.d.ts +1 -1
- package/build/api/models/app-host-get-event-response.js +1 -1
- package/build/api/models/app-host-post-event-req-body.d.ts +4 -4
- package/build/api/models/app-host-post-event-req-body.js +1 -1
- package/build/api/models/app-host-post-event-response.d.ts +1 -1
- package/build/api/models/app-host-post-event-response.js +1 -1
- package/build/api/models/app-host-user-state-response-notifications-enabled-inner.d.ts +1 -1
- package/build/api/models/app-host-user-state-response-notifications-enabled-inner.js +1 -1
- package/build/api/models/app-host-user-state-response.d.ts +1 -1
- package/build/api/models/app-host-user-state-response.js +1 -1
- package/build/api/models/associate-deployment-request-account-association.d.ts +36 -0
- package/build/api/models/{cast-composer-actions-list-response-actions-inner-action.js → associate-deployment-request-account-association.js} +1 -1
- package/build/api/models/associate-deployment-request.d.ts +37 -0
- package/build/api/models/{app-host-post-event-req-body-one-of-signed-message.js → associate-deployment-request.js} +1 -1
- package/build/api/models/{neynar-page-input-text.d.ts → associate-deployment200-response.d.ts} +9 -9
- package/build/api/models/{app-host-post-event-req-body-one-of1.js → associate-deployment200-response.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/best-friends-response-users-inner.d.ts +1 -1
- package/build/api/models/best-friends-response-users-inner.js +1 -1
- package/build/api/models/best-friends-response.d.ts +1 -1
- package/build/api/models/best-friends-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-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-and-conversations-ref.d.ts +1 -8
- package/build/api/models/cast-and-conversations-ref.js +1 -1
- package/build/api/models/cast-and-conversations.d.ts +1 -8
- package/build/api/models/cast-and-conversations.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-notification-type.d.ts +1 -1
- package/build/api/models/cast-notification-type.js +1 -1
- package/build/api/models/cast-reactions.d.ts +5 -3
- package/build/api/models/cast-reactions.js +1 -1
- package/build/api/models/cast-replies.d.ts +1 -1
- package/build/api/models/cast-replies.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.d.ts +1 -8
- 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.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-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/create-deployment-request.d.ts +38 -0
- package/build/api/models/{app-host-post-event-req-body-one-of.js → create-deployment-request.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/{neynar-frame-creation-req-body.d.ts → delete-deployment-request.d.ts} +11 -12
- package/build/api/models/delete-deployment-request.js +15 -0
- package/build/api/models/{validated-frame-action-tapped-button.d.ts → delete-deployment200-response.d.ts} +11 -5
- package/build/api/models/delete-deployment200-response.js +15 -0
- 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/{cast-id.d.ts → embed-cast-deep-cast-id.d.ts} +6 -6
- package/build/api/models/embed-cast-deep-cast-id.js +15 -0
- package/build/api/models/embed-cast-deep.d.ts +5 -5
- package/build/api/models/embed-cast-deep.js +1 -1
- package/build/api/models/embed-cast.d.ts +5 -5
- 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-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/encoded-json-farcaster-signature.d.ts +1 -1
- package/build/api/models/encoded-json-farcaster-signature.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-fungible.d.ts +41 -0
- package/build/api/models/{neynar-page-image.js → farcaster-fungible.js} +4 -5
- 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.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/fetch-cast-quotes200-response.d.ts +1 -1
- package/build/api/models/fetch-cast-quotes200-response.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-relevant-frames200-response-relevant-frames-inner-frame-metadata.d.ts +1 -1
- package/build/api/models/fetch-relevant-frames200-response-relevant-frames-inner-frame-metadata.js +1 -1
- package/build/api/models/fetch-relevant-frames200-response-relevant-frames-inner-frame.d.ts +1 -1
- package/build/api/models/fetch-relevant-frames200-response-relevant-frames-inner-frame.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/{frame-input.d.ts → fetch-trending-fungibles200-response-trending-inner-fungible-price.d.ts} +6 -6
- package/build/api/models/fetch-trending-fungibles200-response-trending-inner-fungible-price.js +15 -0
- package/build/api/models/fetch-trending-fungibles200-response-trending-inner-fungible.d.ts +78 -0
- package/build/api/models/{neynar-page-button.js → fetch-trending-fungibles200-response-trending-inner-fungible.js} +4 -7
- package/build/api/models/fetch-trending-fungibles200-response-trending-inner.d.ts +35 -0
- package/build/api/models/{validated-frame-action.js → fetch-trending-fungibles200-response-trending-inner.js} +4 -4
- package/build/api/models/fetch-trending-fungibles200-response.d.ts +25 -0
- package/build/api/models/fetch-trending-fungibles200-response.js +15 -0
- 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/fetch-user-reciprocal-followers200-response.d.ts +1 -1
- package/build/api/models/fetch-user-reciprocal-followers200-response.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/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/frame-action-button.d.ts +1 -1
- package/build/api/models/frame-action-button.js +1 -1
- package/build/api/models/frame-button-action-type.d.ts +1 -1
- package/build/api/models/frame-button-action-type.js +1 -1
- 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-notification-tokens-notification-tokens-inner.d.ts +2 -1
- package/build/api/models/frame-notification-tokens-notification-tokens-inner.js +3 -2
- 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-req-body-transaction.d.ts +1 -1
- package/build/api/models/frame-pay-transaction-req-body-transaction.js +1 -1
- package/build/api/models/frame-pay-transaction-req-body.d.ts +1 -1
- package/build/api/models/frame-pay-transaction-req-body.js +1 -1
- package/build/api/models/frame-v1-input.d.ts +1 -1
- package/build/api/models/frame-v1-input.js +1 -1
- package/build/api/models/frame-v1-state.d.ts +1 -1
- package/build/api/models/frame-v1-state.js +1 -1
- package/build/api/models/frame-v1.d.ts +1 -1
- package/build/api/models/frame-v1.js +1 -1
- package/build/api/models/frame-v2-with-full-author.d.ts +1 -1
- package/build/api/models/frame-v2-with-full-author.js +1 -1
- package/build/api/models/frame-v2.d.ts +1 -1
- package/build/api/models/frame-v2.js +1 -1
- package/build/api/models/frame.d.ts +1 -1
- package/build/api/models/frame.js +1 -1
- package/build/api/models/fungible.d.ts +71 -0
- package/build/api/models/fungible.js +19 -0
- package/build/api/models/{fetch-frame-meta-tags-from-url200-response.d.ts → fungibles-response-schema.d.ts} +8 -8
- package/build/api/models/fungibles-response-schema.js +15 -0
- package/build/api/models/get-conversation-messages200-response-messages-inner.d.ts +66 -0
- package/build/api/models/get-conversation-messages200-response-messages-inner.js +21 -0
- package/build/api/models/get-conversation-messages200-response.d.ts +25 -0
- package/build/api/models/get-conversation-messages200-response.js +15 -0
- package/build/api/models/get-deployment-file200-response.d.ts +30 -0
- package/build/api/models/get-deployment-file200-response.js +15 -0
- package/build/api/models/{frame-state.d.ts → get-deployment-logs200-response.d.ts} +6 -6
- package/build/api/models/get-deployment-logs200-response.js +15 -0
- package/build/api/models/get-notification-campaign-stats200-response.d.ts +4 -4
- package/build/api/models/get-notification-campaign-stats200-response.js +1 -1
- package/build/api/models/html-metadata-oembed.d.ts +1 -1
- package/build/api/models/html-metadata-oembed.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/index.d.ts +41 -48
- package/build/api/models/index.js +41 -48
- 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/list-conversations200-response-conversations-inner.d.ts +48 -0
- package/build/api/models/list-conversations200-response-conversations-inner.js +15 -0
- package/build/api/models/list-conversations200-response.d.ts +25 -0
- package/build/api/models/list-conversations200-response.js +15 -0
- package/build/api/models/list-deployment-files200-response-files-inner.d.ts +36 -0
- package/build/api/models/list-deployment-files200-response-files-inner.js +15 -0
- package/build/api/models/list-deployment-files200-response.d.ts +25 -0
- package/build/api/models/list-deployment-files200-response.js +15 -0
- package/build/api/models/list-deployments200-response-inner.d.ts +72 -0
- package/build/api/models/list-deployments200-response-inner.js +15 -0
- package/build/api/models/{delete-frame-req-body.d.ts → list-deployments400-response.d.ts} +5 -5
- package/build/api/models/list-deployments400-response.js +15 -0
- 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/mint-nft-request-recipients-inner.d.ts +1 -1
- package/build/api/models/mint-nft-request-recipients-inner.js +1 -1
- package/build/api/models/mint-nft-request.d.ts +1 -1
- package/build/api/models/mint-nft-request.js +1 -1
- package/build/api/models/mint-nft200-response-transactions-inner-receipt.d.ts +1 -1
- package/build/api/models/mint-nft200-response-transactions-inner-receipt.js +1 -1
- package/build/api/models/mint-nft200-response-transactions-inner-recipient.d.ts +1 -1
- package/build/api/models/mint-nft200-response-transactions-inner-recipient.js +1 -1
- package/build/api/models/mint-nft200-response-transactions-inner.d.ts +1 -1
- package/build/api/models/mint-nft200-response-transactions-inner.js +1 -1
- package/build/api/models/mint-nft200-response.d.ts +1 -1
- package/build/api/models/mint-nft200-response.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/network.d.ts +1 -1
- package/build/api/models/network.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/nonce-response.d.ts +1 -1
- package/build/api/models/nonce-response.js +1 -1
- package/build/api/models/{get-notification-campaign-stats200-response-notification-campaigns-inner-stats-error-breakdown.d.ts → notification-campaign-stats-error-breakdown.d.ts} +5 -5
- package/build/api/models/notification-campaign-stats-error-breakdown.js +15 -0
- package/build/api/models/{get-notification-campaign-stats200-response-notification-campaigns-inner-stats.d.ts → notification-campaign-stats.d.ts} +15 -15
- package/build/api/models/notification-campaign-stats.js +15 -0
- package/build/api/models/notification-campaign.d.ts +49 -0
- package/build/api/models/notification-campaign.js +15 -0
- package/build/api/models/notification-delivery.d.ts +6 -2
- package/build/api/models/notification-delivery.js +6 -2
- 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-link-data.d.ts +1 -1
- package/build/api/models/oembed-link-data.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.d.ts +1 -1
- package/build/api/models/oembed-rich-data.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/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-author.d.ts +1 -1
- package/build/api/models/post-cast-response-cast-author.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/prompt-deployment-request.d.ts +50 -0
- package/build/api/models/prompt-deployment-request.js +15 -0
- package/build/api/models/prompt-deployment200-response.d.ts +30 -0
- package/build/api/models/prompt-deployment200-response.js +15 -0
- 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/reciprocal-follower.d.ts +1 -1
- package/build/api/models/reciprocal-follower.js +1 -1
- package/build/api/models/register-auth-address-developer-managed-signed-key-req-body.d.ts +1 -1
- package/build/api/models/register-auth-address-developer-managed-signed-key-req-body.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-signed-key-for-developer-managed-auth-address200-response.d.ts +1 -1
- package/build/api/models/register-signed-key-for-developer-managed-auth-address200-response.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-on-chain-req-body-pre-registration-calls-inner.d.ts +1 -1
- package/build/api/models/register-user-on-chain-req-body-pre-registration-calls-inner.js +1 -1
- package/build/api/models/register-user-on-chain-req-body-registration.d.ts +1 -1
- package/build/api/models/register-user-on-chain-req-body-registration.js +1 -1
- package/build/api/models/register-user-on-chain-req-body-signers-inner.d.ts +1 -1
- package/build/api/models/register-user-on-chain-req-body-signers-inner.js +1 -1
- package/build/api/models/register-user-on-chain-req-body.d.ts +1 -1
- package/build/api/models/register-user-on-chain-req-body.js +1 -1
- package/build/api/models/register-user-on-chain-response.d.ts +1 -1
- package/build/api/models/register-user-on-chain-response.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/{neynar-frame-update-req-body.d.ts → register-user-req-body-signer.d.ts} +17 -12
- package/build/api/models/register-user-req-body-signer.js +15 -0
- package/build/api/models/register-user-req-body.d.ts +8 -1
- package/build/api/models/register-user-req-body.js +1 -1
- package/build/api/models/register-user-response-signers-inner.d.ts +72 -0
- package/build/api/models/register-user-response-signers-inner.js +25 -0
- package/build/api/models/register-user-response.d.ts +9 -2
- 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/send-frame-notifications-req-body-filters-near-location.d.ts +1 -1
- package/build/api/models/send-frame-notifications-req-body-filters-near-location.js +1 -1
- package/build/api/models/send-frame-notifications-req-body-filters.d.ts +1 -1
- package/build/api/models/send-frame-notifications-req-body-filters.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 +2 -2
- 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 +2 -2
- package/build/api/models/signed-key-request-sponsor.js +1 -1
- package/build/api/models/{app-host-post-event-req-body-one-of-signed-message.d.ts → signed-message-body-signed-message.d.ts} +3 -3
- package/build/api/models/signed-message-body-signed-message.js +15 -0
- package/build/api/models/{app-host-post-event-req-body-one-of.d.ts → signed-message-body.d.ts} +8 -8
- package/build/api/models/signed-message-body.js +15 -0
- 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/{app-host-post-event-req-body-one-of1.d.ts → signer-uuid-body.d.ts} +7 -7
- package/build/api/models/signer-uuid-body.js +15 -0
- package/build/api/models/signer.d.ts +1 -1
- package/build/api/models/signer.js +1 -1
- package/build/api/models/simulate-nft-mint-response-inner.d.ts +1 -1
- package/build/api/models/simulate-nft-mint-response-inner.js +1 -1
- package/build/api/models/simulate-nft-mint-response.d.ts +1 -1
- package/build/api/models/simulate-nft-mint-response.js +1 -1
- package/build/api/models/start-app-request.d.ts +30 -0
- package/build/api/models/start-app-request.js +15 -0
- package/build/api/models/{delete-frame-response.d.ts → start-app200-response.d.ts} +8 -8
- package/build/api/models/start-app200-response.js +15 -0
- 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-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-value.d.ts +1 -1
- package/build/api/models/subscription-check-response-value.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-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-config.d.ts +1 -1
- 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.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 +1 -1
- package/build/api/models/transaction-frame-type.js +1 -1
- package/build/api/models/transaction-frame.d.ts +1 -1
- package/build/api/models/transaction-frame.js +1 -1
- package/build/api/models/transaction-send-fungibles-receipt.d.ts +1 -1
- package/build/api/models/transaction-send-fungibles-receipt.js +1 -1
- package/build/api/models/transaction-send-fungibles-recipient.d.ts +1 -1
- package/build/api/models/transaction-send-fungibles-recipient.js +1 -1
- package/build/api/models/transaction-send-fungibles-req-body.d.ts +1 -1
- package/build/api/models/transaction-send-fungibles-req-body.js +1 -1
- package/build/api/models/transaction-send-fungibles-response.d.ts +1 -1
- package/build/api/models/transaction-send-fungibles-response.js +1 -1
- package/build/api/models/transaction-send-tx-info.d.ts +1 -1
- package/build/api/models/transaction-send-tx-info.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/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 +14 -2
- package/build/api/models/update-user-req-body.js +1 -1
- package/build/api/models/{frame-transaction.d.ts → update-user207-response-errors-inner.d.ts} +6 -6
- package/build/api/models/update-user207-response-errors-inner.js +15 -0
- package/build/api/models/{validate-frame-action-response.d.ts → update-user207-response.d.ts} +9 -9
- package/build/api/models/update-user207-response.js +15 -0
- package/build/api/models/{cast-composer-actions-list-response-actions-inner-action.d.ts → upload-image-url-request.d.ts} +15 -9
- package/build/api/models/upload-image-url-request.js +15 -0
- package/build/api/models/upload-image200-response.d.ts +42 -0
- package/build/api/models/upload-image200-response.js +15 -0
- package/build/api/models/user-auth-addresses-inner.d.ts +1 -1
- package/build/api/models/user-auth-addresses-inner.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-pro.d.ts +1 -1
- package/build/api/models/user-pro.js +1 -1
- package/build/api/models/user-profile-banner.d.ts +1 -1
- package/build/api/models/user-profile-banner.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 +1 -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/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 +13 -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-trade.d.ts +36 -0
- package/build/api/models/webhook-subscription-filters-trade.js +15 -0
- 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 +8 -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 +511 -379
- package/build/clients/NeynarAPIClient.js +547 -403
- package/build/hub-api/base.js +1 -1
- package/build/types/webhooks.d.ts +5 -1
- package/package.json +1 -1
- package/build/api/models/cast-composer-actions-list-response-actions-inner.d.ts +0 -97
- package/build/api/models/cast-composer-actions-list-response-actions-inner.js +0 -15
- package/build/api/models/cast-composer-actions-list-response.d.ts +0 -32
- package/build/api/models/cast-composer-actions-list-response.js +0 -15
- package/build/api/models/cast-id.js +0 -15
- package/build/api/models/delete-frame-req-body.js +0 -15
- package/build/api/models/delete-frame-response.js +0 -15
- package/build/api/models/fetch-frame-meta-tags-from-url200-response.js +0 -15
- package/build/api/models/frame-action-req-body.d.ts +0 -37
- package/build/api/models/frame-action-req-body.js +0 -15
- package/build/api/models/frame-action.d.ts +0 -82
- package/build/api/models/frame-action.js +0 -15
- package/build/api/models/frame-developer-managed-action-req-body.d.ts +0 -38
- package/build/api/models/frame-developer-managed-action-req-body.js +0 -15
- package/build/api/models/frame-input.js +0 -15
- package/build/api/models/frame-signature-packet-trusted-data.d.ts +0 -24
- package/build/api/models/frame-signature-packet-trusted-data.js +0 -15
- package/build/api/models/frame-signature-packet-untrusted-data.d.ts +0 -85
- package/build/api/models/frame-signature-packet-untrusted-data.js +0 -15
- package/build/api/models/frame-signature-packet.d.ts +0 -32
- package/build/api/models/frame-signature-packet.js +0 -15
- package/build/api/models/frame-state.js +0 -15
- package/build/api/models/frame-transaction.js +0 -15
- package/build/api/models/frame-validate-analytics-input-text-input-texts-inner.d.ts +0 -36
- package/build/api/models/frame-validate-analytics-input-text-input-texts-inner.js +0 -15
- package/build/api/models/frame-validate-analytics-input-text.d.ts +0 -25
- package/build/api/models/frame-validate-analytics-input-text.js +0 -15
- package/build/api/models/frame-validate-analytics-interactions-per-cast-interactions-per-cast-inner.d.ts +0 -48
- package/build/api/models/frame-validate-analytics-interactions-per-cast-interactions-per-cast-inner.js +0 -15
- package/build/api/models/frame-validate-analytics-interactions-per-cast.d.ts +0 -25
- package/build/api/models/frame-validate-analytics-interactions-per-cast.js +0 -15
- package/build/api/models/frame-validate-analytics-interactors-interactors-inner.d.ts +0 -36
- package/build/api/models/frame-validate-analytics-interactors-interactors-inner.js +0 -15
- package/build/api/models/frame-validate-analytics-interactors.d.ts +0 -25
- package/build/api/models/frame-validate-analytics-interactors.js +0 -15
- package/build/api/models/frame-validate-analytics-response.d.ts +0 -20
- package/build/api/models/frame-validate-analytics-response.js +0 -15
- package/build/api/models/frame-validate-analytics-total-interactors.d.ts +0 -24
- package/build/api/models/frame-validate-analytics-total-interactors.js +0 -15
- package/build/api/models/frame-validate-list-response.d.ts +0 -24
- package/build/api/models/frame-validate-list-response.js +0 -15
- package/build/api/models/get-notification-campaign-stats200-response-notification-campaigns-inner-stats-error-breakdown.js +0 -15
- package/build/api/models/get-notification-campaign-stats200-response-notification-campaigns-inner-stats.js +0 -15
- package/build/api/models/get-notification-campaign-stats200-response-notification-campaigns-inner.d.ts +0 -49
- package/build/api/models/get-notification-campaign-stats200-response-notification-campaigns-inner.js +0 -15
- package/build/api/models/neynar-frame-creation-req-body.js +0 -15
- package/build/api/models/neynar-frame-page.d.ts +0 -57
- package/build/api/models/neynar-frame-page.js +0 -15
- package/build/api/models/neynar-frame-update-req-body.js +0 -15
- package/build/api/models/neynar-frame.d.ts +0 -49
- package/build/api/models/neynar-frame.js +0 -15
- package/build/api/models/neynar-next-frame-page-mint-url.d.ts +0 -24
- package/build/api/models/neynar-next-frame-page-mint-url.js +0 -15
- package/build/api/models/neynar-next-frame-page-redirect.d.ts +0 -24
- package/build/api/models/neynar-next-frame-page-redirect.js +0 -15
- package/build/api/models/neynar-next-frame-page.d.ts +0 -24
- package/build/api/models/neynar-next-frame-page.js +0 -15
- package/build/api/models/neynar-page-button-next-page.d.ts +0 -19
- package/build/api/models/neynar-page-button-next-page.js +0 -15
- package/build/api/models/neynar-page-button.d.ts +0 -50
- package/build/api/models/neynar-page-image.d.ts +0 -35
- package/build/api/models/neynar-page-input-text.js +0 -15
- package/build/api/models/neynar-page-input.d.ts +0 -25
- package/build/api/models/neynar-page-input.js +0 -15
- package/build/api/models/validate-frame-action-req-body.d.ts +0 -48
- package/build/api/models/validate-frame-action-req-body.js +0 -15
- package/build/api/models/validate-frame-action-response.js +0 -15
- package/build/api/models/validated-frame-action-signer.d.ts +0 -25
- package/build/api/models/validated-frame-action-signer.js +0 -15
- package/build/api/models/validated-frame-action-tapped-button.js +0 -15
- package/build/api/models/validated-frame-action.d.ts +0 -95
|
@@ -0,0 +1,1445 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Neynar API
|
|
3
|
+
* The Neynar API allows you to interact with the Farcaster protocol among other things. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 3.78.0
|
|
6
|
+
* Contact: team@neynar.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { Configuration } from '../configuration';
|
|
13
|
+
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
|
+
import { type RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import type { AssociateDeployment200Response } from '../models';
|
|
16
|
+
import type { AssociateDeploymentRequest } from '../models';
|
|
17
|
+
import type { CreateDeploymentRequest } from '../models';
|
|
18
|
+
import type { DeleteDeployment200Response } from '../models';
|
|
19
|
+
import type { DeleteDeploymentRequest } from '../models';
|
|
20
|
+
import type { GetConversationMessages200Response } from '../models';
|
|
21
|
+
import type { GetDeploymentFile200Response } from '../models';
|
|
22
|
+
import type { GetDeploymentLogs200Response } from '../models';
|
|
23
|
+
import type { ListConversations200Response } from '../models';
|
|
24
|
+
import type { ListDeploymentFiles200Response } from '../models';
|
|
25
|
+
import type { ListDeployments200ResponseInner } from '../models';
|
|
26
|
+
import type { PromptDeployment200Response } from '../models';
|
|
27
|
+
import type { PromptDeploymentRequest } from '../models';
|
|
28
|
+
import type { StartApp200Response } from '../models';
|
|
29
|
+
import type { StartAppRequest } from '../models';
|
|
30
|
+
import type { UploadImage200Response } from '../models';
|
|
31
|
+
import type { UploadImageUrlRequest } from '../models';
|
|
32
|
+
/**
|
|
33
|
+
* StudioApi - axios parameter creator
|
|
34
|
+
* @export
|
|
35
|
+
*/
|
|
36
|
+
export declare const StudioApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
37
|
+
/**
|
|
38
|
+
* Associates a generated miniapp with a Farcaster account using a JFS-signed domain association. Requires API key authentication.
|
|
39
|
+
* @summary Set account association
|
|
40
|
+
* @param {AssociateDeploymentRequest} associateDeploymentRequest
|
|
41
|
+
* @param {*} [options] Override http request option.
|
|
42
|
+
* @throws {RequiredError}
|
|
43
|
+
* @returns {Promise<AssociateDeployment200Response>} A promise that resolves to a `AssociateDeployment200Response` object
|
|
44
|
+
*
|
|
45
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/associate-deployment)
|
|
46
|
+
*
|
|
47
|
+
*/
|
|
48
|
+
associateDeployment: (associateDeploymentRequest: AssociateDeploymentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
49
|
+
/**
|
|
50
|
+
* Creates and deploys an instance of the miniapp generator for a user. Requires authentication via API key in the request header.
|
|
51
|
+
* @summary Create a miniapp generator deployment
|
|
52
|
+
* @param {CreateDeploymentRequest} createDeploymentRequest
|
|
53
|
+
* @param {*} [options] Override http request option.
|
|
54
|
+
* @throws {RequiredError}
|
|
55
|
+
* @returns {Promise<ListDeployments200ResponseInner>} A promise that resolves to a `ListDeployments200ResponseInner` object
|
|
56
|
+
*
|
|
57
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/create-deployment)
|
|
58
|
+
*
|
|
59
|
+
*/
|
|
60
|
+
createDeployment: (createDeploymentRequest: CreateDeploymentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
61
|
+
/**
|
|
62
|
+
* Deletes a specific miniapp generator deployment or all deployments for a FID. If name is provided, deletes single deployment. If only FID is provided, deletes all deployments for that FID. Requires API key authentication.
|
|
63
|
+
* @summary Delete deployment(s)
|
|
64
|
+
* @param {DeleteDeploymentRequest} deleteDeploymentRequest
|
|
65
|
+
* @param {*} [options] Override http request option.
|
|
66
|
+
* @throws {RequiredError}
|
|
67
|
+
* @returns {Promise<DeleteDeployment200Response>} A promise that resolves to a `DeleteDeployment200Response` object
|
|
68
|
+
*
|
|
69
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/delete-deployment)
|
|
70
|
+
*
|
|
71
|
+
*/
|
|
72
|
+
deleteDeployment: (deleteDeploymentRequest: DeleteDeploymentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
73
|
+
/**
|
|
74
|
+
* Retrieves all messages in a specific conversation. Requires API key authentication.
|
|
75
|
+
* @summary Get messages in a conversation
|
|
76
|
+
* @param {number | null} fid Farcaster ID of the user
|
|
77
|
+
* @param {string} name Kubernetes deployment name
|
|
78
|
+
* @param {string} conversationId Conversation ID
|
|
79
|
+
* @param {boolean | null} [includeDeleted] Include deleted messages in the response. Defaults to false.
|
|
80
|
+
* @param {*} [options] Override http request option.
|
|
81
|
+
* @throws {RequiredError}
|
|
82
|
+
* @returns {Promise<GetConversationMessages200Response>} A promise that resolves to a `GetConversationMessages200Response` object
|
|
83
|
+
*
|
|
84
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-conversation-messages)
|
|
85
|
+
*
|
|
86
|
+
*/
|
|
87
|
+
getConversationMessages: (fid: number | null, name: string, conversationId: string, includeDeleted?: boolean | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
88
|
+
/**
|
|
89
|
+
* Fetches info about a miniapp generator deployment by its name and creator\'s Farcaster ID. Requires API key authentication.
|
|
90
|
+
* @summary Get deployment info
|
|
91
|
+
* @param {number} fid Farcaster ID of the user
|
|
92
|
+
* @param {string} name Kubernetes deployment name
|
|
93
|
+
* @param {*} [options] Override http request option.
|
|
94
|
+
* @throws {RequiredError}
|
|
95
|
+
* @returns {Promise<ListDeployments200ResponseInner>} A promise that resolves to a `ListDeployments200ResponseInner` object
|
|
96
|
+
*
|
|
97
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-deployment)
|
|
98
|
+
*
|
|
99
|
+
*/
|
|
100
|
+
getDeployment: (fid: number, name: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
101
|
+
/**
|
|
102
|
+
* Retrieves the contents of a specific file from the generated app. Requires Studio admin authentication.
|
|
103
|
+
* @summary Get deployment file contents
|
|
104
|
+
* @param {number | null} fid Farcaster ID of the user
|
|
105
|
+
* @param {string} name Kubernetes deployment name
|
|
106
|
+
* @param {string} filePath File path relative to gen/
|
|
107
|
+
* @param {*} [options] Override http request option.
|
|
108
|
+
* @throws {RequiredError}
|
|
109
|
+
* @returns {Promise<GetDeploymentFile200Response>} A promise that resolves to a `GetDeploymentFile200Response` object
|
|
110
|
+
*
|
|
111
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-deployment-file)
|
|
112
|
+
*
|
|
113
|
+
*/
|
|
114
|
+
getDeploymentFile: (fid: number | null, name: string, filePath: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
115
|
+
/**
|
|
116
|
+
* Retrieves the server.log file from a miniapp-generator deployment. Requires Studio admin authentication.
|
|
117
|
+
* @summary Get deployment logs
|
|
118
|
+
* @param {number | null} fid Farcaster ID of the user
|
|
119
|
+
* @param {string} name Kubernetes deployment name
|
|
120
|
+
* @param {*} [options] Override http request option.
|
|
121
|
+
* @throws {RequiredError}
|
|
122
|
+
* @returns {Promise<GetDeploymentLogs200Response>} A promise that resolves to a `GetDeploymentLogs200Response` object
|
|
123
|
+
*
|
|
124
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-deployment-logs)
|
|
125
|
+
*
|
|
126
|
+
*/
|
|
127
|
+
getDeploymentLogs: (fid: number | null, name: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
128
|
+
/**
|
|
129
|
+
* Lists all conversations for a specific deployment. Requires API key authentication.
|
|
130
|
+
* @summary List conversations for a deployment
|
|
131
|
+
* @param {number | null} [fid] Farcaster ID of the user. Required for non-admin users. Studio admins can omit to query all conversations.
|
|
132
|
+
* @param {string} [name] Kubernetes deployment name. If provided, filters conversations to this deployment only.
|
|
133
|
+
* @param {boolean | null} [includeDeleted] Include deleted conversations in the response. Defaults to false.
|
|
134
|
+
* @param {*} [options] Override http request option.
|
|
135
|
+
* @throws {RequiredError}
|
|
136
|
+
* @returns {Promise<ListConversations200Response>} A promise that resolves to a `ListConversations200Response` object
|
|
137
|
+
*
|
|
138
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-conversations)
|
|
139
|
+
*
|
|
140
|
+
*/
|
|
141
|
+
listConversations: (fid?: number | null, name?: string, includeDeleted?: boolean | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
142
|
+
/**
|
|
143
|
+
* Lists files in a directory of the generated app. Requires Studio admin authentication.
|
|
144
|
+
* @summary List deployment files
|
|
145
|
+
* @param {number | null} fid Farcaster ID of the user
|
|
146
|
+
* @param {string} name Kubernetes deployment name
|
|
147
|
+
* @param {string} [directory] Directory path relative to gen/ (defaults to root)
|
|
148
|
+
* @param {*} [options] Override http request option.
|
|
149
|
+
* @throws {RequiredError}
|
|
150
|
+
* @returns {Promise<ListDeploymentFiles200Response>} A promise that resolves to a `ListDeploymentFiles200Response` object
|
|
151
|
+
*
|
|
152
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-deployment-files)
|
|
153
|
+
*
|
|
154
|
+
*/
|
|
155
|
+
listDeploymentFiles: (fid: number | null, name: string, directory?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
156
|
+
/**
|
|
157
|
+
* Lists all miniapp generator deployments for a user. Requires API key authentication.
|
|
158
|
+
* @summary List deployments
|
|
159
|
+
* @param {number | null} [fid] Farcaster ID of the user. Required for non-admin users. Studio admins can omit to query all deployments.
|
|
160
|
+
* @param {number} [limit] Maximum number of deployments to return. Defaults to 50, max 1000. (Default: 50, Maximum: 1000)
|
|
161
|
+
* @param {number | null} [offset] Number of deployments to skip for pagination. Defaults to 0.
|
|
162
|
+
* @param {boolean | null} [includeDeleted] Include deleted deployments in the response. Defaults to false.
|
|
163
|
+
* @param {*} [options] Override http request option.
|
|
164
|
+
* @throws {RequiredError}
|
|
165
|
+
* @returns {Promise<Array<ListDeployments200ResponseInner>>} A promise that resolves to a `Array<ListDeployments200ResponseInner>` object
|
|
166
|
+
*
|
|
167
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-deployments)
|
|
168
|
+
*
|
|
169
|
+
*/
|
|
170
|
+
listDeployments: (fid?: number | null, limit?: number, offset?: number | null, includeDeleted?: boolean | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
171
|
+
/**
|
|
172
|
+
* Sends a prompt to a specific miniapp generator deployment. Requires authentication via API key in the request header.
|
|
173
|
+
* @summary Prompt a deployment
|
|
174
|
+
* @param {PromptDeploymentRequest} promptDeploymentRequest
|
|
175
|
+
* @param {*} [options] Override http request option.
|
|
176
|
+
* @throws {RequiredError}
|
|
177
|
+
* @returns {Promise<PromptDeployment200Response>} A promise that resolves to a `PromptDeployment200Response` object
|
|
178
|
+
*
|
|
179
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/prompt-deployment)
|
|
180
|
+
*
|
|
181
|
+
*/
|
|
182
|
+
promptDeployment: (promptDeploymentRequest: PromptDeploymentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
183
|
+
/**
|
|
184
|
+
* Sends a prompt to a specific miniapp generator deployment and returns a streaming response using Server-Sent Events. The response is a continuous stream of Server-Sent Events, not a single JSON payload. Each event contains a JSON object with type, message, and other fields specific to the message type. Requires authentication via API key in the request header.
|
|
185
|
+
* @summary Prompt a deployment with streaming response
|
|
186
|
+
* @param {PromptDeploymentRequest} promptDeploymentRequest
|
|
187
|
+
* @param {*} [options] Override http request option.
|
|
188
|
+
* @throws {RequiredError}
|
|
189
|
+
* @returns {Promise<>} A promise that resolves to a `` object
|
|
190
|
+
*
|
|
191
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/prompt-deployment-stream)
|
|
192
|
+
*
|
|
193
|
+
*/
|
|
194
|
+
promptDeploymentStream: (promptDeploymentRequest: PromptDeploymentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
195
|
+
/**
|
|
196
|
+
* Starts the Next.js development server for the generated miniapp. Requires Studio admin authentication.
|
|
197
|
+
* @summary Start generated miniapp
|
|
198
|
+
* @param {StartAppRequest} startAppRequest
|
|
199
|
+
* @param {*} [options] Override http request option.
|
|
200
|
+
* @throws {RequiredError}
|
|
201
|
+
* @returns {Promise<StartApp200Response>} A promise that resolves to a `StartApp200Response` object
|
|
202
|
+
*
|
|
203
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/start-app)
|
|
204
|
+
*
|
|
205
|
+
*/
|
|
206
|
+
startApp: (startAppRequest: StartAppRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
207
|
+
/**
|
|
208
|
+
* Stops the Next.js development server for the generated miniapp. Requires Studio admin authentication.
|
|
209
|
+
* @summary Stop generated miniapp
|
|
210
|
+
* @param {StartAppRequest} startAppRequest
|
|
211
|
+
* @param {*} [options] Override http request option.
|
|
212
|
+
* @throws {RequiredError}
|
|
213
|
+
* @returns {Promise<StartApp200Response>} A promise that resolves to a `StartApp200Response` object
|
|
214
|
+
*
|
|
215
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/stop-app)
|
|
216
|
+
*
|
|
217
|
+
*/
|
|
218
|
+
stopApp: (startAppRequest: StartAppRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
219
|
+
/**
|
|
220
|
+
* Uploads an image file to the generated miniapp public folder. The image will be accessible as a static asset on the deployed miniapp. Requires API key authentication.
|
|
221
|
+
* @summary Upload image to deployment
|
|
222
|
+
* @param {*} [options] Override http request option.
|
|
223
|
+
* @throws {RequiredError}
|
|
224
|
+
* @returns {Promise<UploadImage200Response>} A promise that resolves to a `UploadImage200Response` object
|
|
225
|
+
*
|
|
226
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/upload-image)
|
|
227
|
+
*
|
|
228
|
+
*/
|
|
229
|
+
uploadImage: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
230
|
+
/**
|
|
231
|
+
* Downloads an image from the provided URL and saves it to the generated miniapp public folder. The image will be accessible as a static asset on the deployed miniapp. Requires API key authentication.
|
|
232
|
+
* @summary Upload image from URL to deployment
|
|
233
|
+
* @param {UploadImageUrlRequest} uploadImageUrlRequest
|
|
234
|
+
* @param {*} [options] Override http request option.
|
|
235
|
+
* @throws {RequiredError}
|
|
236
|
+
* @returns {Promise<UploadImage200Response>} A promise that resolves to a `UploadImage200Response` object
|
|
237
|
+
*
|
|
238
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/upload-image-url)
|
|
239
|
+
*
|
|
240
|
+
*/
|
|
241
|
+
uploadImageUrl: (uploadImageUrlRequest: UploadImageUrlRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
242
|
+
};
|
|
243
|
+
/**
|
|
244
|
+
* StudioApi - functional programming interface
|
|
245
|
+
* @export
|
|
246
|
+
*/
|
|
247
|
+
export declare const StudioApiFp: (configuration?: Configuration) => {
|
|
248
|
+
/**
|
|
249
|
+
* Associates a generated miniapp with a Farcaster account using a JFS-signed domain association. Requires API key authentication.
|
|
250
|
+
* @summary Set account association
|
|
251
|
+
* @param {AssociateDeploymentRequest} associateDeploymentRequest
|
|
252
|
+
* @param {*} [options] Override http request option.
|
|
253
|
+
* @throws {RequiredError}
|
|
254
|
+
* @returns {Promise<AssociateDeployment200Response>} A promise that resolves to a `AssociateDeployment200Response` object
|
|
255
|
+
*
|
|
256
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/associate-deployment)
|
|
257
|
+
*
|
|
258
|
+
*/
|
|
259
|
+
associateDeployment(associateDeploymentRequest: AssociateDeploymentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AssociateDeployment200Response>>;
|
|
260
|
+
/**
|
|
261
|
+
* Creates and deploys an instance of the miniapp generator for a user. Requires authentication via API key in the request header.
|
|
262
|
+
* @summary Create a miniapp generator deployment
|
|
263
|
+
* @param {CreateDeploymentRequest} createDeploymentRequest
|
|
264
|
+
* @param {*} [options] Override http request option.
|
|
265
|
+
* @throws {RequiredError}
|
|
266
|
+
* @returns {Promise<ListDeployments200ResponseInner>} A promise that resolves to a `ListDeployments200ResponseInner` object
|
|
267
|
+
*
|
|
268
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/create-deployment)
|
|
269
|
+
*
|
|
270
|
+
*/
|
|
271
|
+
createDeployment(createDeploymentRequest: CreateDeploymentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDeployments200ResponseInner>>;
|
|
272
|
+
/**
|
|
273
|
+
* Deletes a specific miniapp generator deployment or all deployments for a FID. If name is provided, deletes single deployment. If only FID is provided, deletes all deployments for that FID. Requires API key authentication.
|
|
274
|
+
* @summary Delete deployment(s)
|
|
275
|
+
* @param {DeleteDeploymentRequest} deleteDeploymentRequest
|
|
276
|
+
* @param {*} [options] Override http request option.
|
|
277
|
+
* @throws {RequiredError}
|
|
278
|
+
* @returns {Promise<DeleteDeployment200Response>} A promise that resolves to a `DeleteDeployment200Response` object
|
|
279
|
+
*
|
|
280
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/delete-deployment)
|
|
281
|
+
*
|
|
282
|
+
*/
|
|
283
|
+
deleteDeployment(deleteDeploymentRequest: DeleteDeploymentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteDeployment200Response>>;
|
|
284
|
+
/**
|
|
285
|
+
* Retrieves all messages in a specific conversation. Requires API key authentication.
|
|
286
|
+
* @summary Get messages in a conversation
|
|
287
|
+
* @param {number | null} fid Farcaster ID of the user
|
|
288
|
+
* @param {string} name Kubernetes deployment name
|
|
289
|
+
* @param {string} conversationId Conversation ID
|
|
290
|
+
* @param {boolean | null} [includeDeleted] Include deleted messages in the response. Defaults to false.
|
|
291
|
+
* @param {*} [options] Override http request option.
|
|
292
|
+
* @throws {RequiredError}
|
|
293
|
+
* @returns {Promise<GetConversationMessages200Response>} A promise that resolves to a `GetConversationMessages200Response` object
|
|
294
|
+
*
|
|
295
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-conversation-messages)
|
|
296
|
+
*
|
|
297
|
+
*/
|
|
298
|
+
getConversationMessages(fid: number | null, name: string, conversationId: string, includeDeleted?: boolean | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetConversationMessages200Response>>;
|
|
299
|
+
/**
|
|
300
|
+
* Fetches info about a miniapp generator deployment by its name and creator\'s Farcaster ID. Requires API key authentication.
|
|
301
|
+
* @summary Get deployment info
|
|
302
|
+
* @param {number} fid Farcaster ID of the user
|
|
303
|
+
* @param {string} name Kubernetes deployment name
|
|
304
|
+
* @param {*} [options] Override http request option.
|
|
305
|
+
* @throws {RequiredError}
|
|
306
|
+
* @returns {Promise<ListDeployments200ResponseInner>} A promise that resolves to a `ListDeployments200ResponseInner` object
|
|
307
|
+
*
|
|
308
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-deployment)
|
|
309
|
+
*
|
|
310
|
+
*/
|
|
311
|
+
getDeployment(fid: number, name: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDeployments200ResponseInner>>;
|
|
312
|
+
/**
|
|
313
|
+
* Retrieves the contents of a specific file from the generated app. Requires Studio admin authentication.
|
|
314
|
+
* @summary Get deployment file contents
|
|
315
|
+
* @param {number | null} fid Farcaster ID of the user
|
|
316
|
+
* @param {string} name Kubernetes deployment name
|
|
317
|
+
* @param {string} filePath File path relative to gen/
|
|
318
|
+
* @param {*} [options] Override http request option.
|
|
319
|
+
* @throws {RequiredError}
|
|
320
|
+
* @returns {Promise<GetDeploymentFile200Response>} A promise that resolves to a `GetDeploymentFile200Response` object
|
|
321
|
+
*
|
|
322
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-deployment-file)
|
|
323
|
+
*
|
|
324
|
+
*/
|
|
325
|
+
getDeploymentFile(fid: number | null, name: string, filePath: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDeploymentFile200Response>>;
|
|
326
|
+
/**
|
|
327
|
+
* Retrieves the server.log file from a miniapp-generator deployment. Requires Studio admin authentication.
|
|
328
|
+
* @summary Get deployment logs
|
|
329
|
+
* @param {number | null} fid Farcaster ID of the user
|
|
330
|
+
* @param {string} name Kubernetes deployment name
|
|
331
|
+
* @param {*} [options] Override http request option.
|
|
332
|
+
* @throws {RequiredError}
|
|
333
|
+
* @returns {Promise<GetDeploymentLogs200Response>} A promise that resolves to a `GetDeploymentLogs200Response` object
|
|
334
|
+
*
|
|
335
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-deployment-logs)
|
|
336
|
+
*
|
|
337
|
+
*/
|
|
338
|
+
getDeploymentLogs(fid: number | null, name: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDeploymentLogs200Response>>;
|
|
339
|
+
/**
|
|
340
|
+
* Lists all conversations for a specific deployment. Requires API key authentication.
|
|
341
|
+
* @summary List conversations for a deployment
|
|
342
|
+
* @param {number | null} [fid] Farcaster ID of the user. Required for non-admin users. Studio admins can omit to query all conversations.
|
|
343
|
+
* @param {string} [name] Kubernetes deployment name. If provided, filters conversations to this deployment only.
|
|
344
|
+
* @param {boolean | null} [includeDeleted] Include deleted conversations in the response. Defaults to false.
|
|
345
|
+
* @param {*} [options] Override http request option.
|
|
346
|
+
* @throws {RequiredError}
|
|
347
|
+
* @returns {Promise<ListConversations200Response>} A promise that resolves to a `ListConversations200Response` object
|
|
348
|
+
*
|
|
349
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-conversations)
|
|
350
|
+
*
|
|
351
|
+
*/
|
|
352
|
+
listConversations(fid?: number | null, name?: string, includeDeleted?: boolean | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListConversations200Response>>;
|
|
353
|
+
/**
|
|
354
|
+
* Lists files in a directory of the generated app. Requires Studio admin authentication.
|
|
355
|
+
* @summary List deployment files
|
|
356
|
+
* @param {number | null} fid Farcaster ID of the user
|
|
357
|
+
* @param {string} name Kubernetes deployment name
|
|
358
|
+
* @param {string} [directory] Directory path relative to gen/ (defaults to root)
|
|
359
|
+
* @param {*} [options] Override http request option.
|
|
360
|
+
* @throws {RequiredError}
|
|
361
|
+
* @returns {Promise<ListDeploymentFiles200Response>} A promise that resolves to a `ListDeploymentFiles200Response` object
|
|
362
|
+
*
|
|
363
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-deployment-files)
|
|
364
|
+
*
|
|
365
|
+
*/
|
|
366
|
+
listDeploymentFiles(fid: number | null, name: string, directory?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDeploymentFiles200Response>>;
|
|
367
|
+
/**
|
|
368
|
+
* Lists all miniapp generator deployments for a user. Requires API key authentication.
|
|
369
|
+
* @summary List deployments
|
|
370
|
+
* @param {number | null} [fid] Farcaster ID of the user. Required for non-admin users. Studio admins can omit to query all deployments.
|
|
371
|
+
* @param {number} [limit] Maximum number of deployments to return. Defaults to 50, max 1000. (Default: 50, Maximum: 1000)
|
|
372
|
+
* @param {number | null} [offset] Number of deployments to skip for pagination. Defaults to 0.
|
|
373
|
+
* @param {boolean | null} [includeDeleted] Include deleted deployments in the response. Defaults to false.
|
|
374
|
+
* @param {*} [options] Override http request option.
|
|
375
|
+
* @throws {RequiredError}
|
|
376
|
+
* @returns {Promise<Array<ListDeployments200ResponseInner>>} A promise that resolves to a `Array<ListDeployments200ResponseInner>` object
|
|
377
|
+
*
|
|
378
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-deployments)
|
|
379
|
+
*
|
|
380
|
+
*/
|
|
381
|
+
listDeployments(fid?: number | null, limit?: number, offset?: number | null, includeDeleted?: boolean | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ListDeployments200ResponseInner>>>;
|
|
382
|
+
/**
|
|
383
|
+
* Sends a prompt to a specific miniapp generator deployment. Requires authentication via API key in the request header.
|
|
384
|
+
* @summary Prompt a deployment
|
|
385
|
+
* @param {PromptDeploymentRequest} promptDeploymentRequest
|
|
386
|
+
* @param {*} [options] Override http request option.
|
|
387
|
+
* @throws {RequiredError}
|
|
388
|
+
* @returns {Promise<PromptDeployment200Response>} A promise that resolves to a `PromptDeployment200Response` object
|
|
389
|
+
*
|
|
390
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/prompt-deployment)
|
|
391
|
+
*
|
|
392
|
+
*/
|
|
393
|
+
promptDeployment(promptDeploymentRequest: PromptDeploymentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PromptDeployment200Response>>;
|
|
394
|
+
/**
|
|
395
|
+
* Sends a prompt to a specific miniapp generator deployment and returns a streaming response using Server-Sent Events. The response is a continuous stream of Server-Sent Events, not a single JSON payload. Each event contains a JSON object with type, message, and other fields specific to the message type. Requires authentication via API key in the request header.
|
|
396
|
+
* @summary Prompt a deployment with streaming response
|
|
397
|
+
* @param {PromptDeploymentRequest} promptDeploymentRequest
|
|
398
|
+
* @param {*} [options] Override http request option.
|
|
399
|
+
* @throws {RequiredError}
|
|
400
|
+
* @returns {Promise<>} A promise that resolves to a `` object
|
|
401
|
+
*
|
|
402
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/prompt-deployment-stream)
|
|
403
|
+
*
|
|
404
|
+
*/
|
|
405
|
+
promptDeploymentStream(promptDeploymentRequest: PromptDeploymentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
406
|
+
/**
|
|
407
|
+
* Starts the Next.js development server for the generated miniapp. Requires Studio admin authentication.
|
|
408
|
+
* @summary Start generated miniapp
|
|
409
|
+
* @param {StartAppRequest} startAppRequest
|
|
410
|
+
* @param {*} [options] Override http request option.
|
|
411
|
+
* @throws {RequiredError}
|
|
412
|
+
* @returns {Promise<StartApp200Response>} A promise that resolves to a `StartApp200Response` object
|
|
413
|
+
*
|
|
414
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/start-app)
|
|
415
|
+
*
|
|
416
|
+
*/
|
|
417
|
+
startApp(startAppRequest: StartAppRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StartApp200Response>>;
|
|
418
|
+
/**
|
|
419
|
+
* Stops the Next.js development server for the generated miniapp. Requires Studio admin authentication.
|
|
420
|
+
* @summary Stop generated miniapp
|
|
421
|
+
* @param {StartAppRequest} startAppRequest
|
|
422
|
+
* @param {*} [options] Override http request option.
|
|
423
|
+
* @throws {RequiredError}
|
|
424
|
+
* @returns {Promise<StartApp200Response>} A promise that resolves to a `StartApp200Response` object
|
|
425
|
+
*
|
|
426
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/stop-app)
|
|
427
|
+
*
|
|
428
|
+
*/
|
|
429
|
+
stopApp(startAppRequest: StartAppRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StartApp200Response>>;
|
|
430
|
+
/**
|
|
431
|
+
* Uploads an image file to the generated miniapp public folder. The image will be accessible as a static asset on the deployed miniapp. Requires API key authentication.
|
|
432
|
+
* @summary Upload image to deployment
|
|
433
|
+
* @param {*} [options] Override http request option.
|
|
434
|
+
* @throws {RequiredError}
|
|
435
|
+
* @returns {Promise<UploadImage200Response>} A promise that resolves to a `UploadImage200Response` object
|
|
436
|
+
*
|
|
437
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/upload-image)
|
|
438
|
+
*
|
|
439
|
+
*/
|
|
440
|
+
uploadImage(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UploadImage200Response>>;
|
|
441
|
+
/**
|
|
442
|
+
* Downloads an image from the provided URL and saves it to the generated miniapp public folder. The image will be accessible as a static asset on the deployed miniapp. Requires API key authentication.
|
|
443
|
+
* @summary Upload image from URL to deployment
|
|
444
|
+
* @param {UploadImageUrlRequest} uploadImageUrlRequest
|
|
445
|
+
* @param {*} [options] Override http request option.
|
|
446
|
+
* @throws {RequiredError}
|
|
447
|
+
* @returns {Promise<UploadImage200Response>} A promise that resolves to a `UploadImage200Response` object
|
|
448
|
+
*
|
|
449
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/upload-image-url)
|
|
450
|
+
*
|
|
451
|
+
*/
|
|
452
|
+
uploadImageUrl(uploadImageUrlRequest: UploadImageUrlRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UploadImage200Response>>;
|
|
453
|
+
};
|
|
454
|
+
/**
|
|
455
|
+
* StudioApi - factory interface
|
|
456
|
+
* @export
|
|
457
|
+
*/
|
|
458
|
+
export declare const StudioApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
459
|
+
/**
|
|
460
|
+
* Associates a generated miniapp with a Farcaster account using a JFS-signed domain association. Requires API key authentication.
|
|
461
|
+
* @summary Set account association
|
|
462
|
+
* @param {StudioApiAssociateDeploymentRequest} requestParameters Request parameters.
|
|
463
|
+
* @param {*} [options] Override http request option.
|
|
464
|
+
* @throws {RequiredError}
|
|
465
|
+
* @returns {Promise<AssociateDeployment200Response>} A promise that resolves to a `AssociateDeployment200Response` object
|
|
466
|
+
*
|
|
467
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/associate-deployment)
|
|
468
|
+
*
|
|
469
|
+
*/
|
|
470
|
+
associateDeployment(requestParameters: StudioApiAssociateDeploymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<AssociateDeployment200Response>;
|
|
471
|
+
/**
|
|
472
|
+
* Creates and deploys an instance of the miniapp generator for a user. Requires authentication via API key in the request header.
|
|
473
|
+
* @summary Create a miniapp generator deployment
|
|
474
|
+
* @param {StudioApiCreateDeploymentRequest} requestParameters Request parameters.
|
|
475
|
+
* @param {*} [options] Override http request option.
|
|
476
|
+
* @throws {RequiredError}
|
|
477
|
+
* @returns {Promise<ListDeployments200ResponseInner>} A promise that resolves to a `ListDeployments200ResponseInner` object
|
|
478
|
+
*
|
|
479
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/create-deployment)
|
|
480
|
+
*
|
|
481
|
+
*/
|
|
482
|
+
createDeployment(requestParameters: StudioApiCreateDeploymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListDeployments200ResponseInner>;
|
|
483
|
+
/**
|
|
484
|
+
* Deletes a specific miniapp generator deployment or all deployments for a FID. If name is provided, deletes single deployment. If only FID is provided, deletes all deployments for that FID. Requires API key authentication.
|
|
485
|
+
* @summary Delete deployment(s)
|
|
486
|
+
* @param {StudioApiDeleteDeploymentRequest} requestParameters Request parameters.
|
|
487
|
+
* @param {*} [options] Override http request option.
|
|
488
|
+
* @throws {RequiredError}
|
|
489
|
+
* @returns {Promise<DeleteDeployment200Response>} A promise that resolves to a `DeleteDeployment200Response` object
|
|
490
|
+
*
|
|
491
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/delete-deployment)
|
|
492
|
+
*
|
|
493
|
+
*/
|
|
494
|
+
deleteDeployment(requestParameters: StudioApiDeleteDeploymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DeleteDeployment200Response>;
|
|
495
|
+
/**
|
|
496
|
+
* Retrieves all messages in a specific conversation. Requires API key authentication.
|
|
497
|
+
* @summary Get messages in a conversation
|
|
498
|
+
* @param {StudioApiGetConversationMessagesRequest} requestParameters Request parameters.
|
|
499
|
+
* @param {*} [options] Override http request option.
|
|
500
|
+
* @throws {RequiredError}
|
|
501
|
+
* @returns {Promise<GetConversationMessages200Response>} A promise that resolves to a `GetConversationMessages200Response` object
|
|
502
|
+
*
|
|
503
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-conversation-messages)
|
|
504
|
+
*
|
|
505
|
+
*/
|
|
506
|
+
getConversationMessages(requestParameters: StudioApiGetConversationMessagesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetConversationMessages200Response>;
|
|
507
|
+
/**
|
|
508
|
+
* Fetches info about a miniapp generator deployment by its name and creator\'s Farcaster ID. Requires API key authentication.
|
|
509
|
+
* @summary Get deployment info
|
|
510
|
+
* @param {StudioApiGetDeploymentRequest} requestParameters Request parameters.
|
|
511
|
+
* @param {*} [options] Override http request option.
|
|
512
|
+
* @throws {RequiredError}
|
|
513
|
+
* @returns {Promise<ListDeployments200ResponseInner>} A promise that resolves to a `ListDeployments200ResponseInner` object
|
|
514
|
+
*
|
|
515
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-deployment)
|
|
516
|
+
*
|
|
517
|
+
*/
|
|
518
|
+
getDeployment(requestParameters: StudioApiGetDeploymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListDeployments200ResponseInner>;
|
|
519
|
+
/**
|
|
520
|
+
* Retrieves the contents of a specific file from the generated app. Requires Studio admin authentication.
|
|
521
|
+
* @summary Get deployment file contents
|
|
522
|
+
* @param {StudioApiGetDeploymentFileRequest} requestParameters Request parameters.
|
|
523
|
+
* @param {*} [options] Override http request option.
|
|
524
|
+
* @throws {RequiredError}
|
|
525
|
+
* @returns {Promise<GetDeploymentFile200Response>} A promise that resolves to a `GetDeploymentFile200Response` object
|
|
526
|
+
*
|
|
527
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-deployment-file)
|
|
528
|
+
*
|
|
529
|
+
*/
|
|
530
|
+
getDeploymentFile(requestParameters: StudioApiGetDeploymentFileRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetDeploymentFile200Response>;
|
|
531
|
+
/**
|
|
532
|
+
* Retrieves the server.log file from a miniapp-generator deployment. Requires Studio admin authentication.
|
|
533
|
+
* @summary Get deployment logs
|
|
534
|
+
* @param {StudioApiGetDeploymentLogsRequest} requestParameters Request parameters.
|
|
535
|
+
* @param {*} [options] Override http request option.
|
|
536
|
+
* @throws {RequiredError}
|
|
537
|
+
* @returns {Promise<GetDeploymentLogs200Response>} A promise that resolves to a `GetDeploymentLogs200Response` object
|
|
538
|
+
*
|
|
539
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-deployment-logs)
|
|
540
|
+
*
|
|
541
|
+
*/
|
|
542
|
+
getDeploymentLogs(requestParameters: StudioApiGetDeploymentLogsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetDeploymentLogs200Response>;
|
|
543
|
+
/**
|
|
544
|
+
* Lists all conversations for a specific deployment. Requires API key authentication.
|
|
545
|
+
* @summary List conversations for a deployment
|
|
546
|
+
* @param {StudioApiListConversationsRequest} requestParameters Request parameters.
|
|
547
|
+
* @param {*} [options] Override http request option.
|
|
548
|
+
* @throws {RequiredError}
|
|
549
|
+
* @returns {Promise<ListConversations200Response>} A promise that resolves to a `ListConversations200Response` object
|
|
550
|
+
*
|
|
551
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-conversations)
|
|
552
|
+
*
|
|
553
|
+
*/
|
|
554
|
+
listConversations(requestParameters?: StudioApiListConversationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListConversations200Response>;
|
|
555
|
+
/**
|
|
556
|
+
* Lists files in a directory of the generated app. Requires Studio admin authentication.
|
|
557
|
+
* @summary List deployment files
|
|
558
|
+
* @param {StudioApiListDeploymentFilesRequest} requestParameters Request parameters.
|
|
559
|
+
* @param {*} [options] Override http request option.
|
|
560
|
+
* @throws {RequiredError}
|
|
561
|
+
* @returns {Promise<ListDeploymentFiles200Response>} A promise that resolves to a `ListDeploymentFiles200Response` object
|
|
562
|
+
*
|
|
563
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-deployment-files)
|
|
564
|
+
*
|
|
565
|
+
*/
|
|
566
|
+
listDeploymentFiles(requestParameters: StudioApiListDeploymentFilesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListDeploymentFiles200Response>;
|
|
567
|
+
/**
|
|
568
|
+
* Lists all miniapp generator deployments for a user. Requires API key authentication.
|
|
569
|
+
* @summary List deployments
|
|
570
|
+
* @param {StudioApiListDeploymentsRequest} requestParameters Request parameters.
|
|
571
|
+
* @param {*} [options] Override http request option.
|
|
572
|
+
* @throws {RequiredError}
|
|
573
|
+
* @returns {Promise<Array<ListDeployments200ResponseInner>>} A promise that resolves to a `Array<ListDeployments200ResponseInner>` object
|
|
574
|
+
*
|
|
575
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-deployments)
|
|
576
|
+
*
|
|
577
|
+
*/
|
|
578
|
+
listDeployments(requestParameters?: StudioApiListDeploymentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<ListDeployments200ResponseInner>>;
|
|
579
|
+
/**
|
|
580
|
+
* Sends a prompt to a specific miniapp generator deployment. Requires authentication via API key in the request header.
|
|
581
|
+
* @summary Prompt a deployment
|
|
582
|
+
* @param {StudioApiPromptDeploymentRequest} requestParameters Request parameters.
|
|
583
|
+
* @param {*} [options] Override http request option.
|
|
584
|
+
* @throws {RequiredError}
|
|
585
|
+
* @returns {Promise<PromptDeployment200Response>} A promise that resolves to a `PromptDeployment200Response` object
|
|
586
|
+
*
|
|
587
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/prompt-deployment)
|
|
588
|
+
*
|
|
589
|
+
*/
|
|
590
|
+
promptDeployment(requestParameters: StudioApiPromptDeploymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<PromptDeployment200Response>;
|
|
591
|
+
/**
|
|
592
|
+
* Sends a prompt to a specific miniapp generator deployment and returns a streaming response using Server-Sent Events. The response is a continuous stream of Server-Sent Events, not a single JSON payload. Each event contains a JSON object with type, message, and other fields specific to the message type. Requires authentication via API key in the request header.
|
|
593
|
+
* @summary Prompt a deployment with streaming response
|
|
594
|
+
* @param {StudioApiPromptDeploymentStreamRequest} requestParameters Request parameters.
|
|
595
|
+
* @param {*} [options] Override http request option.
|
|
596
|
+
* @throws {RequiredError}
|
|
597
|
+
* @returns {Promise<>} A promise that resolves to a `` object
|
|
598
|
+
*
|
|
599
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/prompt-deployment-stream)
|
|
600
|
+
*
|
|
601
|
+
*/
|
|
602
|
+
promptDeploymentStream(requestParameters: StudioApiPromptDeploymentStreamRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
603
|
+
/**
|
|
604
|
+
* Starts the Next.js development server for the generated miniapp. Requires Studio admin authentication.
|
|
605
|
+
* @summary Start generated miniapp
|
|
606
|
+
* @param {StudioApiStartAppRequest} requestParameters Request parameters.
|
|
607
|
+
* @param {*} [options] Override http request option.
|
|
608
|
+
* @throws {RequiredError}
|
|
609
|
+
* @returns {Promise<StartApp200Response>} A promise that resolves to a `StartApp200Response` object
|
|
610
|
+
*
|
|
611
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/start-app)
|
|
612
|
+
*
|
|
613
|
+
*/
|
|
614
|
+
startApp(requestParameters: StudioApiStartAppRequest, options?: RawAxiosRequestConfig): AxiosPromise<StartApp200Response>;
|
|
615
|
+
/**
|
|
616
|
+
* Stops the Next.js development server for the generated miniapp. Requires Studio admin authentication.
|
|
617
|
+
* @summary Stop generated miniapp
|
|
618
|
+
* @param {StudioApiStopAppRequest} requestParameters Request parameters.
|
|
619
|
+
* @param {*} [options] Override http request option.
|
|
620
|
+
* @throws {RequiredError}
|
|
621
|
+
* @returns {Promise<StartApp200Response>} A promise that resolves to a `StartApp200Response` object
|
|
622
|
+
*
|
|
623
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/stop-app)
|
|
624
|
+
*
|
|
625
|
+
*/
|
|
626
|
+
stopApp(requestParameters: StudioApiStopAppRequest, options?: RawAxiosRequestConfig): AxiosPromise<StartApp200Response>;
|
|
627
|
+
/**
|
|
628
|
+
* Uploads an image file to the generated miniapp public folder. The image will be accessible as a static asset on the deployed miniapp. Requires API key authentication.
|
|
629
|
+
* @summary Upload image to deployment
|
|
630
|
+
* @param {*} [options] Override http request option.
|
|
631
|
+
* @throws {RequiredError}
|
|
632
|
+
* @returns {Promise<UploadImage200Response>} A promise that resolves to a `UploadImage200Response` object
|
|
633
|
+
*
|
|
634
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/upload-image)
|
|
635
|
+
*
|
|
636
|
+
*/
|
|
637
|
+
uploadImage(options?: RawAxiosRequestConfig): AxiosPromise<UploadImage200Response>;
|
|
638
|
+
/**
|
|
639
|
+
* Downloads an image from the provided URL and saves it to the generated miniapp public folder. The image will be accessible as a static asset on the deployed miniapp. Requires API key authentication.
|
|
640
|
+
* @summary Upload image from URL to deployment
|
|
641
|
+
* @param {StudioApiUploadImageUrlRequest} requestParameters Request parameters.
|
|
642
|
+
* @param {*} [options] Override http request option.
|
|
643
|
+
* @throws {RequiredError}
|
|
644
|
+
* @returns {Promise<UploadImage200Response>} A promise that resolves to a `UploadImage200Response` object
|
|
645
|
+
*
|
|
646
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/upload-image-url)
|
|
647
|
+
*
|
|
648
|
+
*/
|
|
649
|
+
uploadImageUrl(requestParameters: StudioApiUploadImageUrlRequest, options?: RawAxiosRequestConfig): AxiosPromise<UploadImage200Response>;
|
|
650
|
+
};
|
|
651
|
+
/**
|
|
652
|
+
* StudioApi - interface
|
|
653
|
+
* @export
|
|
654
|
+
* @interface StudioApi
|
|
655
|
+
*/
|
|
656
|
+
export interface StudioApiInterface {
|
|
657
|
+
/**
|
|
658
|
+
* Associates a generated miniapp with a Farcaster account using a JFS-signed domain association. Requires API key authentication.
|
|
659
|
+
* @summary Set account association
|
|
660
|
+
* @param {StudioApiAssociateDeploymentRequest} requestParameters Request parameters.
|
|
661
|
+
* @param {*} [options] Override http request option.
|
|
662
|
+
* @throws {RequiredError}
|
|
663
|
+
* @memberof StudioApiInterface
|
|
664
|
+
* @returns {Promise<AssociateDeployment200Response>} A promise that resolves to a `AssociateDeployment200Response` object
|
|
665
|
+
*
|
|
666
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/associate-deployment)
|
|
667
|
+
*
|
|
668
|
+
*/
|
|
669
|
+
associateDeployment(requestParameters: StudioApiAssociateDeploymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<AssociateDeployment200Response>;
|
|
670
|
+
/**
|
|
671
|
+
* Creates and deploys an instance of the miniapp generator for a user. Requires authentication via API key in the request header.
|
|
672
|
+
* @summary Create a miniapp generator deployment
|
|
673
|
+
* @param {StudioApiCreateDeploymentRequest} requestParameters Request parameters.
|
|
674
|
+
* @param {*} [options] Override http request option.
|
|
675
|
+
* @throws {RequiredError}
|
|
676
|
+
* @memberof StudioApiInterface
|
|
677
|
+
* @returns {Promise<ListDeployments200ResponseInner>} A promise that resolves to a `ListDeployments200ResponseInner` object
|
|
678
|
+
*
|
|
679
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/create-deployment)
|
|
680
|
+
*
|
|
681
|
+
*/
|
|
682
|
+
createDeployment(requestParameters: StudioApiCreateDeploymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListDeployments200ResponseInner>;
|
|
683
|
+
/**
|
|
684
|
+
* Deletes a specific miniapp generator deployment or all deployments for a FID. If name is provided, deletes single deployment. If only FID is provided, deletes all deployments for that FID. Requires API key authentication.
|
|
685
|
+
* @summary Delete deployment(s)
|
|
686
|
+
* @param {StudioApiDeleteDeploymentRequest} requestParameters Request parameters.
|
|
687
|
+
* @param {*} [options] Override http request option.
|
|
688
|
+
* @throws {RequiredError}
|
|
689
|
+
* @memberof StudioApiInterface
|
|
690
|
+
* @returns {Promise<DeleteDeployment200Response>} A promise that resolves to a `DeleteDeployment200Response` object
|
|
691
|
+
*
|
|
692
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/delete-deployment)
|
|
693
|
+
*
|
|
694
|
+
*/
|
|
695
|
+
deleteDeployment(requestParameters: StudioApiDeleteDeploymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DeleteDeployment200Response>;
|
|
696
|
+
/**
|
|
697
|
+
* Retrieves all messages in a specific conversation. Requires API key authentication.
|
|
698
|
+
* @summary Get messages in a conversation
|
|
699
|
+
* @param {StudioApiGetConversationMessagesRequest} requestParameters Request parameters.
|
|
700
|
+
* @param {*} [options] Override http request option.
|
|
701
|
+
* @throws {RequiredError}
|
|
702
|
+
* @memberof StudioApiInterface
|
|
703
|
+
* @returns {Promise<GetConversationMessages200Response>} A promise that resolves to a `GetConversationMessages200Response` object
|
|
704
|
+
*
|
|
705
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-conversation-messages)
|
|
706
|
+
*
|
|
707
|
+
*/
|
|
708
|
+
getConversationMessages(requestParameters: StudioApiGetConversationMessagesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetConversationMessages200Response>;
|
|
709
|
+
/**
|
|
710
|
+
* Fetches info about a miniapp generator deployment by its name and creator\'s Farcaster ID. Requires API key authentication.
|
|
711
|
+
* @summary Get deployment info
|
|
712
|
+
* @param {StudioApiGetDeploymentRequest} requestParameters Request parameters.
|
|
713
|
+
* @param {*} [options] Override http request option.
|
|
714
|
+
* @throws {RequiredError}
|
|
715
|
+
* @memberof StudioApiInterface
|
|
716
|
+
* @returns {Promise<ListDeployments200ResponseInner>} A promise that resolves to a `ListDeployments200ResponseInner` object
|
|
717
|
+
*
|
|
718
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-deployment)
|
|
719
|
+
*
|
|
720
|
+
*/
|
|
721
|
+
getDeployment(requestParameters: StudioApiGetDeploymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListDeployments200ResponseInner>;
|
|
722
|
+
/**
|
|
723
|
+
* Retrieves the contents of a specific file from the generated app. Requires Studio admin authentication.
|
|
724
|
+
* @summary Get deployment file contents
|
|
725
|
+
* @param {StudioApiGetDeploymentFileRequest} requestParameters Request parameters.
|
|
726
|
+
* @param {*} [options] Override http request option.
|
|
727
|
+
* @throws {RequiredError}
|
|
728
|
+
* @memberof StudioApiInterface
|
|
729
|
+
* @returns {Promise<GetDeploymentFile200Response>} A promise that resolves to a `GetDeploymentFile200Response` object
|
|
730
|
+
*
|
|
731
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-deployment-file)
|
|
732
|
+
*
|
|
733
|
+
*/
|
|
734
|
+
getDeploymentFile(requestParameters: StudioApiGetDeploymentFileRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetDeploymentFile200Response>;
|
|
735
|
+
/**
|
|
736
|
+
* Retrieves the server.log file from a miniapp-generator deployment. Requires Studio admin authentication.
|
|
737
|
+
* @summary Get deployment logs
|
|
738
|
+
* @param {StudioApiGetDeploymentLogsRequest} requestParameters Request parameters.
|
|
739
|
+
* @param {*} [options] Override http request option.
|
|
740
|
+
* @throws {RequiredError}
|
|
741
|
+
* @memberof StudioApiInterface
|
|
742
|
+
* @returns {Promise<GetDeploymentLogs200Response>} A promise that resolves to a `GetDeploymentLogs200Response` object
|
|
743
|
+
*
|
|
744
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-deployment-logs)
|
|
745
|
+
*
|
|
746
|
+
*/
|
|
747
|
+
getDeploymentLogs(requestParameters: StudioApiGetDeploymentLogsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetDeploymentLogs200Response>;
|
|
748
|
+
/**
|
|
749
|
+
* Lists all conversations for a specific deployment. Requires API key authentication.
|
|
750
|
+
* @summary List conversations for a deployment
|
|
751
|
+
* @param {StudioApiListConversationsRequest} requestParameters Request parameters.
|
|
752
|
+
* @param {*} [options] Override http request option.
|
|
753
|
+
* @throws {RequiredError}
|
|
754
|
+
* @memberof StudioApiInterface
|
|
755
|
+
* @returns {Promise<ListConversations200Response>} A promise that resolves to a `ListConversations200Response` object
|
|
756
|
+
*
|
|
757
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-conversations)
|
|
758
|
+
*
|
|
759
|
+
*/
|
|
760
|
+
listConversations(requestParameters?: StudioApiListConversationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListConversations200Response>;
|
|
761
|
+
/**
|
|
762
|
+
* Lists files in a directory of the generated app. Requires Studio admin authentication.
|
|
763
|
+
* @summary List deployment files
|
|
764
|
+
* @param {StudioApiListDeploymentFilesRequest} requestParameters Request parameters.
|
|
765
|
+
* @param {*} [options] Override http request option.
|
|
766
|
+
* @throws {RequiredError}
|
|
767
|
+
* @memberof StudioApiInterface
|
|
768
|
+
* @returns {Promise<ListDeploymentFiles200Response>} A promise that resolves to a `ListDeploymentFiles200Response` object
|
|
769
|
+
*
|
|
770
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-deployment-files)
|
|
771
|
+
*
|
|
772
|
+
*/
|
|
773
|
+
listDeploymentFiles(requestParameters: StudioApiListDeploymentFilesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListDeploymentFiles200Response>;
|
|
774
|
+
/**
|
|
775
|
+
* Lists all miniapp generator deployments for a user. Requires API key authentication.
|
|
776
|
+
* @summary List deployments
|
|
777
|
+
* @param {StudioApiListDeploymentsRequest} requestParameters Request parameters.
|
|
778
|
+
* @param {*} [options] Override http request option.
|
|
779
|
+
* @throws {RequiredError}
|
|
780
|
+
* @memberof StudioApiInterface
|
|
781
|
+
* @returns {Promise<Array<ListDeployments200ResponseInner>>} A promise that resolves to a `Array<ListDeployments200ResponseInner>` object
|
|
782
|
+
*
|
|
783
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-deployments)
|
|
784
|
+
*
|
|
785
|
+
*/
|
|
786
|
+
listDeployments(requestParameters?: StudioApiListDeploymentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<ListDeployments200ResponseInner>>;
|
|
787
|
+
/**
|
|
788
|
+
* Sends a prompt to a specific miniapp generator deployment. Requires authentication via API key in the request header.
|
|
789
|
+
* @summary Prompt a deployment
|
|
790
|
+
* @param {StudioApiPromptDeploymentRequest} requestParameters Request parameters.
|
|
791
|
+
* @param {*} [options] Override http request option.
|
|
792
|
+
* @throws {RequiredError}
|
|
793
|
+
* @memberof StudioApiInterface
|
|
794
|
+
* @returns {Promise<PromptDeployment200Response>} A promise that resolves to a `PromptDeployment200Response` object
|
|
795
|
+
*
|
|
796
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/prompt-deployment)
|
|
797
|
+
*
|
|
798
|
+
*/
|
|
799
|
+
promptDeployment(requestParameters: StudioApiPromptDeploymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<PromptDeployment200Response>;
|
|
800
|
+
/**
|
|
801
|
+
* Sends a prompt to a specific miniapp generator deployment and returns a streaming response using Server-Sent Events. The response is a continuous stream of Server-Sent Events, not a single JSON payload. Each event contains a JSON object with type, message, and other fields specific to the message type. Requires authentication via API key in the request header.
|
|
802
|
+
* @summary Prompt a deployment with streaming response
|
|
803
|
+
* @param {StudioApiPromptDeploymentStreamRequest} requestParameters Request parameters.
|
|
804
|
+
* @param {*} [options] Override http request option.
|
|
805
|
+
* @throws {RequiredError}
|
|
806
|
+
* @memberof StudioApiInterface
|
|
807
|
+
* @returns {Promise<>} A promise that resolves to a `` object
|
|
808
|
+
*
|
|
809
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/prompt-deployment-stream)
|
|
810
|
+
*
|
|
811
|
+
*/
|
|
812
|
+
promptDeploymentStream(requestParameters: StudioApiPromptDeploymentStreamRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
813
|
+
/**
|
|
814
|
+
* Starts the Next.js development server for the generated miniapp. Requires Studio admin authentication.
|
|
815
|
+
* @summary Start generated miniapp
|
|
816
|
+
* @param {StudioApiStartAppRequest} requestParameters Request parameters.
|
|
817
|
+
* @param {*} [options] Override http request option.
|
|
818
|
+
* @throws {RequiredError}
|
|
819
|
+
* @memberof StudioApiInterface
|
|
820
|
+
* @returns {Promise<StartApp200Response>} A promise that resolves to a `StartApp200Response` object
|
|
821
|
+
*
|
|
822
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/start-app)
|
|
823
|
+
*
|
|
824
|
+
*/
|
|
825
|
+
startApp(requestParameters: StudioApiStartAppRequest, options?: RawAxiosRequestConfig): AxiosPromise<StartApp200Response>;
|
|
826
|
+
/**
|
|
827
|
+
* Stops the Next.js development server for the generated miniapp. Requires Studio admin authentication.
|
|
828
|
+
* @summary Stop generated miniapp
|
|
829
|
+
* @param {StudioApiStopAppRequest} requestParameters Request parameters.
|
|
830
|
+
* @param {*} [options] Override http request option.
|
|
831
|
+
* @throws {RequiredError}
|
|
832
|
+
* @memberof StudioApiInterface
|
|
833
|
+
* @returns {Promise<StartApp200Response>} A promise that resolves to a `StartApp200Response` object
|
|
834
|
+
*
|
|
835
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/stop-app)
|
|
836
|
+
*
|
|
837
|
+
*/
|
|
838
|
+
stopApp(requestParameters: StudioApiStopAppRequest, options?: RawAxiosRequestConfig): AxiosPromise<StartApp200Response>;
|
|
839
|
+
/**
|
|
840
|
+
* Uploads an image file to the generated miniapp public folder. The image will be accessible as a static asset on the deployed miniapp. Requires API key authentication.
|
|
841
|
+
* @summary Upload image to deployment
|
|
842
|
+
* @param {*} [options] Override http request option.
|
|
843
|
+
* @throws {RequiredError}
|
|
844
|
+
* @memberof StudioApiInterface
|
|
845
|
+
* @returns {Promise<UploadImage200Response>} A promise that resolves to a `UploadImage200Response` object
|
|
846
|
+
*
|
|
847
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/upload-image)
|
|
848
|
+
*
|
|
849
|
+
*/
|
|
850
|
+
uploadImage(options?: RawAxiosRequestConfig): AxiosPromise<UploadImage200Response>;
|
|
851
|
+
/**
|
|
852
|
+
* Downloads an image from the provided URL and saves it to the generated miniapp public folder. The image will be accessible as a static asset on the deployed miniapp. Requires API key authentication.
|
|
853
|
+
* @summary Upload image from URL to deployment
|
|
854
|
+
* @param {StudioApiUploadImageUrlRequest} requestParameters Request parameters.
|
|
855
|
+
* @param {*} [options] Override http request option.
|
|
856
|
+
* @throws {RequiredError}
|
|
857
|
+
* @memberof StudioApiInterface
|
|
858
|
+
* @returns {Promise<UploadImage200Response>} A promise that resolves to a `UploadImage200Response` object
|
|
859
|
+
*
|
|
860
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/upload-image-url)
|
|
861
|
+
*
|
|
862
|
+
*/
|
|
863
|
+
uploadImageUrl(requestParameters: StudioApiUploadImageUrlRequest, options?: RawAxiosRequestConfig): AxiosPromise<UploadImage200Response>;
|
|
864
|
+
}
|
|
865
|
+
/**
|
|
866
|
+
* Request parameters for associateDeployment operation in StudioApi.
|
|
867
|
+
* @export
|
|
868
|
+
* @interface StudioApiAssociateDeploymentRequest
|
|
869
|
+
*/
|
|
870
|
+
export interface StudioApiAssociateDeploymentRequest {
|
|
871
|
+
/**
|
|
872
|
+
*
|
|
873
|
+
*
|
|
874
|
+
*
|
|
875
|
+
*
|
|
876
|
+
* @type {AssociateDeploymentRequest}
|
|
877
|
+
* @memberof StudioApiAssociateDeployment
|
|
878
|
+
*/
|
|
879
|
+
readonly associateDeploymentRequest: AssociateDeploymentRequest;
|
|
880
|
+
}
|
|
881
|
+
/**
|
|
882
|
+
* Request parameters for createDeployment operation in StudioApi.
|
|
883
|
+
* @export
|
|
884
|
+
* @interface StudioApiCreateDeploymentRequest
|
|
885
|
+
*/
|
|
886
|
+
export interface StudioApiCreateDeploymentRequest {
|
|
887
|
+
/**
|
|
888
|
+
*
|
|
889
|
+
*
|
|
890
|
+
*
|
|
891
|
+
*
|
|
892
|
+
* @type {CreateDeploymentRequest}
|
|
893
|
+
* @memberof StudioApiCreateDeployment
|
|
894
|
+
*/
|
|
895
|
+
readonly createDeploymentRequest: CreateDeploymentRequest;
|
|
896
|
+
}
|
|
897
|
+
/**
|
|
898
|
+
* Request parameters for deleteDeployment operation in StudioApi.
|
|
899
|
+
* @export
|
|
900
|
+
* @interface StudioApiDeleteDeploymentRequest
|
|
901
|
+
*/
|
|
902
|
+
export interface StudioApiDeleteDeploymentRequest {
|
|
903
|
+
/**
|
|
904
|
+
*
|
|
905
|
+
*
|
|
906
|
+
*
|
|
907
|
+
*
|
|
908
|
+
* @type {DeleteDeploymentRequest}
|
|
909
|
+
* @memberof StudioApiDeleteDeployment
|
|
910
|
+
*/
|
|
911
|
+
readonly deleteDeploymentRequest: DeleteDeploymentRequest;
|
|
912
|
+
}
|
|
913
|
+
/**
|
|
914
|
+
* Request parameters for getConversationMessages operation in StudioApi.
|
|
915
|
+
* @export
|
|
916
|
+
* @interface StudioApiGetConversationMessagesRequest
|
|
917
|
+
*/
|
|
918
|
+
export interface StudioApiGetConversationMessagesRequest {
|
|
919
|
+
/**
|
|
920
|
+
* Farcaster ID of the user
|
|
921
|
+
*
|
|
922
|
+
*
|
|
923
|
+
*
|
|
924
|
+
* @type {number}
|
|
925
|
+
* @memberof StudioApiGetConversationMessages
|
|
926
|
+
*/
|
|
927
|
+
readonly fid: number | null;
|
|
928
|
+
/**
|
|
929
|
+
* Kubernetes deployment name
|
|
930
|
+
*
|
|
931
|
+
*
|
|
932
|
+
*
|
|
933
|
+
* @type {string}
|
|
934
|
+
* @memberof StudioApiGetConversationMessages
|
|
935
|
+
*/
|
|
936
|
+
readonly name: string;
|
|
937
|
+
/**
|
|
938
|
+
* Conversation ID
|
|
939
|
+
*
|
|
940
|
+
*
|
|
941
|
+
*
|
|
942
|
+
* @type {string}
|
|
943
|
+
* @memberof StudioApiGetConversationMessages
|
|
944
|
+
*/
|
|
945
|
+
readonly conversationId: string;
|
|
946
|
+
/**
|
|
947
|
+
* Include deleted messages in the response. Defaults to false.
|
|
948
|
+
*
|
|
949
|
+
*
|
|
950
|
+
*
|
|
951
|
+
* @type {boolean}
|
|
952
|
+
* @memberof StudioApiGetConversationMessages
|
|
953
|
+
*/
|
|
954
|
+
readonly includeDeleted?: boolean | null;
|
|
955
|
+
}
|
|
956
|
+
/**
|
|
957
|
+
* Request parameters for getDeployment operation in StudioApi.
|
|
958
|
+
* @export
|
|
959
|
+
* @interface StudioApiGetDeploymentRequest
|
|
960
|
+
*/
|
|
961
|
+
export interface StudioApiGetDeploymentRequest {
|
|
962
|
+
/**
|
|
963
|
+
* Farcaster ID of the user
|
|
964
|
+
*
|
|
965
|
+
*
|
|
966
|
+
*
|
|
967
|
+
* @type {number}
|
|
968
|
+
* @memberof StudioApiGetDeployment
|
|
969
|
+
*/
|
|
970
|
+
readonly fid: number;
|
|
971
|
+
/**
|
|
972
|
+
* Kubernetes deployment name
|
|
973
|
+
*
|
|
974
|
+
*
|
|
975
|
+
*
|
|
976
|
+
* @type {string}
|
|
977
|
+
* @memberof StudioApiGetDeployment
|
|
978
|
+
*/
|
|
979
|
+
readonly name: string;
|
|
980
|
+
}
|
|
981
|
+
/**
|
|
982
|
+
* Request parameters for getDeploymentFile operation in StudioApi.
|
|
983
|
+
* @export
|
|
984
|
+
* @interface StudioApiGetDeploymentFileRequest
|
|
985
|
+
*/
|
|
986
|
+
export interface StudioApiGetDeploymentFileRequest {
|
|
987
|
+
/**
|
|
988
|
+
* Farcaster ID of the user
|
|
989
|
+
*
|
|
990
|
+
*
|
|
991
|
+
*
|
|
992
|
+
* @type {number}
|
|
993
|
+
* @memberof StudioApiGetDeploymentFile
|
|
994
|
+
*/
|
|
995
|
+
readonly fid: number | null;
|
|
996
|
+
/**
|
|
997
|
+
* Kubernetes deployment name
|
|
998
|
+
*
|
|
999
|
+
*
|
|
1000
|
+
*
|
|
1001
|
+
* @type {string}
|
|
1002
|
+
* @memberof StudioApiGetDeploymentFile
|
|
1003
|
+
*/
|
|
1004
|
+
readonly name: string;
|
|
1005
|
+
/**
|
|
1006
|
+
* File path relative to gen/
|
|
1007
|
+
*
|
|
1008
|
+
*
|
|
1009
|
+
*
|
|
1010
|
+
* @type {string}
|
|
1011
|
+
* @memberof StudioApiGetDeploymentFile
|
|
1012
|
+
*/
|
|
1013
|
+
readonly filePath: string;
|
|
1014
|
+
}
|
|
1015
|
+
/**
|
|
1016
|
+
* Request parameters for getDeploymentLogs operation in StudioApi.
|
|
1017
|
+
* @export
|
|
1018
|
+
* @interface StudioApiGetDeploymentLogsRequest
|
|
1019
|
+
*/
|
|
1020
|
+
export interface StudioApiGetDeploymentLogsRequest {
|
|
1021
|
+
/**
|
|
1022
|
+
* Farcaster ID of the user
|
|
1023
|
+
*
|
|
1024
|
+
*
|
|
1025
|
+
*
|
|
1026
|
+
* @type {number}
|
|
1027
|
+
* @memberof StudioApiGetDeploymentLogs
|
|
1028
|
+
*/
|
|
1029
|
+
readonly fid: number | null;
|
|
1030
|
+
/**
|
|
1031
|
+
* Kubernetes deployment name
|
|
1032
|
+
*
|
|
1033
|
+
*
|
|
1034
|
+
*
|
|
1035
|
+
* @type {string}
|
|
1036
|
+
* @memberof StudioApiGetDeploymentLogs
|
|
1037
|
+
*/
|
|
1038
|
+
readonly name: string;
|
|
1039
|
+
}
|
|
1040
|
+
/**
|
|
1041
|
+
* Request parameters for listConversations operation in StudioApi.
|
|
1042
|
+
* @export
|
|
1043
|
+
* @interface StudioApiListConversationsRequest
|
|
1044
|
+
*/
|
|
1045
|
+
export interface StudioApiListConversationsRequest {
|
|
1046
|
+
/**
|
|
1047
|
+
* Farcaster ID of the user. Required for non-admin users. Studio admins can omit to query all conversations.
|
|
1048
|
+
*
|
|
1049
|
+
*
|
|
1050
|
+
*
|
|
1051
|
+
* @type {number}
|
|
1052
|
+
* @memberof StudioApiListConversations
|
|
1053
|
+
*/
|
|
1054
|
+
readonly fid?: number | null;
|
|
1055
|
+
/**
|
|
1056
|
+
* Kubernetes deployment name. If provided, filters conversations to this deployment only.
|
|
1057
|
+
*
|
|
1058
|
+
*
|
|
1059
|
+
*
|
|
1060
|
+
* @type {string}
|
|
1061
|
+
* @memberof StudioApiListConversations
|
|
1062
|
+
*/
|
|
1063
|
+
readonly name?: string;
|
|
1064
|
+
/**
|
|
1065
|
+
* Include deleted conversations in the response. Defaults to false.
|
|
1066
|
+
*
|
|
1067
|
+
*
|
|
1068
|
+
*
|
|
1069
|
+
* @type {boolean}
|
|
1070
|
+
* @memberof StudioApiListConversations
|
|
1071
|
+
*/
|
|
1072
|
+
readonly includeDeleted?: boolean | null;
|
|
1073
|
+
}
|
|
1074
|
+
/**
|
|
1075
|
+
* Request parameters for listDeploymentFiles operation in StudioApi.
|
|
1076
|
+
* @export
|
|
1077
|
+
* @interface StudioApiListDeploymentFilesRequest
|
|
1078
|
+
*/
|
|
1079
|
+
export interface StudioApiListDeploymentFilesRequest {
|
|
1080
|
+
/**
|
|
1081
|
+
* Farcaster ID of the user
|
|
1082
|
+
*
|
|
1083
|
+
*
|
|
1084
|
+
*
|
|
1085
|
+
* @type {number}
|
|
1086
|
+
* @memberof StudioApiListDeploymentFiles
|
|
1087
|
+
*/
|
|
1088
|
+
readonly fid: number | null;
|
|
1089
|
+
/**
|
|
1090
|
+
* Kubernetes deployment name
|
|
1091
|
+
*
|
|
1092
|
+
*
|
|
1093
|
+
*
|
|
1094
|
+
* @type {string}
|
|
1095
|
+
* @memberof StudioApiListDeploymentFiles
|
|
1096
|
+
*/
|
|
1097
|
+
readonly name: string;
|
|
1098
|
+
/**
|
|
1099
|
+
* Directory path relative to gen/ (defaults to root)
|
|
1100
|
+
*
|
|
1101
|
+
*
|
|
1102
|
+
*
|
|
1103
|
+
* @type {string}
|
|
1104
|
+
* @memberof StudioApiListDeploymentFiles
|
|
1105
|
+
*/
|
|
1106
|
+
readonly directory?: string;
|
|
1107
|
+
}
|
|
1108
|
+
/**
|
|
1109
|
+
* Request parameters for listDeployments operation in StudioApi.
|
|
1110
|
+
* @export
|
|
1111
|
+
* @interface StudioApiListDeploymentsRequest
|
|
1112
|
+
*/
|
|
1113
|
+
export interface StudioApiListDeploymentsRequest {
|
|
1114
|
+
/**
|
|
1115
|
+
* Farcaster ID of the user. Required for non-admin users. Studio admins can omit to query all deployments.
|
|
1116
|
+
*
|
|
1117
|
+
*
|
|
1118
|
+
*
|
|
1119
|
+
* @type {number}
|
|
1120
|
+
* @memberof StudioApiListDeployments
|
|
1121
|
+
*/
|
|
1122
|
+
readonly fid?: number | null;
|
|
1123
|
+
/**
|
|
1124
|
+
* Maximum number of deployments to return. Defaults to 50, max 1000. (Default: 50, Maximum: 1000)
|
|
1125
|
+
*
|
|
1126
|
+
*
|
|
1127
|
+
*
|
|
1128
|
+
* @type {number}
|
|
1129
|
+
* @memberof StudioApiListDeployments
|
|
1130
|
+
*/
|
|
1131
|
+
readonly limit?: number;
|
|
1132
|
+
/**
|
|
1133
|
+
* Number of deployments to skip for pagination. Defaults to 0.
|
|
1134
|
+
*
|
|
1135
|
+
*
|
|
1136
|
+
*
|
|
1137
|
+
* @type {number}
|
|
1138
|
+
* @memberof StudioApiListDeployments
|
|
1139
|
+
*/
|
|
1140
|
+
readonly offset?: number | null;
|
|
1141
|
+
/**
|
|
1142
|
+
* Include deleted deployments in the response. Defaults to false.
|
|
1143
|
+
*
|
|
1144
|
+
*
|
|
1145
|
+
*
|
|
1146
|
+
* @type {boolean}
|
|
1147
|
+
* @memberof StudioApiListDeployments
|
|
1148
|
+
*/
|
|
1149
|
+
readonly includeDeleted?: boolean | null;
|
|
1150
|
+
}
|
|
1151
|
+
/**
|
|
1152
|
+
* Request parameters for promptDeployment operation in StudioApi.
|
|
1153
|
+
* @export
|
|
1154
|
+
* @interface StudioApiPromptDeploymentRequest
|
|
1155
|
+
*/
|
|
1156
|
+
export interface StudioApiPromptDeploymentRequest {
|
|
1157
|
+
/**
|
|
1158
|
+
*
|
|
1159
|
+
*
|
|
1160
|
+
*
|
|
1161
|
+
*
|
|
1162
|
+
* @type {PromptDeploymentRequest}
|
|
1163
|
+
* @memberof StudioApiPromptDeployment
|
|
1164
|
+
*/
|
|
1165
|
+
readonly promptDeploymentRequest: PromptDeploymentRequest;
|
|
1166
|
+
}
|
|
1167
|
+
/**
|
|
1168
|
+
* Request parameters for promptDeploymentStream operation in StudioApi.
|
|
1169
|
+
* @export
|
|
1170
|
+
* @interface StudioApiPromptDeploymentStreamRequest
|
|
1171
|
+
*/
|
|
1172
|
+
export interface StudioApiPromptDeploymentStreamRequest {
|
|
1173
|
+
/**
|
|
1174
|
+
*
|
|
1175
|
+
*
|
|
1176
|
+
*
|
|
1177
|
+
*
|
|
1178
|
+
* @type {PromptDeploymentRequest}
|
|
1179
|
+
* @memberof StudioApiPromptDeploymentStream
|
|
1180
|
+
*/
|
|
1181
|
+
readonly promptDeploymentRequest: PromptDeploymentRequest;
|
|
1182
|
+
}
|
|
1183
|
+
/**
|
|
1184
|
+
* Request parameters for startApp operation in StudioApi.
|
|
1185
|
+
* @export
|
|
1186
|
+
* @interface StudioApiStartAppRequest
|
|
1187
|
+
*/
|
|
1188
|
+
export interface StudioApiStartAppRequest {
|
|
1189
|
+
/**
|
|
1190
|
+
*
|
|
1191
|
+
*
|
|
1192
|
+
*
|
|
1193
|
+
*
|
|
1194
|
+
* @type {StartAppRequest}
|
|
1195
|
+
* @memberof StudioApiStartApp
|
|
1196
|
+
*/
|
|
1197
|
+
readonly startAppRequest: StartAppRequest;
|
|
1198
|
+
}
|
|
1199
|
+
/**
|
|
1200
|
+
* Request parameters for stopApp operation in StudioApi.
|
|
1201
|
+
* @export
|
|
1202
|
+
* @interface StudioApiStopAppRequest
|
|
1203
|
+
*/
|
|
1204
|
+
export interface StudioApiStopAppRequest {
|
|
1205
|
+
/**
|
|
1206
|
+
*
|
|
1207
|
+
*
|
|
1208
|
+
*
|
|
1209
|
+
*
|
|
1210
|
+
* @type {StartAppRequest}
|
|
1211
|
+
* @memberof StudioApiStopApp
|
|
1212
|
+
*/
|
|
1213
|
+
readonly startAppRequest: StartAppRequest;
|
|
1214
|
+
}
|
|
1215
|
+
/**
|
|
1216
|
+
* Request parameters for uploadImageUrl operation in StudioApi.
|
|
1217
|
+
* @export
|
|
1218
|
+
* @interface StudioApiUploadImageUrlRequest
|
|
1219
|
+
*/
|
|
1220
|
+
export interface StudioApiUploadImageUrlRequest {
|
|
1221
|
+
/**
|
|
1222
|
+
*
|
|
1223
|
+
*
|
|
1224
|
+
*
|
|
1225
|
+
*
|
|
1226
|
+
* @type {UploadImageUrlRequest}
|
|
1227
|
+
* @memberof StudioApiUploadImageUrl
|
|
1228
|
+
*/
|
|
1229
|
+
readonly uploadImageUrlRequest: UploadImageUrlRequest;
|
|
1230
|
+
}
|
|
1231
|
+
/**
|
|
1232
|
+
* StudioApi - object-oriented interface
|
|
1233
|
+
* @export
|
|
1234
|
+
* @class StudioApi
|
|
1235
|
+
* @extends {BaseAPI}
|
|
1236
|
+
*/
|
|
1237
|
+
export declare class StudioApi extends BaseAPI implements StudioApiInterface {
|
|
1238
|
+
/**
|
|
1239
|
+
* Associates a generated miniapp with a Farcaster account using a JFS-signed domain association. Requires API key authentication.
|
|
1240
|
+
* @summary Set account association
|
|
1241
|
+
* @param {StudioApiAssociateDeploymentRequest} requestParameters Request parameters.
|
|
1242
|
+
* @param {*} [options] Override http request option.
|
|
1243
|
+
* @throws {RequiredError}
|
|
1244
|
+
* @memberof StudioApi
|
|
1245
|
+
* @returns {Promise<AssociateDeployment200Response>} A promise that resolves to a `AssociateDeployment200Response` object
|
|
1246
|
+
*
|
|
1247
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/associate-deployment)
|
|
1248
|
+
*
|
|
1249
|
+
*/
|
|
1250
|
+
associateDeployment(requestParameters: StudioApiAssociateDeploymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AssociateDeployment200Response, any>>;
|
|
1251
|
+
/**
|
|
1252
|
+
* Creates and deploys an instance of the miniapp generator for a user. Requires authentication via API key in the request header.
|
|
1253
|
+
* @summary Create a miniapp generator deployment
|
|
1254
|
+
* @param {StudioApiCreateDeploymentRequest} requestParameters Request parameters.
|
|
1255
|
+
* @param {*} [options] Override http request option.
|
|
1256
|
+
* @throws {RequiredError}
|
|
1257
|
+
* @memberof StudioApi
|
|
1258
|
+
* @returns {Promise<ListDeployments200ResponseInner>} A promise that resolves to a `ListDeployments200ResponseInner` object
|
|
1259
|
+
*
|
|
1260
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/create-deployment)
|
|
1261
|
+
*
|
|
1262
|
+
*/
|
|
1263
|
+
createDeployment(requestParameters: StudioApiCreateDeploymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListDeployments200ResponseInner, any>>;
|
|
1264
|
+
/**
|
|
1265
|
+
* Deletes a specific miniapp generator deployment or all deployments for a FID. If name is provided, deletes single deployment. If only FID is provided, deletes all deployments for that FID. Requires API key authentication.
|
|
1266
|
+
* @summary Delete deployment(s)
|
|
1267
|
+
* @param {StudioApiDeleteDeploymentRequest} requestParameters Request parameters.
|
|
1268
|
+
* @param {*} [options] Override http request option.
|
|
1269
|
+
* @throws {RequiredError}
|
|
1270
|
+
* @memberof StudioApi
|
|
1271
|
+
* @returns {Promise<DeleteDeployment200Response>} A promise that resolves to a `DeleteDeployment200Response` object
|
|
1272
|
+
*
|
|
1273
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/delete-deployment)
|
|
1274
|
+
*
|
|
1275
|
+
*/
|
|
1276
|
+
deleteDeployment(requestParameters: StudioApiDeleteDeploymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteDeployment200Response, any>>;
|
|
1277
|
+
/**
|
|
1278
|
+
* Retrieves all messages in a specific conversation. Requires API key authentication.
|
|
1279
|
+
* @summary Get messages in a conversation
|
|
1280
|
+
* @param {StudioApiGetConversationMessagesRequest} requestParameters Request parameters.
|
|
1281
|
+
* @param {*} [options] Override http request option.
|
|
1282
|
+
* @throws {RequiredError}
|
|
1283
|
+
* @memberof StudioApi
|
|
1284
|
+
* @returns {Promise<GetConversationMessages200Response>} A promise that resolves to a `GetConversationMessages200Response` object
|
|
1285
|
+
*
|
|
1286
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-conversation-messages)
|
|
1287
|
+
*
|
|
1288
|
+
*/
|
|
1289
|
+
getConversationMessages(requestParameters: StudioApiGetConversationMessagesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetConversationMessages200Response, any>>;
|
|
1290
|
+
/**
|
|
1291
|
+
* Fetches info about a miniapp generator deployment by its name and creator\'s Farcaster ID. Requires API key authentication.
|
|
1292
|
+
* @summary Get deployment info
|
|
1293
|
+
* @param {StudioApiGetDeploymentRequest} requestParameters Request parameters.
|
|
1294
|
+
* @param {*} [options] Override http request option.
|
|
1295
|
+
* @throws {RequiredError}
|
|
1296
|
+
* @memberof StudioApi
|
|
1297
|
+
* @returns {Promise<ListDeployments200ResponseInner>} A promise that resolves to a `ListDeployments200ResponseInner` object
|
|
1298
|
+
*
|
|
1299
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-deployment)
|
|
1300
|
+
*
|
|
1301
|
+
*/
|
|
1302
|
+
getDeployment(requestParameters: StudioApiGetDeploymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListDeployments200ResponseInner, any>>;
|
|
1303
|
+
/**
|
|
1304
|
+
* Retrieves the contents of a specific file from the generated app. Requires Studio admin authentication.
|
|
1305
|
+
* @summary Get deployment file contents
|
|
1306
|
+
* @param {StudioApiGetDeploymentFileRequest} requestParameters Request parameters.
|
|
1307
|
+
* @param {*} [options] Override http request option.
|
|
1308
|
+
* @throws {RequiredError}
|
|
1309
|
+
* @memberof StudioApi
|
|
1310
|
+
* @returns {Promise<GetDeploymentFile200Response>} A promise that resolves to a `GetDeploymentFile200Response` object
|
|
1311
|
+
*
|
|
1312
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-deployment-file)
|
|
1313
|
+
*
|
|
1314
|
+
*/
|
|
1315
|
+
getDeploymentFile(requestParameters: StudioApiGetDeploymentFileRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetDeploymentFile200Response, any>>;
|
|
1316
|
+
/**
|
|
1317
|
+
* Retrieves the server.log file from a miniapp-generator deployment. Requires Studio admin authentication.
|
|
1318
|
+
* @summary Get deployment logs
|
|
1319
|
+
* @param {StudioApiGetDeploymentLogsRequest} requestParameters Request parameters.
|
|
1320
|
+
* @param {*} [options] Override http request option.
|
|
1321
|
+
* @throws {RequiredError}
|
|
1322
|
+
* @memberof StudioApi
|
|
1323
|
+
* @returns {Promise<GetDeploymentLogs200Response>} A promise that resolves to a `GetDeploymentLogs200Response` object
|
|
1324
|
+
*
|
|
1325
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-deployment-logs)
|
|
1326
|
+
*
|
|
1327
|
+
*/
|
|
1328
|
+
getDeploymentLogs(requestParameters: StudioApiGetDeploymentLogsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetDeploymentLogs200Response, any>>;
|
|
1329
|
+
/**
|
|
1330
|
+
* Lists all conversations for a specific deployment. Requires API key authentication.
|
|
1331
|
+
* @summary List conversations for a deployment
|
|
1332
|
+
* @param {StudioApiListConversationsRequest} requestParameters Request parameters.
|
|
1333
|
+
* @param {*} [options] Override http request option.
|
|
1334
|
+
* @throws {RequiredError}
|
|
1335
|
+
* @memberof StudioApi
|
|
1336
|
+
* @returns {Promise<ListConversations200Response>} A promise that resolves to a `ListConversations200Response` object
|
|
1337
|
+
*
|
|
1338
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-conversations)
|
|
1339
|
+
*
|
|
1340
|
+
*/
|
|
1341
|
+
listConversations(requestParameters?: StudioApiListConversationsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListConversations200Response, any>>;
|
|
1342
|
+
/**
|
|
1343
|
+
* Lists files in a directory of the generated app. Requires Studio admin authentication.
|
|
1344
|
+
* @summary List deployment files
|
|
1345
|
+
* @param {StudioApiListDeploymentFilesRequest} requestParameters Request parameters.
|
|
1346
|
+
* @param {*} [options] Override http request option.
|
|
1347
|
+
* @throws {RequiredError}
|
|
1348
|
+
* @memberof StudioApi
|
|
1349
|
+
* @returns {Promise<ListDeploymentFiles200Response>} A promise that resolves to a `ListDeploymentFiles200Response` object
|
|
1350
|
+
*
|
|
1351
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-deployment-files)
|
|
1352
|
+
*
|
|
1353
|
+
*/
|
|
1354
|
+
listDeploymentFiles(requestParameters: StudioApiListDeploymentFilesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListDeploymentFiles200Response, any>>;
|
|
1355
|
+
/**
|
|
1356
|
+
* Lists all miniapp generator deployments for a user. Requires API key authentication.
|
|
1357
|
+
* @summary List deployments
|
|
1358
|
+
* @param {StudioApiListDeploymentsRequest} requestParameters Request parameters.
|
|
1359
|
+
* @param {*} [options] Override http request option.
|
|
1360
|
+
* @throws {RequiredError}
|
|
1361
|
+
* @memberof StudioApi
|
|
1362
|
+
* @returns {Promise<Array<ListDeployments200ResponseInner>>} A promise that resolves to a `Array<ListDeployments200ResponseInner>` object
|
|
1363
|
+
*
|
|
1364
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-deployments)
|
|
1365
|
+
*
|
|
1366
|
+
*/
|
|
1367
|
+
listDeployments(requestParameters?: StudioApiListDeploymentsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListDeployments200ResponseInner[], any>>;
|
|
1368
|
+
/**
|
|
1369
|
+
* Sends a prompt to a specific miniapp generator deployment. Requires authentication via API key in the request header.
|
|
1370
|
+
* @summary Prompt a deployment
|
|
1371
|
+
* @param {StudioApiPromptDeploymentRequest} requestParameters Request parameters.
|
|
1372
|
+
* @param {*} [options] Override http request option.
|
|
1373
|
+
* @throws {RequiredError}
|
|
1374
|
+
* @memberof StudioApi
|
|
1375
|
+
* @returns {Promise<PromptDeployment200Response>} A promise that resolves to a `PromptDeployment200Response` object
|
|
1376
|
+
*
|
|
1377
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/prompt-deployment)
|
|
1378
|
+
*
|
|
1379
|
+
*/
|
|
1380
|
+
promptDeployment(requestParameters: StudioApiPromptDeploymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PromptDeployment200Response, any>>;
|
|
1381
|
+
/**
|
|
1382
|
+
* Sends a prompt to a specific miniapp generator deployment and returns a streaming response using Server-Sent Events. The response is a continuous stream of Server-Sent Events, not a single JSON payload. Each event contains a JSON object with type, message, and other fields specific to the message type. Requires authentication via API key in the request header.
|
|
1383
|
+
* @summary Prompt a deployment with streaming response
|
|
1384
|
+
* @param {StudioApiPromptDeploymentStreamRequest} requestParameters Request parameters.
|
|
1385
|
+
* @param {*} [options] Override http request option.
|
|
1386
|
+
* @throws {RequiredError}
|
|
1387
|
+
* @memberof StudioApi
|
|
1388
|
+
* @returns {Promise<>} A promise that resolves to a `` object
|
|
1389
|
+
*
|
|
1390
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/prompt-deployment-stream)
|
|
1391
|
+
*
|
|
1392
|
+
*/
|
|
1393
|
+
promptDeploymentStream(requestParameters: StudioApiPromptDeploymentStreamRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
1394
|
+
/**
|
|
1395
|
+
* Starts the Next.js development server for the generated miniapp. Requires Studio admin authentication.
|
|
1396
|
+
* @summary Start generated miniapp
|
|
1397
|
+
* @param {StudioApiStartAppRequest} requestParameters Request parameters.
|
|
1398
|
+
* @param {*} [options] Override http request option.
|
|
1399
|
+
* @throws {RequiredError}
|
|
1400
|
+
* @memberof StudioApi
|
|
1401
|
+
* @returns {Promise<StartApp200Response>} A promise that resolves to a `StartApp200Response` object
|
|
1402
|
+
*
|
|
1403
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/start-app)
|
|
1404
|
+
*
|
|
1405
|
+
*/
|
|
1406
|
+
startApp(requestParameters: StudioApiStartAppRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<StartApp200Response, any>>;
|
|
1407
|
+
/**
|
|
1408
|
+
* Stops the Next.js development server for the generated miniapp. Requires Studio admin authentication.
|
|
1409
|
+
* @summary Stop generated miniapp
|
|
1410
|
+
* @param {StudioApiStopAppRequest} requestParameters Request parameters.
|
|
1411
|
+
* @param {*} [options] Override http request option.
|
|
1412
|
+
* @throws {RequiredError}
|
|
1413
|
+
* @memberof StudioApi
|
|
1414
|
+
* @returns {Promise<StartApp200Response>} A promise that resolves to a `StartApp200Response` object
|
|
1415
|
+
*
|
|
1416
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/stop-app)
|
|
1417
|
+
*
|
|
1418
|
+
*/
|
|
1419
|
+
stopApp(requestParameters: StudioApiStopAppRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<StartApp200Response, any>>;
|
|
1420
|
+
/**
|
|
1421
|
+
* Uploads an image file to the generated miniapp public folder. The image will be accessible as a static asset on the deployed miniapp. Requires API key authentication.
|
|
1422
|
+
* @summary Upload image to deployment
|
|
1423
|
+
* @param {*} [options] Override http request option.
|
|
1424
|
+
* @throws {RequiredError}
|
|
1425
|
+
* @memberof StudioApi
|
|
1426
|
+
* @returns {Promise<UploadImage200Response>} A promise that resolves to a `UploadImage200Response` object
|
|
1427
|
+
*
|
|
1428
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/upload-image)
|
|
1429
|
+
*
|
|
1430
|
+
*/
|
|
1431
|
+
uploadImage(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UploadImage200Response, any>>;
|
|
1432
|
+
/**
|
|
1433
|
+
* Downloads an image from the provided URL and saves it to the generated miniapp public folder. The image will be accessible as a static asset on the deployed miniapp. Requires API key authentication.
|
|
1434
|
+
* @summary Upload image from URL to deployment
|
|
1435
|
+
* @param {StudioApiUploadImageUrlRequest} requestParameters Request parameters.
|
|
1436
|
+
* @param {*} [options] Override http request option.
|
|
1437
|
+
* @throws {RequiredError}
|
|
1438
|
+
* @memberof StudioApi
|
|
1439
|
+
* @returns {Promise<UploadImage200Response>} A promise that resolves to a `UploadImage200Response` object
|
|
1440
|
+
*
|
|
1441
|
+
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/upload-image-url)
|
|
1442
|
+
*
|
|
1443
|
+
*/
|
|
1444
|
+
uploadImageUrl(requestParameters: StudioApiUploadImageUrlRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UploadImage200Response, any>>;
|
|
1445
|
+
}
|