io.appwrite.services.Account.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of sdk-for-kotlin Show documentation
Show all versions of sdk-for-kotlin Show documentation
Appwrite is an open-source backend as a service server that abstract and simplify complex and repetitive development tasks behind a very simple to use REST API. Appwrite aims to help you develop your apps faster and in a more secure way. Use the Kotlin SDK to integrate your app with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)
package io.appwrite.services
import io.appwrite.Client
import io.appwrite.models.*
import io.appwrite.exceptions.AppwriteException
import io.appwrite.extensions.classOf
import okhttp3.Cookie
import java.io.File
/**
* The Account service allows you to authenticate and manage a user account.
**/
class Account : Service {
public constructor (client: Client) : super(client) { }
/**
* Get Account
*
* Get the currently logged in user.
*
* @return [io.appwrite.models.User]
*/
@Throws(AppwriteException::class)
suspend fun get(
nestedType: Class,
): io.appwrite.models.User {
val apiPath = "/account"
val apiParams = mutableMapOf(
)
val apiHeaders = mutableMapOf(
"content-type" to "application/json",
)
val converter: (Any) -> io.appwrite.models.User = {
io.appwrite.models.User.from(map = it as Map, nestedType)
}
return client.call(
"GET",
apiPath,
apiHeaders,
apiParams,
responseType = classOf(),
converter,
)
}
/**
* Get Account
*
* Get the currently logged in user.
*
* @return [io.appwrite.models.User]
*/
@Throws(AppwriteException::class)
suspend fun get(
): io.appwrite.models.User> = get(
nestedType = classOf(),
)
/**
* Update Email
*
* Update currently logged in user account email address. After changing user address, the user confirmation status will get reset. A new confirmation email is not sent automatically however you can use the send confirmation email endpoint again to send the confirmation email. For security measures, user password is required to complete this request.This endpoint can also be used to convert an anonymous account to a normal one, by passing an email address and a new password.
*
* @param email User email.
* @param password User password. Must be at least 8 chars.
* @return [io.appwrite.models.User]
*/
@Throws(AppwriteException::class)
suspend fun updateEmail(
email: String,
password: String,
nestedType: Class,
): io.appwrite.models.User {
val apiPath = "/account/email"
val apiParams = mutableMapOf(
"email" to email,
"password" to password,
)
val apiHeaders = mutableMapOf(
"content-type" to "application/json",
)
val converter: (Any) -> io.appwrite.models.User = {
io.appwrite.models.User.from(map = it as Map, nestedType)
}
return client.call(
"PATCH",
apiPath,
apiHeaders,
apiParams,
responseType = classOf(),
converter,
)
}
/**
* Update Email
*
* Update currently logged in user account email address. After changing user address, the user confirmation status will get reset. A new confirmation email is not sent automatically however you can use the send confirmation email endpoint again to send the confirmation email. For security measures, user password is required to complete this request.This endpoint can also be used to convert an anonymous account to a normal one, by passing an email address and a new password.
*
* @param email User email.
* @param password User password. Must be at least 8 chars.
* @return [io.appwrite.models.User]
*/
@Throws(AppwriteException::class)
suspend fun updateEmail(
email: String,
password: String,
): io.appwrite.models.User> = updateEmail(
email,
password,
nestedType = classOf(),
)
/**
* List Identities
*
* Get the list of identities for the currently logged in user.
*
* @param queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: userId, provider, providerUid, providerEmail, providerAccessTokenExpiry
* @return [io.appwrite.models.IdentityList]
*/
@JvmOverloads
@Throws(AppwriteException::class)
suspend fun listIdentities(
queries: String? = null,
): io.appwrite.models.IdentityList {
val apiPath = "/account/identities"
val apiParams = mutableMapOf(
"queries" to queries,
)
val apiHeaders = mutableMapOf(
"content-type" to "application/json",
)
val converter: (Any) -> io.appwrite.models.IdentityList = {
io.appwrite.models.IdentityList.from(map = it as Map)
}
return client.call(
"GET",
apiPath,
apiHeaders,
apiParams,
responseType = io.appwrite.models.IdentityList::class.java,
converter,
)
}
/**
* Delete Identity
*
* Delete an identity by its unique ID.
*
* @param identityId Identity ID.
* @return [Any]
*/
@Throws(AppwriteException::class)
suspend fun deleteIdentity(
identityId: String,
): Any {
val apiPath = "/account/identities/{identityId}"
.replace("{identityId}", identityId)
val apiParams = mutableMapOf(
)
val apiHeaders = mutableMapOf(
"content-type" to "application/json",
)
return client.call(
"DELETE",
apiPath,
apiHeaders,
apiParams,
responseType = Any::class.java,
)
}
/**
* List Logs
*
* Get the list of latest security activity logs for the currently logged in user. Each log returns user IP address, location and date and time of log.
*
* @param queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit and offset
* @return [io.appwrite.models.LogList]
*/
@JvmOverloads
@Throws(AppwriteException::class)
suspend fun listLogs(
queries: List? = null,
): io.appwrite.models.LogList {
val apiPath = "/account/logs"
val apiParams = mutableMapOf(
"queries" to queries,
)
val apiHeaders = mutableMapOf(
"content-type" to "application/json",
)
val converter: (Any) -> io.appwrite.models.LogList = {
io.appwrite.models.LogList.from(map = it as Map)
}
return client.call(
"GET",
apiPath,
apiHeaders,
apiParams,
responseType = io.appwrite.models.LogList::class.java,
converter,
)
}
/**
* Update Name
*
* Update currently logged in user account name.
*
* @param name User name. Max length: 128 chars.
* @return [io.appwrite.models.User]
*/
@Throws(AppwriteException::class)
suspend fun updateName(
name: String,
nestedType: Class,
): io.appwrite.models.User {
val apiPath = "/account/name"
val apiParams = mutableMapOf(
"name" to name,
)
val apiHeaders = mutableMapOf(
"content-type" to "application/json",
)
val converter: (Any) -> io.appwrite.models.User = {
io.appwrite.models.User.from(map = it as Map, nestedType)
}
return client.call(
"PATCH",
apiPath,
apiHeaders,
apiParams,
responseType = classOf(),
converter,
)
}
/**
* Update Name
*
* Update currently logged in user account name.
*
* @param name User name. Max length: 128 chars.
* @return [io.appwrite.models.User]
*/
@Throws(AppwriteException::class)
suspend fun updateName(
name: String,
): io.appwrite.models.User> = updateName(
name,
nestedType = classOf(),
)
/**
* Update Password
*
* Update currently logged in user password. For validation, user is required to pass in the new password, and the old password. For users created with OAuth, Team Invites and Magic URL, oldPassword is optional.
*
* @param password New user password. Must be at least 8 chars.
* @param oldPassword Current user password. Must be at least 8 chars.
* @return [io.appwrite.models.User]
*/
@JvmOverloads
@Throws(AppwriteException::class)
suspend fun updatePassword(
password: String,
oldPassword: String? = null,
nestedType: Class,
): io.appwrite.models.User {
val apiPath = "/account/password"
val apiParams = mutableMapOf(
"password" to password,
"oldPassword" to oldPassword,
)
val apiHeaders = mutableMapOf(
"content-type" to "application/json",
)
val converter: (Any) -> io.appwrite.models.User = {
io.appwrite.models.User.from(map = it as Map, nestedType)
}
return client.call(
"PATCH",
apiPath,
apiHeaders,
apiParams,
responseType = classOf(),
converter,
)
}
/**
* Update Password
*
* Update currently logged in user password. For validation, user is required to pass in the new password, and the old password. For users created with OAuth, Team Invites and Magic URL, oldPassword is optional.
*
* @param password New user password. Must be at least 8 chars.
* @param oldPassword Current user password. Must be at least 8 chars.
* @return [io.appwrite.models.User]
*/
@JvmOverloads
@Throws(AppwriteException::class)
suspend fun updatePassword(
password: String,
oldPassword: String? = null,
): io.appwrite.models.User> = updatePassword(
password,
oldPassword,
nestedType = classOf(),
)
/**
* Update Phone
*
* Update the currently logged in user's phone number. After updating the phone number, the phone verification status will be reset. A confirmation SMS is not sent automatically, however you can use the [POST /account/verification/phone](/docs/client/account#accountCreatePhoneVerification) endpoint to send a confirmation SMS.
*
* @param phone Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
* @param password User password. Must be at least 8 chars.
* @return [io.appwrite.models.User]
*/
@Throws(AppwriteException::class)
suspend fun updatePhone(
phone: String,
password: String,
nestedType: Class,
): io.appwrite.models.User {
val apiPath = "/account/phone"
val apiParams = mutableMapOf(
"phone" to phone,
"password" to password,
)
val apiHeaders = mutableMapOf(
"content-type" to "application/json",
)
val converter: (Any) -> io.appwrite.models.User = {
io.appwrite.models.User.from(map = it as Map, nestedType)
}
return client.call(
"PATCH",
apiPath,
apiHeaders,
apiParams,
responseType = classOf(),
converter,
)
}
/**
* Update Phone
*
* Update the currently logged in user's phone number. After updating the phone number, the phone verification status will be reset. A confirmation SMS is not sent automatically, however you can use the [POST /account/verification/phone](/docs/client/account#accountCreatePhoneVerification) endpoint to send a confirmation SMS.
*
* @param phone Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
* @param password User password. Must be at least 8 chars.
* @return [io.appwrite.models.User]
*/
@Throws(AppwriteException::class)
suspend fun updatePhone(
phone: String,
password: String,
): io.appwrite.models.User> = updatePhone(
phone,
password,
nestedType = classOf(),
)
/**
* Get Account Preferences
*
* Get the preferences as a key-value object for the currently logged in user.
*
* @return [io.appwrite.models.Preferences]
*/
@Throws(AppwriteException::class)
suspend fun getPrefs(
nestedType: Class,
): io.appwrite.models.Preferences {
val apiPath = "/account/prefs"
val apiParams = mutableMapOf(
)
val apiHeaders = mutableMapOf(
"content-type" to "application/json",
)
val converter: (Any) -> io.appwrite.models.Preferences = {
io.appwrite.models.Preferences.from(map = it as Map, nestedType)
}
return client.call(
"GET",
apiPath,
apiHeaders,
apiParams,
responseType = classOf(),
converter,
)
}
/**
* Get Account Preferences
*
* Get the preferences as a key-value object for the currently logged in user.
*
* @return [io.appwrite.models.Preferences]
*/
@Throws(AppwriteException::class)
suspend fun getPrefs(
): io.appwrite.models.Preferences> = getPrefs(
nestedType = classOf(),
)
/**
* Update Preferences
*
* Update currently logged in user account preferences. The object you pass is stored as is, and replaces any previous value. The maximum allowed prefs size is 64kB and throws error if exceeded.
*
* @param prefs Prefs key-value JSON object.
* @return [io.appwrite.models.User]
*/
@Throws(AppwriteException::class)
suspend fun updatePrefs(
prefs: Any,
nestedType: Class,
): io.appwrite.models.User {
val apiPath = "/account/prefs"
val apiParams = mutableMapOf(
"prefs" to prefs,
)
val apiHeaders = mutableMapOf(
"content-type" to "application/json",
)
val converter: (Any) -> io.appwrite.models.User = {
io.appwrite.models.User.from(map = it as Map, nestedType)
}
return client.call(
"PATCH",
apiPath,
apiHeaders,
apiParams,
responseType = classOf(),
converter,
)
}
/**
* Update Preferences
*
* Update currently logged in user account preferences. The object you pass is stored as is, and replaces any previous value. The maximum allowed prefs size is 64kB and throws error if exceeded.
*
* @param prefs Prefs key-value JSON object.
* @return [io.appwrite.models.User]
*/
@Throws(AppwriteException::class)
suspend fun updatePrefs(
prefs: Any,
): io.appwrite.models.User> = updatePrefs(
prefs,
nestedType = classOf(),
)
/**
* Create Password Recovery
*
* Sends the user an email with a temporary secret key for password reset. When the user clicks the confirmation link he is redirected back to your app password reset URL with the secret key and email address values attached to the URL query string. Use the query string params to submit a request to the [PUT /account/recovery](/docs/client/account#accountUpdateRecovery) endpoint to complete the process. The verification link sent to the user's email address is valid for 1 hour.
*
* @param email User email.
* @param url URL to redirect the user back to your app from the recovery email. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
* @return [io.appwrite.models.Token]
*/
@Throws(AppwriteException::class)
suspend fun createRecovery(
email: String,
url: String,
): io.appwrite.models.Token {
val apiPath = "/account/recovery"
val apiParams = mutableMapOf(
"email" to email,
"url" to url,
)
val apiHeaders = mutableMapOf(
"content-type" to "application/json",
)
val converter: (Any) -> io.appwrite.models.Token = {
io.appwrite.models.Token.from(map = it as Map)
}
return client.call(
"POST",
apiPath,
apiHeaders,
apiParams,
responseType = io.appwrite.models.Token::class.java,
converter,
)
}
/**
* Create Password Recovery (confirmation)
*
* Use this endpoint to complete the user account password reset. Both the **userId** and **secret** arguments will be passed as query parameters to the redirect URL you have provided when sending your request to the [POST /account/recovery](/docs/client/account#accountCreateRecovery) endpoint.Please note that in order to avoid a [Redirect Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) the only valid redirect URLs are the ones from domains you have set when adding your platforms in the console interface.
*
* @param userId User ID.
* @param secret Valid reset token.
* @param password New user password. Must be at least 8 chars.
* @param passwordAgain Repeat new user password. Must be at least 8 chars.
* @return [io.appwrite.models.Token]
*/
@Throws(AppwriteException::class)
suspend fun updateRecovery(
userId: String,
secret: String,
password: String,
passwordAgain: String,
): io.appwrite.models.Token {
val apiPath = "/account/recovery"
val apiParams = mutableMapOf(
"userId" to userId,
"secret" to secret,
"password" to password,
"passwordAgain" to passwordAgain,
)
val apiHeaders = mutableMapOf(
"content-type" to "application/json",
)
val converter: (Any) -> io.appwrite.models.Token = {
io.appwrite.models.Token.from(map = it as Map)
}
return client.call(
"PUT",
apiPath,
apiHeaders,
apiParams,
responseType = io.appwrite.models.Token::class.java,
converter,
)
}
/**
* List Sessions
*
* Get the list of active sessions across different devices for the currently logged in user.
*
* @return [io.appwrite.models.SessionList]
*/
@Throws(AppwriteException::class)
suspend fun listSessions(
): io.appwrite.models.SessionList {
val apiPath = "/account/sessions"
val apiParams = mutableMapOf(
)
val apiHeaders = mutableMapOf(
"content-type" to "application/json",
)
val converter: (Any) -> io.appwrite.models.SessionList = {
io.appwrite.models.SessionList.from(map = it as Map)
}
return client.call(
"GET",
apiPath,
apiHeaders,
apiParams,
responseType = io.appwrite.models.SessionList::class.java,
converter,
)
}
/**
* Delete Sessions
*
* Delete all sessions from the user account and remove any sessions cookies from the end client.
*
* @return [Any]
*/
@Throws(AppwriteException::class)
suspend fun deleteSessions(
): Any {
val apiPath = "/account/sessions"
val apiParams = mutableMapOf(
)
val apiHeaders = mutableMapOf(
"content-type" to "application/json",
)
return client.call(
"DELETE",
apiPath,
apiHeaders,
apiParams,
responseType = Any::class.java,
)
}
/**
* Get Session
*
* Use this endpoint to get a logged in user's session using a Session ID. Inputting 'current' will return the current session being used.
*
* @param sessionId Session ID. Use the string 'current' to get the current device session.
* @return [io.appwrite.models.Session]
*/
@Throws(AppwriteException::class)
suspend fun getSession(
sessionId: String,
): io.appwrite.models.Session {
val apiPath = "/account/sessions/{sessionId}"
.replace("{sessionId}", sessionId)
val apiParams = mutableMapOf(
)
val apiHeaders = mutableMapOf(
"content-type" to "application/json",
)
val converter: (Any) -> io.appwrite.models.Session = {
io.appwrite.models.Session.from(map = it as Map)
}
return client.call(
"GET",
apiPath,
apiHeaders,
apiParams,
responseType = io.appwrite.models.Session::class.java,
converter,
)
}
/**
* Update OAuth Session (Refresh Tokens)
*
* Access tokens have limited lifespan and expire to mitigate security risks. If session was created using an OAuth provider, this route can be used to "refresh" the access token.
*
* @param sessionId Session ID. Use the string 'current' to update the current device session.
* @return [io.appwrite.models.Session]
*/
@Throws(AppwriteException::class)
suspend fun updateSession(
sessionId: String,
): io.appwrite.models.Session {
val apiPath = "/account/sessions/{sessionId}"
.replace("{sessionId}", sessionId)
val apiParams = mutableMapOf(
)
val apiHeaders = mutableMapOf(
"content-type" to "application/json",
)
val converter: (Any) -> io.appwrite.models.Session = {
io.appwrite.models.Session.from(map = it as Map)
}
return client.call(
"PATCH",
apiPath,
apiHeaders,
apiParams,
responseType = io.appwrite.models.Session::class.java,
converter,
)
}
/**
* Delete Session
*
* Logout the user. Use 'current' as the session ID to logout on this device, use a session ID to logout on another device. If you're looking to logout the user on all devices, use [Delete Sessions](/docs/client/account#accountDeleteSessions) instead.
*
* @param sessionId Session ID. Use the string 'current' to delete the current device session.
* @return [Any]
*/
@Throws(AppwriteException::class)
suspend fun deleteSession(
sessionId: String,
): Any {
val apiPath = "/account/sessions/{sessionId}"
.replace("{sessionId}", sessionId)
val apiParams = mutableMapOf(
)
val apiHeaders = mutableMapOf(
"content-type" to "application/json",
)
return client.call(
"DELETE",
apiPath,
apiHeaders,
apiParams,
responseType = Any::class.java,
)
}
/**
* Update Status
*
* Block the currently logged in user account. Behind the scene, the user record is not deleted but permanently blocked from any access. To completely delete a user, use the Users API instead.
*
* @return [io.appwrite.models.User]
*/
@Throws(AppwriteException::class)
suspend fun updateStatus(
nestedType: Class,
): io.appwrite.models.User {
val apiPath = "/account/status"
val apiParams = mutableMapOf(
)
val apiHeaders = mutableMapOf(
"content-type" to "application/json",
)
val converter: (Any) -> io.appwrite.models.User = {
io.appwrite.models.User.from(map = it as Map, nestedType)
}
return client.call(
"PATCH",
apiPath,
apiHeaders,
apiParams,
responseType = classOf(),
converter,
)
}
/**
* Update Status
*
* Block the currently logged in user account. Behind the scene, the user record is not deleted but permanently blocked from any access. To completely delete a user, use the Users API instead.
*
* @return [io.appwrite.models.User]
*/
@Throws(AppwriteException::class)
suspend fun updateStatus(
): io.appwrite.models.User> = updateStatus(
nestedType = classOf(),
)
/**
* Create Email Verification
*
* Use this endpoint to send a verification message to your user email address to confirm they are the valid owners of that address. Both the **userId** and **secret** arguments will be passed as query parameters to the URL you have provided to be attached to the verification email. The provided URL should redirect the user back to your app and allow you to complete the verification process by verifying both the **userId** and **secret** parameters. Learn more about how to [complete the verification process](/docs/client/account#accountUpdateEmailVerification). The verification link sent to the user's email address is valid for 7 days.Please note that in order to avoid a [Redirect Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md), the only valid redirect URLs are the ones from domains you have set when adding your platforms in the console interface.
*
* @param url URL to redirect the user back to your app from the verification email. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
* @return [io.appwrite.models.Token]
*/
@Throws(AppwriteException::class)
suspend fun createVerification(
url: String,
): io.appwrite.models.Token {
val apiPath = "/account/verification"
val apiParams = mutableMapOf(
"url" to url,
)
val apiHeaders = mutableMapOf(
"content-type" to "application/json",
)
val converter: (Any) -> io.appwrite.models.Token = {
io.appwrite.models.Token.from(map = it as Map)
}
return client.call(
"POST",
apiPath,
apiHeaders,
apiParams,
responseType = io.appwrite.models.Token::class.java,
converter,
)
}
/**
* Create Email Verification (confirmation)
*
* Use this endpoint to complete the user email verification process. Use both the **userId** and **secret** parameters that were attached to your app URL to verify the user email ownership. If confirmed this route will return a 200 status code.
*
* @param userId User ID.
* @param secret Valid verification token.
* @return [io.appwrite.models.Token]
*/
@Throws(AppwriteException::class)
suspend fun updateVerification(
userId: String,
secret: String,
): io.appwrite.models.Token {
val apiPath = "/account/verification"
val apiParams = mutableMapOf(
"userId" to userId,
"secret" to secret,
)
val apiHeaders = mutableMapOf(
"content-type" to "application/json",
)
val converter: (Any) -> io.appwrite.models.Token = {
io.appwrite.models.Token.from(map = it as Map)
}
return client.call(
"PUT",
apiPath,
apiHeaders,
apiParams,
responseType = io.appwrite.models.Token::class.java,
converter,
)
}
/**
* Create Phone Verification
*
* Use this endpoint to send a verification SMS to the currently logged in user. This endpoint is meant for use after updating a user's phone number using the [accountUpdatePhone](/docs/client/account#accountUpdatePhone) endpoint. Learn more about how to [complete the verification process](/docs/client/account#accountUpdatePhoneVerification). The verification code sent to the user's phone number is valid for 15 minutes.
*
* @return [io.appwrite.models.Token]
*/
@Throws(AppwriteException::class)
suspend fun createPhoneVerification(
): io.appwrite.models.Token {
val apiPath = "/account/verification/phone"
val apiParams = mutableMapOf(
)
val apiHeaders = mutableMapOf(
"content-type" to "application/json",
)
val converter: (Any) -> io.appwrite.models.Token = {
io.appwrite.models.Token.from(map = it as Map)
}
return client.call(
"POST",
apiPath,
apiHeaders,
apiParams,
responseType = io.appwrite.models.Token::class.java,
converter,
)
}
/**
* Create Phone Verification (confirmation)
*
* Use this endpoint to complete the user phone verification process. Use the **userId** and **secret** that were sent to your user's phone number to verify the user email ownership. If confirmed this route will return a 200 status code.
*
* @param userId User ID.
* @param secret Valid verification token.
* @return [io.appwrite.models.Token]
*/
@Throws(AppwriteException::class)
suspend fun updatePhoneVerification(
userId: String,
secret: String,
): io.appwrite.models.Token {
val apiPath = "/account/verification/phone"
val apiParams = mutableMapOf(
"userId" to userId,
"secret" to secret,
)
val apiHeaders = mutableMapOf(
"content-type" to "application/json",
)
val converter: (Any) -> io.appwrite.models.Token = {
io.appwrite.models.Token.from(map = it as Map)
}
return client.call(
"PUT",
apiPath,
apiHeaders,
apiParams,
responseType = io.appwrite.models.Token::class.java,
converter,
)
}
} © 2015 - 2024 Weber Informatics LLC | Privacy Policy