/mindwell-app

Android app for mindwell.win/index.html

Primary LanguageKotlin

org.openapitools.client - Kotlin client library for Mindwell

Requires

  • Kotlin 1.4.30
  • Gradle 6.8.3

Build

First, create the gradle wrapper script:

gradle wrapper

Then, run:

./gradlew check assemble

This runs all tests and packages the library.

Features/Implementation Notes

  • Supports JSON inputs/outputs, File inputs, and Form inputs.
  • Supports collection formats for query parameters: csv, tsv, ssv, pipes.
  • Some Kotlin and Java types are fully qualified to avoid conflicts with types defined in OpenAPI definitions.
  • Implementation of ApiClient is intended to reduce method counts, specifically to benefit Android targets.

Documentation for API Endpoints

All URIs are relative to /api/v1

Class Method HTTP request Description
AccountApi accountEmailEmailGet GET /account/email/{email} check if email is used
AccountApi accountEmailPost POST /account/email set new email
AccountApi accountInvitesGet GET /account/invites
AccountApi accountLoginPost POST /account/login
AccountApi accountNameNameGet GET /account/name/{name} check if name is used
AccountApi accountPasswordPost POST /account/password change new password
AccountApi accountRecoverPasswordPost POST /account/recover/password reset password
AccountApi accountRecoverPost POST /account/recover request reset password email
AccountApi accountRegisterPost POST /account/register register new account
AccountApi accountSettingsEmailGet GET /account/settings/email
AccountApi accountSettingsEmailPut PUT /account/settings/email
AccountApi accountSettingsTelegramGet GET /account/settings/telegram
AccountApi accountSettingsTelegramPut PUT /account/settings/telegram
AccountApi accountSubscribeTelegramDelete DELETE /account/subscribe/telegram
AccountApi accountSubscribeTelegramGet GET /account/subscribe/telegram
AccountApi accountSubscribeTokenGet GET /account/subscribe/token
AccountApi accountVerificationEmailGet GET /account/verification/{email} verify account email
AccountApi accountVerificationPost POST /account/verification request verification email
AdmApi admGrandfatherGet GET /adm/grandfather
AdmApi admGrandfatherStatusGet GET /adm/grandfather/status
AdmApi admGrandfatherStatusPost POST /adm/grandfather/status
AdmApi admGrandsonGet GET /adm/grandson
AdmApi admGrandsonPost POST /adm/grandson
AdmApi admGrandsonStatusGet GET /adm/grandson/status
AdmApi admGrandsonStatusPost POST /adm/grandson/status
AdmApi admStatGet GET /adm/stat
ChatsApi chatsGet GET /chats
ChatsApi chatsNameGet GET /chats/{name}
ChatsApi chatsNameMessagesGet GET /chats/{name}/messages
ChatsApi chatsNameMessagesPost POST /chats/{name}/messages
ChatsApi chatsNameReadPut PUT /chats/{name}/read
ChatsApi messagesIdDelete DELETE /messages/{id}
ChatsApi messagesIdGet GET /messages/{id}
ChatsApi messagesIdPut PUT /messages/{id}
CommentsApi commentsIdComplainPost POST /comments/{id}/complain
CommentsApi commentsIdDelete DELETE /comments/{id}
CommentsApi commentsIdGet GET /comments/{id}
CommentsApi commentsIdPut PUT /comments/{id}
CommentsApi entriesIdCommentsGet GET /entries/{id}/comments
CommentsApi entriesIdCommentsPost POST /entries/{id}/comments
DesignApi designFontsGet GET /design/fonts
DesignApi designGet GET /design
DesignApi designPut PUT /design
EntriesApi entriesAnonymousGet GET /entries/anonymous
EntriesApi entriesAnonymousPost POST /entries/anonymous
EntriesApi entriesBestGet GET /entries/best
EntriesApi entriesFriendsGet GET /entries/friends
EntriesApi entriesIdAdjacentGet GET /entries/{id}/adjacent
EntriesApi entriesIdComplainPost POST /entries/{id}/complain
EntriesApi entriesIdDelete DELETE /entries/{id}
EntriesApi entriesIdGet GET /entries/{id}
EntriesApi entriesIdPut PUT /entries/{id}
EntriesApi entriesLiveGet GET /entries/live
EntriesApi entriesRandomGet GET /entries/random
EntriesApi entriesTagsGet GET /entries/tags
EntriesApi entriesWatchingGet GET /entries/watching
FavoritesApi entriesIdFavoriteDelete DELETE /entries/{id}/favorite
FavoritesApi entriesIdFavoriteGet GET /entries/{id}/favorite
FavoritesApi entriesIdFavoritePut PUT /entries/{id}/favorite
ImagesApi imagesIdDelete DELETE /images/{id}
ImagesApi imagesIdGet GET /images/{id}
ImagesApi imagesPost POST /images
MeApi meAvatarPut PUT /me/avatar
MeApi meCalendarGet GET /me/calendar
MeApi meCoverPut PUT /me/cover
MeApi meFavoritesGet GET /me/favorites
MeApi meFollowersGet GET /me/followers
MeApi meFollowingsGet GET /me/followings
MeApi meGet GET /me
MeApi meHiddenGet GET /me/hidden
MeApi meIgnoredGet GET /me/ignored
MeApi meImagesGet GET /me/images
MeApi meInvitedGet GET /me/invited
MeApi meOnlinePut PUT /me/online
MeApi mePut PUT /me
MeApi meRequestedGet GET /me/requested
MeApi meTagsGet GET /me/tags
MeApi meTlogGet GET /me/tlog
MeApi meTlogPost POST /me/tlog
NotificationsApi notificationsGet GET /notifications
NotificationsApi notificationsIdGet GET /notifications/{id}
NotificationsApi notificationsReadPut PUT /notifications/read
Oauth2Api oauth2AllowPost POST /oauth2/allow only for internal usage
Oauth2Api oauth2AppsIdGet GET /oauth2/apps/{id}
Oauth2Api oauth2DenyGet GET /oauth2/deny only for internal usage
Oauth2Api oauth2TokenPost POST /oauth2/token
RelationsApi relationsFromNameDelete DELETE /relations/from/{name} cancel following request or unsubscribe the user
RelationsApi relationsFromNameGet GET /relations/from/{name}
RelationsApi relationsFromNamePut PUT /relations/from/{name} permit the user to follow you
RelationsApi relationsInvitedNamePost POST /relations/invited/{name}
RelationsApi relationsToNameDelete DELETE /relations/to/{name}
RelationsApi relationsToNameGet GET /relations/to/{name}
RelationsApi relationsToNamePut PUT /relations/to/{name}
UsersApi usersGet GET /users
UsersApi usersNameCalendarGet GET /users/{name}/calendar
UsersApi usersNameFavoritesGet GET /users/{name}/favorites
UsersApi usersNameFollowersGet GET /users/{name}/followers
UsersApi usersNameFollowingsGet GET /users/{name}/followings
UsersApi usersNameGet GET /users/{name}
UsersApi usersNameImagesGet GET /users/{name}/images
UsersApi usersNameInvitedGet GET /users/{name}/invited
UsersApi usersNameTagsGet GET /users/{name}/tags
UsersApi usersNameTlogGet GET /users/{name}/tlog
VotesApi commentsIdVoteDelete DELETE /comments/{id}/vote
VotesApi commentsIdVoteGet GET /comments/{id}/vote
VotesApi commentsIdVotePut PUT /comments/{id}/vote
VotesApi entriesIdVoteDelete DELETE /entries/{id}/vote
VotesApi entriesIdVoteGet GET /entries/{id}/vote
VotesApi entriesIdVotePut PUT /entries/{id}/vote
WatchingsApi entriesIdWatchingDelete DELETE /entries/{id}/watching
WatchingsApi entriesIdWatchingGet GET /entries/{id}/watching
WatchingsApi entriesIdWatchingPut PUT /entries/{id}/watching

Documentation for Models

Documentation for Authorization

OAuth2App

  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes: N/A

OAuth2Code

  • Type: OAuth
  • Flow: accessCode
  • Authorization URL: /oauth
  • Scopes:
    • account:read: read available invites, etc.
    • account:write: change email, password, etc.
    • adm:read: read adm info and statuses
    • adm:write: change adm info and update statuses
    • comments:read: read comments and comment votes
    • comments:write: create, edit and remove comments
    • entries:read: read entries, entry votes, favorites, watchings, tags
    • entries:write: create, edit and remove tlog entries
    • favorites:write: add entries to favorites and remove
    • images:read: get uploaded images
    • images:write: upload new images
    • messages:read: read chats and messages and set them read
    • messages:write: create, edit and remove messages
    • notifications:read: read notifications and set them read
    • relations:write: follow, block, hide tlogs, accept followers, invite people
    • settings:read: read account settings
    • settings:write: change account settings
    • users:read: read profile info, relations
    • users:write: change profile info, avatar, etc.
    • votes:write: vote and unvote entries and comments
    • watchings:write: subscribe to entry comments and unsubscribe

OAuth2Password

  • Type: OAuth
  • Flow: password
  • Authorization URL:
  • Scopes: N/A