marianoguerra/megalodon/client does not have a README file

    Client

    pub struct Client {
    transport : &
    Transport

    base_url : String
    software : ServerSoftware
    access_token : String?
    user_agent : String
    extra_headers : Map[String, String]
    }

    Client::add_accounts_to_list

    async fn Client::add_accounts_to_list(self : Client, id : String, account_ids : Array[String]) ->
    Response
    [Json] raise
    MegalodonError

    Client::add_reaction_to_announcement

    async fn Client::add_reaction_to_announcement(self : Client, id : String, name : String) ->
    Response
    [Json] raise
    MegalodonError

    Client::base_url

    fn Client::base_url(self : Client) -> String

    Client::block_domain

    Client::call

    The complete REST escape hatch. Endpoint inventories every operation in the reference interface; query/body encoding remains explicit for forward compatibility with server extensions.

    Client::cancel_scheduled_status

    Client::create_app

    async fn Client::create_app(self : Client, client_name : String, redirect_uris? : String, scopes? : Array[String], website? : String) ->
    AppData
    raise
    MegalodonError

    Client::create_emoji_reaction

    Client::delete_accounts_from_list

    async fn Client::delete_accounts_from_list(self : Client, id : String, account_ids : Array[String]) ->
    Response
    [Json] raise
    MegalodonError

    Client::delete_conversation

    Client::delete_emoji_reaction

    Client::delete_push_subscription

    Client::dismiss_instance_announcement

    Client::dismiss_notification

    Client::dismiss_notifications

    Client::edit_status

    async fn Client::edit_status(self : Client, id : String, status? : String, media_ids? : Array[String], sensitive? : Bool, spoiler_text? : String, language? : String) ->
    Response
    [
    Status
    ] raise
    MegalodonError

    Client::fetch_access_token

    async fn Client::fetch_access_token(self : Client, client_id : String, client_secret : String, code : String, redirect_uri? : String) ->
    TokenData
    raise
    MegalodonError

    Client::get_account_favourites

    async fn Client::get_account_favourites(self : Client, id : String, limit? : Int, max_id? : String, min_id? : String) ->
    Response
    [Array[
    Status
    ]] raise
    MegalodonError

    Client::get_account_followers

    async fn Client::get_account_followers(self : Client, id : String, limit? : Int, max_id? : String, since_id? : String) ->
    Response
    [Array[
    Account
    ]] raise
    MegalodonError

    Client::get_account_following

    async fn Client::get_account_following(self : Client, id : String, limit? : Int, max_id? : String, since_id? : String) ->
    Response
    [Array[
    Account
    ]] raise
    MegalodonError

    Client::get_account_statuses

    async fn Client::get_account_statuses(self : Client, id : String, limit? : Int, max_id? : String, since_id? : String, min_id? : String, pinned? : Bool, exclude_replies? : Bool, exclude_reblogs? : Bool, only_media? : Bool, only_public? : Bool) ->
    Response
    [Array[
    Status
    ]] raise
    MegalodonError

    Client::get_accounts_in_list

    Client::get_blocks

    Client::get_bookmarks

    async fn Client::get_bookmarks(self : Client, limit? : Int, max_id? : String, since_id? : String, min_id? : String) ->
    Response
    [Array[
    Status
    ]] raise
    MegalodonError

    Client::get_conversation_timeline

    async fn Client::get_conversation_timeline(self : Client, limit? : Int, max_id? : String, since_id? : String, min_id? : String) ->
    Response
    [Array[
    EntityObject
    ]] raise
    MegalodonError

    Client::get_domain_blocks

    async fn Client::get_domain_blocks(self : Client, limit? : Int, max_id? : String) ->
    Response
    [Array[String]] raise
    MegalodonError

    Client::get_favourites

    Client::get_home_timeline

    async fn Client::get_home_timeline(self : Client, limit? : Int, max_id? : String, since_id? : String, min_id? : String) ->
    Response
    [Array[
    Status
    ]] raise
    MegalodonError

    Client::get_instance_directory

    Client::get_instance_peers

    Client::get_list_timeline

    async fn Client::get_list_timeline(self : Client, list_id : String, limit? : Int, max_id? : String, since_id? : String, min_id? : String) ->
    Response
    [Array[
    Status
    ]] raise
    MegalodonError

    Client::get_local_timeline

    async fn Client::get_local_timeline(self : Client, limit? : Int, max_id? : String, since_id? : String, min_id? : String, only_media? : Bool) ->
    Response
    [Array[
    Status
    ]] raise
    MegalodonError

    Client::get_notifications

    async fn Client::get_notifications(self : Client, limit? : Int, max_id? : String, since_id? : String, min_id? : String, account_id? : String, exclude_types? : Array[
    NotificationType
    ]) ->
    Response
    [Array[
    Notification
    ]] raise
    MegalodonError

    Client::get_public_timeline

    async fn Client::get_public_timeline(self : Client, limit? : Int, max_id? : String, since_id? : String, min_id? : String, only_media? : Bool, local_only? : Bool) ->
    Response
    [Array[
    Status
    ]] raise
    MegalodonError

    Client::get_status_favourited_by

    Client::get_status_reblogged_by

    Client::get_tag_timeline

    async fn Client::get_tag_timeline(self : Client, hashtag : String, limit? : Int, max_id? : String, since_id? : String, min_id? : String, only_media? : Bool, local_only? : Bool) ->
    Response
    [Array[
    Status
    ]] raise
    MegalodonError

    Client::mute_account

    Client::new

    fn Client::new(transport : &
    Transport
    , software : ServerSoftware, base_url : String, access_token? : String, user_agent? : String, extra_headers? : Map[String, String]) -> Client

    Client::post_status

    async fn Client::post_status(self : Client, status : String, media_ids? : Array[String], in_reply_to_id? : String, sensitive? : Bool, spoiler_text? : String, visibility? :
    StatusVisibility
    , scheduled_at? : String, language? : String, quote_id? : String) ->
    Response
    [Json] raise
    MegalodonError

    Client::read_notifications

    Client::refresh_access_token

    async fn Client::refresh_access_token(self : Client, client_id : String, client_secret : String, refresh_token : String) ->
    TokenData
    raise
    MegalodonError

    Client::register_app

    async fn Client::register_app(self : Client, client_name : String, redirect_uris? : String, scopes? : Array[String], website? : String) ->
    AppData
    raise
    MegalodonError

    Client::remove_reaction_from_announcement

    async fn Client::remove_reaction_from_announcement(self : Client, id : String, name : String) ->
    Response
    [Json] raise
    MegalodonError

    Client::revoke_access_token

    async fn Client::revoke_access_token(self : Client, client_id : String, client_secret : String, token : String) ->
    Response
    [Json] raise
    MegalodonError

    Client::search

    async fn Client::search(self : Client, q : String, search_type? : SearchType, limit? : Int, max_id? : String, min_id? : String, resolve? : Bool, offset? : Int64, following? : Bool, account_id? : String, exclude_unreviewed? : Bool) ->
    Response
    [
    EntityObject
    ] raise
    MegalodonError

    Client::search_account

    async fn Client::search_account(self : Client, q : String, following? : Bool, resolve? : Bool, limit? : Int, max_id? : String, since_id? : String) ->
    Response
    [Array[
    Account
    ]] raise
    MegalodonError

    Client::software

    fn Client::software(self : Client) -> ServerSoftware

    Client::unblock_domain

    Client::update_media

    Client::upload_media

    async fn Client::upload_media(self : Client, bytes : Bytes, mime_type : String, file_name? : String, description? : String, focus? : String, boundary? : String) ->
    Response
    [
    UploadMedia
    ] raise
    MegalodonError

    DirectoryOrder

    pub(all) enum DirectoryOrder {
    Active
    New
    } derive(Eq,
    Debug
    )

    DirectoryOrder::to_string

    fn DirectoryOrder::to_string(self : DirectoryOrder) -> String

    Endpoint

    pub(all) enum Endpoint {
    CreateApp
    FetchAccessToken
    RefreshAccessToken
    RevokeAccessToken
    VerifyAppCredentials
    RegisterAccount
    VerifyAccountCredentials
    UpdateCredentials
    GetAccount(String)
    GetAccountStatuses(String)
    GetAccountFavourites(String)
    SubscribeAccount(String)
    UnsubscribeAccount(String)
    GetAccountFollowers(String)
    GetAccountFollowing(String)
    GetAccountLists(String)
    GetIdentityProofs(String)
    FollowAccount(String)
    UnfollowAccount(String)
    BlockAccount(String)
    UnblockAccount(String)
    MuteAccount(String)
    UnmuteAccount(String)
    PinAccount(String)
    UnpinAccount(String)
    SetAccountNote(String)
    GetRelationships
    SearchAccount
    LookupAccount
    GetBookmarks
    GetFavourites
    GetMutes
    GetBlocks
    GetDomainBlocks
    BlockDomain
    UnblockDomain
    GetFilters
    GetFilter(String)
    CreateFilter
    UpdateFilter(String)
    DeleteFilter(String)
    Report
    GetFollowRequests
    AcceptFollowRequest(String)
    RejectFollowRequest(String)
    GetEndorsements
    GetFeaturedTags
    CreateFeaturedTag
    DeleteFeaturedTag(String)
    GetSuggestedTags
    GetPreferences
    GetFollowedTags
    GetSuggestions
    GetTag(String)
    FollowTag(String)
    UnfollowTag(String)
    PostStatus
    GetStatus(String)
    GetStatusSource(String)
    EditStatus(String)
    DeleteStatus(String)
    GetStatusContext(String)
    GetStatusRebloggedBy(String)
    GetStatusFavouritedBy(String)
    FavouriteStatus(String)
    UnfavouriteStatus(String)
    ReblogStatus(String)
    UnreblogStatus(String)
    BookmarkStatus(String)
    UnbookmarkStatus(String)
    MuteStatus(String)
    UnmuteStatus(String)
    PinStatus(String)
    UnpinStatus(String)
    UploadMedia
    GetMedia(String)
    UpdateMedia(String)
    GetPoll(String)
    VotePoll(String)
    GetScheduledStatuses
    GetScheduledStatus(String)
    ScheduleStatus(String)
    CancelScheduledStatus(String)
    GetPublicTimeline
    GetLocalTimeline
    GetTagTimeline(String)
    GetHomeTimeline
    GetListTimeline(String)
    GetConversationTimeline
    DeleteConversation(String)
    ReadConversation(String)
    GetLists
    GetList(String)
    CreateList
    UpdateList(String)
    DeleteList(String)
    GetAccountsInList(String)
    AddAccountsToList(String)
    DeleteAccountsFromList(String)
    GetMarkers
    SaveMarkers
    GetNotifications
    GetNotification(String)
    DismissNotifications
    DismissNotification(String)
    ReadNotifications
    SubscribePushNotification
    GetPushSubscription
    UpdatePushSubscription
    DeletePushSubscription
    Search
    GetInstance
    GetInstancePeers
    GetInstanceActivity
    GetInstanceTrends
    GetInstanceDirectory
    GetInstanceCustomEmojis
    GetInstanceAnnouncements
    DismissInstanceAnnouncement(String)
    AddReactionToAnnouncement(id~ : String, name~ : String)
    RemoveReactionFromAnnouncement(id~ : String, name~ : String)
    CreateEmojiReaction(id~ : String, emoji~ : String)
    DeleteEmojiReaction(id~ : String, emoji~ : String)
    GetEmojiReactions(String)
    GetEmojiReaction(id~ : String, emoji~ : String)
    } derive(Eq,
    Debug
    )

    The complete non-streaming, non-admin operation inventory from megalodon-rs/src/megalodon.rs at the revision recorded in provenance.

    Endpoint::http_method

    Endpoint::path

    fn Endpoint::path(self : Endpoint) -> String

    PollOptions

    pub(all) struct PollOptions {
    options : Array[String]
    expires_in : Int64?
    multiple : Bool?
    hide_totals : Bool?
    } derive(Eq,
    Debug
    )

    SearchType

    pub(all) enum SearchType {
    Accounts
    Hashtags
    Statuses
    } derive(Eq,
    Debug
    )

    SearchType::to_string

    fn SearchType::to_string(self : SearchType) -> String

    ServerSoftware

    pub(all) enum ServerSoftware {
    Mastodon
    Pleroma
    Friendica
    Firefish
    GoToSocial
    Pixelfed
    Akkoma
    Hometown
    Iceshrimp
    Unknown(String)
    } derive(Eq,
    Debug
    )

    ServerSoftware::parse

    fn ServerSoftware::parse(value : String) -> ServerSoftware

    ServerSoftware::to_string

    fn ServerSoftware::to_string(self : ServerSoftware) -> String

    authorization_url

    fn authorization_url(base_url : String, client_id : String, redirect_uri? : String, scopes? : Array[String]) -> String

    page_params

    fn page_params(limit? : Int, max_id? : String, since_id? : String, min_id? : String) ->
    Params

    Pagination accepted by most collection endpoints.