revolt_api
| Crates.io | revolt_api |
| lib.rs | revolt_api |
| version | 0.6.5 |
| source | src |
| created_at | 2022-09-06 14:37:07.349064 |
| updated_at | 2023-07-20 20:33:24.045084 |
| description | Open source user-first chat platform. |
| homepage | |
| repository | https://github.com/yvvki/revolute |
| max_upload_size | |
| id | 659567 |
| size | 1,077,145 |
Yuuki Rika (yvvki)
documentation
README
Rust API client for revolt_api
Open source user-first chat platform.
For more information, please visit https://revolt.chat
Overview
This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.
- API version: 0.6.5
- Package version: 0.6.5
- Build package:
org.openapitools.codegen.languages.RustClientCodegen
Installation
Put the package under your project folder in a directory named revolt_api and add the following to Cargo.toml under [dependencies]:
revolt_api = { path = "./revolt_api" }
Documentation for API Endpoints
All URIs are relative to https://api.revolt.chat
| Class | Method | HTTP request | Description |
|---|
AccountApi | change_email_change_email | PATCH /auth/account/change/email | Change Email AccountApi | change_password_change_password | PATCH /auth/account/change/password | Change Password AccountApi | confirm_deletion_confirm_deletion | PUT /auth/account/delete | Confirm Account Deletion AccountApi | create_account_create_account | POST /auth/account/create | Create Account AccountApi | delete_account_delete_account | POST /auth/account/delete | Delete Account AccountApi | disable_account_disable_account | POST /auth/account/disable | Disable Account AccountApi | fetch_account_fetch_account | GET /auth/account/ | Fetch Account AccountApi | password_reset_password_reset | PATCH /auth/account/reset_password | Password Reset AccountApi | resend_verification_resend_verification | POST /auth/account/reverify | Resend Verification AccountApi | send_password_reset_send_password_reset | POST /auth/account/reset_password | Send Password Reset AccountApi | verify_email_verify_email | POST /auth/account/verify/{code} | Verify Email AdminApi | message_query_message_query | POST /admin/messages | Globally Fetch Messages AdminApi | stats_stats | GET /admin/stats | Query Stats BotsApi | create_create_bot | POST /bots/create | Create Bot BotsApi | delete_delete_bot | DELETE /bots/{target} | Delete Bot BotsApi | edit_edit_bot | PATCH /bots/{target} | Edit Bot BotsApi | fetch_fetch_bot | GET /bots/{bot} | Fetch Bot BotsApi | fetch_owned_fetch_owned_bots | GET /bots/@me | Fetch Owned Bots BotsApi | fetch_public_fetch_public_bot | GET /bots/{target}/invite | Fetch Public Bot BotsApi | invite_invite_bot | POST /bots/{target}/invite | Invite Bot ChannelInformationApi | channel_delete_req | DELETE /channels/{target} | Close Channel ChannelInformationApi | channel_edit_req | PATCH /channels/{target} | Edit Channel ChannelInformationApi | channel_fetch_req | GET /channels/{target} | Fetch Channel ChannelInvitesApi | invite_create_req | POST /channels/{target}/invites | Create Invite ChannelPermissionsApi | permissions_set_default_req | PUT /channels/{target}/permissions/default | Set Default Permission ChannelPermissionsApi | permissions_set_req | PUT /channels/{target}/permissions/{role_id} | Set Role Permission CoreApi | root_root | GET / | Query Node DirectMessagingApi | fetch_dms_req | GET /users/dms | Fetch Direct Message Channels DirectMessagingApi | open_dm_req | GET /users/{target}/dm | Open Direct Message EmojisApi | emoji_create_create_emoji | PUT /custom/emoji/{id} | Create New Emoji EmojisApi | emoji_delete_delete_emoji | DELETE /custom/emoji/{id} | Delete Emoji EmojisApi | emoji_fetch_fetch_emoji | GET /custom/emoji/{id} | Fetch Emoji GroupsApi | group_add_member_req | PUT /channels/{target}/recipients/{member} | Add Member to Group GroupsApi | group_create_req | POST /channels/create | Create Group GroupsApi | group_remove_member_req | DELETE /channels/{target}/recipients/{member} | Remove Member from Group GroupsApi | members_fetch_req | GET /channels/{target}/members | Fetch Group Members InteractionsApi | message_clear_reactions_clear_reactions | DELETE /channels/{target}/messages/{msg}/reactions | Remove All Reactions from Message InteractionsApi | message_react_react_message | PUT /channels/{target}/messages/{msg}/reactions/{emoji} | Add Reaction to Message InteractionsApi | message_unreact_unreact_message | DELETE /channels/{target}/messages/{msg}/reactions/{emoji} | Remove Reaction(s) to Message InvitesApi | invite_delete_req | DELETE /invites/{target} | Delete Invite InvitesApi | invite_fetch_req | GET /invites/{target} | Fetch Invite InvitesApi | invite_join_req | POST /invites/{target} | Join Invite MfaApi | create_ticket_create_ticket | PUT /auth/mfa/ticket | Create MFA ticket MfaApi | fetch_recovery_fetch_recovery | POST /auth/mfa/recovery | Fetch Recovery Codes MfaApi | fetch_status_fetch_status | GET /auth/mfa/ | MFA Status MfaApi | generate_recovery_generate_recovery | PATCH /auth/mfa/recovery | Generate Recovery Codes MfaApi | get_mfa_methods_get_mfa_methods | GET /auth/mfa/methods | Get MFA Methods MfaApi | totp_disable_totp_disable | DELETE /auth/mfa/totp | Disable TOTP 2FA MfaApi | totp_enable_totp_enable | PUT /auth/mfa/totp | Enable TOTP 2FA MfaApi | totp_generate_secret_totp_generate_secret | POST /auth/mfa/totp | Generate TOTP Secret MessagingApi | channel_ack_req | PUT /channels/{target}/ack/{message} | Acknowledge Message MessagingApi | message_bulk_delete_req | DELETE /channels/{target}/messages/bulk | Bulk Delete Messages MessagingApi | message_delete_req | DELETE /channels/{target}/messages/{msg} | Delete Message MessagingApi | message_edit_req | PATCH /channels/{target}/messages/{msg} | Edit Message MessagingApi | message_fetch_req | GET /channels/{target}/messages/{msg} | Fetch Message MessagingApi | message_query_req | GET /channels/{target}/messages | Fetch Messages MessagingApi | message_query_stale_req | POST /channels/{_target}/messages/stale | Poll Message Changes MessagingApi | message_search_req | POST /channels/{target}/search | Search for Messages MessagingApi | message_send_message_send | POST /channels/{target}/messages | Send Message OnboardingApi | complete_req | POST /onboard/complete | Complete Onboarding OnboardingApi | hello_req | GET /onboard/hello | Check Onboarding Status RelationshipsApi | add_friend_req | PUT /users/{target}/friend | Accept Friend Request RelationshipsApi | block_user_req | PUT /users/{target}/block | Block User RelationshipsApi | find_mutual_req | GET /users/{target}/mutual | Fetch Mutual Friends And Servers RelationshipsApi | remove_friend_req | DELETE /users/{target}/friend | Deny Friend Request / Remove Friend RelationshipsApi | send_friend_request_req | POST /users/friend | Send Friend Request RelationshipsApi | unblock_user_req | DELETE /users/{target}/block | Unblock User ServerCustomisationApi | emoji_list_list_emoji | GET /servers/{target}/emojis | Fetch Server Emoji ServerInformationApi | channel_create_req | POST /servers/{target}/channels | Create Channel ServerInformationApi | server_ack_req | PUT /servers/{target}/ack | Mark Server As Read ServerInformationApi | server_create_req | POST /servers/create | Create Server ServerInformationApi | server_delete_req | DELETE /servers/{target} | Delete / Leave Server ServerInformationApi | server_edit_req | PATCH /servers/{target} | Edit Server ServerInformationApi | server_fetch_req | GET /servers/{target} | Fetch Server ServerMembersApi | ban_create_req | PUT /servers/{server}/bans/{target} | Ban User ServerMembersApi | ban_list_req | GET /servers/{target}/bans | Fetch Bans ServerMembersApi | ban_remove_req | DELETE /servers/{server}/bans/{target} | Unban user ServerMembersApi | invites_fetch_req | GET /servers/{target}/invites | Fetch Invites ServerMembersApi | member_edit_req | PATCH /servers/{server}/members/{target} | Edit Member ServerMembersApi | member_experimental_query_member_experimental_query | GET /servers/{target}/members_experimental_query | Query members by name ServerMembersApi | member_fetch_all_req | GET /servers/{target}/members | Fetch Members ServerMembersApi | member_fetch_req | GET /servers/{target}/members/{member} | Fetch Member ServerMembersApi | member_remove_req | DELETE /servers/{target}/members/{member} | Kick Member ServerPermissionsApi | permissions_set_default_req | PUT /servers/{target}/permissions/default | Set Default Permission ServerPermissionsApi | permissions_set_req | PUT /servers/{target}/permissions/{role_id} | Set Role Permission ServerPermissionsApi | roles_create_req | POST /servers/{target}/roles | Create Role ServerPermissionsApi | roles_delete_req | DELETE /servers/{target}/roles/{role_id} | Delete Role ServerPermissionsApi | roles_edit_req | PATCH /servers/{target}/roles/{role_id} | Edit Role SessionApi | edit_edit | PATCH /auth/session/{id} | Edit Session SessionApi | fetch_all_fetch_all | GET /auth/session/all | Fetch Sessions SessionApi | login_login | POST /auth/session/login | Login SessionApi | logout_logout | POST /auth/session/logout | Logout SessionApi | revoke_all_revoke_all | DELETE /auth/session/all | Delete All Sessions SessionApi | revoke_revoke | DELETE /auth/session/{id} | Revoke Session SyncApi | get_settings_req | POST /sync/settings/fetch | Fetch Settings SyncApi | get_unreads_req | GET /sync/unreads | Fetch Unreads SyncApi | set_settings_req | POST /sync/settings/set | Set Settings UserInformationApi | change_username_req | PATCH /users/@me/username | Change Username UserInformationApi | edit_user_req | PATCH /users/{target} | Edit User UserInformationApi | fetch_profile_req | GET /users/{target}/profile | Fetch User Profile UserInformationApi | fetch_self_req | GET /users/@me | Fetch Self UserInformationApi | fetch_user_flags_fetch_user_flags | GET /users/{target}/flags | Fetch User Flags UserInformationApi | fetch_user_req | GET /users/{target} | Fetch User UserInformationApi | get_default_avatar_req | GET /users/{target}/default_avatar | Fetch Default Avatar UserSafetyApi | create_strike_create_strike | POST /safety/strikes | Create Strike UserSafetyApi | delete_strike_delete_strike | DELETE /safety/strikes/{strike_id} | Delete Strike UserSafetyApi | edit_report_edit_report | PATCH /safety/reports/{report} | Edit Report UserSafetyApi | edit_strike_edit_strike | POST /safety/strikes/{strike_id} | Edit Strike UserSafetyApi | fetch_report_fetch_report | GET /safety/report/{id} | Fetch Report UserSafetyApi | fetch_reports_fetch_reports | GET /safety/reports | Fetch Reports UserSafetyApi | fetch_snapshots_fetch_snapshots | GET /safety/snapshot/{report_id} | Fetch Snapshots UserSafetyApi | fetch_strikes_fetch_strikes | GET /safety/strikes/{user_id} | Fetch Strikes UserSafetyApi | report_content_report_content | POST /safety/report | Report Content VoiceApi | voice_join_req | POST /channels/{target}/join_call | Join Call WebPushApi | subscribe_req | POST /push/subscribe | Push Subscribe WebPushApi | unsubscribe_req | POST /push/unsubscribe | Unsubscribe WebhooksApi | webhook_create_req | POST /channels/{target}/webhooks | Creates a webhook WebhooksApi | webhook_fetch_all_req | GET /channels/{channel_id}/webhooks | Gets all webhooks
Documentation For Models
To get access to the crate's generated documentation, use:
cargo doc --open