@cutls/megalodon

import FirefishAPI from './firefish/api_client' import OAuth from './oauth' import Response from './response' import { MegalodonInterface, WebSocketInterface } from './megalodon' import Entity from './entity' export default class Firefish implements MegalodonInterface { client: FirefishAPI.Interface baseUrl: string constructor(baseUrl: string, accessToken?: string | null, userAgent?: string | null) cancel(): void registerApp( client_name: string, options?: Partial<{ scopes: Array<string> redirect_uris: string website: string }> ): Promise<OAuth.AppData> createApp( client_name: string, options?: Partial<{ scopes: Array<string> redirect_uris: string website: string }> ): Promise<OAuth.AppData> generateAuthUrlAndToken(clientSecret: string): Promise<FirefishAPI.Entity.Session> verifyAppCredentials(): Promise<Response<Entity.Application>> fetchAccessToken(_client_id: string | null, client_secret: string, session_token: string, _redirect_uri?: string): Promise<OAuth.TokenData> refreshToken(_client_id: string, _client_secret: string, _refresh_token: string): Promise<OAuth.TokenData> revokeToken(_client_id: string, _client_secret: string, _token: string): Promise<Response<Record<never, never>>> registerAccount(_username: string, _email: string, _password: string, _agreement: boolean, _locale: string, _reason?: string | null): Promise<Response<Entity.Token>> verifyAccountCredentials(): Promise<Response<Entity.Account>> updateCredentials(options?: { discoverable?: boolean bot?: boolean display_name?: string note?: string avatar?: string header?: string locked?: boolean source?: { privacy?: string sensitive?: boolean language?: string } | null fields_attributes?: Array<{ name: string value: string }> }): Promise<Response<Entity.Account>> getAccount(id: string): Promise<Response<Entity.Account>> getAccountStatuses( id: string, options?: { limit?: number max_id?: string since_id?: string pinned?: boolean exclude_replies: boolean exclude_reblogs: boolean only_media?: boolean } ): Promise<Response<Array<Entity.Status>>> getAccountFavourites( _id: string, _options?: { limit?: number max_id?: string since_id?: string } ): Promise<Response<Array<Entity.Status>>> subscribeAccount(_id: string): Promise<Response<Entity.Relationship>> unsubscribeAccount(_id: string): Promise<Response<Entity.Relationship>> getAccountFollowers( id: string, options?: { limit?: number max_id?: string since_id?: string } ): Promise<Response<Array<Entity.Account>>> getAccountFollowing( id: string, options?: { limit?: number max_id?: string since_id?: string } ): Promise<Response<Array<Entity.Account>>> getAccountLists(_id: string): Promise<Response<Array<Entity.List>>> getIdentityProof(_id: string): Promise<Response<Array<Entity.IdentityProof>>> followAccount( id: string, _options?: { reblog?: boolean } ): Promise<Response<Entity.Relationship>> unfollowAccount(id: string): Promise<Response<Entity.Relationship>> blockAccount(id: string): Promise<Response<Entity.Relationship>> unblockAccount(id: string): Promise<Response<Entity.Relationship>> muteAccount(id: string, _notifications: boolean): Promise<Response<Entity.Relationship>> unmuteAccount(id: string): Promise<Response<Entity.Relationship>> pinAccount(_id: string): Promise<Response<Entity.Relationship>> unpinAccount(_id: string): Promise<Response<Entity.Relationship>> getRelationship(id: string): Promise<Response<Entity.Relationship>> getRelationships(ids: Array<string>): Promise<Response<Array<Entity.Relationship>>> searchAccount( q: string, options?: { following?: boolean resolve?: boolean limit?: number max_id?: string since_id?: string } ): Promise<Response<Array<Entity.Account>>> lookupAccount(_acct: string): Promise<Response<Entity.Account>> getBookmarks(_options?: { limit?: number; max_id?: string; since_id?: string; min_id?: string }): Promise<Response<Array<Entity.Status>>> getFavourites(options?: { limit?: number; max_id?: string; min_id?: string }): Promise<Response<Array<Entity.Status>>> getMutes(options?: { limit?: number; max_id?: string; min_id?: string }): Promise<Response<Array<Entity.Account>>> getBlocks(options?: { limit?: number; max_id?: string; min_id?: string }): Promise<Response<Array<Entity.Account>>> getDomainBlocks(_options?: { limit?: number; max_id?: string; min_id?: string }): Promise<Response<Array<string>>> blockDomain(_domain: string): Promise<Response<Record<never, never>>> unblockDomain(_domain: string): Promise<Response<Record<never, never>>> getFilters(): Promise<Response<Array<Entity.Filter>>> getFilter(_id: string): Promise<Response<Entity.Filter>> createFilter( _phrase: string, _context: Array<string>, _options?: { irreversible?: boolean whole_word?: boolean expires_in?: string } ): Promise<Response<Entity.Filter>> updateFilter( _id: string, _phrase: string, _context: Array<string>, _options?: { irreversible?: boolean whole_word?: boolean expires_in?: string } ): Promise<Response<Entity.Filter>> deleteFilter(_id: string): Promise<Response<Entity.Filter>> report( account_id: string, options: { status_ids?: Array<string> comment: string forward?: boolean category: Entity.Category rule_ids?: Array<number> } ): Promise<Response<Entity.Report>> getFollowRequests(_limit?: number): Promise<Response<Array<Entity.Account>>> acceptFollowRequest(id: string): Promise<Response<Entity.Relationship>> rejectFollowRequest(id: string): Promise<Response<Entity.Relationship>> getEndorsements(_options?: { limit?: number; max_id?: string; since_id?: string }): Promise<Response<Array<Entity.Account>>> getFeaturedTags(): Promise<Response<Array<Entity.FeaturedTag>>> createFeaturedTag(_name: string): Promise<Response<Entity.FeaturedTag>> deleteFeaturedTag(_id: string): Promise<Response<Record<never, never>>> getSuggestedTags(): Promise<Response<Array<Entity.Tag>>> getPreferences(): Promise<Response<Entity.Preferences>> private getDefaultPostPrivacy getFollowedTags(): Promise<Response<Array<Entity.Tag>>> getSuggestions(limit?: number): Promise<Response<Array<Entity.Account>>> getTag(_id: string): Promise<Response<Entity.Tag>> followTag(_id: string): Promise<Response<Entity.Tag>> unfollowTag(_id: string): Promise<Response<Entity.Tag>> postStatus( status: string, options?: { media_ids?: Array<string> poll?: { options: Array<string> expires_in: number multiple?: boolean hide_totals?: boolean } in_reply_to_id?: string sensitive?: boolean spoiler_text?: string visibility?: Entity.StatusVisibility scheduled_at?: string language?: string quote_id?: string } ): Promise<Response<Entity.Status>> getStatus(id: string): Promise<Response<Entity.Status>> editStatus( _id: string, _options: { status?: string spoiler_text?: string sensitive?: boolean media_ids?: Array<string> poll?: { options?: Array<string> expires_in?: number multiple?: boolean hide_totals?: boolean } } ): Promise<Response<Entity.Status>> deleteStatus(id: string): Promise<Response<Record<never, never>>> getStatusContext( id: string, options?: { limit?: number max_id?: string since_id?: string } ): Promise<Response<Entity.Context>> getStatusSource(_id: string): Promise<Response<Entity.StatusSource>> getStatusRebloggedBy(id: string): Promise<Response<Array<Entity.Account>>> getStatusFavouritedBy(_id: string): Promise<Response<Array<Entity.Account>>> favouriteStatus(id: string): Promise<Response<Entity.Status>> unfavouriteStatus(id: string): Promise<Response<Entity.Status>> reblogStatus(id: string): Promise<Response<Entity.Status>> unreblogStatus(id: string): Promise<Response<Entity.Status>> bookmarkStatus(_id: string): Promise<Response<Entity.Status>> unbookmarkStatus(_id: string): Promise<Response<Entity.Status>> muteStatus(_id: string): Promise<Response<Entity.Status>> unmuteStatus(_id: string): Promise<Response<Entity.Status>> pinStatus(id: string): Promise<Response<Entity.Status>> unpinStatus(id: string): Promise<Response<Entity.Status>> private reactionName uploadMedia( file: any, _options?: { description?: string focus?: string } ): Promise<Response<Entity.Attachment>> getMedia(id: string): Promise<Response<Entity.Attachment>> updateMedia( id: string, options?: { file?: any description?: string focus?: string is_sensitive?: boolean } ): Promise<Response<Entity.Attachment>> getPoll(_id: string): Promise<Response<Entity.Poll>> votePoll(_id: string, choices: Array<number>, status_id?: string | null): Promise<Response<Entity.Poll>> getScheduledStatuses(_options?: { limit?: number; max_id?: string; since_id?: string; min_id?: string }): Promise<Response<Array<Entity.ScheduledStatus>>> getScheduledStatus(_id: string): Promise<Response<Entity.ScheduledStatus>> scheduleStatus(_id: string, _scheduled_at?: string | null): Promise<Response<Entity.ScheduledStatus>> cancelScheduledStatus(_id: string): Promise<Response<Record<never, never>>> getPublicTimeline(options?: { only_media?: boolean; limit?: number; max_id?: string; since_id?: string; min_id?: string }): Promise<Response<Array<Entity.Status>>> getLocalTimeline(options?: { only_media?: boolean; limit?: number; max_id?: string; since_id?: string; min_id?: string }): Promise<Response<Array<Entity.Status>>> getTagTimeline( hashtag: string, options?: { local?: boolean only_media?: boolean limit?: number max_id?: string since_id?: string min_id?: string } ): Promise<Response<Array<Entity.Status>>> getHomeTimeline(options?: { local?: boolean; limit?: number; max_id?: string; since_id?: string; min_id?: string }): Promise<Response<Array<Entity.Status>>> getListTimeline( list_id: string, options?: { limit?: number max_id?: string since_id?: string min_id?: string } ): Promise<Response<Array<Entity.Status>>> getConversationTimeline(options?: { limit?: number; max_id?: string; since_id?: string; min_id?: string }): Promise<Response<Array<Entity.Conversation>>> deleteConversation(_id: string): Promise<Response<Record<never, never>>> readConversation(_id: string): Promise<Response<Entity.Conversation>> getLists(): Promise<Response<Array<Entity.List>>> getList(id: string): Promise<Response<Entity.List>> createList(title: string): Promise<Response<Entity.List>> updateList(id: string, title: string): Promise<Response<Entity.List>> deleteList(id: string): Promise<Response<Record<never, never>>> getAccountsInList( id: string, _options?: { limit?: number max_id?: string since_id?: string } ): Promise<Response<Array<Entity.Account>>> addAccountsToList(id: string, account_ids: Array<string>): Promise<Response<Record<never, never>>> deleteAccountsFromList(id: string, account_ids: Array<string>): Promise<Response<Record<never, never>>> getMarkers(_timeline: Array<string>): Promise<Response<Entity.Marker | Record<never, never>>> saveMarkers(_options?: { home?: { last_read_id: string } notifications?: { last_read_id: string } }): Promise<Response<Entity.Marker>> getNotifications(options?: { limit?: number max_id?: string since_id?: string min_id?: string exclude_type?: Array<Entity.NotificationType> account_id?: string }): Promise<Response<Array<Entity.Notification>>> getNotification(_id: string): Promise<Response<Entity.Notification>> dismissNotifications(): Promise<Response<Record<never, never>>> dismissNotification(_id: string): Promise<Response<Record<never, never>>> readNotifications(_options: { id?: string; max_id?: string }): Promise<Response<Entity.Notification | Array<Entity.Notification>>> subscribePushNotification( _subscription: { endpoint: string keys: { p256dh: string auth: string } }, _data?: { alerts: { follow?: boolean favourite?: boolean reblog?: boolean mention?: boolean poll?: boolean } } | null ): Promise<Response<Entity.PushSubscription>> getPushSubscription(): Promise<Response<Entity.PushSubscription>> updatePushSubscription( _data?: { alerts: { follow?: boolean favourite?: boolean reblog?: boolean mention?: boolean poll?: boolean } } | null ): Promise<Response<Entity.PushSubscription>> deletePushSubscription(): Promise<Response<Record<never, never>>> private searchAccounts private searchStatuses private searchHashtags private searchAll search( q: string, options?: { type: 'accounts' | 'hashtags' | 'statuses' limit?: number max_id?: string min_id?: string resolve?: boolean offset?: number following?: boolean account_id?: string exclude_unreviewed?: boolean } ): Promise<Response<Entity.Results>> getInstance(): Promise<Response<Entity.Instance>> getInstancePeers(): Promise<Response<Array<string>>> getInstanceActivity(): Promise<Response<Array<Entity.Activity>>> getInstanceTrends(_limit?: number | null): Promise<Response<Array<Entity.Tag>>> getInstanceDirectory(_options?: { limit?: number; offset?: number; order?: 'active' | 'new'; local?: boolean }): Promise<Response<Array<Entity.Account>>> getInstanceCustomEmojis(): Promise<Response<Array<Entity.Emoji>>> getInstanceAnnouncements(): Promise<Response<Array<Entity.Announcement>>> dismissInstanceAnnouncement(_id: string): Promise<Response<Record<never, never>>> addReactionToAnnouncement(_id: string, _name: string): Promise<Response<Record<never, never>>> removeReactionFromAnnouncement(_id: string, _name: string): Promise<Response<Record<never, never>>> createEmojiReaction(id: string, emoji: string): Promise<Response<Entity.Status>> deleteEmojiReaction(id: string, emoji: string): Promise<Response<Entity.Status>> getEmojiReactions(id: string): Promise<Response<Array<Entity.Reaction>>> getEmojiReaction(_id: string, _emoji: string): Promise<Response<Entity.Reaction>> streamingURL(): Promise<string> userStreaming(): Promise<WebSocketInterface> publicStreaming(): Promise<WebSocketInterface> localStreaming(): Promise<WebSocketInterface> tagStreaming(_tag: string): Promise<WebSocketInterface> listStreaming(list_id: string): Promise<WebSocketInterface> directStreaming(): Promise<WebSocketInterface> userStreamingSubscription(): Promise<WebSocketInterface> publicStreamingSubscription(_socket: any): Promise<WebSocketInterface> localStreamingSubscription(_socket: any): Promise<WebSocketInterface> tagStreamingSubscription(_socket: any, tag: string): Promise<WebSocketInterface> listStreamingSubscription(_socket: any, list_id: string): Promise<WebSocketInterface> directStreamingSubscription(_socket: any): Promise<WebSocketInterface> }